menu

Documentation

Overview

a simple dmenu Menu implementation

package menu gives interfaces for integrating menu programs such as dmenu into a go program

provides basic dmenu and ui implementations

Index

• Variables
• type Map
• type Menu
  • func NewDmenu(items string, flags []string, passFlag string, mapp Map) (Menu, error)
  • func NewSlicedDmenu(items, flags []string, passFlag string, mapp Map) (Menu, error)

Variables

var AlrRan = errors.New("Already Ran")

var Escaped = errors.New("User made no selection")

var NotInstalled = errors.New("Dmenu not installed")

errors

Types

type Map

type Map map[string][2]interface{}

used for keeping track of ui.Menu's while keeping the mass amount of potential the ui package has

type Menu

type Menu interface {
	// pass is whether or not the prompt should
	// be password protected.
	Prompt(pass bool) error // prompts the user
	Bytes() []byte          // bytes returned, if any
	Ran() bool              // if the user has been prompted
	Error() error           // returns the error, if any.

	Map() Map // can be nil for other use cases
}

this is supposed to be use once like exec.Cmd

a reuseable interface would be more complex. though it might be better for some projects, it isn't for this one.

func NewDmenu

func NewDmenu(items string, flags []string, passFlag string, mapp Map) (Menu, error)

items seperated by '\n'

mapp can be nil and passFlag can be an empty string if not patched

mapp can be nil

func NewSlicedDmenu

func NewSlicedDmenu(items, flags []string, passFlag string, mapp Map) (Menu, error)

like NewDmenu but takes []string for items rather than a string seperated by '\n'

mapp can be nil