Illume API Information

The following group defines variables, structures, and functions available to a policy. More...

Functions

EAPI Eina_Bool e_illume_border_is_indicator (E_Border *bd)
 Determine if a given border is an Indicator window.
EAPI Eina_Bool e_illume_border_is_softkey (E_Border *bd)
 Determine if a given border is a Softkey window.
EAPI Eina_Bool e_illume_border_is_keyboard (E_Border *bd)
 Determine if a given border is a Keyboard window.
EAPI Eina_Bool e_illume_border_is_home (E_Border *bd)
 Determine if a given border is a Home window.
EAPI Eina_Bool e_illume_border_is_splash (E_Border *bd)
 Determine if a given border is a splash screen.
EAPI Eina_Bool e_illume_border_is_dialog (E_Border *bd)
 Determine if a given border is a dialog.
EAPI Eina_Bool e_illume_border_is_qt_frame (E_Border *bd)
 Determine if a given border is a QT VCLSalFrame.
EAPI Eina_Bool e_illume_border_is_fullscreen (E_Border *bd)
 Determine if a given border is a fullscreen window.
EAPI Eina_Bool e_illume_border_is_conformant (E_Border *bd)
 Determine if a given border is an illume conformant window.
EAPI Eina_Bool e_illume_border_is_quickpanel (E_Border *bd)
 Determine if a given border is a quickpanel window.
EAPI Eina_Bool e_illume_border_is_fixed_size (E_Border *bd)
 Determine if the border request a fixed size.
EAPI void e_illume_border_min_get (E_Border *bd, int *w, int *h)
 Retrieves the minimum space required to display this border.
EAPI E_Border * e_illume_border_at_xy_get (E_Zone *zone, int x, int y)
 Retrieves a border, given an x and y coordinate, from a zone.
EAPI E_Border * e_illume_border_parent_get (E_Border *bd)
 Retrieve the parent of a given dialog.
EAPI void e_illume_border_show (E_Border *bd)
 Show a given border.
EAPI void e_illume_border_hide (E_Border *bd)
 Hide a given border.
EAPI E_Border * e_illume_border_indicator_get (E_Zone *zone)
 Retrieve the Indicator window on a given zone.
EAPI void e_illume_border_indicator_pos_get (E_Zone *zone, int *x, int *y)
 Retrieves the current position of the Indicator window.
EAPI E_Border * e_illume_border_softkey_get (E_Zone *zone)
 Retrieve the Softkey window on a given zone.
EAPI void e_illume_border_softkey_pos_get (E_Zone *zone, int *x, int *y)
 Retrieves the current position of the Softkey window.
EAPI E_Border * e_illume_border_home_get (E_Zone *zone)
 Retrieve the Home window on a given zone.
EAPI Eina_List * e_illume_border_home_borders_get (E_Zone *zone)
 Retrieve the list of Home windows on a given zone.

Detailed Description

The following group defines variables, structures, and functions available to a policy.


Function Documentation

EAPI E_Border* e_illume_border_at_xy_get ( E_Zone *  zone,
int  x,
int  y 
)

Retrieves a border, given an x and y coordinate, from a zone.

Parameters:
zoneThe zone.
xThe X coordinate to check for border at.
yThe Y coordinate to check for border at.
Note:
if zone is NULL then this function will return NULL.
Warning:
Both X and Y coordinates are required to reliably detect a border.

References e_illume_border_is_home(), e_illume_border_is_indicator(), e_illume_border_is_keyboard(), e_illume_border_is_quickpanel(), and e_illume_border_is_softkey().

EAPI void e_illume_border_hide ( E_Border *  bd)

Hide a given border.

Parameters:
bdThe border to hide.
Note:
If bd is NULL then this function will return.
EAPI Eina_List* e_illume_border_home_borders_get ( E_Zone *  zone)

Retrieve the list of Home windows on a given zone.

Parameters:
zoneThe zone.
Returns:
A list of existing Home windows, or NULL if none exist.
Note:
If zone is NULL then this function will return NULL.

References e_illume_border_is_home().

EAPI E_Border* e_illume_border_home_get ( E_Zone *  zone)

Retrieve the Home window on a given zone.

Parameters:
zoneThe zone.
Returns:
The Home window, or NULL if no Home window exists.
Note:
If zone is NULL then this function will return NULL.

References e_illume_border_is_home().

EAPI E_Border* e_illume_border_indicator_get ( E_Zone *  zone)

Retrieve the Indicator window on a given zone.

Parameters:
zoneThe zone.
Returns:
The Indicator border, or NULL if no Indicator exists.
Note:
If zone is NULL then this function will return NULL.

References e_illume_border_is_indicator().

Referenced by e_illume_border_indicator_pos_get().

EAPI void e_illume_border_indicator_pos_get ( E_Zone *  zone,
int *  x,
int *  y 
)

Retrieves the current position of the Indicator window.

Parameters:
zoneThe zone on which to retrieve the Indicator position.
xPointer to an integer into which the left is to be stored.
yPointer to an integer into which the top is to be stored.
Note:
if zone is NULL then x, y, w, and h will return 0.

References e_illume_border_indicator_get().

EAPI Eina_Bool e_illume_border_is_conformant ( E_Border *  bd)

Determine if a given border is an illume conformant window.

Parameters:
bdThe border to test.
Returns:
EINA_TRUE if it is conformant, EINA_FALSE otherwise.
Note:
If bd is NULL then this function will return EINA_FALSE.
EAPI Eina_Bool e_illume_border_is_dialog ( E_Border *  bd)

Determine if a given border is a dialog.

Parameters:
bdThe border to test.
Returns:
EINA_TRUE if it is a dialog, EINA_FALSE otherwise.
Note:
If bd is NULL then this function will return EINA_FALSE.
EAPI Eina_Bool e_illume_border_is_fixed_size ( E_Border *  bd)

Determine if the border request a fixed size.

Parameters:
bdThe border to get the minium space for.
Returns:
EINA_TRUE if border requested fixed size, EINA_FALSE otherwise.
Note:
If bd is NULL then this function will return EINA_FALSE.
EAPI Eina_Bool e_illume_border_is_fullscreen ( E_Border *  bd)

Determine if a given border is a fullscreen window.

Parameters:
bdThe border to test.
Returns:
EINA_TRUE if it is fullscreen, EINA_FALSE otherwise.
Note:
If bd is NULL then this function will return EINA_FALSE.
EAPI Eina_Bool e_illume_border_is_home ( E_Border *  bd)

Determine if a given border is a Home window.

Parameters:
bdThe border to test.
Returns:
EINA_TRUE if it is a Home window, EINA_FALSE otherwise.
Note:
If bd is NULL then this function will return EINA_FALSE.

Referenced by e_illume_border_at_xy_get(), e_illume_border_home_borders_get(), and e_illume_border_home_get().

EAPI Eina_Bool e_illume_border_is_indicator ( E_Border *  bd)

Determine if a given border is an Indicator window.

Parameters:
bdThe border to test.
Returns:
EINA_TRUE if it is an Indicator window, EINA_FALSE otherwise.
Note:
If bd is NULL then this function will return EINA_FALSE.
It is assumed that Indicator windows are of type ECORE_X_WINDOW_TYPE_DOCK.

Referenced by e_illume_border_at_xy_get(), and e_illume_border_indicator_get().

EAPI Eina_Bool e_illume_border_is_keyboard ( E_Border *  bd)

Determine if a given border is a Keyboard window.

Parameters:
bdThe border to test.
Returns:
EINA_TRUE if it is a Keyboard window, EINA_FALSE otherwise.
Note:
If bd is NULL then this function will return EINA_FALSE.

Referenced by e_illume_border_at_xy_get().

EAPI Eina_Bool e_illume_border_is_qt_frame ( E_Border *  bd)

Determine if a given border is a QT VCLSalFrame.

Parameters:
bdThe border to test.
Returns:
EINA_TRUE if it is a VCLSalFrame, EINA_FALSE otherwise.
Note:
If bd is NULL then this function will return EINA_FALSE.
EAPI Eina_Bool e_illume_border_is_quickpanel ( E_Border *  bd)

Determine if a given border is a quickpanel window.

Parameters:
bdThe border to test.
Returns:
EINA_TRUE if it is a quickpanel, EINA_FALSE otherwise.
Note:
If bd is NULL then this function will return EINA_FALSE.

Referenced by e_illume_border_at_xy_get().

EAPI Eina_Bool e_illume_border_is_softkey ( E_Border *  bd)

Determine if a given border is a Softkey window.

Parameters:
bdThe border to test.
Returns:
EINA_TRUE if it is a Softkey window, EINA_FALSE otherwise.
Note:
If bd is NULL then this function will return EINA_FALSE.
It is assumed that Softkey windows are of type ECORE_X_WINDOW_TYPE_DOCK.

Referenced by e_illume_border_at_xy_get(), and e_illume_border_softkey_get().

EAPI Eina_Bool e_illume_border_is_splash ( E_Border *  bd)

Determine if a given border is a splash screen.

Parameters:
bdThe border to test.
Returns:
EINA_TRUE if it is a splash screen, EINA_FALSE otherwise.
Note:
If bd is NULL then this function will return EINA_FALSE.
EAPI void e_illume_border_min_get ( E_Border *  bd,
int *  w,
int *  h 
)

Retrieves the minimum space required to display this border.

Parameters:
bdThe border to get the minium space for.
wPointer to an integer into which the width is to be stored.
hPointer to an integer into which the height is to be stored.
Note:
if bd is NULL then w and h will return 0.
EAPI E_Border* e_illume_border_parent_get ( E_Border *  bd)

Retrieve the parent of a given dialog.

Parameters:
bdThe border to get the parent of.
Returns:
The border's parent, or NULL if no parent exists.
Note:
If bd is NULL then this function will return NULL.
EAPI void e_illume_border_show ( E_Border *  bd)

Show a given border.

Parameters:
bdThe border to show.
Note:
If bd is NULL then this function will return.
EAPI E_Border* e_illume_border_softkey_get ( E_Zone *  zone)

Retrieve the Softkey window on a given zone.

Parameters:
zoneThe zone.
Returns:
The Softkey border, or NULL if no Softkey exists.
Note:
If zone is NULL then this function will return NULL.

References e_illume_border_is_softkey().

Referenced by e_illume_border_softkey_pos_get().

EAPI void e_illume_border_softkey_pos_get ( E_Zone *  zone,
int *  x,
int *  y 
)

Retrieves the current position of the Softkey window.

Parameters:
zoneThe zone on which to retrieve the Softkey position.
xPointer to an integer into which the left is to be stored.
yPointer to an integer into which the top is to be stored.
Note:
if zone is NULL then x, y, w, and h will return 0.

References e_illume_border_softkey_get().