summaryrefslogtreecommitdiff
path: root/legacy/ecore/src/lib/ecore_fb/Ecore_Fb.h
diff options
context:
space:
mode:
authorVincent Torri <vincent.torri@gmail.com>2010-10-12 07:55:24 +0000
committerVincent Torri <vincent.torri@gmail.com>2010-10-12 07:55:24 +0000
commit9243d767a7ba7a8a30c03bc0570dcfc5d3925d4a (patch)
tree86e30169ca82b0868cc3f7da088a968c33e66c5e /legacy/ecore/src/lib/ecore_fb/Ecore_Fb.h
parenteeb330adc3beca78a2b8a099318f1198c697cca1 (diff)
Ecore_Fb doc finished
SVN revision: 53297
Diffstat (limited to '')
-rw-r--r--legacy/ecore/src/lib/ecore_fb/Ecore_Fb.h84
1 files changed, 64 insertions, 20 deletions
diff --git a/legacy/ecore/src/lib/ecore_fb/Ecore_Fb.h b/legacy/ecore/src/lib/ecore_fb/Ecore_Fb.h
index 330f82dee6..416ab9d246 100644
--- a/legacy/ecore/src/lib/ecore_fb/Ecore_Fb.h
+++ b/legacy/ecore/src/lib/ecore_fb/Ecore_Fb.h
@@ -17,11 +17,6 @@
17# define EAPI 17# define EAPI
18#endif 18#endif
19 19
20/**
21 * @file
22 * @brief Ecore frame buffer system functions.
23 */
24
25/* FIXME: 20/* FIXME:
26 * maybe a new module? 21 * maybe a new module?
27 * - code to get battery info 22 * - code to get battery info
@@ -38,9 +33,24 @@
38extern "C" { 33extern "C" {
39#endif 34#endif
40 35
41typedef struct _Ecore_Fb_Input_Device Ecore_Fb_Input_Device; /* an input device handler */ 36/**
37 * @defgroup Ecore_FB_Group Ecore_FB - Frame buffer convenience functions.
38 *
39 * Functions used to set up and shut down the Ecore_Framebuffer functions.
40 *
41 * @{
42 */
43
44/**
45 * @typedef Ecore_Fb_Input_Device
46 * Input device handler.
47 */
48typedef struct _Ecore_Fb_Input_Device Ecore_Fb_Input_Device;
42 49
43/* device capabilities */ 50/**
51 * @enum _Ecore_Fb_Input_Device_Cap
52 * Device capabilities.
53 */
44enum _Ecore_Fb_Input_Device_Cap 54enum _Ecore_Fb_Input_Device_Cap
45{ 55{
46 ECORE_FB_INPUT_DEVICE_CAP_NONE = 0x00000000, 56 ECORE_FB_INPUT_DEVICE_CAP_NONE = 0x00000000,
@@ -48,6 +58,11 @@ enum _Ecore_Fb_Input_Device_Cap
48 ECORE_FB_INPUT_DEVICE_CAP_ABSOLUTE = 0x00000002, 58 ECORE_FB_INPUT_DEVICE_CAP_ABSOLUTE = 0x00000002,
49 ECORE_FB_INPUT_DEVICE_CAP_KEYS_OR_BUTTONS = 0x00000004 59 ECORE_FB_INPUT_DEVICE_CAP_KEYS_OR_BUTTONS = 0x00000004
50}; 60};
61
62/**
63 * @typedef Ecore_Fb_Input_Device_Cap
64 * Device capabilities.
65 */
51typedef enum _Ecore_Fb_Input_Device_Cap Ecore_Fb_Input_Device_Cap; 66typedef enum _Ecore_Fb_Input_Device_Cap Ecore_Fb_Input_Device_Cap;
52 67
53EAPI extern int ECORE_FB_EVENT_KEY_DOWN; /**< FB Key Down event */ 68EAPI extern int ECORE_FB_EVENT_KEY_DOWN; /**< FB Key Down event */
@@ -64,23 +79,35 @@ typedef struct _Ecore_Fb_Event_Mouse_Button_Up Ecore_Fb_Event_Mouse_Button_Up;
64typedef struct _Ecore_Fb_Event_Mouse_Move Ecore_Fb_Event_Mouse_Move; /**< FB Mouse Move event */ 79typedef struct _Ecore_Fb_Event_Mouse_Move Ecore_Fb_Event_Mouse_Move; /**< FB Mouse Move event */
65typedef struct _Ecore_Fb_Event_Mouse_Wheel Ecore_Fb_Event_Mouse_Wheel; /**< FB Mouse Wheel event */ 80typedef struct _Ecore_Fb_Event_Mouse_Wheel Ecore_Fb_Event_Mouse_Wheel; /**< FB Mouse Wheel event */
66 81
67struct _Ecore_Fb_Event_Key_Down /** FB Key Down event */ 82/**
83 * @struct _Ecore_Fb_Event_Key_Down
84 * Framebuffer Key Down event.
85 */
86struct _Ecore_Fb_Event_Key_Down
68{ 87{
69 Ecore_Fb_Input_Device *dev; /**< The device associated with the event */ 88 Ecore_Fb_Input_Device *dev; /**< The device associated with the event */
70 char *keyname; /**< The name of the key that was pressed */ 89 char *keyname; /**< The name of the key that was pressed */
71 char *keysymbol; /**< The logical symbol of the key that was pressed */ 90 char *keysymbol; /**< The logical symbol of the key that was pressed */
72 char *key_compose; /**< The UTF-8 string conversion if any */ 91 char *key_compose; /**< The UTF-8 string conversion if any */
73}; 92};
74 93
75struct _Ecore_Fb_Event_Key_Up /** FB Key Up event */ 94/**
95 * @struct _Ecore_Fb_Event_Key_Up
96 * Framebuffer Key Up event.
97 */
98struct _Ecore_Fb_Event_Key_Up
76{ 99{
77 Ecore_Fb_Input_Device *dev; /**< The device associated with the event */ 100 Ecore_Fb_Input_Device *dev; /**< The device associated with the event */
78 char *keyname; /**< The name of the key that was released */ 101 char *keyname; /**< The name of the key that was released */
79 char *keysymbol; /**< The logical symbol of the key that was pressed */ 102 char *keysymbol; /**< The logical symbol of the key that was pressed */
80 char *key_compose; /**< The UTF-8 string conversion if any */ 103 char *key_compose; /**< The UTF-8 string conversion if any */
81}; 104};
82 105
83struct _Ecore_Fb_Event_Mouse_Button_Down /** FB Mouse Down event */ 106/**
107 * @struct _Ecore_Fb_Event_Mouse_Button_Down
108 * Framebuffer Mouse Down event.
109 */
110struct _Ecore_Fb_Event_Mouse_Button_Down
84{ 111{
85 Ecore_Fb_Input_Device *dev; /**< The device associated with the event */ 112 Ecore_Fb_Input_Device *dev; /**< The device associated with the event */
86 int button; /**< Mouse button that was pressed (1 - 32) */ 113 int button; /**< Mouse button that was pressed (1 - 32) */
@@ -89,8 +116,12 @@ struct _Ecore_Fb_Event_Mouse_Button_Down /** FB Mouse Down event */
89 int double_click : 1; /**< Set if click was a double click */ 116 int double_click : 1; /**< Set if click was a double click */
90 int triple_click : 1; /**< Set if click was a triple click */ 117 int triple_click : 1; /**< Set if click was a triple click */
91}; 118};
92 119
93struct _Ecore_Fb_Event_Mouse_Button_Up /** FB Mouse Up event */ 120/**
121 * @struct _Ecore_Fb_Event_Mouse_Button_Up
122 * Framebuffer Mouse Up event.
123 */
124struct _Ecore_Fb_Event_Mouse_Button_Up
94{ 125{
95 Ecore_Fb_Input_Device *dev; /**< The device associated with the event */ 126 Ecore_Fb_Input_Device *dev; /**< The device associated with the event */
96 int button; /**< Mouse button that was released (1 - 32) */ 127 int button; /**< Mouse button that was released (1 - 32) */
@@ -99,15 +130,23 @@ struct _Ecore_Fb_Event_Mouse_Button_Up /** FB Mouse Up event */
99 int double_click : 1; /**< Set if click was a double click */ 130 int double_click : 1; /**< Set if click was a double click */
100 int triple_click : 1; /**< Set if click was a triple click */ 131 int triple_click : 1; /**< Set if click was a triple click */
101}; 132};
102 133
103struct _Ecore_Fb_Event_Mouse_Move /** FB Mouse Move event */ 134/**
135 * @struct _Ecore_Fb_Event_Mouse_Move
136 * Framebuffer Mouse Move event.
137 */
138struct _Ecore_Fb_Event_Mouse_Move
104{ 139{
105 Ecore_Fb_Input_Device *dev; /**< The device associated with the event */ 140 Ecore_Fb_Input_Device *dev; /**< The device associated with the event */
106 int x; /**< Mouse co-ordinates where the mouse cursor moved to */ 141 int x; /**< Mouse co-ordinates where the mouse cursor moved to */
107 int y; /**< Mouse co-ordinates where the mouse cursor moved to */ 142 int y; /**< Mouse co-ordinates where the mouse cursor moved to */
108}; 143};
109 144
110struct _Ecore_Fb_Event_Mouse_Wheel /** FB Mouse Wheel event */ 145/**
146 * @struct _Ecore_Fb_Event_Mouse_Wheel
147 * Framebuffer Mouse Wheel event.
148 */
149struct _Ecore_Fb_Event_Mouse_Wheel
111{ 150{
112 Ecore_Fb_Input_Device *dev; 151 Ecore_Fb_Input_Device *dev;
113 int x,y; 152 int x,y;
@@ -130,13 +169,18 @@ EAPI void ecore_fb_input_threshold_click_set(Ecore_Fb_Input
130EAPI double ecore_fb_input_threshold_click_get(Ecore_Fb_Input_Device *dev); 169EAPI double ecore_fb_input_threshold_click_get(Ecore_Fb_Input_Device *dev);
131 170
132/* ecore_fb.c */ 171/* ecore_fb.c */
172
133EAPI int ecore_fb_init(const char *name); 173EAPI int ecore_fb_init(const char *name);
134EAPI int ecore_fb_shutdown(void); 174EAPI int ecore_fb_shutdown(void);
135EAPI void ecore_fb_size_get(int *w, int *h); 175EAPI void ecore_fb_size_get(int *w, int *h);
136 176
137EAPI void ecore_fb_touch_screen_calibrate_set(int xscale, int xtrans, int yscale, int ytrans, int xyswap); 177EAPI void ecore_fb_touch_screen_calibrate_set(int xscale, int xtrans, int yscale, int ytrans, int xyswap);
138EAPI void ecore_fb_touch_screen_calibrate_get(int *xscale, int *xtrans, int *yscale, int *ytrans, int *xyswap); 178EAPI void ecore_fb_touch_screen_calibrate_get(int *xscale, int *xtrans, int *yscale, int *ytrans, int *xyswap);
139 179
180/**
181 * @}
182 */
183
140#ifdef __cplusplus 184#ifdef __cplusplus
141} 185}
142#endif 186#endif