isa/mutter
1
0
Fork 0
mirror of https://github.com/brl/mutter.git synced 2025-02-16 21:34:09 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add more docs...80% coverage

Browse Source
This commit is contained in:
Iain Holmes 2006-06-22 14:31:19 +00:00
parent 9e1308d9a4
commit 96ed832b09
2 changed files with 44 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
ChangeLog
View File

@ -1,3 +1,7 @@
2006-06-22 Iain Holmes <iain@openedhand.com>
* clutter/clutter-event.c: Add docs
2006-06-22 Iain Holmes <iain@openedhand.com> 2006-06-22 Iain Holmes <iain@openedhand.com>
* clutter/clutter-media.c: Add docs * clutter/clutter-media.c: Add docs

40
clutter/clutter-event.c
View File

@ -99,30 +99,70 @@ clutter_motion_event_state (ClutterMotionEvent *motionev)
/* keys */ /* keys */
/**
* clutter_key_event_time:
* @keyev: A #ClutterKeyEvent
*
* Retrieves the time of @keyev
*
* Return value: The time that the event occurred
*/
guint32 guint32
clutter_key_event_time (ClutterKeyEvent *keyev) clutter_key_event_time (ClutterKeyEvent *keyev)
{ {
return keyev->time; return keyev->time;
} }
/**
* clutter_key_event_state:
* @keyev: A #ClutterKeyEvent
*
* Retrieves the state of the modifier keys whenever the event occurred
*
* Return value: A mask representing the state of the modifier keys
*/
guint guint
clutter_key_event_state (ClutterKeyEvent *keyev) clutter_key_event_state (ClutterKeyEvent *keyev)
{ {
return keyev->modifier_state; return keyev->modifier_state;
} }
/**
* clutter_key_event_symbol:
* @keyev: A #ClutterKeyEvent
*
* Retrieves the value of the key that caused @keyev.
*
* Return value: The keysym representing the key
*/
guint guint
clutter_key_event_symbol (ClutterKeyEvent *keyev) clutter_key_event_symbol (ClutterKeyEvent *keyev)
{ {
return keyev->keyval; return keyev->keyval;
} }
/**
* clutter_key_event_code:
* @keyev: A #ClutterKeyEvent
*
* Retrieves the keycode of the key that caused @keyev.
*
* Return value: The keycode representing the key
*/
guint16 guint16
clutter_key_event_code (ClutterKeyEvent *keyev) clutter_key_event_code (ClutterKeyEvent *keyev)
{ {
return keyev->hardware_keycode; return keyev->hardware_keycode;
} }
/**
* clutter_key_event_unicode:
* @keyev: A #ClutterKeyEvent
*
* Retrieves the unicode value for the key that caused @keyev.
*
* Return value: The unicode value representing the key
*/
guint32 guint32
clutter_key_event_unicode (ClutterKeyEvent *keyev) clutter_key_event_unicode (ClutterKeyEvent *keyev)
{ {