Back to godoc.org
gioui.org / app

Package app

v0.0.0 (17b5898)
Latest Go to latest
Published: 1 hour ago | Licenses: MIT , Unlicense | Module: gioui.org

Overview

Package app provides a platform-independent interface to operating system functionality for running graphical user interfaces.

See https://gioui.org for instructions to set up and run Gio programs.

Windows

Create a new Window by calling NewWindow. On mobile platforms or when Gio is embedded in another project, NewWindow merely connects with a previously created window.

A Window is run by receiving events from its Events channel. The most important event is FrameEvent that prompts an update of the window contents and state.

For example:

import "gioui.org/unit"

w := app.NewWindow()
for e := range w.Events() {
	if e, ok := e.(system.FrameEvent); ok {
		ops.Reset()
		// Add operations to ops.
		...
		// Completely replace the window contents and state.
		e.Frame(ops)
	}
}

A program must keep receiving events from the event channel until DestroyEvent is received.

Main

The Main function must be called from a program's main function, to hand over control of the main thread to operating systems that need it.

Because Main is also blocking on some platforms, the event loop of a Window must run in a goroutine.

For example, to display a blank but otherwise functional window:

package main

import "gioui.org/app"

func main() {
	go func() {
		w := app.NewWindow()
		for range w.Events() {
		}
	}()
	app.Main()
}

Event queue

A FrameEvent's Queue method returns an event.Queue implementation that distributes incoming events to the event handlers declared in the last frame. See the gioui.org/io/event package for more information about event handlers.

Permissions

The packages under gioui.org/app/permission should be imported by a Gio program or by one of its dependencies to indicate that specific operating-system permissions are required. Please see documentation for package gioui.org/app/permission for more information.

Index

Package Files

func DataDir

func DataDir() (string, error)

DataDir returns a path to use for application-specific configuration data. On desktop systems, DataDir use os.UserConfigDir. On iOS NSDocumentDirectory is queried. For Android Context.getFilesDir is used.

BUG: DataDir blocks on Android until init functions have completed.

func Main

func Main()

Main must be called last from the program main function. On most platforms Main blocks forever, for Android and iOS it returns immediately to give control of the main thread back to the system.

Calling Main is necessary because some operating systems require control of the main thread of the program for running windows.

type Option

type Option func(opts *window.Options)

WindowOption configures a Window.

func MaxSize

func MaxSize(w, h unit.Value) Option

MaxSize sets the maximum size of the window.

func MinSize

func MinSize(w, h unit.Value) Option

MinSize sets the minimum size of the window.

func Size

func Size(w, h unit.Value) Option

Size sets the size of the window.

func Title

func Title(t string) Option

Title sets the title of the window.

type Window

type Window struct {
	// contains filtered or unexported fields
}

Window represents an operating system window.

func NewWindow

func NewWindow(options ...Option) *Window

NewWindow creates a new window for a set of window options. The options are hints; the platform is free to ignore or adjust them.

If the current program is running on iOS and Android, NewWindow returns the window previously created by the platform.

Calling NewWindow more than once is not supported on iOS, Android, WebAssembly.

func (*Window) Close

func (w *Window) Close()

Close the window. The window's event loop should exit when it receives system.DestroyEvent.

Currently, only macOS, Windows and X11 drivers implement this functionality, all others are stubbed.

func (*Window) Events

func (w *Window) Events() <-chan event.Event

Events returns the channel where events are delivered.

func (*Window) Invalidate

func (w *Window) Invalidate()

Invalidate the window such that a FrameEvent will be generated immediately. If the window is inactive, the event is sent when the window becomes active. Invalidate is safe for concurrent use.

func (*Window) ReadClipboard

func (w *Window) ReadClipboard()

ReadClipboard initiates a read of the clipboard in the form of a system.ClipboardEvent. Multiple reads may be coalesced to a single event.

func (*Window) WriteClipboard

func (w *Window) WriteClipboard(s string)

WriteClipboard writes a string to the clipboard.

Documentation was rendered with GOOS=linux and GOARCH=amd64.

Jump to identifier

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to identifier