event

Documentation

Index

• Constants
• Variables
• type Button
  • func (e Button) Type() int
• type Clipboard
  • func (c Clipboard) Type() int
• type Configure
  • func (e Configure) Type() int
• type Eventer
• type General
  • func (e General) Type() int
• type Keyboard
  • func (e Keyboard) IsGraphic() bool
  • func (e Keyboard) Type() int
• type Menu
  • func NewMenu(short string) Menu
  • func (e Menu) Type() int
• type Motion
  • func (e Motion) Type() int
• type Scroll
  • func (e Scroll) Type() int

Constants

const (
	GeneralType int
	KeyboardType
	ButtonType
	MotionType
	MenuType
	ConfigureType
	ScrollType
	ClipboardType
)

Event types

const (
	ButtonActionPress   = 4
	ButtonActionDouble  = 5
	ButtonActionTriple  = 6
	ButtonActionRelease = 7
)

Button action type

const (
	ButtonLeft   = 1
	ButtonMiddle = 2
	ButtonRight  = 3
)

Button number

const (
	ScrollUp     = 0
	ScrollDown   = 1
	ScrollLeft   = 2
	ScrollRight  = 3
	ScrollSmooth = 4
)

Scroll direction type

Variables

var (
	UnknownEvent = General{Event: 0}
	DestroyEvent = General{Event: 1}
)

Signal events

var (
	KeyLeft      = Keyboard{Name: "Left"}
	KeyRight     = Keyboard{Name: "Right"}
	KeyUp        = Keyboard{Name: "Up"}
	KeyDown      = Keyboard{Name: "Down"}
	KeyBackSpace = Keyboard{Rune: 8, Name: "BackSpace"}
	KeyTab       = Keyboard{Rune: 9, Name: "Tab"}
	KeyEnter     = Keyboard{Rune: 13, Name: "Return"}
	KeyEscape    = Keyboard{Rune: 27, Name: "Escape"}
	KeySpace     = Keyboard{Rune: 32, Name: "space"}
	KeyDelete    = Keyboard{Rune: 127, Name: "Delete"}
	KeyPageUp    = Keyboard{Name: "Page_Up"}
	KeyPageDown  = Keyboard{Name: "Page_Down"}
	KeyHome      = Keyboard{Name: "Home"}
	KeyEnd       = Keyboard{Name: "End"}
)

Keyboard events

var (
	KeySave  = Keyboard{Rune: 115, Name: "s", Control: true}
	KeyExit  = Keyboard{Rune: 119, Name: "w", Control: true}
	KeyCopy  = Keyboard{Rune: 99, Name: "c", Control: true}
	KeyPaste = Keyboard{Rune: 118, Name: "v", Control: true}
)

Platform specified keyboard events

Types

type Button

type Button struct {
	Action int
	Button int
	Point  image.Point
}

Button is mouse button event

func (Button) Type

func (e Button) Type() int

Type returns event type

type Clipboard

type Clipboard struct {
	Data clipboard.Clipboarder
}

Clipboard is event with clipboard data

func (Clipboard) Type

func (c Clipboard) Type() int

Type returns event type

type Configure

type Configure struct {
	Size      image.Point
	InnerSize image.Point
}

Configure event

func (Configure) Type

func (e Configure) Type() int

Type returns event type

type Eventer

type Eventer interface {
	Type() int
}

Eventer is the interface that groups GUI events

type General

type General struct {
	Event int
}

General is a general purpose notification

func (General) Type

func (e General) Type() int

Type returns event type

type Keyboard

type Keyboard struct {
	Rune    rune
	Shift   bool
	Control bool
	Alt     bool
	Meta    bool
	Name    string
}

Keyboard is a keyboard event

func (Keyboard) IsGraphic

func (e Keyboard) IsGraphic() bool

IsGraphic tests printable rune

func (Keyboard) Type

func (e Keyboard) Type() int

Type returns event type

type Menu

type Menu struct {
	Action string
}

Menu is menu action event

func NewMenu

func NewMenu(short string) Menu

NewMenu returns a menu action event

func (Menu) Type

func (e Menu) Type() int

Type returns event type

type Motion

type Motion struct {
	Point   image.Point
	Shift   bool
	Control bool
	Alt     bool
	Meta    bool
}

Motion is mouse motion event

func (Motion) Type

func (e Motion) Type() int

Type returns event type

type Scroll

type Scroll struct {
	Direction int
	DeltaX    int
	DeltaY    int
}

Scroll is scroll event

func (Scroll) Type

func (e Scroll) Type() int

Type returns event type