• Get and modify settings

• Table of settings
  • General
  • Applications view
  • Windows view

• Key bindings and actions

• List of actions
  • XfdashboardFocusable
  • XfdashboardFocusManager
  • XfdashboardQuicklaunch
  • XfdashboardWindowsView

The settings of xfdashboard are stored via Xfconf in channel xfdashboard.

To get value of a setting execute the following command:

xfconf-query -c xfdashboard -p PROPERTY-NAME

To modify a value either use the graphical editor xfce4-settings-editor or run the following command:

xfconf-query -c xfdashboard -p PROPERTY-NAME -n -t TYPE -s VALUE

The following table lists all possible settings affecting the core of xfdashboard. All property names must be prefixed with the path /.

The following table lists all possible settings affecting the built-in applications view of xfdashboard. All property names must be prefixed with the path /components/applications-view/.

The following table lists all possible settings affecting the built-in windows view of xfdashboard. All property names must be prefixed with the path /components/windows-view/.

A key binding describes which action to trigger when a specified key combination is pressed at an actor - optionally this action can be triggered at a different target actor.

Key bindings are configured in a XML document.

xfdashboard will look up for the key binding configuration file bindings.xml at the paths in the following order:

• ${XDG_CONFIG_HOME}/xfdashboard/bindings.xml
• ${SYSTEM-WIDE-DATA}/xfdashboard/bindings.xml

The XML document must begin with the top-level element <bindings> which is a grouping element for all key bindings defined. The top-level element does not expect any attributes set.

Key bindings are <key> elements under the top-level elements and takes two required attributes and three optional attributes.

The first required attribute is code which describes the key combination. Each key and modifier must be listed here and seperated by either +, - or spaces. Modifiers must be enclosed by < and >. Valid modifiers are: <Ctrl>, <Control>, <Shift>, <Alt>, <Mod1>, <Mod2>, <Mod3>, <Mod4>, <Mod5>, <Super>, <Hyper> and <Meta>.

The second required attribute is source which describes which actor must have be focus when the key combination configured in code is pressed to get the action triggered. It take the object's class name. Using XfdashboardFocusable as source matches every currently focused actor and can be used as a global key bindings which works at any time.

The third attribute when is optional and describes when the action should be triggered - either when the key combination configured in code is pressed or released. Valid value are pressed when the action should be triggered when the key combination is pressed or released when it should be triggered on release of the pressed key combination. If this attribute is missing the default is pressed.

The fourth attribute target is optional and describes at which other actor the action should be triggered at. The target actor must be a focusable actor that means it must be derived from class XfdashboardFocusable. The value of this attribute is the object's class name of the targer. If this attribute is missing the default is to trigger the action on currently focused actor which is usually the same as in source.

The fifth attribute allow-unfocusable-targets is optional and describes if an action should also be triggered, even if an unfocusable actor was defined at target. This attribute expect a boolean value - either true or false. But also their numeric counterparts 0 and 1 are valid. Usually you should never set this attribute and is mostly used for views at the moment as the view in target may not be active and visible at the time the action should be triggered. If this attribute is missing the default is false.

The content of the key element is the action to trigger and must be set.

The format for the XML file can be described with the following simple but not fully accurate DTD:

<!ELEMENT bindings (key*)>

<!ELEMENT key      (#CDATA)>
<!ATTLIST key      code                         CDATA    #REQUIRED
                   source                       CDATA    #REQUIRED
                   when                         CDATA    #IMPLIED
                   target                       CDATA    #IMPLIED
                   allow-unfocusable-targets    CDATA    #IMPLIED>

Back To Top

Return to Xfdashboard Main Documentation Page