e_illume.h File Reference

This header provides the various defines, structures and functions that make writing Illume policies easier. More...

Data Structures

struct  _E_Illume_Keyboard
 structure for keyboard. More...
 
struct  _E_Illume_Policy_Api
 structure for policy API. More...
 
struct  _E_Illume_Policy
 structure for policy More...
 
struct  _E_Illume_Config
 structure for Illume configuration. More...
 
struct  _E_Illume_Config_Zone
 structure for Illume zone configuration. More...
 
struct  _E_Illume_Quickpanel
 structure for Illume Quickpanels. More...
 

Macros

#define E_ILLUME_POLICY_API_VERSION   2
 Current version of the Policy API that is supported by the Illume module. More...
 

Typedefs

typedef struct _E_Illume_Keyboard E_Illume_Keyboard
 
typedef struct _E_Illume_Policy_Api E_Illume_Policy_Api
 
typedef struct _E_Illume_Policy E_Illume_Policy
 
typedef struct _E_Illume_Config E_Illume_Config
 
typedef struct
_E_Illume_Config_Zone 
E_Illume_Config_Zone
 
typedef struct _E_Illume_Quickpanel E_Illume_Quickpanel
 
typedef enum
_E_Illume_Keyboard_Layout 
E_Illume_Keyboard_Layout
 

Enumerations

enum  _E_Illume_Keyboard_Layout {
  E_ILLUME_KEYBOARD_LAYOUT_NONE,
  E_ILLUME_KEYBOARD_LAYOUT_DEFAULT,
  E_ILLUME_KEYBOARD_LAYOUT_ALPHA,
  E_ILLUME_KEYBOARD_LAYOUT_NUMERIC,
  E_ILLUME_KEYBOARD_LAYOUT_PIN,
  E_ILLUME_KEYBOARD_LAYOUT_PHONE_NUMBER,
  E_ILLUME_KEYBOARD_LAYOUT_HEX,
  E_ILLUME_KEYBOARD_LAYOUT_TERMINAL,
  E_ILLUME_KEYBOARD_LAYOUT_PASSWORD,
  E_ILLUME_KEYBOARD_LAYOUT_IP,
  E_ILLUME_KEYBOARD_LAYOUT_HOST,
  E_ILLUME_KEYBOARD_LAYOUT_FILE,
  E_ILLUME_KEYBOARD_LAYOUT_URL,
  E_ILLUME_KEYBOARD_LAYOUT_KEYPAD,
  E_ILLUME_KEYBOARD_LAYOUT_J2ME
}
 

Functions

EAPI E_Illume_Config_Zonee_illume_zone_config_get (int id)
 Returns the E_Illume_Config_Zone structure for a specific zone. More...
 
EAPI Eina_Bool e_illume_border_is_indicator (E_Border *bd)
 Determine if a given border is an Indicator window. More...
 
EAPI Eina_Bool e_illume_border_is_softkey (E_Border *bd)
 Determine if a given border is a Softkey window. More...
 
EAPI Eina_Bool e_illume_border_is_keyboard (E_Border *bd)
 Determine if a given border is a Keyboard window. More...
 
EAPI Eina_Bool e_illume_border_is_home (E_Border *bd)
 Determine if a given border is a Home window. More...
 
EAPI Eina_Bool e_illume_border_is_splash (E_Border *bd)
 Determine if a given border is a splash screen. More...
 
EAPI Eina_Bool e_illume_border_is_dialog (E_Border *bd)
 Determine if a given border is a dialog. More...
 
EAPI Eina_Bool e_illume_border_is_qt_frame (E_Border *bd)
 Determine if a given border is a QT VCLSalFrame. More...
 
EAPI Eina_Bool e_illume_border_is_fullscreen (E_Border *bd)
 Determine if a given border is a fullscreen window. More...
 
EAPI Eina_Bool e_illume_border_is_conformant (E_Border *bd)
 Determine if a given border is an illume conformant window. More...
 
EAPI Eina_Bool e_illume_border_is_quickpanel (E_Border *bd)
 Determine if a given border is a quickpanel window. More...
 
EAPI Eina_Bool e_illume_border_is_fixed_size (E_Border *bd)
 Determine if the border request a fixed size. More...
 
EAPI void e_illume_border_min_get (E_Border *bd, int *w, int *h)
 Retrieves the minimum space required to display this border. More...
 
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. More...
 
EAPI E_Border * e_illume_border_parent_get (E_Border *bd)
 Retrieve the parent of a given dialog. More...
 
EAPI void e_illume_border_show (E_Border *bd)
 Show a given border. More...
 
EAPI void e_illume_border_hide (E_Border *bd)
 Hide a given border. More...
 
EAPI E_Border * e_illume_border_indicator_get (E_Zone *zone)
 Retrieve the Indicator window on a given zone. More...
 
EAPI void e_illume_border_indicator_pos_get (E_Zone *zone, int *x, int *y)
 Retrieves the current position of the Indicator window. More...
 
EAPI E_Border * e_illume_border_softkey_get (E_Zone *zone)
 Retrieve the Softkey window on a given zone. More...
 
EAPI void e_illume_border_softkey_pos_get (E_Zone *zone, int *x, int *y)
 Retrieves the current position of the Softkey window. More...
 
EAPI E_Illume_Keyboarde_illume_keyboard_get (void)
 Retrieve the Keyboard. More...
 
EAPI void e_illume_keyboard_safe_app_region_get (E_Zone *zone, int *x, int *y, int *w, int *h)
 Retrieves the available screen space not occupied by the virtual keyboard. More...
 
EAPI E_Border * e_illume_border_home_get (E_Zone *zone)
 Retrieve the Home window on a given zone. More...
 
EAPI Eina_List * e_illume_border_home_borders_get (E_Zone *zone)
 Retrieve the list of Home windows on a given zone. More...
 
EAPI E_Illume_Quickpanele_illume_quickpanel_by_zone_get (E_Zone *zone)
 Retrieve the Illume Quickpanel on a given zone. More...
 
EAPI void e_illume_quickpanel_show (E_Zone *zone)
 Show the Illume Quickpanel on a given zone. More...
 
EAPI void e_illume_quickpanel_hide (E_Zone *zone)
 Hide the Illume Quickpanel on a given zone. More...
 

Detailed Description

This header provides the various defines, structures and functions that make writing Illume policies easier.

For details on the available functions, see Illume API Information.

For details on the configuration structure, see Illume Configuration Information.

For details on the virtual keyboard, see Illume Keyboard Information.

For details on the Policy API, see Illume Policy Information.

For details on quickpanels, see Illume Quickpanel Information.

Enumeration Type Documentation

Enumerator
E_ILLUME_KEYBOARD_LAYOUT_NONE 

no keyboard layout specified.

E_ILLUME_KEYBOARD_LAYOUT_DEFAULT 

default keyboard layout.

E_ILLUME_KEYBOARD_LAYOUT_ALPHA 

alpha keyboard layout.

E_ILLUME_KEYBOARD_LAYOUT_NUMERIC 

numeric keyboard layout

E_ILLUME_KEYBOARD_LAYOUT_PIN 

pin keyboard layout

E_ILLUME_KEYBOARD_LAYOUT_PHONE_NUMBER 

phone number keyboard layout

E_ILLUME_KEYBOARD_LAYOUT_HEX 

hex keyboard layout

E_ILLUME_KEYBOARD_LAYOUT_TERMINAL 

terminal keyboard layout

E_ILLUME_KEYBOARD_LAYOUT_PASSWORD 

password keyboard layout

E_ILLUME_KEYBOARD_LAYOUT_IP 

IP keyboard layout.

E_ILLUME_KEYBOARD_LAYOUT_HOST 

host keyboard layout

E_ILLUME_KEYBOARD_LAYOUT_FILE 

file keyboard layout

E_ILLUME_KEYBOARD_LAYOUT_URL 

url keyboard layout

E_ILLUME_KEYBOARD_LAYOUT_KEYPAD 

keypad keyboard layout

E_ILLUME_KEYBOARD_LAYOUT_J2ME 

J2ME keyboard layout.