polybar

Documentation

Index

• Constants
• func WithDmenu()
• func WithGUI()
• type ActionButton
  • func ActionOver(a ActionButton, index MouseIndex, command string) ActionButton
  • func (a ActionButton) String() string
• type FormatType
• type MouseIndex
• type Polybar
  • func (Polybar) HandleError(err error, message string)
  • func (Polybar) HandleNothingPlaying() (shouldExit bool)
  • func (p Polybar) PrintDisabled()
  • func (p Polybar) Update(player *mpris.Player)
• type Span
  • func (s Span) String() string

Constants

const (
	LEFT_CLICK = MouseIndex(iota + 1)
	MIDDLE_CLICK
	RIGHT_CLICK
	SCROLL_UP
	SCROLL_DOWN
	// Double click is kinda "meh", so avoid it
	DOUBLE_LEFT_CLICK
	DOUBLE_MIDDLE_CLICK
	DOUBLE_RIGHT_CLICK
)

From https://github.com/polybar/polybar/wiki/Formatting#action-a

const (
	FOREGROUND = FormatType("F")
	BACKGROUND = FormatType("B")
	REVERSE    = FormatType("R")
	UNDERLINE  = FormatType("u")
	OVERLINE   = FormatType("o")
	FONT       = FormatType("T")
	OFFSET     = FormatType("o")
)

from https://github.com/polybar/polybar/wiki/Formatting#format-tags

Functions

func WithDmenu

func WithDmenu()

func WithGUI

func WithGUI()

Types

type ActionButton

type ActionButton struct {
	Index            MouseIndex
	Display, Command string
}

func ActionOver

func ActionOver(a ActionButton, index MouseIndex, command string) ActionButton

func (ActionButton) String

func (a ActionButton) String() string

type FormatType

type FormatType string

type MouseIndex

type MouseIndex uint

type Polybar

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

func (Polybar) HandleError

func (Polybar) HandleError(err error, message string)

func (Polybar) HandleNothingPlaying

func (Polybar) HandleNothingPlaying() (shouldExit bool)

func (Polybar) PrintDisabled

func (p Polybar) PrintDisabled()

func (Polybar) Update

func (p Polybar) Update(player *mpris.Player)

type Span

type Span struct {
	Format FormatType
	Extra  string
	Text   string
}

func (Span) String

func (s Span) String() string