cdtype

type Action struct {
	ID      int
	Name    string
	Call    func()
	Icon    string
	Menu    MenuItemType
	Bool    *bool  // reference to active value for checkitems.
	Group   int    // Radio item group.
	Tooltip string // Entry tooltip.

	// in fact all actions are threaded in the go version, but we could certainly
	// use this as a "add to actions queue" to prevent problems with settings
	// changed while working, or double launch.
	//
	Threaded bool
}

type AppAction interface {
	// Add adds actions to the list.
	//
	Add(acts ...*Action)

	// Len returns the number of actions defined.
	//
	Len() int

	// Callback returns a callback to the given action ID.
	//
	Callback(ID int) func()

	// CallbackInt returns a callback to the given action ID with an int input,
	// for left click events.
	//
	CallbackInt(ID int) func(int)

	// Count returns the number of started actions.
	//
	Count() int

	// ID finds the ID matching given action name.
	//
	ID(name string) int

	// Launch starts the desired action by ID.
	//
	Launch(ID int)

	// SetBool sets the pointer to the boolean value for a checkentry menu field.
	//
	SetBool(ID int, boolPointer *bool)

	// SetMax sets the maximum number of actions that can be started at the same time.
	//
	SetMax(max int)

	// SetIndicators set the pre and post action callbacks.
	//
	SetIndicators(onStart, onStop func())

	// BuildMenu fills the menu with the given actions list.
	//
	// MenuCheckBox: If Call isn't set, a default toggle callback will be used.
	//
	BuildMenu(menu Menuer, actionIds []int)

	// CallbackMenu provides a fill menu callback with the given actions list.
	//
	CallbackMenu(actionIds ...int) func(menu Menuer)
}

type AppBackend interface {
	AppIcon

	SetOnEvent(func(string, ...interface{}) bool)
}

type AppBase interface {

	// Extends AppIcon, for all interactions with the dock icon.
	//
	AppIcon

	// --- Common ---
	//
	// Name returns the applet name as known by the dock. As an external app = dir name.
	//
	Name() string // Name returns the applet name as known by the dock. As an external app = dir name.

	// Translate translates a string in the applet domain.
	//
	Translate(str string) string

	// SetDefaults set basic defaults icon settings in one call.
	// Empty fields will be reset, so this is better used in the Init() call.
	//
	SetDefaults(def Defaults)

	// SetConfig sets the applet config pointer and can add actions.
	//
	SetConfig(confPtr interface{}, actions ...*Action)

	// --- Files ---
	//
	// FileLocation returns the full path to a file in the applet data dir.
	//
	FileLocation(filename ...string) string

	// FileDataDir returns the path to the config root dir (~/.config/cairo-dock).
	//
	FileDataDir(filename ...string) string // RootDataDir.

	// --- Config ---
	//
	// LoadConfig will try to create and fill the given config struct with data from
	// the configuration file.
	//
	// Won't do anything if loadConf is false.
	// If an error is returned, the backend is expected to unload the applet
	// (or crash in a standalone mode).
	//
	LoadConfig(loadConf bool) (Defaults, error)

	// UpdateConfig opens the applet config file for edition.
	//
	// You must ensure that Save or Cancel is called, and fast to prevent memory
	// leaks and deadlocks.
	//
	UpdateConfig() (ConfUpdater, error)

	// --- Grouped Interfaces ---
	//
	// Action returns a manager of launchable actions for applets
	//
	Action() AppAction

	// Command returns a manager of launchable commands for applets
	//
	Command() AppCommand

	// Poller returns the applet poller if any.
	//
	Poller() AppPoller

	// Log gives access to the applet logger.
	//
	Log() Logger
	// contains filtered or unexported methods
}

type AppCommand interface {
	// Add adds a command to the list.
	//
	Add(key int, cmd *Command)

	// Callback returns a callback to the given command ID.
	// To bind with event OnClick or OnMiddleClick.
	//
	Callback(ID int) func()

	// CallbackInt returns a callback to the given command ID with an int input,
	// To bind with event OnClickMod.
	//
	CallbackInt(ID int) func(int)

	// Launch executes one of the configured command by its reference.
	//
	Launch(ID int)

	// FindMonitor return the configured window class for the command.
	//
	FindMonitor() string

	// Clear clears the commands list.
	//
	Clear()
}

type AppIcon interface {
	// Extends IconBase. The main icon also has the same actions as subicons,
	// so subicons are used the same way as the main icon.
	//
	IconBase

	// DemandsAttention is like the Animate method, but will animate the icon
	// endlessly, and the icon will be visible even if the dock is hidden. If the
	// animation is an empty string, or "default", the animation used when an
	// application demands the attention will be used.
	// The first argument is true to start animation, or false to stop it.
	//
	DemandsAttention(start bool, animation string) error

	// PopupDialog opens a dialog box.
	// The dialog can contain a message, an icon, some buttons, and a widget the
	// user can act on.
	//
	// Adding buttons will trigger the provided callback when the user use them.
	//
	// See DialogData for the list of options.
	//
	PopupDialog(DialogData) error

	// DataRenderer manages the graphic data renderer of the icon.
	//
	// You must add a renderer (Gauge, Graph, Progress) before you can Render
	// a list of floats values (from 0 lowest, to 1 highest).
	//
	DataRenderer() IconRenderer

	// Window gives access to actions on the controlled window.
	//
	Window() IconWindow

	// BindShortkey binds any number of keyboard shortcuts to your applet.
	//
	BindShortkey(shortkeys ...*Shortkey) error

	// IconProperties gets all applet icon properties at once.
	//
	IconProperties() (IconProperties, error)

	// IconProperty gets applet icon properties one by one.
	//
	IconProperty() IconProperty

	// AddSubIcon adds subicons by pack of 3 strings : label, icon, ID.
	//
	AddSubIcon(fields ...string) error

	// RemoveSubIcon only need the ID to remove the SubIcon.
	// The option to remove all icons is "any".
	//
	RemoveSubIcon(id string) error

	// RemoveSubIcons removes all subicons from the subdock.
	//
	RemoveSubIcons() error

	// SubIcon returns the subicon object you can act on for the given key.
	//
	SubIcon(key string) IconBase
}

type AppInstance interface {
	// Need to be defined in user applet.
	Init(def *Defaults, confLoaded bool)

	// Provided by extending
	AppBase
}

type AppPoller interface {
	// Exists returns true if the poller exists (isn't nil).
	//
	Exists() bool

	// Add adds a poller to handle in the main loop. Only one can be active.
	// Multiple calls will just override the action called.
	//
	Add(call func()) AppPoller

	// SetPreCheck callback actions to launch before the polling job.
	//
	SetPreCheck(onStarted func())

	// SetPostCheck callback actions to launch after the polling job.
	//
	SetPostCheck(onFinished func())

	// SetInterval sets the polling interval time, in seconds. You can add a default
	// value as a second argument to be sure you will have a valid value (> 0).
	//
	SetInterval(delay ...int) int

	// Start enables the polling ticker.
	//
	Start()

	// Restart resets the counter and launch Action in a goroutine.
	// Safe to use on nil poller.
	//
	Restart()

	// Stop disables the polling ticker.
	//
	Stop()

	// Wait return a channel that will be triggered after the defined poller interval.
	// You will have to call it on every loop as it not a real ticker.
	// It's just a single use chan.
	//
	Wait() <-chan time.Time

	// Plop increase the counter and launch the action if it reached the interval.
	// The counter is also reset if the action is launched.
	// Safe to use on nil poller.
	//
	Plop() bool
}

type CategoryType int

type Command struct {
	Name      string // Command or location to open.
	UseOpen   bool   // If true, open with the cdglobal.CmdOpen command.
	Monitored bool   // If true, the window will be monitored by the dock. (don't work wit UseOpen)
	Class     string // Window class if needed.
}

type Commands map[int]*Command

type ConfGroupIconBoth struct {
	Icon  string `conf:"icon"`
	Name  string `conf:"name"`
	Debug bool
}

type ConfKeyer interface {
	Name() string
	Comment() string
	valuer.Valuer
}

type ConfUpdater interface {
	// Save saves the edited config to disk, and releases the file locks.
	//
	Save() error

	// Cancel releases the file locks.
	//
	Cancel()

	// Set sets a new value for the group/key reference.
	//
	Set(group, key string, value interface{}) error

	// SetComment sets the comment for the key.
	//
	SetComment(group, key, comment string) error

	// GetComment gets the comment for the key.
	//
	GetComment(group, key string) (string, error)

	// Valuer returns the valuer for the given group/key combo.
	//
	Valuer(group, key string) valuer.Valuer

	// ParseGroups calls the given func for every group with its list of keys.
	//
	ParseGroups(func(group string, keys []ConfKeyer))

	// MarshalGroup fills the config with data from the struct provided.
	//
	MarshalGroup(value interface{}, group string, fieldKey GetFieldKey) error

	// UnmarshalGroup parse a config group to fill the ptr to struct provided.
	//
	// The group param must match a group in the file with the format [MYGROUP]
	//
	UnmarshalGroup(v interface{}, group string, fieldKey GetFieldKey) []error

	// SetNewVersion replaces the version in a config file.
	// The given group must represent the first group of the file.
	//
	SetNewVersion(group, oldver, newver string) error
}

type ContainerPosition int

type ContainerType int

type Defaults struct {
	// Those are provided by ConfGroupIconBoth.
	Icon  string // Icon path.
	Label string // Text label.
	Debug bool   // Enable debug flood.

	// Gathered by LoadConfig.
	Shortkeys []*Shortkey

	// Others to fill.
	QuickInfo      string
	PollerInterval int
	Commands       Commands
	AppliClass     string // Monitored application window class.
}

type DeskletVisibility int

type DialogData struct {
	// Dialog box text.
	Message string

	// Icon displayed next to the message (default=applet icon).
	Icon string

	// Duration of the dialog, in second (0=unlimited).
	TimeLength int

	// True to force the dialog above. Use it with parcimony.
	ForceAbove bool

	// True to use Pango markup to add text decorations.
	UseMarkup bool

	// Images of the buttons, separated by comma ";".
	// "ok" and "cancel" are used as keywords defined by the dock.
	Buttons string

	// Callback when buttons are used.
	//
	// The type of data depends on the widget provided:
	//     nil         if no widget is provided.
	//     string      for a DialogWidgetText.
	//     float64     for a DialogWidgetScale.
	//     int         for a DialogWidgetList with Editable=false.
	//     string      for a DialogWidgetList with Editable=true.
	//
	// Callback can be tested and asserted with one of the following functions.
	// The callback will be triggered only if the first button or the enter key
	// is pressed.
	//     DialogCallbackValidNoArg       callback without arguments.
	//     DialogCallbackValidInt         callback with an int.
	//     DialogCallbackValidString      callback with a string.
	//
	Callback func(button int, data interface{})

	// Optional custom widget.
	// Can be of type DialogWidgetText, DialogWidgetScale, DialogWidgetList.
	Widget interface{}
}

type DialogWidgetList struct {
	// Editable represents whether the user can enter a custom choice or not.
	//   false:  InitialValue and returned value are int.
	//   true:   InitialValue and returned value are string.
	Editable bool

	// Values represents the combo list values.
	// Note that values separator will be a semicolon ";" on the DBus backend.
	Values []string

	// InitialValue defines the default value, presented to the user.
	// Type:  int if Editable=false or string if Editable=true.
	InitialValue interface{}
}

type DialogWidgetScale struct {
	MinValue     float64 // Lower value.
	MaxValue     float64 // Upper value.
	NbDigit      int     // Number of digits after the dot.
	InitialValue float64 // Value initially set to the scale.
	MinLabel     string  // Label displayed on the left of the scale.
	MaxLabel     string  // Label displayed on the right of the scale.
}

type DialogWidgetText struct {
	MultiLines   bool   // true to have a multi-lines text-entry, ie a text-view.
	Locked       bool   // false if the user can modify the text.
	Hidden       bool   // false if the input text is visible (set to true for passwords).
	NbChars      int    // Maximum number of chars (the current number of chars will be displayed next to the entry) (0=infinite).
	InitialValue string // Text initially contained in the entry.
}

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

type EmblemPosition int

type Events struct {
	// Action when the user clicks on the icon.
	OnClick func()

	// Action when the user clicks on the icon.
	// Same as OnClick with the key modifier state (ctrl, shift...).
	OnClickMod func(btnState int)

	// Action when the user use the middle-click on the icon.
	OnMiddleClick func()

	// Action when the user use the right-click on the icon, opening the menu with full options.
	OnBuildMenu func(Menuer)

	// Action when the user use the mouse wheel on the icon.
	OnScroll func(scrollUp bool)

	// Action when the user drop data on the icon.
	OnDropData func(data string)

	// Action when the focus of the managed window change.
	OnChangeFocus func(active bool)

	// Action on default reload, called before Init.
	// Can be used when you need to act on the previous config before its reset.
	PreInit func(loadConf bool)

	// Action when a reload applet event is triggered from the dock.
	// A default callback is provided that calls Init. (See cdapplet.SetEvents)
	Reload func(bool)

	// Action when the quit applet event is triggered from the dock.
	End func()

	// SubEvents actions work the same as main event with an additional argument
	// for the id of the clicked icon.
	//
	// Action when the user clicks on the subicon.
	OnSubClick func(icon string)

	// Action when the user clicks on the subicon.
	// Same as OnSubClick with the key modifier state (ctrl, shift...).
	OnSubClickMod func(icon string, btnState int)

	// Action when the user use the middle-click on the subicon.
	OnSubMiddleClick func(icon string)

	// Action when the user use the right-click on the subicon, opening the menu.
	OnSubBuildMenu func(icon string, menu Menuer)

	// Action when the user use the mouse wheel on the subicon.
	OnSubScroll func(icon string, scrollUp bool)

	// Action when the user drop data on the subicon.
	OnSubDropData func(icon string, data string)
}

type GetFieldKey func(reflect.StructField) string

type IconBase interface {
	// SetQuickInfo change the quickinfo text displayed on the subicon.
	//
	SetQuickInfo(info string) error

	// SetLabel change the text label next to the subicon.
	//
	SetLabel(label string) error

	// SetIcon set the image of the icon, overwriting the previous one.
	// A lot of image formats are supported, including SVG.
	// You can refer to the image by either its name if it's an image from a icon theme, or by a path.
	//   app.SetIcon("gimp")
	//   app.SetIcon("go-up")
	//   app.SetIcon("/path/to/image")
	//
	SetIcon(icon string) error

	// SetEmblem set an emblem image on the icon.
	// To remove it, you have to use SetEmblem again with an empty string.
	//
	//   app.SetEmblem(app.FileLocation("img", "emblem-work.png"), cdtype.EmblemBottomLeft)
	//
	SetEmblem(iconPath string, position EmblemPosition) error

	// Animate animates the icon for a given number of rounds.
	//
	Animate(animation string, rounds int) error

	// ShowDialog pops up a simple dialog bubble on the icon.
	// The dialog can be closed by clicking on it.
	//
	ShowDialog(message string, duration int) error
}

type IconProperties interface {
	// X gets the position of the icon's on the horizontal axis.
	//
	X() int

	// Y gets the position of the icon's on the vertical axis.
	//
	Y() int

	// Width gets the width of the icon, in pixels.
	//
	Width() int

	// Height gets the height of the icon, in pixels.
	//
	Height() int

	//ContainerPosition gets the position of the container on the screen.
	//
	ContainerPosition() ContainerPosition

	// ContainerType gets the type of the applet's container (DOCK, DESKLET).
	//
	ContainerType() ContainerType

	// Xid gets the ID of the application's window controlled by the applet,
	//
	Xid() uint64

	// HasFocus gets whether the application's window has the focus or not.
	//
	HasFocus() bool
}

type IconProperty interface {
	// X gets the position of the icon's on the horizontal axis.
	// Starting from 0 on the left.
	//
	X() (int, error)

	// Y gets the position of the icon's on the vertical axis.
	// Starting from 0 at the top of the screen.
	//
	Y() (int, error)

	// Width gets the width of the icon, in pixels.
	// This is the maximum width, when the icon is zoomed.
	//
	Width() (int, error)

	// Height gets the height of the icon, in pixels.
	// This is the maximum height, when the icon is zoomed.
	//
	Height() (int, error)

	//ContainerPosition gets the position of the container on the screen.
	// (bottom, top, right, left). A desklet has always an orientation of bottom.
	//
	ContainerPosition() (ContainerPosition, error)

	// ContainerType gets the type of the applet's container (DOCK, DESKLET).
	//
	ContainerType() (ContainerType, error)

	// Xid gets the ID of the application's window controlled by the applet,
	//  or 0 if none (this parameter can only be non nul if you used the method
	// ControlAppli beforehand).
	//
	Xid() (uint64, error)

	// HasFocus gets whether the application's window which is controlled by the
	// applet is the current active window (it has the focus) or not.
	//
	HasFocus() (bool, error)
}

type IconRenderer interface {
	Gauge(nbval int, themeName string) error // sets a gauge data renderer.
	Progress(nbval int) error                // sets a progress data renderer.

	Graph(nbval int, typ RendererGraphType) error // sets a graph data renderer.
	GraphLine(nbval int) error                    // sets a graph of type RendererGraphLine.
	GraphPlain(nbval int) error                   // sets a graph of type RendererGraphPlain.
	GraphBar(nbval int) error                     // sets a graph of type RendererGraphBar.
	GraphCircle(nbval int) error                  // sets a graph of type RendererGraphCircle.
	GraphPlainCircle(nbval int) error             // sets a graph of type RendererGraphPlainCircle.

	Remove() error // removes the data renderer.

	// Render renders new values on the icon.
	//
	//   * You must have set a data renderer before.
	//   * The number of values sent must match the number declared before.
	//   * Values are given between 0 and 1.
	//
	Render(values ...float64) error
}

type IconWindow interface {
	// SetAppliClass allow your applet to control the window of an external
	// application and to steal its icon from the Taskbar.
	//
	//  *Use the xprop command find the class of the window you want to control.
	//  *Use "none" if you want to reset application control.
	//  *Controlling an application enables the OnChangeFocus callback.
	//
	SetAppliClass(applicationClass string) error // Sets the monitored class name.

	IsOpened() bool // Returns true if the monitored application is opened.

	Minimize() error               // Hide the window.
	Show() error                   // Show the window and give it focus.
	SetVisibility(show bool) error // Set the visible state of the window.
	ToggleVisibility() error       // Send Show or Minimize.

	Maximize() error   // Sets the window in full size.
	Restore() error    // Removes the maximized size of the window.
	ToggleSize() error // Send Maximize or Restore.

	Close() error // Close the window (some programs will just hide in the systray).
	Kill() error  // Kill the X window.
}

type InfoPosition int

type ListApps map[string]NewAppletFunc

type LogFmt interface {
	FormatMsg(level LogLevel, sender, msg string, more ...interface{}) string
	FormatErr(e error, level LogLevel, sender string, msg ...interface{}) string
	SetTimeFormat(format string)
	SetColorName(func(string) string)
	SetColorInfo(func(string) string)
	SetColorDebug(func(string) string)
	SetColorDEV(func(string) string)
	SetColorWarn(func(string) string)
	SetColorError(func(string) string)
}

type LogLevel int

type LogMsg struct {
	Text   string
	Sender string
	Time   time.Time
}

type LogOut interface {
	LogFmt // extends the log formater.

	Raw(sender, msg string)
	Msg(level LogLevel, sender, msg string, more ...interface{})
	Err(e error, level LogLevel, sender, msg string)
	List() []LogMsg
}

type Logger interface {
	LogFmt // extends the log formater.

	// SetDebug change the debug state of the logger.
	// Only enable or disable messages send with the Debug command.
	//
	SetDebug(debug bool) Logger

	// GetDebug gets the debug state of the logger.
	//
	GetDebug() bool

	// SetName set the displayed and forwarded name for the logger.
	//
	SetName(name string) Logger

	// SetLogOut connects the optional forwarder to the logger.
	//
	SetLogOut(LogOut) Logger

	// LogOut returns the optional forwarder of the logger.
	//
	LogOut() LogOut

	// Debug is to be used every time a useful step is reached in your module
	// activity. It will display the flood to the user only when the debug flag is
	// enabled.
	//
	Debug(msg string, more ...interface{})

	// Debugf log a new debug message with arguments formatting.
	//
	Debugf(msg, format string, args ...interface{})

	// Info displays normal informations on the standard output, with the first param in green.
	//
	Info(msg string, more ...interface{})

	// Infof log a new info message with arguments formatting.
	//
	Infof(msg, format string, args ...interface{})

	// Warn test and log the error as warning type. Return true if an error was found.
	//
	Warn(e error, msg ...interface{}) (fail bool)

	// NewWarn log a new warning.
	//
	NewWarn(msg string, args ...interface{})

	// Warnf log a new warning with arguments formatting.
	//
	Warnf(msg, format string, args ...interface{})

	// Err test and log the error as Error type. Return true if an error was found.
	//
	Err(e error, msg ...interface{}) (fail bool)

	// NewErr log a new error.
	//
	NewErr(e string, msg ...interface{})

	// Errorf log a new error with arguments formatting.
	//
	Errorf(msg, format string, args ...interface{})

	// ExecShow run a command with output forwarded to console and wait.
	//
	ExecShow(command string, args ...string) error

	// ExecSync run a command with and grab the output to return it when finished.
	//
	ExecSync(command string, args ...string) (string, error)

	// ExecAsync run a command with output forwarded to console but don't wait for its completion.
	// Errors will be logged.
	//
	ExecAsync(command string, args ...string) error

	// ExecCmd provides a generic command with output forwarded to console.
	//
	ExecCmd(command string, args ...string) *exec.Cmd

	// ExecShlex parse the command with shlex before returning an ExecCmd.
	//
	ExecShlex(command string, args ...string) (*exec.Cmd, error)

	// PlaySound plays a sound file.
	//
	PlaySound(file string) error

	// Recover from crash. Use with defer before a dangerous action.
	//
	Recover()

	// GoTry launch a secured go routine. Panic will be recovered and logged.
	//
	GoTry(call func())

	// DEV is like Info, but to be used by the dev for his temporary tests (easier to grep).
	//
	DEV(msg string, more ...interface{})
}

type MenuItemType int

type MenuWidgeter interface {
	SetTooltipText(string)
}

type Menuer interface {
	// AddSubMenu adds a submenu to the menu.
	//
	AddSubMenu(label, iconPath string) Menuer

	// AddSeparator adds a separator to the menu.
	//
	AddSeparator()

	// AddEntry adds an item to the menu with its callback.
	//
	AddEntry(label, iconPath string, call interface{}, userData ...interface{}) MenuWidgeter

	// AddCheckEntry adds a check entry to the menu.
	//
	AddCheckEntry(label string, active bool, call interface{}, userData ...interface{}) MenuWidgeter

	// AddRadioEntry adds a radio entry to the menu.
	//
	AddRadioEntry(label string, active bool, group int, call interface{}, userData ...interface{}) MenuWidgeter
}

type NewAppletFunc func(base AppBase, events *Events) AppInstance

type PackageType int

type RenderSimple interface {
	DataRenderer() IconRenderer
	FileLocation(...string) string
	SetIcon(string) error
	SetLabel(string) error
	SetQuickInfo(string) error
}

type RendererGraphType int

type Shortkey struct {
	ConfGroup string
	ConfKey   string
	Shortkey  string       // value
	Desc      string       // tag "desc"
	ActionID  int          // tag "action". Will be converted to Call at SetDefaults.
	Call      func()       // Simple callback when triggered.
	CallE     func() error // Error returned callback. If set, used first.
}

type Template struct {
	*template.Template // extends the basic template.
	FilePath           string
}

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

type ToDefaultser interface {
	ToDefaults(*Defaults)
}