forked from enlightenment/enlightenment
330 lines
9.0 KiB
C
330 lines
9.0 KiB
C
#ifndef E_ILLUME_H
|
|
# define E_ILLUME_H
|
|
|
|
/* include standard E header */
|
|
# include "e.h"
|
|
|
|
/**
|
|
* @mainpage Illume
|
|
*
|
|
* @image html e.png
|
|
*
|
|
* @author Christopher Michael
|
|
* @date 2010
|
|
*
|
|
* @section illume_toc_sec Table of contents
|
|
*
|
|
* <ul>
|
|
* <li> @ref illume_intro_sec
|
|
* </ul>
|
|
*
|
|
* @section illume_intro_sec Introduction to Illume
|
|
*
|
|
* Illume is a module for Enlightenment that modifies the user interface of
|
|
* enlightenment to work cleanly and nicely on a mobile device - such as an
|
|
* Openmoko phone. It is resolution independent meaning that it can
|
|
* accommodate a very wide range of devices, from cell phones and PDAs to
|
|
* tablets and desktops. Illume has been designed from the ground up to
|
|
* support more than one screen in more than one way (multihead and xinerama).
|
|
*
|
|
* This is a work in progress and as such is subject to change.
|
|
*/
|
|
|
|
/**
|
|
* @file e_illume.h
|
|
*
|
|
* This header provides the various defines, structures and functions that
|
|
* make writing illume policies easier.
|
|
*
|
|
* For details on the available functions, see @ref E_Illume_Main_Group.
|
|
*
|
|
* For details on the configuration structure, see @ref E_Illume_Config_Group.
|
|
*
|
|
* For details on the virtual keyboard, see @ref E_Illume_Keyboard_Group.
|
|
*
|
|
* For details on the Policy API, see @ref E_Illume_Policy_Group.
|
|
*
|
|
* For details on quickpanels, see @ref E_Illume_Quickpanel_Group.
|
|
*/
|
|
|
|
/**
|
|
* @defgroup E_Illume_Keyboard_Group Illume Keyboard Information
|
|
*
|
|
* The following group defines information needed to interact with the
|
|
* Virtual Keyboard.
|
|
*
|
|
*/
|
|
|
|
/* define enumeration for keyboard layout */
|
|
typedef enum _E_Illume_Keyboard_Layout E_Illume_Keyboard_Layout;
|
|
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
|
|
};
|
|
|
|
/**
|
|
* @typedef E_Illume_Keyboard
|
|
* @brief structure for keyboard.
|
|
*
|
|
* @ingroup E_Illume_Keyboard_Group
|
|
*/
|
|
typedef struct _E_Illume_Keyboard E_Illume_Keyboard;
|
|
|
|
/**
|
|
* @struct E_Illume_Keyboard
|
|
* @brief structure for keyboard.
|
|
*
|
|
* @ingroup E_Illume_Keyboard_Group
|
|
*/
|
|
struct _E_Illume_Keyboard
|
|
{
|
|
E_Object e_obj_inherit;
|
|
|
|
E_Border *border; /**< Test struct member */
|
|
Ecore_Timer *timer;
|
|
Ecore_Animator *animator;
|
|
|
|
E_Illume_Keyboard_Layout layout;
|
|
Eina_List *waiting_borders;
|
|
|
|
double start, len;
|
|
int adjust, adjust_start, adjust_end;
|
|
|
|
unsigned char visible : 1;
|
|
unsigned char disabled : 1;
|
|
unsigned char fullscreen : 1;
|
|
};
|
|
|
|
/**
|
|
* @defgroup E_Illume_Policy_Group Illume Policy Information
|
|
*
|
|
* The following group defines information needed to implement an Illume
|
|
* Policy.
|
|
*
|
|
* @warning There are some requirements that every policy must implement.
|
|
*/
|
|
|
|
/**
|
|
* @def E_ILLUME_POLICY_API_VERSION
|
|
* @brief Current version of the Policy API that is supported by the Illume module.
|
|
*
|
|
* @warning Policies not written to match this version will fail to load.
|
|
*
|
|
* @ingroup E_Illume_Policy_Group
|
|
*/
|
|
# define E_ILLUME_POLICY_API_VERSION 2
|
|
|
|
/**
|
|
* @struct E_Illume_Policy_Api
|
|
* @brief structure for policy api
|
|
*
|
|
* When Illume tries to load a policy, it will check for the existince of
|
|
* this structure. If it is not found, the policy will fail to load.
|
|
*
|
|
* @warning This structure is required for Illume to load a policy.
|
|
*
|
|
* @ingroup E_Illume_Policy_Group
|
|
*/
|
|
typedef struct _E_Illume_Policy_Api E_Illume_Policy_Api;
|
|
struct _E_Illume_Policy_Api
|
|
{
|
|
int version; /**< The version of this policy. */
|
|
|
|
/**< The name of this policy. */
|
|
const char *name;
|
|
/**< The label of this policy. */
|
|
const char *label;
|
|
};
|
|
|
|
/**
|
|
* @typedef E_Illume_Policy
|
|
* @brief structure for policy
|
|
*
|
|
* This structure actually holds the policy functions to call.
|
|
*
|
|
* @ingroup E_Illume_Policy_Group
|
|
*/
|
|
typedef struct _E_Illume_Policy E_Illume_Policy;
|
|
struct _E_Illume_Policy
|
|
{
|
|
E_Object e_obj_inherit;
|
|
|
|
/** pointer to the @ref E_Illume_Policy_Api policy api structure. */
|
|
E_Illume_Policy_Api *api;
|
|
|
|
void *handle;
|
|
|
|
struct
|
|
{
|
|
/** @warning Required Functions. */
|
|
void *(*init) (E_Illume_Policy *p); /**< pointer to the function that will be called by Illume to initialize this policy. */
|
|
int (*shutdown) (E_Illume_Policy *p); /**< pointer to the function that Illume will call to shutdown this policy.*/
|
|
|
|
/** @note Optional Functions. */
|
|
void (*border_add) (E_Border *bd);
|
|
void (*border_del) (E_Border *bd);
|
|
void (*border_focus_in) (E_Border *bd);
|
|
void (*border_focus_out) (E_Border *bd);
|
|
void (*border_activate) (E_Border *bd);
|
|
void (*border_post_fetch) (E_Border *bd);
|
|
void (*border_post_assign) (E_Border *bd);
|
|
void (*zone_layout) (E_Zone *zone);
|
|
void (*zone_move_resize) (E_Zone *zone);
|
|
void (*zone_mode_change) (E_Zone *zone, Ecore_X_Atom mode);
|
|
void (*zone_close) (E_Zone *zone);
|
|
void (*drag_start) (E_Border *bd);
|
|
void (*drag_end) (E_Border *bd);
|
|
void (*focus_back) (E_Zone *zone);
|
|
void (*focus_forward) (E_Zone *zone);
|
|
void (*focus_home) (E_Zone *zone);
|
|
void (*property_change) (Ecore_X_Event_Window_Property *event);
|
|
} funcs;
|
|
};
|
|
|
|
/**
|
|
* @defgroup E_Illume_Config_Group Illume Configuration Information
|
|
*
|
|
* The following group defines information pertaining to Illume Configuration.
|
|
*/
|
|
|
|
/**
|
|
* @typedef E_Illume_Config
|
|
* @brief structure for Illume configuration.
|
|
*
|
|
* @ingroup E_Illume_Config_Group
|
|
*/
|
|
typedef struct _E_Illume_Config E_Illume_Config;
|
|
struct _E_Illume_Config
|
|
{
|
|
int version;
|
|
|
|
struct
|
|
{
|
|
struct
|
|
{
|
|
int duration;
|
|
} vkbd, quickpanel;
|
|
} animation;
|
|
|
|
struct
|
|
{
|
|
const char *name;
|
|
struct
|
|
{
|
|
const char *class, *name, *title;
|
|
int type;
|
|
struct
|
|
{
|
|
int class, name, title, type;
|
|
} match;
|
|
} vkbd, indicator, softkey, home;
|
|
Eina_List *zones;
|
|
} policy;
|
|
};
|
|
|
|
|
|
/**
|
|
* @typedef E_Illume_Config_Zone
|
|
* @brief structure for Illume zone configuration.
|
|
*
|
|
* @ingroup E_Illume_Config_Group
|
|
*/
|
|
typedef struct _E_Illume_Config_Zone E_Illume_Config_Zone;
|
|
struct _E_Illume_Config_Zone
|
|
{
|
|
int id; /**< Id of the Zone that this config belongs to. */
|
|
struct
|
|
{
|
|
int dual;
|
|
int side;
|
|
} mode;
|
|
|
|
/* NB: These are not configurable by user...just placeholders */
|
|
struct
|
|
{
|
|
int size;
|
|
} vkbd, indicator, softkey;
|
|
};
|
|
|
|
/**
|
|
* @defgroup E_Illume_Quickpanel_Group Illume Quickpanel Information
|
|
*
|
|
* The following group defines information pertaining to Illume Quickpanels.
|
|
*/
|
|
|
|
/**
|
|
* @typedef E_Illume_Quickpanel
|
|
* @brief structure for Illume Quickpanels.
|
|
*
|
|
* @ingroup E_Illume_Quickpanel_Group
|
|
*/
|
|
typedef struct _E_Illume_Quickpanel E_Illume_Quickpanel;
|
|
struct _E_Illume_Quickpanel
|
|
{
|
|
E_Object e_obj_inherit;
|
|
|
|
E_Zone *zone;
|
|
Eina_List *borders;
|
|
Ecore_Timer *timer;
|
|
Ecore_Animator *animator;
|
|
double start, len;
|
|
int h, ih, adjust, adjust_start, adjust_end;
|
|
unsigned char visible : 1;
|
|
};
|
|
|
|
/* define function prototypes that policies can use */
|
|
E_Illume_Config_Zone *e_illume_zone_config_get(int id);
|
|
|
|
/* general functions */
|
|
Eina_Bool e_illume_border_is_indicator(E_Border *bd);
|
|
Eina_Bool e_illume_border_is_softkey(E_Border *bd);
|
|
Eina_Bool e_illume_border_is_keyboard(E_Border *bd);
|
|
Eina_Bool e_illume_border_is_home(E_Border *bd);
|
|
Eina_Bool e_illume_border_is_splash(E_Border *bd);
|
|
Eina_Bool e_illume_border_is_dialog(E_Border *bd);
|
|
Eina_Bool e_illume_border_is_qt_frame(E_Border *bd);
|
|
Eina_Bool e_illume_border_is_fullscreen(E_Border *bd);
|
|
Eina_Bool e_illume_border_is_conformant(E_Border *bd);
|
|
Eina_Bool e_illume_border_is_quickpanel(E_Border *bd);
|
|
|
|
void e_illume_border_min_get(E_Border *bd, int *w, int *h);
|
|
E_Border *e_illume_border_at_xy_get(E_Zone *zone, int x, int y);
|
|
E_Border *e_illume_border_parent_get(E_Border *bd);
|
|
void e_illume_border_show(E_Border *bd);
|
|
void e_illume_border_hide(E_Border *bd);
|
|
|
|
/* indicator functions */
|
|
E_Border *e_illume_border_indicator_get(E_Zone *zone);
|
|
void e_illume_border_indicator_pos_get(E_Zone *zone, int *x, int *y);
|
|
|
|
/* softkey functions */
|
|
E_Border *e_illume_border_softkey_get(E_Zone *zone);
|
|
void e_illume_border_softkey_pos_get(E_Zone *zone, int *x, int *y);
|
|
|
|
/* keyboard functions */
|
|
E_Illume_Keyboard *e_illume_keyboard_get(void);
|
|
void e_illume_keyboard_safe_app_region_get(E_Zone *zone, int *x, int *y, int *w, int *h);
|
|
|
|
/* home functions */
|
|
E_Border *e_illume_border_home_get(E_Zone *zone);
|
|
Eina_List *e_illume_border_home_borders_get(E_Zone *zone);
|
|
|
|
/* quickpanel functions */
|
|
E_Illume_Quickpanel *e_illume_quickpanel_by_zone_get(E_Zone *zone);
|
|
|
|
#endif
|