Add doc for EekKeysym.

This commit is contained in:
Daiki Ueno
2011-03-02 16:56:06 +09:00
parent 2d66bf24fb
commit 838a15d31a

View File

@ -214,6 +214,14 @@ eek_keysym_init (EekKeysym *self)
priv->xkeysym = EEK_INVALID_KEYSYM; priv->xkeysym = EEK_INVALID_KEYSYM;
} }
/**
* eek_keysym_new_with_modifier:
* @xkeysym: an X keysym value
* @modifier_mask: modifier assigned to @xkeysym
*
* Create an #EekKeysym with given X keysym value @xkeysym and
* modifier @modifier_mask.
*/
EekKeysym * EekKeysym *
eek_keysym_new_with_modifier (guint xkeysym, EekModifierType modifier_mask) eek_keysym_new_with_modifier (guint xkeysym, EekModifierType modifier_mask)
{ {
@ -291,12 +299,24 @@ eek_keysym_new_with_modifier (guint xkeysym, EekModifierType modifier_mask)
return keysym; return keysym;
} }
/**
* eek_keysym_new:
* @xkeysym: an X keysym value
*
* Create an #EekKeysym with given X keysym value @xkeysym.
*/
EekKeysym * EekKeysym *
eek_keysym_new (guint xkeysym) eek_keysym_new (guint xkeysym)
{ {
return eek_keysym_new_with_modifier (xkeysym, get_modifier_mask (xkeysym)); return eek_keysym_new_with_modifier (xkeysym, get_modifier_mask (xkeysym));
} }
/**
* eek_keysym_new_from_name:
* @name: an X keysym name
*
* Create an #EekKeysym with an X keysym value looked up by @name.
*/
EekKeysym * EekKeysym *
eek_keysym_new_from_name (const gchar *name) eek_keysym_new_from_name (const gchar *name)
{ {
@ -315,6 +335,12 @@ eek_keysym_new_from_name (const gchar *name)
NULL); NULL);
} }
/**
* eek_keysym_get_xkeysym:
* @keysym: an #EekKeysym
*
* Get an X keysym value associated with @keysym
*/
guint guint
eek_keysym_get_xkeysym (EekKeysym *keysym) eek_keysym_get_xkeysym (EekKeysym *keysym)
{ {