datatype

type Appleter interface {

	// Icon() string
	IsInstalled() bool
	Install(options string) error
	Uninstall() error
	CanUninstall() bool
	IsActive() bool
	Activate() string
	Deactivate()
	CanAdd() bool

	GetTitle() string // module name translated for the user.
	GetName() string  // module name used as key.
	GetAuthor() string
	GetDescription() string
	GetPreviewFilePath() string
	GetIconFilePath() string
	IconState() string
	FormatState() string
	FormatSize() string
	FormatCategory() string
	Dir() string
}

type DesktopClassNil struct{}

type DesktopClasser interface {
	// String returns the desktop class as a string.
	//
	String() string

	// Name returns the desktop class application name.
	//
	Name() string

	// Command returns the desktop class command.
	//
	Command() string

	// Icon returns the desktop class icon.
	//
	Icon() string

	// MenuItems returns the list of extra commands for the class, by packs of 3
	// strings: Name, Command, Icon.
	//
	MenuItems() [][]string
}

type Field struct {
	Conf string
	Key  string
	Name string
	Icon string
}

type HandbookDescDisk struct{ Handbooker }

type HandbookDescSplit struct{ Handbooker }

type HandbookSimple struct {
	Key         string
	Title       string
	Author      string
	Description string
	Preview     string
}

type Handbooker interface {
	// GetName returns the book key.
	//
	GetName() string // name will be used as key.

	// GetTitle returns the book readable name.
	//
	GetTitle() string

	// GetAuthor returns the book author.
	//
	GetAuthor() string

	// GetDescription returns the book description.
	//
	GetDescription() string

	// GetDescription returns the book icon name or path.
	//
	GetPreviewFilePath() string

	// GetDescription returns the book gettext domain for translations.
	//
	GetGettextDomain() string

	// GetDescription returns the book version.
	//
	GetModuleVersion() string
}

type IconSimple struct {
	Field
	Taskbar bool
}

type Iconer interface {
	// ConfigPath gives the full path to the icon config file.
	//
	ConfigPath() string

	// OriginalConfigPath gives the full path to the icon original config file.
	// This is the default unchanged config file.
	//
	OriginalConfigPath() string

	DefaultNameIcon() (string, string) //applets map[string]*packages.AppletPackage) (string, string)
	IsTaskbar() bool
	IsLauncher() bool

	IsStackIcon() bool

	// ConfigGroup gives the config group to build if any.
	// If no config file is set, it defines a special config key.
	//
	ConfigGroup() string

	// GetClass returns the class defined for the icon, able to get all related
	// desktop class informations.
	//
	GetClass() DesktopClasser

	GetCommand() string
	Reload()

	// MoveAfterNext swaps the icon position with the previous one.
	//
	MoveBeforePrevious()

	// MoveAfterNext swaps the icon position with the next one.
	//
	MoveAfterNext()

	// RemoveFromDock removes the icon from the dock.
	RemoveFromDock()

	// GetGettextDomain returns the translation domain for the applet.
	GetGettextDomain() string
}

type ListIcon struct {
	Maindocks []*ListIconContainer
	Subdocks  map[string][]Iconer
}

type ListIconContainer struct {
	Container Iconer
	Icons     []Iconer
}

type Source interface {
	cdglobal.Crypto // Encrypt and Decrypt string.

	//MainConfigFile returns the full path to the dock config file.
	//
	MainConfigFile() string

	//MainConfigDefault returns the full path to the dock config file.
	//
	MainConfigDefault() string

	// AppIcon returns the application icon path.
	//
	AppIcon() string

	// DirUserAppData returns the path to user applet common data in ~/.config/cairo-dock/
	//
	DirUserAppData(path ...string) (string, error)

	// DirShareData returns the path to the shared data dir (/usr/share/cairo-dock/).
	//
	DirShareData(path ...string) string

	// DesktopClasser allows to get desktop class informations for a given name.
	//
	DesktopClasser(class string) DesktopClasser

	// DisplayMode tells which renderer mode is used.
	//
	DisplayMode() cdglobal.DisplayMode

	// ListIcons builds the list of all icons.
	//
	ListIcons() *ListIcon

	// ListKnownApplets builds the list of all applets.
	//
	ListKnownApplets() map[string]Appleter

	// ListDownloadApplets builds the list of downloadable user applets (installed or not).
	//
	ListDownloadApplets() (map[string]Appleter, error)

	// ListIconsMainDock builds the list of icons in the maindock.
	//
	ListIconsMainDock() []Field

	// ListShortkeys returns the list of dock shortkeys.
	//
	ListShortkeys() []cdglobal.Shortkeyer

	// ListScreens returns the list of screens (active monitors on the session).
	//
	ListScreens() []Field

	// ListViews returns the list of views.
	//
	ListViews() map[string]Handbooker

	// ListAnimations returns the list of animations.
	//
	ListAnimations() []Field

	// ListDeskletDecorations returns the list of desklet decorations.
	//
	ListDeskletDecorations() []Field

	// ListDialogDecorator returns the list of dialog decorators.
	//
	ListDialogDecorator() []Field

	// ListDocks builds the list of docks with a readable name.
	// Both options are docks to remove from the list. Subdock childrens are removed too.
	//
	ListDocks(parent, subdock string) []Field

	// ListThemeDesktopIcon builds a list of desktop icon-themes in system and user dir.
	//
	ListThemeDesktopIcon() []Field

	// ListDockThemes builds the list of dock themes local and distant.
	//
	ListDockThemeLoad() (map[string]Appleter, error)

	// ListDockThemes builds the list of dock themes local only.
	//
	ListDockThemeSave() []Field

	// CurrentThemeSave saves the current dock theme.
	//
	CurrentThemeSave(themeName string, saveBehaviour, saveLaunchers, needPackage bool, dirPackage string) error

	// CurrentThemeLoad imports and loads a dock theme.
	//
	CurrentThemeLoad(themeName string, useBehaviour, useLaunchers bool) error

	// Handbook creates a handbook (description) for the given applet name.
	//
	Handbook(appletName string) Handbooker

	// ListThemeXML builds a list of icon theme in system and user dir.
	//
	ListThemeXML(localSystem, localUser, distant string) map[string]Handbooker

	// ListThemeINI builds a list of icon theme in system and user dir.
	//
	ListThemeINI(localSystem, localUser, distant string) map[string]Handbooker

	// ManagerReload reloads the manager matching the given name.
	//
	ManagerReload(name string, b bool, keyf *keyfile.KeyFile)

	// CreateMainDock creates a new main dock to store a moved icon.
	//
	CreateMainDock() string

	// GrabWindowClass waits a user window selection and returns its class.
	//
	GrabWindowClass() (string, error)
}

type SourceCommon struct {
	Log     cdtype.Logger
	ConfDir string // Path to user config dir with "extras" themes dir.
}

type UpdateModuleStater interface {
	UpdateModuleState(name string, active bool)
}