summaryrefslogtreecommitdiff
path: root/legacy/ecore/src/lib/ecore_fb/ecore_fb_vt.c
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_vt.c
parenteeb330adc3beca78a2b8a099318f1198c697cca1 (diff)
Ecore_Fb doc finished
SVN revision: 53297
Diffstat (limited to '')
-rw-r--r--legacy/ecore/src/lib/ecore_fb/ecore_fb_vt.c33
1 files changed, 27 insertions, 6 deletions
diff --git a/legacy/ecore/src/lib/ecore_fb/ecore_fb_vt.c b/legacy/ecore/src/lib/ecore_fb/ecore_fb_vt.c
index 6ff9dc3d51..65f201351b 100644
--- a/legacy/ecore/src/lib/ecore_fb/ecore_fb_vt.c
+++ b/legacy/ecore/src/lib/ecore_fb/ecore_fb_vt.c
@@ -219,10 +219,21 @@ ecore_fb_vt_shutdown(void)
219} 219}
220 220
221/** 221/**
222 * To be documented. 222 * @addtogroup Ecore_FB_Group Ecore_FB - Frame buffer convenience functions.
223 * 223 *
224 * FIXME: To be fixed. 224 * @{
225 * @todo Documentation: Find out what this does. 225 */
226
227/**
228 * @brief Set a callback called when a virtual terminal is gained.
229 *
230 * @param func The callback called when vt is gained.
231 * @param data The data to pass to the callback.
232 *
233 * This function sets the callback @p func which will be called when a
234 * virtual terminal is gained (for example you press Ctrl-Alt-F1 to go
235 * to vt1 and your app was using vt1). @p data will be pass to @p func if
236 * the callback is called.
226 */ 237 */
227EAPI void 238EAPI void
228ecore_fb_callback_gain_set(void (*func) (void *data), void *data) 239ecore_fb_callback_gain_set(void (*func) (void *data), void *data)
@@ -232,10 +243,15 @@ ecore_fb_callback_gain_set(void (*func) (void *data), void *data)
232} 243}
233 244
234/** 245/**
235 * To be documented. 246 * @brief Set a callback called when a virtual terminal is lost.
236 * 247 *
237 * FIXME: To be fixed. 248 * @param func The callback called when vt is lost.
238 * @todo Documentation: Find out what this does. 249 * @param data The data to pass to the callback.
250 *
251 * This function sets the callback @p func which will be called when a
252 * virtual terminal is lost (someone wants the tv from you and you
253 * want to give up that vt). @p data will be pass to @p func if the
254 * callback is called.
239 */ 255 */
240EAPI void 256EAPI void
241ecore_fb_callback_lose_set(void (*func) (void *data), void *data) 257ecore_fb_callback_lose_set(void (*func) (void *data), void *data)
@@ -244,6 +260,11 @@ ecore_fb_callback_lose_set(void (*func) (void *data), void *data)
244 _ecore_fb_func_fb_lost_data = data; 260 _ecore_fb_func_fb_lost_data = data;
245 261
246} 262}
263
264/**
265 * @}
266 */
267
247typedef struct _Ecore_Fb_Filter_Data Ecore_Fb_Filter_Data; 268typedef struct _Ecore_Fb_Filter_Data Ecore_Fb_Filter_Data;
248 269
249struct _Ecore_Fb_Filter_Data 270struct _Ecore_Fb_Filter_Data