Documentation
¶
Overview ¶
Package appgldi implements the dock applet API for go internal applets.
Its goal is to connect the main Cairo-Dock Golang applet object, godock/libs/cdapplet, to its parent, the dock.
Index ¶
- type AppGldi
- func (o *AppGldi) AddSubIcon(fields ...string) error
- func (o *AppGldi) BindShortkey(shortkeys ...*cdtype.Shortkey) error
- func (o *AppGldi) DataRenderer() cdtype.IconRenderer
- func (o *AppGldi) DemandsAttention(start bool, animation string) error
- func (o *AppGldi) IconProperties() (cdtype.IconProperties, error)
- func (o *AppGldi) IconProperty() cdtype.IconProperty
- func (o *AppGldi) PopupDialog(data cdtype.DialogData) error
- func (o *AppGldi) RemoveSubIcon(id string) error
- func (o *AppGldi) RemoveSubIcons() error
- func (o *AppGldi) SetOnEvent(onEvent func(string, ...interface{}) bool)
- func (o *AppGldi) SubIcon(key string) cdtype.IconBase
- func (o *AppGldi) Window() cdtype.IconWindow
- type IconBase
- func (o *IconBase) Animate(animation string, rounds int) error
- func (o *IconBase) SetEmblem(iconPath string, position cdtype.EmblemPosition) error
- func (o *IconBase) SetIcon(icon string) error
- func (o *IconBase) SetLabel(label string) error
- func (o *IconBase) SetQuickInfo(info string) error
- func (o *IconBase) ShowDialog(message string, duration int) error
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AppGldi ¶
type AppGldi struct {
*IconBase // extend subIcon methods and dock Icon object to benefit from all its magic.
// contains filtered or unexported fields
}
AppGldi is an applet connection to Cairo-Dock using the gldi backend.
func (*AppGldi) AddSubIcon ¶
AddSubIcon adds subicons by pack of 3 strings : label, icon, ID. See cdtype.AppIcon.
func (*AppGldi) BindShortkey ¶
BindShortkey binds any number of keyboard shortcuts to your applet. See cdtype.Shortkey.
func (*AppGldi) DataRenderer ¶
func (o *AppGldi) DataRenderer() cdtype.IconRenderer
DataRenderer manages the graphic data renderer of the icon.
func (*AppGldi) DemandsAttention ¶
DemandsAttention is an endless Animate method. See cdtype.AppIcon.
func (*AppGldi) IconProperties ¶
func (o *AppGldi) IconProperties() (cdtype.IconProperties, error)
IconProperties gets all applet icon properties at once.
func (*AppGldi) IconProperty ¶
func (o *AppGldi) IconProperty() cdtype.IconProperty
IconProperty gets applet icon properties one by one.
func (*AppGldi) PopupDialog ¶
func (o *AppGldi) PopupDialog(data cdtype.DialogData) error
PopupDialog opens a dialog box. See cdtype.AppIcon.
func (*AppGldi) RemoveSubIcon ¶
RemoveSubIcon only need the ID to remove the SubIcon. See cdtype.AppIcon.
func (*AppGldi) RemoveSubIcons ¶
RemoveSubIcons removes all subicons from the subdock.
func (*AppGldi) SetOnEvent ¶
SetOnEvent sets the OnEvent callback to forwards events.
func (*AppGldi) Window ¶
func (o *AppGldi) Window() cdtype.IconWindow
Window gives access to actions on the controlled window.
type IconBase ¶
IconBase defines common actions for icons and subdock icons.
func (*IconBase) SetEmblem ¶
func (o *IconBase) SetEmblem(iconPath string, position cdtype.EmblemPosition) error
SetEmblem set an emblem image on the icon. See cdtype.AppIcon.
func (*IconBase) SetIcon ¶
SetIcon set the image of the icon, overwriting the previous one. See cdtype.AppIcon.
func (*IconBase) SetQuickInfo ¶
SetQuickInfo change the quickinfo text displayed on the subicon.
Source Files