Cairo-Dock  3.4.0
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
cairo-dock-desktop-manager.h File Reference

Data Structures

struct  _GldiDesktopManagerBackend
 Definition of the Desktop Manager backend. More...
 
struct  _GldiDesktopBackground
 Definition of a Desktop Background Buffer. It has a reference count so that it can be shared across all the lib. More...
 

Enumerations

enum  CairoDesktopNotifications {
  NOTIFICATION_DESKTOP_CHANGED,
  NOTIFICATION_DESKTOP_GEOMETRY_CHANGED,
  NOTIFICATION_DESKTOP_VISIBILITY_CHANGED,
  NOTIFICATION_KBD_STATE_CHANGED,
  NOTIFICATION_DESKTOP_NAMES_CHANGED,
  NOTIFICATION_DESKTOP_WALLPAPER_CHANGED,
  NOTIFICATION_SHORTKEY_PRESSED,
  NOTIFICATION_KEYMAP_CHANGED
}
 signals More...
 

Functions

void gldi_desktop_manager_register_backend (GldiDesktopManagerBackend *pBackend)
 
gboolean gldi_desktop_present_class (const gchar *cClass)
 
gboolean gldi_desktop_present_windows (void)
 
gboolean gldi_desktop_present_desktops (void)
 
gboolean gldi_desktop_show_widget_layer (void)
 
gboolean gldi_desktop_set_on_widget_layer (GldiContainer *pContainer, gboolean bOnWidgetLayer)
 
void gldi_desktop_get_current (int *iCurrentDesktop, int *iCurrentViewportX, int *iCurrentViewportY)
 

Detailed Description

This class manages the desktop: screen geometry, current desktop/viewport, etc, and notifies for any change on it.

Enumeration Type Documentation

signals

Enumerator
NOTIFICATION_DESKTOP_CHANGED 

notification called when the user switches to another desktop/viewport. data : NULL

NOTIFICATION_DESKTOP_GEOMETRY_CHANGED 

notification called when the geometry of the desktop has changed (number of viewports/desktops, dimensions). data: resolution-has-changed

NOTIFICATION_DESKTOP_VISIBILITY_CHANGED 

notification called when the desktop is shown/hidden. data: NULL

NOTIFICATION_KBD_STATE_CHANGED 

notification called when the state of the keyboard has changed.

NOTIFICATION_DESKTOP_NAMES_CHANGED 

notification called when the names of the desktops have changed

NOTIFICATION_DESKTOP_WALLPAPER_CHANGED 

notification called when the wallpaper has changed

NOTIFICATION_SHORTKEY_PRESSED 

notification called when a shortkey that has been registered by the dock is pressed. data: keycode, modifiers

NOTIFICATION_KEYMAP_CHANGED 

notification called when the keymap changed, before and after updating it. data: updated

Function Documentation

void gldi_desktop_manager_register_backend ( GldiDesktopManagerBackend pBackend)

Register a Desktop Manager backend. NULL functions do not overwrite existing ones.

Parameters
pBackenda Desktop Manager backend; can be freeed after.
gboolean gldi_desktop_present_class ( const gchar *  cClass)

Present all the windows of a given class.

Parameters
cClassthe class.
Returns
TRUE on success
gboolean gldi_desktop_present_windows ( void  )

Present all the windows of the current desktop.

Returns
TRUE on success
gboolean gldi_desktop_present_desktops ( void  )

Present all the desktops.

Returns
TRUE on success
gboolean gldi_desktop_show_widget_layer ( void  )

Show the Widget Layer.

Returns
TRUE on success
gboolean gldi_desktop_set_on_widget_layer ( GldiContainer pContainer,
gboolean  bOnWidgetLayer 
)

Set a Container to be displayed on the Widget Layer.

Parameters
pContainera container.
bOnWidgetLayerwhether to set or unset the option.
Returns
TRUE on success
void gldi_desktop_get_current ( int *  iCurrentDesktop,
int *  iCurrentViewportX,
int *  iCurrentViewportY 
)

Get the current workspace (desktop and viewport).

Parameters
iCurrentDesktopwill be filled with the current desktop number
iCurrentViewportXwill be filled with the current horizontal viewport number
iCurrentViewportYwill be filled with the current vertical viewport number