Add doc-comments.
This commit is contained in:
@ -417,7 +417,9 @@ eek_keyboard_get_keysym_index (EekKeyboard *keyboard,
|
|||||||
* @name: name of the section
|
* @name: name of the section
|
||||||
* @bounds: bounding box of the section
|
* @bounds: bounding box of the section
|
||||||
*
|
*
|
||||||
* Create an #EekSection instance and attach it to @keyboard.
|
* Create an #EekSection instance and append it to @keyboard. This
|
||||||
|
* function is rarely called by application but called by #EekLayout
|
||||||
|
* implementation.
|
||||||
*/
|
*/
|
||||||
EekSection *
|
EekSection *
|
||||||
eek_keyboard_create_section (EekKeyboard *keyboard)
|
eek_keyboard_create_section (EekKeyboard *keyboard)
|
||||||
@ -451,6 +453,14 @@ eek_keyboard_realize (EekKeyboard *keyboard)
|
|||||||
EEK_KEYBOARD_GET_CLASS(keyboard)->realize (keyboard);
|
EEK_KEYBOARD_GET_CLASS(keyboard)->realize (keyboard);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* eek_keyboard_find_key_by_keycode:
|
||||||
|
* @keyboard: an #EekKeyboard
|
||||||
|
* @keycode: a keycode
|
||||||
|
*
|
||||||
|
* Find an #EekKey whose keycode is @keycode.
|
||||||
|
* Returns: an #EekKey or NULL (if not found)
|
||||||
|
*/
|
||||||
EekKey *
|
EekKey *
|
||||||
eek_keyboard_find_key_by_keycode (EekKeyboard *keyboard,
|
eek_keyboard_find_key_by_keycode (EekKeyboard *keyboard,
|
||||||
guint keycode)
|
guint keycode)
|
||||||
|
|||||||
@ -304,6 +304,13 @@ eek_section_init (EekSection *self)
|
|||||||
priv->rows = NULL;
|
priv->rows = NULL;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* eek_section_set_angle:
|
||||||
|
* @section: an #EekSection
|
||||||
|
* @angle: rotation angle
|
||||||
|
*
|
||||||
|
* Set rotation angle of @section to @angle.
|
||||||
|
*/
|
||||||
void
|
void
|
||||||
eek_section_set_angle (EekSection *section,
|
eek_section_set_angle (EekSection *section,
|
||||||
gint angle)
|
gint angle)
|
||||||
@ -312,6 +319,12 @@ eek_section_set_angle (EekSection *section,
|
|||||||
EEK_SECTION_GET_CLASS(section)->set_angle (section, angle);
|
EEK_SECTION_GET_CLASS(section)->set_angle (section, angle);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* eek_section_get_angle:
|
||||||
|
* @section: an #EekSection
|
||||||
|
*
|
||||||
|
* Get rotation angle of @section.
|
||||||
|
*/
|
||||||
gint
|
gint
|
||||||
eek_section_get_angle (EekSection *section)
|
eek_section_get_angle (EekSection *section)
|
||||||
{
|
{
|
||||||
@ -319,6 +332,12 @@ eek_section_get_angle (EekSection *section)
|
|||||||
return EEK_SECTION_GET_CLASS(section)->get_angle (section);
|
return EEK_SECTION_GET_CLASS(section)->get_angle (section);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* eek_section_get_n_rows:
|
||||||
|
* @section: an #EekSection
|
||||||
|
*
|
||||||
|
* Get the number of rows in @section.
|
||||||
|
*/
|
||||||
gint
|
gint
|
||||||
eek_section_get_n_rows (EekSection *section)
|
eek_section_get_n_rows (EekSection *section)
|
||||||
{
|
{
|
||||||
@ -326,6 +345,15 @@ eek_section_get_n_rows (EekSection *section)
|
|||||||
return EEK_SECTION_GET_CLASS(section)->get_n_rows (section);
|
return EEK_SECTION_GET_CLASS(section)->get_n_rows (section);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* eek_section_add_row:
|
||||||
|
* @section: an #EekSection
|
||||||
|
* @num_columns: the number of column in the row
|
||||||
|
* @orientation: #EekOrientation of the row
|
||||||
|
*
|
||||||
|
* Add a row which has @num_columns columns and whose orientation is
|
||||||
|
* @orientation to @section.
|
||||||
|
*/
|
||||||
void
|
void
|
||||||
eek_section_add_row (EekSection *section,
|
eek_section_add_row (EekSection *section,
|
||||||
gint num_columns,
|
gint num_columns,
|
||||||
@ -337,6 +365,15 @@ eek_section_add_row (EekSection *section,
|
|||||||
orientation);
|
orientation);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* eek_section_get_row:
|
||||||
|
* @section: an #EekSection
|
||||||
|
* @index: the index of row
|
||||||
|
* @num_columns: pointer where the number of column in the row will be stored
|
||||||
|
* @orientation: pointer where #EekOrientation of the row will be stored
|
||||||
|
*
|
||||||
|
* Get the information about the @index-th row in @section.
|
||||||
|
*/
|
||||||
void
|
void
|
||||||
eek_section_get_row (EekSection *section,
|
eek_section_get_row (EekSection *section,
|
||||||
gint index,
|
gint index,
|
||||||
@ -350,6 +387,16 @@ eek_section_get_row (EekSection *section,
|
|||||||
orientation);
|
orientation);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* eek_section_create_key:
|
||||||
|
* @section: an #EekSection
|
||||||
|
* @column: the column index of the key
|
||||||
|
* @row: the row index of the key
|
||||||
|
*
|
||||||
|
* Create an #EekKey instance and append it to @section. This
|
||||||
|
* function is rarely called by application but called by #EekLayout
|
||||||
|
* implementation.
|
||||||
|
*/
|
||||||
EekKey *
|
EekKey *
|
||||||
eek_section_create_key (EekSection *section,
|
eek_section_create_key (EekSection *section,
|
||||||
gint column,
|
gint column,
|
||||||
@ -359,6 +406,14 @@ eek_section_create_key (EekSection *section,
|
|||||||
return EEK_SECTION_GET_CLASS(section)->create_key (section, column, row);
|
return EEK_SECTION_GET_CLASS(section)->create_key (section, column, row);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* eek_section_find_key_by_keycode:
|
||||||
|
* @section: an #EekSection
|
||||||
|
* @keycode: a keycode
|
||||||
|
*
|
||||||
|
* Find an #EekKey whose keycode is @keycode.
|
||||||
|
* Returns: an #EekKey or NULL (if not found)
|
||||||
|
*/
|
||||||
EekKey *
|
EekKey *
|
||||||
eek_section_find_key_by_keycode (EekSection *section,
|
eek_section_find_key_by_keycode (EekSection *section,
|
||||||
guint keycode)
|
guint keycode)
|
||||||
|
|||||||
Reference in New Issue
Block a user