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

Macros

#define cairo_dock_get_available_docks_for_icon(pIcon)
 

Functions

void cairo_dock_update_dock_size (CairoDock *pDock)
 
Iconcairo_dock_calculate_dock_icons (CairoDock *pDock)
 
void cairo_dock_show_subdock (Icon *pPointedIcon, CairoDock *pParentDock)
 
GList * cairo_dock_get_available_docks (CairoDock *pParentDock, CairoDock *pSubDock)
 
void cairo_dock_calculate_icons_positions_at_rest_linear (GList *pIconList, double fFlatDockWidth)
 
Iconcairo_dock_apply_wave_effect_linear (CairoDock *pDock)
 
double cairo_dock_get_current_dock_width_linear (CairoDock *pDock)
 
void cairo_dock_check_if_mouse_inside_linear (CairoDock *pDock)
 
void cairo_dock_check_can_drop_linear (CairoDock *pDock)
 
GList * cairo_dock_get_first_drawn_element_linear (GList *icons)
 

Detailed Description

This class contains functions to manipulate docks. Some functions are dedicated to linear docks, that is to say when the icon's position can be defined by 1 coordinate inside a non looped interval; it doesn't mean they have to be drawn on a straight line though, see the Curve view.

Macro Definition Documentation

#define cairo_dock_get_available_docks_for_icon (   pIcon)

Get a list of available docks where an user icon can be placed. Its current parent dock is excluded, as well as its sub-dock (if any) and its children.

Parameters
pIconthe icon
Returns
a list of CairoDock*

Function Documentation

void cairo_dock_update_dock_size ( CairoDock pDock)

Compute the maximum size of a dock, and resize it if necessary. It takes into account the size limit, and moves the dock so that it stays centered. Also updates the dock's background if necessary, and re-place the appli thumbnails.

Parameters
pDockthe dock.
Icon* cairo_dock_calculate_dock_icons ( CairoDock pDock)

Calculate the position of all icons inside a dock, and triggers the enter/leave events according to the position of the mouse.

Parameters
pDockthe dock.
Returns
the pointed icon, or NULL if none is pointed.
void cairo_dock_show_subdock ( Icon pPointedIcon,
CairoDock pParentDock 
)

Pop up a sub-dock.

Parameters
pPointedIconicon pointing on the sub-dock.
pParentDockdock containing the icon.
GList* cairo_dock_get_available_docks ( CairoDock pParentDock,
CairoDock pSubDock 
)

Get a list of available docks.

Parameters
pParentDockexcluding this dock if not NULL
pSubDockexcluding this dock and its children if not NULL
Returns
a list of CairoDock*
void cairo_dock_calculate_icons_positions_at_rest_linear ( GList *  pIconList,
double  fFlatDockWidth 
)

Calculate the position at rest (when the mouse is outside of the dock and its size is normal) of the icons of a linear dock.

Parameters
pIconLista list of icons.
fFlatDockWidthwidth of all the icons placed next to each other.
Icon* cairo_dock_apply_wave_effect_linear ( CairoDock pDock)

Apply a wave effect on the icons of a linear dock. It is the famous zoom when the mouse hovers an icon.

Parameters
pDocka linear dock.
Returns
the pointed icon, or NULL if none is pointed.
double cairo_dock_get_current_dock_width_linear ( CairoDock pDock)

Get the current width of all the icons of a linear dock. It doesn't take into account any decoration or frame, only the space occupied by the icons.

Parameters
pDocka linear dock.
Returns
the dock's width.
void cairo_dock_check_if_mouse_inside_linear ( CairoDock pDock)

Check the position of the mouse inside a linear dock. It can be inside, on the edge, or outside. Update the 'iMousePositionType' field.

Parameters
pDocka linear dock.
void cairo_dock_check_can_drop_linear ( CairoDock pDock)

Check if one can drop inside a linear dock. Drop is allowed between 2 icons of the launchers group, if the user is dragging something over the dock. Update the 'bCanDrop' field.

Parameters
pDocka linear dock.
GList* cairo_dock_get_first_drawn_element_linear ( GList *  icons)

Get the first icon to be drawn inside a linear dock, so that if you draw from left to right, the pointed icon will be drawn at last.

Parameters
iconsa list of icons of a linear dock.
Returns
the element of the list that contains the first icon to draw.