desktop

Documentation

Index

• func CreateWorkspaces() map[store.Location]*Workspace
• type Channels
• type Handler
  • func (h *Handler) Active() bool
  • func (h *Handler) Reset()
• type Handlers
• type Layout
  • func CreateLayouts(loc store.Location) []Layout
• type Tracker
  • func CreateTracker() *Tracker
  • func (tr *Tracker) ActiveWorkspace() *Workspace
  • func (tr *Tracker) ClientAt(ws *Workspace, p common.Point) *store.Client
  • func (tr *Tracker) ClientWorkspace(c *store.Client) *Workspace
  • func (tr *Tracker) Reset()
  • func (tr *Tracker) Tile(ws *Workspace)
  • func (tr *Tracker) Update()
  • func (tr *Tracker) WorkspaceAt(deskNum uint, screenNum uint) *Workspace
  • func (tr *Tracker) Write()
• type Workspace
  • func (ws *Workspace) ActiveLayout() Layout
  • func (ws *Workspace) AddClient(c *store.Client)
  • func (ws *Workspace) Cache() common.Cache[*Workspace]
  • func (ws *Workspace) CycleLayout(step int)
  • func (ws *Workspace) Disable()
  • func (ws *Workspace) Disabled() bool
  • func (ws *Workspace) Enable()
  • func (ws *Workspace) Enabled() bool
  • func (ws *Workspace) Read() *Workspace
  • func (ws *Workspace) RemoveClient(c *store.Client)
  • func (ws *Workspace) ResetLayouts()
  • func (ws *Workspace) Restore(flag uint8)
  • func (ws *Workspace) SetLayout(layoutNum uint)
  • func (ws *Workspace) Tile()
  • func (ws *Workspace) Write()

Functions

func CreateWorkspaces

func CreateWorkspaces() map[store.Location]*Workspace

Types

type Channels

type Channels struct {
	Event  chan string // Channel for events
	Action chan string // Channel for actions
}

type Handler

type Handler struct {
	Dragging bool        // Indicates pointer dragging event
	Source   interface{} // Stores moved/resized client
	Target   interface{} // Stores client/workspace
}

func (*Handler) Active

func (h *Handler) Active() bool

func (*Handler) Reset

func (h *Handler) Reset()

type Handlers

type Handlers struct {
	Timer        *time.Timer // Timer to handle delayed structure events
	ResizeClient *Handler    // Stores client for proportion change
	MoveClient   *Handler    // Stores client for tiling after move
	SwapClient   *Handler    // Stores clients for window swap
	SwapScreen   *Handler    // Stores client for screen swap
}

type Layout

type Layout interface {
	Reset()
	Apply()
	AddClient(c *store.Client)
	RemoveClient(c *store.Client)
	MakeMaster(c *store.Client)
	SwapClient(c1 *store.Client, c2 *store.Client)
	NextClient() *store.Client
	PreviousClient() *store.Client
	IncreaseMaster()
	DecreaseMaster()
	IncreaseSlave()
	DecreaseSlave()
	IncreaseProportion()
	DecreaseProportion()
	UpdateProportions(c *store.Client, d *store.Directions)
	GetManager() *store.Manager
	GetName() string
}

func CreateLayouts

func CreateLayouts(loc store.Location) []Layout

type Tracker

type Tracker struct {
	Clients    map[xproto.Window]*store.Client // List of tracked clients
	Workspaces map[store.Location]*Workspace   // List of workspaces per location
	Channels   *Channels                       // Helper for channel communication
	Handlers   *Handlers                       // Helper for event handlers

}

func CreateTracker

func CreateTracker() *Tracker

func (*Tracker) ActiveWorkspace

func (tr *Tracker) ActiveWorkspace() *Workspace

func (*Tracker) ClientAt

func (tr *Tracker) ClientAt(ws *Workspace, p common.Point) *store.Client

func (*Tracker) ClientWorkspace

func (tr *Tracker) ClientWorkspace(c *store.Client) *Workspace

func (*Tracker) Reset

func (tr *Tracker) Reset()

func (*Tracker) Tile

func (tr *Tracker) Tile(ws *Workspace)

func (*Tracker) Update

func (tr *Tracker) Update()

func (*Tracker) WorkspaceAt

func (tr *Tracker) WorkspaceAt(deskNum uint, screenNum uint) *Workspace

func (*Tracker) Write

func (tr *Tracker) Write()

type Workspace

type Workspace struct {
	Name            string         // Workspace location name
	Location        store.Location // Desktop and screen location
	Layouts         []Layout       // List of available layouts
	ActiveLayoutNum uint           // Index of active layout
	TilingEnabled   bool           // Tiling is enabled or not
}

func (*Workspace) ActiveLayout

func (ws *Workspace) ActiveLayout() Layout

func (*Workspace) AddClient

func (ws *Workspace) AddClient(c *store.Client)

func (*Workspace) Cache

func (ws *Workspace) Cache() common.Cache[*Workspace]

func (*Workspace) CycleLayout

func (ws *Workspace) CycleLayout(step int)

func (*Workspace) Disable

func (ws *Workspace) Disable()

func (*Workspace) Disabled

func (ws *Workspace) Disabled() bool

func (*Workspace) Enable

func (ws *Workspace) Enable()

func (*Workspace) Enabled

func (ws *Workspace) Enabled() bool

func (*Workspace) Read

func (ws *Workspace) Read() *Workspace

func (*Workspace) RemoveClient

func (ws *Workspace) RemoveClient(c *store.Client)

func (*Workspace) ResetLayouts

func (ws *Workspace) ResetLayouts()

func (*Workspace) Restore

func (ws *Workspace) Restore(flag uint8)

func (*Workspace) SetLayout

func (ws *Workspace) SetLayout(layoutNum uint)

func (*Workspace) Tile

func (ws *Workspace) Tile()

func (*Workspace) Write

func (ws *Workspace) Write()