i3

Documentation

Index

• type Layout
  • func New() *Layout
  • func (l *Layout) Arrange(start layout.Container)
  • func (l *Layout) ArrangeRoot()
  • func (l *Layout) Focus(ctx context.Context, c layout.Container)
  • func (l *Layout) Focused(ctx context.Context) layout.Container
  • func (l *Layout) FocusedByType(ctx context.Context, typ layout.ContainerType) layout.Container
  • func (l *Layout) Move(ctx context.Context, dir layout.Direction)
  • func (l *Layout) NewOutput(ctx context.Context, output backend.Output)
  • func (l *Layout) NewView(ctx context.Context, view backend.View)
  • func (l *Layout) NewWorkspace(ctx context.Context, output *layout.Output, name string, num uint)

Types

type Layout

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

Layout defines an i3 inspired layout handler.

func New

func New() *Layout

New initiliazes a new empty layout.

func (*Layout) Arrange

func (l *Layout) Arrange(start layout.Container)

Arrange arranges the layout starting from container specified by start.

func (*Layout) ArrangeRoot

func (l *Layout) ArrangeRoot()

ArrangeRoot arranges the layout starting from the root container and all the way down through the layout tree.

func (*Layout) Focus

func (l *Layout) Focus(ctx context.Context, c layout.Container)

Focus sets focus to a container.

func (*Layout) Focused

func (l *Layout) Focused(ctx context.Context) layout.Container

Focused returns the focused container lowest in the three, or nil if none is found.

func (*Layout) FocusedByType

func (l *Layout) FocusedByType(ctx context.Context, typ layout.ContainerType) layout.Container

FocusedByType returns the currently focused container by type.

func (*Layout) Move

func (l *Layout) Move(ctx context.Context, dir layout.Direction)

Move TODO: implement

func (*Layout) NewOutput

func (l *Layout) NewOutput(ctx context.Context, output backend.Output)

NewOutput creates a new output from a backend output handle.

func (*Layout) NewView

func (l *Layout) NewView(ctx context.Context, view backend.View)

NewView adds a new view to the layout. The view will be added to the currently focused container.

func (*Layout) NewWorkspace

func (l *Layout) NewWorkspace(ctx context.Context, output *layout.Output, name string, num uint)

NewWorkspace creates a new workspace for an output.