backendmenu

Documentation

Overview

Package backendmenu provides menu events and widgets to build the menu.

Index

• func GetIconForDesklet(icon gldi.Icon, container *gldi.Container) gldi.Icon
• func Register(l cdtype.Logger, menucontainer, menuicon func(*DockMenu) bool)
• func WrapDockMenuCallback(call func(dm *DockMenu) bool) ...
• type DockMenu
  • func WrapDockMenu(icon gldi.Icon, container *gldi.Container, dock *gldi.CairoDock, ...) *DockMenu
  • func (m *DockMenu) AddButtonsEntry(label string, btns ...MenuBtn) *menus.ButtonsEntry
  • func (m *DockMenu) AddSubMenu(label, iconPath string) *DockMenu
  • func (m *DockMenu) Entry(entry MenuEntry) bool
• type MenuBtn
• type MenuEntry

Functions

func GetIconForDesklet

func GetIconForDesklet(icon gldi.Icon, container *gldi.Container) gldi.Icon

GetIconForDesklet will return the correct icon if clicked on a desklet.

func Register

func Register(l cdtype.Logger, menucontainer, menuicon func(*DockMenu) bool)

Register registers menu callbacks, to receive menu events.

func WrapDockMenuCallback

func WrapDockMenuCallback(call func(dm *DockMenu) bool) func(icon gldi.Icon, container *gldi.Container, dock *gldi.CairoDock, menu *gtk.Menu) bool

WrapDockMenuCallback returns a DockMenu wrapper function.

Types

type DockMenu

type DockMenu struct {
	menus.Menu
	Icon      gldi.Icon
	Container *gldi.Container
	Dock      *gldi.CairoDock // just a pointer to container with type dock.
}

DockMenu represents a dock menu.

func WrapDockMenu

func WrapDockMenu(icon gldi.Icon, container *gldi.Container, dock *gldi.CairoDock, menu *gtk.Menu) *DockMenu

WrapDockMenu wraps a menu as DockMenu.

func (*DockMenu) AddButtonsEntry

func (m *DockMenu) AddButtonsEntry(label string, btns ...MenuBtn) *menus.ButtonsEntry

AddButtonsEntry adds an item with button entries to the menu.

func (*DockMenu) AddSubMenu

func (m *DockMenu) AddSubMenu(label, iconPath string) *DockMenu

AddSubMenu adds a submenu to the menu.

func (*DockMenu) Entry

func (m *DockMenu) Entry(entry MenuEntry) bool

Entry adds a defined entry to the menu. Returns if a separator is needed.

type MenuBtn

type MenuBtn int

MenuBtn represents common menu button entries type.

const (
	MenuWindowClose MenuBtn = iota
	MenuWindowCloseAll
	MenuWindowMax
	MenuWindowMin
	MenuWindowMinAll
	MenuWindowShow
	MenuWindowShowAll
)

Common menu button entries.

type MenuEntry

type MenuEntry int

MenuEntry represents common menu item entries type.

const (
	MenuAbout MenuEntry = iota
	MenuAddApplet
	MenuAddLauncher
	MenuAddMainDock
	MenuAddSeparator
	MenuAddSubDock
	MenuClassItems
	MenuConfigure
	MenuCustomIconRemove
	MenuCustomIconSet
	MenuDeleteDock
	MenuDeskletLock
	MenuDeskletSticky
	MenuDeskletVisibility
	MenuDetachApplet
	MenuEditDock
	MenuDuplicateApplet
	MenuEditApplet
	MenuEditIcon
	MenuEditTarget
	MenuHandbook
	MenuHelp
	MenuLaunchNew
	MenuLockIcons
	MenuMakeLauncher
	MenuMoveToDesktopClass
	MenuMoveToDesktopWindow
	MenuMoveToDock
	MenuQuickHide
	MenuQuit
	MenuRemoveApplet
	MenuRemoveIcon
	MenuThemes
	MenuWindowAbove
	MenuWindowBelow
	MenuWindowFullScreen
	MenuWindowKill
	MenuWindowMoveAllHere
	MenuWindowMoveHere
	MenuWindowSticky
)

Common menu item entries.