diff --git a/docs/reference/eek/eek-overview.xml b/docs/reference/eek/eek-overview.xml index 81a1c8ed..2eb5afc3 100644 --- a/docs/reference/eek/eek-overview.xml +++ b/docs/reference/eek/eek-overview.xml @@ -25,20 +25,21 @@ #ClutterActor: -EekKeyboard *keyboard; EekLayout *layout; +EekKeyboard *keyboard; +ClutterActor *actor; -/* Create a keyboard layout using libxklavier configuration. */ +/* Create a layout engine based on libxklavier configuration. */ layout = eek_xkl_layout_new (); -/* Create a keyboard implemented as ClutterActor. */ -keyboard = eek_clutter_keyboard_new (); +/* Create a keyboard from the given layout. */ +keyboard = eek_keyboard_new (layout, initial_width, initial_height); -/* Apply the layout to the keyboard. */ -eek_keyboard_set_layout (keyboard, layout); +/* Create a ClutterActor. */ +actor = eek_clutter_keyboard_new (eekboard->keyboard); -clutter_group_add (CLUTTER_GROUP(stage), - eek_clutter_keyboard_get_actor (EEK_CLUTTER_KEYBOARD(keyboard))); +/* Add the actor to a stage. */ +clutter_group_add (CLUTTER_GROUP(stage), actor); diff --git a/docs/reference/eek/eek-sections.txt b/docs/reference/eek/eek-sections.txt index 0285dc6e..8ae3a04c 100644 --- a/docs/reference/eek/eek-sections.txt +++ b/docs/reference/eek/eek-sections.txt @@ -2,13 +2,11 @@ eek-keyboard EekKeyboard EekKeyboardClass -EekKeyboardPrivate EekKeyboard +eek_keyboard_new eek_keyboard_set_keysym_index eek_keyboard_get_keysym_index eek_keyboard_create_section -eek_keyboard_set_layout -eek_keyboard_realize eek_keyboard_find_key_by_keycode EEK_KEYBOARD @@ -40,9 +38,7 @@ EEK_LAYOUT_GET_IFACE EekGtkKeyboard EekGtkKeyboard EekGtkKeyboardClass -EekGtkKeyboardPrivate eek_gtk_keyboard_new -eek_gtk_keyboard_get_widget EEK_GTK_KEYBOARD EEK_IS_GTK_KEYBOARD @@ -57,7 +53,6 @@ EEK_GTK_KEYBOARD_GET_CLASS eek-section EekSection EekSectionClass -EekSectionPrivate EekSection eek_section_set_angle eek_section_get_angle @@ -80,13 +75,11 @@ EEK_SECTION_GET_CLASS eek-container EekContainer EekContainerClass -EekContainerPrivate EekCallback EekCompareFunc EekContainer eek_container_foreach_child eek_container_find -eek_container_find_by_position EEK_CONTAINER EEK_IS_CONTAINER @@ -102,9 +95,7 @@ EEK_CONTAINER_GET_CLASS EekClutterKeyboard EekClutterKeyboard EekClutterKeyboardClass -EekClutterKeyboardPrivate eek_clutter_keyboard_new -eek_clutter_keyboard_get_actor EEK_CLUTTER_KEYBOARD EEK_IS_CLUTTER_KEYBOARD @@ -120,7 +111,6 @@ EEK_CLUTTER_KEYBOARD_GET_CLASS EekXklLayout EekXklLayout EekXklLayoutClass -EekXklLayoutPrivate eek_xkl_layout_new eek_xkl_layout_set_config eek_xkl_layout_set_config_full @@ -150,7 +140,6 @@ EEK_XKL_LAYOUT_GET_CLASS EekXkbLayout EekXkbLayout EekXkbLayoutClass -EekXkbLayoutPrivate eek_xkb_layout_new eek_xkb_layout_set_names eek_xkb_layout_set_names_full @@ -174,7 +163,6 @@ EEK_XKB_LAYOUT_GET_CLASS eek-key EekKey EekKeyClass -EekKeyPrivate EekKey eek_key_set_keycode eek_key_get_keycode @@ -201,7 +189,6 @@ EEK_KEY_GET_CLASS eek-element EekElement EekElementClass -EekElementPrivate EekElement eek_element_set_parent eek_element_get_parent diff --git a/eek/eek-clutter-keyboard.c b/eek/eek-clutter-keyboard.c index 63840a1c..24621c04 100644 --- a/eek/eek-clutter-keyboard.c +++ b/eek/eek-clutter-keyboard.c @@ -155,7 +155,8 @@ create_section (EekElement *element, gpointer user_data) * eek_clutter_keyboard_new: * @keyboard: an #EekKeyboard * - * Create a new #EekClutterKeyboard. + * Create a new #ClutterActor displaying @keyboard. + * Returns: a #ClutterActor */ ClutterActor * eek_clutter_keyboard_new (EekKeyboard *keyboard) diff --git a/eek/eek-container.h b/eek/eek-container.h index 65a0a5ea..08c45c54 100644 --- a/eek/eek-container.h +++ b/eek/eek-container.h @@ -88,7 +88,7 @@ void eek_container_foreach_child (EekContainer *container, gpointer user_data); EekElement *eek_container_find (EekContainer *container, EekCompareFunc func, - gpointer data); + gpointer user_data); G_END_DECLS #endif /* EEK_CONTAINER_H */ diff --git a/eek/eek-gtk-keyboard.c b/eek/eek-gtk-keyboard.c index 0e1c63be..70ed98c1 100644 --- a/eek/eek-gtk-keyboard.c +++ b/eek/eek-gtk-keyboard.c @@ -250,7 +250,8 @@ eek_gtk_keyboard_init (EekGtkKeyboard *self) * eek_gtk_keyboard_new: * @keyboard: an #EekKeyboard * - * Create a new #EekGtkKeyboard. + * Create a new #GtkWidget displaying @keyboard. + * Returns: a #GtkWidget */ GtkWidget * eek_gtk_keyboard_new (EekKeyboard *keyboard) diff --git a/eek/eek-key.h b/eek/eek-key.h index fea9e80e..0ecd7e05 100644 --- a/eek/eek-key.h +++ b/eek/eek-key.h @@ -61,6 +61,7 @@ struct _EekKey * @get_keysym_index: virtual function for getting group and level of the key * @pressed: class handler for #EekKey::pressed signal * @released: class handler for #EekKey::released signal + * @is_pressed: virtual function for getting whether the key is pressed */ struct _EekKeyClass { diff --git a/eek/eek-keyboard.c b/eek/eek-keyboard.c index bbe33865..733f3b21 100644 --- a/eek/eek-keyboard.c +++ b/eek/eek-keyboard.c @@ -448,15 +448,15 @@ eek_keyboard_find_key_by_keycode (EekKeyboard *keyboard, /** * eek_keyboard_new: * @layout: an #EekLayout - * @preferred_width: default width of returned keyboard - * @preferred_height: default height of returned keyboard + * @initial_width: default width of returned keyboard + * @initial_height: default height of returned keyboard * * Create a new #EekKeyboard instance based on @layout. */ EekKeyboard * eek_keyboard_new (EekLayout *layout, - gint preferred_width, - gint preferred_height) + gint initial_width, + gint initial_height) { EekKeyboard *keyboard = g_object_new (EEK_TYPE_KEYBOARD, NULL); EekBounds bounds; @@ -464,8 +464,8 @@ eek_keyboard_new (EekLayout *layout, g_return_val_if_fail (EEK_IS_LAYOUT (layout), NULL); bounds.x = bounds.y = 0.0; - bounds.width = preferred_width; - bounds.height = preferred_height; + bounds.width = initial_width; + bounds.height = initial_height; eek_element_set_bounds (EEK_ELEMENT(keyboard), &bounds); eek_layout_apply (layout, keyboard); diff --git a/eek/eek-keyboard.h b/eek/eek-keyboard.h index b2e70194..8d384467 100644 --- a/eek/eek-keyboard.h +++ b/eek/eek-keyboard.h @@ -52,10 +52,9 @@ struct _EekKeyboard * @get_keysym_index: virtual function for getting group and level of * the entire keyboard * @create_section: virtual function for creating a section - * @set_layout: virtual function for setting layout engine * @find_key_by_keycode: virtual function for finding a key in the * keyboard by keycode - * @realize: virtual function for applying a layout to the keyboard + * @keysym_index_changed: class handler for #EekKeyboard::keysym-index-changed signal */ struct _EekKeyboardClass { @@ -88,8 +87,8 @@ struct _EekKeyboardClass GType eek_keyboard_get_type (void) G_GNUC_CONST; EekKeyboard *eek_keyboard_new (EekLayout *layout, - gint preferred_width, - gint preferred_height); + gint initial_width, + gint initial_height); void eek_keyboard_set_keysym_index (EekKeyboard *keyboard, gint group, gint level);