core

type C ¶

type C = layout.Context

type ClipboardData ¶

type ClipboardData struct {
	Text   string
	Images []ClipboardImage
	Files  []string
}

ClipboardData holds the available text, images and file paths in one paste. Paths are references only; the UI does not open the files automatically.

type ClipboardImage ¶

type ClipboardImage struct {
	MIME string
	Data []byte
}

ClipboardImage is owned encoded image data provided to a paste handler.

type ClipboardReader ¶

type ClipboardReader func(done func(ClipboardData, error))

ClipboardReader starts an asynchronous read. It must call done once, on any goroutine; input components marshal completion back to the UI loop. An error falls back to Gio text paste. Applications can adapt native/clipboard.Read.

type CodeToken ¶ added in v0.0.7

type CodeToken struct {
	Text         string
	Color        color.NRGBA
	Bold, Italic bool
	Kind         CodeTokenKind
}

CodeToken is a run of source text with its style. A zero Color means the default text color.

type CodeTokenKind ¶ added in v0.0.7

type CodeTokenKind uint8

CodeTokenKind is the syntax context of a token, for editing rules such as not pairing brackets inside strings.

const (
	CodeTokenCode CodeTokenKind = iota
	CodeTokenString
	CodeTokenComment
)

type D ¶

type D = layout.Dimensions

func Semantic(gtx C, w func(gtx C) D, ops ...interface{ Add(*op.Ops) }) D

type EditAction ¶ added in v0.1.6

type EditAction string

EditAction is a standard application-menu operation. Custom editors may consume these with NextEditAction while they retain keyboard focus.

const (
	EditCopy      EditAction = "copy"
	EditCut       EditAction = "cut"
	EditPaste     EditAction = "paste"
	EditSelectAll EditAction = "select-all"
	EditUndo      EditAction = "undo"
	EditRedo      EditAction = "redo"
)

func NextEditAction(gtx C, tag event.Tag) (EditAction, bool)

type Func ¶

type Func func(gtx C) D

Func adapts a plain Gio layout function to Widget.

func (f Func) Layout(gtx C) D

type HighlightOptions ¶ added in v0.0.7

type HighlightOptions struct {
	// Language is a name, alias or file extension ("go", "Go", "golang").
	Language string
	// Guess detects the language from the code when Language is empty or
	// unknown.
	Guess bool
	// Style names a color scheme; empty picks one for Dark.
	Style string
	// Dark is true on a dark code background.
	Dark bool
}

HighlightOptions say how to highlight.

type Highlighter ¶ added in v0.0.7

type Highlighter interface {
	// Highlight splits code into tokens whose texts concatenate to code.
	// ok is false when the language is unknown (and not guessed): the code
	// then stays plain.
	Highlight(code string, opts HighlightOptions) (tokens []CodeToken, ok bool)
	// Language is the canonical name of a language, "" when unknown.
	Language(name string) string
}

Highlighter tokenizes source code. It is called off the UI goroutine.

func CurrentHighlighter() Highlighter

type ImageFetcher ¶ added in v0.0.7

type ImageFetcher func(ctx context.Context, url string, header map[string]string) (status int, respHeader map[string]string, body io.ReadCloser, err error)

ImageFetcher downloads a network image source. header holds request headers; it returns the status code, the response headers with canonical names ("Etag", "Last-Modified", "Cache-Control") and the body, which the caller closes.

type ScrollDevice ¶ added in v0.0.4

type ScrollDevice uint8

ScrollDevice is the kind of device behind scroll input.

const (
	// ScrollDeviceUnknown: the platform does not say.
	ScrollDeviceUnknown ScrollDevice = iota
	// ScrollDeviceWheel scrolls in notches.
	ScrollDeviceWheel
	// ScrollDeviceTrackpad scrolls continuously, with gesture phases.
	ScrollDeviceTrackpad
)

type ScrollGesture ¶ added in v0.0.4

type ScrollGesture struct {
	Device ScrollDevice
	// Phases is true once the platform has reported gesture phases, so
	// Active and Ended can be trusted.
	Phases bool
	// Active is true while fingers are on the trackpad.
	Active bool
	// Momentum is true while inertial scrolling continues after a lift.
	Momentum bool
	// Ended counts finished gestures; a change means the fingers lifted.
	Ended uint64
}

ScrollGesture is what the platform reports about scroll input beyond the deltas Gio delivers. macOS and Wayland report it; elsewhere Phases is false and components fall back to timing.

func CurrentScrollGesture() ScrollGesture

type Widget ¶

type Widget interface {
	Layout(gtx C) D
}

Widget is anything that can lay itself out. Every component and container is one.

type WindowControls ¶

type WindowControls interface {
	// Frameless reports whether the window draws its own title bar.
	Frameless() bool
	// Focused reports native window activation, not an individual control focus.
	Focused() bool
	// TitleBarArea registers the current draggable title region in window dp.
	// The window clears it each frame; controls must be outside this rectangle.
	TitleBarArea(x, y, width, height float32)
	Minimize()
	// ToggleMaximize maximizes the window, or restores it when maximized.
	ToggleMaximize()
	Maximized() bool
	Close()
}

WindowControls is what UI code may ask of the window it is drawn in: a custom title bar uses it for its buttons. ui/window implements it.

func CurrentWindow() WindowControls