cairo-dock-applications-manager.h File Reference

Defines
#define	_cairo_dock_appli_is_on_our_way(icon, pDock)
	void cairo_dock_reset_applications_manager (void);
Functions
void	cairo_dock_start_applications_manager (CairoDock *pDock)
Icon *	cairo_dock_search_window_covering_dock (CairoDock *pDock, gboolean bMaximizedWindow, gboolean bFullScreenWindow)
Icon *	cairo_dock_search_window_overlapping_dock (CairoDock *pDock)
GList *	cairo_dock_get_current_applis_list (void)
Window	cairo_dock_get_current_active_window (void)
Icon *	cairo_dock_get_current_active_icon (void)
Icon *	cairo_dock_get_icon_with_Xid (Window Xid)
void	cairo_dock_foreach_applis (CairoDockForeachIconFunc pFunction, gboolean bOutsideDockOnly, gpointer pUserData)
void	cairo_dock_foreach_applis_on_viewport (CairoDockForeachIconFunc pFunction, int iNumDesktop, int iNumViewportX, int iNumViewportY, gpointer pUserData)

---

Detailed Description

This class manages the list of known windows, ie the Taskbar. It also provides convenient functions to act on all the applis icons at once.

---

Function Documentation

void cairo_dock_start_applications_manager

(

CairoDock *

pDock

)

Start the applications manager. It will load all the applis, and keep monitoring them. If enabled, it will insert them into the dock.

Parameters:

pDock

the main dock

Icon* cairo_dock_search_window_covering_dock	(	CairoDock *	pDock,
		gboolean	bMaximizedWindow,
		gboolean	bFullScreenWindow
	)

Get the icon of an application whose window covers entirely a dock, or NULL if none. If both parameters are FALSE, check for all windows.

Parameters:

pDock	the dock to test.
bMaximizedWindow	check for maximized windows only.
bFullScreenWindow	check for full screen windows only.

Returns:

the icon representing the window, or NULL if none has been found.

Icon* cairo_dock_search_window_overlapping_dock

(

CairoDock *

pDock

)

Get the icon of an application whose window overlaps a dock, or NULL if none.

Parameters:

pDock

the dock to test.

Returns:

the icon of the window, or NULL if none has been found.

GList* cairo_dock_get_current_applis_list

(

void

)

Get the list of appli's icons currently known by Cairo-Dock, including the icons not displayed in the dock. You can then order the list by z-order, name, etc.

Returns:

a newly allocated list of applis's icons. You must free the list when you're done with it, but not the icons.

Window cairo_dock_get_current_active_window

(

void

)

Get the currently active window ID.

Returns:

the X id.

Icon* cairo_dock_get_current_active_icon

(

void

)

Get the icon of the currently active window.

Returns:

the icon (maybe not inside a dock).

Icon* cairo_dock_get_icon_with_Xid

(

Window

Xid

)

Get the icon of a given window. The search is fast.

Parameters:

Xid	the id of the X window.

Returns:

the icon (maybe not inside a dock).

void cairo_dock_foreach_applis	(	CairoDockForeachIconFunc	pFunction,
		gboolean	bOutsideDockOnly,
		gpointer	pUserData
	)

Run a function on all appli's icons.

Parameters:

pFunction	a /ref CairoDockForeachIconFunc function to be called
bOutsideDockOnly	TRUE if you only want to go through icons that are not inside a dock, FALSE to go through all icons.
pUserData	a data passed to the function.

void cairo_dock_foreach_applis_on_viewport	(	CairoDockForeachIconFunc	pFunction,
		int	iNumDesktop,
		int	iNumViewportX,
		int	iNumViewportY,
		gpointer	pUserData
	)

Run a function on all appli's icons present on a given workspace.

Parameters:

pFunction	a /ref CairoDockForeachIconFunc function to be called
iNumDesktop	number of the desktop
iNumViewportX	number of the horizontal viewport
iNumViewportY	number of the vertical viewport
pUserData	a data passed to the function.