system

Documentation

Overview

Package system contains events usually handled at the top-level program level.

Index

• type CommandEvent
  • func (_ *CommandEvent) ImplementsEvent()
• type CommandType
• type Config
• type DestroyEvent
  • func (_ DestroyEvent) ImplementsEvent()
• type FrameEvent
  • func (_ FrameEvent) ImplementsEvent()
• type Insets
• type Stage
  • func (l Stage) String() string
• type StageEvent
  • func (_ StageEvent) ImplementsEvent()

Types

type CommandEvent

type CommandEvent struct {
	Type CommandType
	// Suppress the default action of the command.
	Cancel bool
}

CommandEvent is a system event.

func (*CommandEvent) ImplementsEvent

func (_ *CommandEvent) ImplementsEvent()

type CommandType

type CommandType uint8

CommandType is the type of a CommandEvent.

const (
	// CommandBack is the command for a back action
	// such as the Android back button.
	CommandBack CommandType = iota
)

type Config

type Config interface {
	// Now returns the current animation time.
	Now() time.Time

	unit.Converter
}

Config defines the essential properties of the environment.

type DestroyEvent

type DestroyEvent struct {
	// Err is nil for normal window closures. If a
	// window is prematurely closed, Err is the cause.
	Err error
}

DestroyEvent is the last event sent through a window event channel.

func (DestroyEvent) ImplementsEvent

func (_ DestroyEvent) ImplementsEvent()

type FrameEvent

type FrameEvent struct {
	Config Config
	// Size is the dimensions of the window.
	Size image.Point
	// Insets is the insets to apply.
	Insets Insets
	// Frame replaces the window's frame with the new
	// frame.
	Frame func(frame *op.Ops)
	// contains filtered or unexported fields
}

A FrameEvent asks for a new frame in the form of a list of operations.

func (FrameEvent) ImplementsEvent

func (_ FrameEvent) ImplementsEvent()

type Insets

type Insets struct {
	Top, Bottom, Left, Right unit.Value
}

Insets is the space taken up by system decoration such as translucent system bars and software keyboards.

type Stage

type Stage uint8

Stage of a Window.

const (
	// StagePaused is the Stage for inactive Windows.
	// Inactive Windows don't receive FrameEvents.
	StagePaused Stage = iota
	// StateRunning is for active Windows.
	StageRunning
)

func (Stage) String

func (l Stage) String() string

type StageEvent

type StageEvent struct {
	Stage Stage
}

A StageEvent is generated whenever the stage of a Window changes.

func (StageEvent) ImplementsEvent

func (_ StageEvent) ImplementsEvent()