actions

Documentation

Index

• func MoveLeft(activeConfig ActiveConfig)
• func MoveRight(activeConfig ActiveConfig)
• func ToNextGrid(activeConfig ActiveConfig)
• func ToPreviousGrid(activeConfig ActiveConfig)
• type ActionHandler
• type ActiveConfig
• type Grid
  • func (grid *Grid) Validate() (err error)
• type Presets
• type SnapActions
  • func NewSnapActions() *SnapActions
  • func (snapActions *SnapActions) SpanHorizontal(increase bool) ActionHandler
  • func (snapActions *SnapActions) SpanVertical(increase bool) ActionHandler
  • func (snapActions *SnapActions) ToBottom() ActionHandler
  • func (snapActions *SnapActions) ToLeft() ActionHandler
  • func (snapActions *SnapActions) ToRight() ActionHandler
  • func (snapActions *SnapActions) ToTop() ActionHandler
• type Span
• type TargetWindow
  • func GetTarget() TargetWindow

Functions

func MoveLeft

func MoveLeft(activeConfig ActiveConfig)

func MoveRight

func MoveRight(activeConfig ActiveConfig)

func ToNextGrid

func ToNextGrid(activeConfig ActiveConfig)

func ToPreviousGrid

func ToPreviousGrid(activeConfig ActiveConfig)

Types

type ActionHandler

type ActionHandler func(activeConfig ActiveConfig)

ActionHandler defines the handler functions an actions must comply with

type ActiveConfig

type ActiveConfig interface {
	Grid() *Grid
	GridIndex() int
	OnPreviousGrid()
	OnNextGrid()
}

ActiveConfig defines the currently active configuration along with additional data like row or column span

type Grid

type Grid struct {
	Name    string
	Columns []int
	Rows    []int
	Presets []Presets
}

Grid defines a basic grid on the screen at which windows can be snapped to

func (*Grid) Validate

func (grid *Grid) Validate() (err error)

Validate determines if the grid object is setup correctly

type Presets

type Presets struct {
	Executable string
	Span       *Span
}

Presets defines values for windows which are set as defaults

type SnapActions

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

SnapActions defines a set of actions for snaping windows to a grid, this structure is NOT usable without initialization

func NewSnapActions

func NewSnapActions() *SnapActions

NewSnapActions creates a new initialized snap actions structure

func (*SnapActions) SpanHorizontal

func (snapActions *SnapActions) SpanHorizontal(increase bool) ActionHandler

SpanHorizontal increases/decrease the horizontal span of grid tiles of the target window

func (*SnapActions) SpanVertical

func (snapActions *SnapActions) SpanVertical(increase bool) ActionHandler

SpanVertical increases/decrease the vertical span of grid tiles of the target window

func (*SnapActions) ToBottom

func (snapActions *SnapActions) ToBottom() ActionHandler

ToBottom returns the action handler for snapping to the next grid line on the top

func (*SnapActions) ToLeft

func (snapActions *SnapActions) ToLeft() ActionHandler

ToLeft returns the action handler for snapping to the next grid line on the left

func (*SnapActions) ToRight

func (snapActions *SnapActions) ToRight() ActionHandler

ToRight returns the action handler for snapping to the next grid line on the right

func (*SnapActions) ToTop

func (snapActions *SnapActions) ToTop() ActionHandler

ToTop returns the action handler for snapping to the next grid line on the top

type Span

type Span struct {
	Columns int
	Rows    int
}

Span defines the amount of grid tiles the window should span over

type TargetWindow

type TargetWindow interface {
	Hwnd() winapi.Hwnd
	Size() *winapi.Rect
	DesktopSize() *winapi.Rect
	Delta() (deltaH int, deltaV int)
	Move(left int, top int, width int, height int)
}

TargetWindow provides data and functions specific to the window along with aditional general informations like size of the desktop

func GetTarget

func GetTarget() TargetWindow

GetTarget will retrieve the currently focus window