amy

Documentation

Index

• func Run(gem Gem)
• type Facet
  • func NewFacet(position FacetPosition) Facet
  • func (facet *Facet) ToString() string
• type FacetPosition
• type Gem
  • func FromArray(facets [8]Facet) Gem
  • func FromDmenuReader(reader io.Reader) Gem
  • func NewGem() Gem
  • func (gem *Gem) ToArray() []Facet
  • func (gem *Gem) ToString() string

Functions

func Run

func Run(gem Gem)

Run launches the GUI that display the given gem to user's screen.

Types

type Facet

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

Facet represents a gem facet, that can be chosed by the user.

func NewFacet

func NewFacet(position FacetPosition) Facet

NewFacet creates a new facet at a given position, with "∅" as label.

func (*Facet) ToString

func (facet *Facet) ToString() string

ToString returns the string reprensentation of a facet.

type FacetPosition

type FacetPosition string

FacetPosition represents the position of a facet in the gem (north, south, etc.).

type Gem

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

Gem represents an the radial menu content and composed into many facets.

func FromArray

func FromArray(facets [8]Facet) Gem

FromArray returns a gem structure containing all the facets listed in the given array (the opposite of ToArray).

func FromDmenuReader

func FromDmenuReader(reader io.Reader) Gem

FromDmenuReader returns a gem structure containing the facet listed in the given reader (ie. stdin or file) in dmenu syntax.

func NewGem

func NewGem() Gem

NewGem creates a new gem and all its facets for each possible position.

func (*Gem) ToArray

func (gem *Gem) ToArray() []Facet

ToArray returns an array containing all the gem facets (the opposite of FromArray).

func (*Gem) ToString

func (gem *Gem) ToString() string

ToString returns the string reprensentation of a gem.