From 96ed832b09b56569e70cbf5ebabdb3673b627082 Mon Sep 17 00:00:00 2001 From: Iain Holmes Date: Thu, 22 Jun 2006 14:31:19 +0000 Subject: [PATCH] Add more docs...80% coverage --- ChangeLog | 4 ++++ clutter/clutter-event.c | 40 ++++++++++++++++++++++++++++++++++++++++ 2 files changed, 44 insertions(+) diff --git a/ChangeLog b/ChangeLog index 25dccc9..223933f 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,5 +1,9 @@ 2006-06-22 Iain Holmes + * clutter/clutter-event.c: Add docs + +2006-06-22 Iain Holmes + * clutter/clutter-media.c: Add docs 2006-06-22 Iain Holmes diff --git a/clutter/clutter-event.c b/clutter/clutter-event.c index 0a060a9..196e080 100644 --- a/clutter/clutter-event.c +++ b/clutter/clutter-event.c @@ -99,30 +99,70 @@ clutter_motion_event_state (ClutterMotionEvent *motionev) /* keys */ +/** + * clutter_key_event_time: + * @keyev: A #ClutterKeyEvent + * + * Retrieves the time of @keyev + * + * Return value: The time that the event occurred + */ guint32 clutter_key_event_time (ClutterKeyEvent *keyev) { 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 clutter_key_event_state (ClutterKeyEvent *keyev) { 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 clutter_key_event_symbol (ClutterKeyEvent *keyev) { 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 clutter_key_event_code (ClutterKeyEvent *keyev) { 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 clutter_key_event_unicode (ClutterKeyEvent *keyev) { -- 2.7.4