docs: Remove stale eekboard docs
This commit is contained in:
Dorota Czaplejewicz
@ -1,83 +0,0 @@
|
|||||||
<?xml version="1.0"?>
|
|
||||||
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
|
|
||||||
"http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd"
|
|
||||||
[
|
|
||||||
<!ENTITY % local.common.attrib "xmlns:xi CDATA #FIXED 'http://www.w3.org/2003/XInclude'">
|
|
||||||
]>
|
|
||||||
<book id="index">
|
|
||||||
<bookinfo>
|
|
||||||
<title>libeek Reference Manual</title>
|
|
||||||
<releaseinfo>
|
|
||||||
for libeek 0.90.0.
|
|
||||||
</releaseinfo>
|
|
||||||
<copyright>
|
|
||||||
<year>2010-2011</year>
|
|
||||||
<holder>Daiki Ueno</holder>
|
|
||||||
</copyright>
|
|
||||||
|
|
||||||
<copyright>
|
|
||||||
<year>2010-2011</year>
|
|
||||||
<holder>Red Hat, Inc.</holder>
|
|
||||||
</copyright>
|
|
||||||
|
|
||||||
<legalnotice>
|
|
||||||
<para>
|
|
||||||
Permission is granted to copy, distribute and/or modify this
|
|
||||||
document under the terms of the GNU Free Documentation License,
|
|
||||||
Version 1.3 or any later version published by the Free Software
|
|
||||||
Foundation; with no Invariant Sections, no Front-Cover Texts and
|
|
||||||
no Back-Cover Texts. A copy of the license is included in the
|
|
||||||
section entitled "GNU Free Documentation License".
|
|
||||||
</para>
|
|
||||||
</legalnotice>
|
|
||||||
</bookinfo>
|
|
||||||
|
|
||||||
<xi:include href="xml/eek-overview.xml"/>
|
|
||||||
<part id="apireference">
|
|
||||||
<title>API Manual</title>
|
|
||||||
<chapter>
|
|
||||||
<title>Base Classes, Interfaces, and Utilities</title>
|
|
||||||
<xi:include href="xml/eek.xml"/>
|
|
||||||
<xi:include href="xml/eek-serializable.xml"/>
|
|
||||||
<xi:include href="xml/eek-element.xml"/>
|
|
||||||
<xi:include href="xml/eek-container.xml"/>
|
|
||||||
<xi:include href="xml/eek-keyboard.xml"/>
|
|
||||||
<xi:include href="xml/eek-section.xml"/>
|
|
||||||
<xi:include href="xml/eek-key.xml"/>
|
|
||||||
<xi:include href="xml/eek-symbol.xml"/>
|
|
||||||
<xi:include href="xml/eek-keysym.xml"/>
|
|
||||||
<xi:include href="xml/eek-text.xml"/>
|
|
||||||
<xi:include href="xml/eek-layout.xml"/>
|
|
||||||
<xi:include href="xml/eek-types.xml"/>
|
|
||||||
</chapter>
|
|
||||||
<chapter>
|
|
||||||
<title>GTK Adapter</title>
|
|
||||||
<xi:include href="xml/eek-gtk-keyboard.xml"/>
|
|
||||||
</chapter>
|
|
||||||
<chapter>
|
|
||||||
<title>Clutter Adapter</title>
|
|
||||||
<xi:include href="xml/eek-clutter-keyboard.xml"/>
|
|
||||||
</chapter>
|
|
||||||
<chapter>
|
|
||||||
<title>Libxklavier Layout Engine</title>
|
|
||||||
<xi:include href="xml/eek-xkl-layout.xml"/>
|
|
||||||
</chapter>
|
|
||||||
<chapter>
|
|
||||||
<title>XKB Layout Engine</title>
|
|
||||||
<xi:include href="xml/eek-xkb-layout.xml"/>
|
|
||||||
</chapter>
|
|
||||||
<chapter>
|
|
||||||
<title>XML Layout Engine</title>
|
|
||||||
<xi:include href="xml/eek-xml-layout.xml"/>
|
|
||||||
<xi:include href="xml/eek-xml.xml"/>
|
|
||||||
</chapter>
|
|
||||||
<chapter id="object-tree">
|
|
||||||
<title>Object Hierarchy</title>
|
|
||||||
<xi:include href="xml/tree_index.sgml"/>
|
|
||||||
</chapter>
|
|
||||||
<index id="api-index-full">
|
|
||||||
<title>API Index</title>
|
|
||||||
<xi:include href="xml/api-index-full.xml"><xi:fallback /></xi:include>
|
|
||||||
</index>
|
|
||||||
</part>
|
|
||||||
</book>
|
|
||||||
@ -1,70 +0,0 @@
|
|||||||
<part id="eek-overview">
|
|
||||||
<title>Usage Overview</title>
|
|
||||||
<partintro>
|
|
||||||
|
|
||||||
<para>libeek is a library to create keyboard-like user interface.
|
|
||||||
Since it is designed as simple as possible, it provides only two
|
|
||||||
kind of objects. One is <emphasis>keyboard element</emphasis>
|
|
||||||
(objects derived from #EekElement) and another is
|
|
||||||
<emphasis>keyboard layout engine</emphasis> (objects which
|
|
||||||
implements the #EekLayout interface).</para>
|
|
||||||
|
|
||||||
<para>A keyboard element represents either a keyboard
|
|
||||||
(#EekKeyboard), a section (#EekSection), or a key (#EekKey). Each
|
|
||||||
element implements the Builder design pattern so that it can map
|
|
||||||
itself to different UI widgets (#ClutterActor, #GtkDrawingArea,
|
|
||||||
aso).</para>
|
|
||||||
|
|
||||||
<para>A layout engine arranges keyboard elements using information
|
|
||||||
from external configuration mechanisms (libxklavier, XKB,
|
|
||||||
matchbox-keyboard layouts in XML, aso)</para>
|
|
||||||
|
|
||||||
<para>Here is a sample code which demonstrates (1) keyboard
|
|
||||||
elements are arranged with the system keyboard layout using
|
|
||||||
libxklavier and (2) keyboard elements are mapped into
|
|
||||||
#ClutterActor:</para>
|
|
||||||
<informalexample>
|
|
||||||
<programlisting>
|
|
||||||
EekLayout *layout;
|
|
||||||
EekKeyboard *keyboard;
|
|
||||||
ClutterActor *actor;
|
|
||||||
|
|
||||||
/* Create a layout engine based on libxklavier configuration. */
|
|
||||||
layout = eek_xkl_layout_new ();
|
|
||||||
|
|
||||||
/* Create a keyboard from the given layout. */
|
|
||||||
keyboard = eek_keyboard_new (layout, initial_width, initial_height);
|
|
||||||
|
|
||||||
/* Create a ClutterActor. */
|
|
||||||
actor = eek_clutter_keyboard_new (eekboard->keyboard);
|
|
||||||
|
|
||||||
/* Add the actor to a stage. */
|
|
||||||
clutter_group_add (CLUTTER_GROUP(stage), actor);
|
|
||||||
</programlisting>
|
|
||||||
</informalexample>
|
|
||||||
|
|
||||||
<para>libeek currently supports GTK+ and Clutter as UI toolkits.
|
|
||||||
To create a keyboard-like #GtkWidget instead of #ClutterActor,
|
|
||||||
replace eek_clutter_keyboard_new() with eek_gtk_keyboard_new().
|
|
||||||
Similarly, if you want to use XKB configuration directly (without
|
|
||||||
libxklavier), you will only need to replace eek_xkl_layout_new ()
|
|
||||||
with eek_xkb_layout_new().</para>
|
|
||||||
|
|
||||||
<para>In the above example, a keyboard is represented as a tree of
|
|
||||||
#EekElement -- #EekKeyboard contains one or more #EekSection's and
|
|
||||||
#EekSection contains one or more #EekKey's. Each element may emit
|
|
||||||
events when user pushes the corresponding UI widget.</para>
|
|
||||||
<para>
|
|
||||||
Here is another sample code which demonstrates logical events on
|
|
||||||
#EekElement:
|
|
||||||
</para>
|
|
||||||
<informalexample>
|
|
||||||
<programlisting>
|
|
||||||
/* Find a key element in the logical keyboard. */
|
|
||||||
EekKey *key = eek_keyboard_find_key_by_keycode (keyboard, 0x38);
|
|
||||||
g_signal_connect (key, "pressed", on_a_pressed);
|
|
||||||
</programlisting>
|
|
||||||
</informalexample>
|
|
||||||
<para>When user pushed a widget which looks like "a" key (i.e. keycode 0x38), on_a_pressed will be called.</para>
|
|
||||||
</partintro>
|
|
||||||
</part>
|
|
||||||
@ -1,544 +0,0 @@
|
|||||||
<SECTION>
|
|
||||||
<FILE>eek</FILE>
|
|
||||||
eek_init
|
|
||||||
</SECTION>
|
|
||||||
|
|
||||||
<SECTION>
|
|
||||||
<FILE>eek-clutter</FILE>
|
|
||||||
|
|
||||||
</SECTION>
|
|
||||||
|
|
||||||
<SECTION>
|
|
||||||
<FILE>eek-clutter-key</FILE>
|
|
||||||
<TITLE>EekClutterKey</TITLE>
|
|
||||||
EekClutterKey
|
|
||||||
EekClutterKeyClass
|
|
||||||
eek_clutter_key_new
|
|
||||||
<SUBSECTION Standard>
|
|
||||||
EEK_CLUTTER_KEY
|
|
||||||
EEK_CLUTTER_KEY_CLASS
|
|
||||||
EEK_CLUTTER_KEY_GET_CLASS
|
|
||||||
EEK_IS_CLUTTER_KEY
|
|
||||||
EEK_IS_CLUTTER_KEY_CLASS
|
|
||||||
EEK_TYPE_CLUTTER_KEY
|
|
||||||
EekClutterKeyPrivate
|
|
||||||
eek_clutter_key_get_type
|
|
||||||
</SECTION>
|
|
||||||
|
|
||||||
<SECTION>
|
|
||||||
<FILE>eek-clutter-keyboard</FILE>
|
|
||||||
<TITLE>EekClutterKeyboard</TITLE>
|
|
||||||
EekClutterKeyboard
|
|
||||||
EekClutterKeyboardClass
|
|
||||||
eek_clutter_keyboard_new
|
|
||||||
eek_clutter_keyboard_set_theme
|
|
||||||
<SUBSECTION Standard>
|
|
||||||
EEK_CLUTTER_KEYBOARD
|
|
||||||
EEK_CLUTTER_KEYBOARD_CLASS
|
|
||||||
EEK_CLUTTER_KEYBOARD_GET_CLASS
|
|
||||||
EEK_IS_CLUTTER_KEYBOARD
|
|
||||||
EEK_IS_CLUTTER_KEYBOARD_CLASS
|
|
||||||
EEK_TYPE_CLUTTER_KEYBOARD
|
|
||||||
EekClutterKeyboardPrivate
|
|
||||||
eek_clutter_keyboard_get_type
|
|
||||||
</SECTION>
|
|
||||||
|
|
||||||
<SECTION>
|
|
||||||
<FILE>eek-clutter-renderer</FILE>
|
|
||||||
<TITLE>EekClutterRenderer</TITLE>
|
|
||||||
EekClutterRenderer
|
|
||||||
EekClutterRendererClass
|
|
||||||
eek_clutter_renderer_new
|
|
||||||
eek_clutter_renderer_render_key
|
|
||||||
<SUBSECTION Standard>
|
|
||||||
EEK_CLUTTER_RENDERER
|
|
||||||
EEK_CLUTTER_RENDERER_CLASS
|
|
||||||
EEK_CLUTTER_RENDERER_GET_CLASS
|
|
||||||
EEK_IS_CLUTTER_RENDERER
|
|
||||||
EEK_IS_CLUTTER_RENDERER_CLASS
|
|
||||||
EEK_TYPE_CLUTTER_RENDERER
|
|
||||||
EekClutterRendererPrivate
|
|
||||||
eek_clutter_renderer_get_type
|
|
||||||
</SECTION>
|
|
||||||
|
|
||||||
<SECTION>
|
|
||||||
<FILE>eek-clutter-section</FILE>
|
|
||||||
<TITLE>EekClutterSection</TITLE>
|
|
||||||
EekClutterSection
|
|
||||||
EekClutterSectionClass
|
|
||||||
eek_clutter_section_new
|
|
||||||
<SUBSECTION Standard>
|
|
||||||
EEK_CLUTTER_SECTION
|
|
||||||
EEK_CLUTTER_SECTION_CLASS
|
|
||||||
EEK_CLUTTER_SECTION_GET_CLASS
|
|
||||||
EEK_IS_CLUTTER_SECTION
|
|
||||||
EEK_IS_CLUTTER_SECTION_CLASS
|
|
||||||
EEK_TYPE_CLUTTER_SECTION
|
|
||||||
EekClutterSectionPrivate
|
|
||||||
eek_clutter_section_get_type
|
|
||||||
</SECTION>
|
|
||||||
|
|
||||||
<SECTION>
|
|
||||||
<FILE>eek-container</FILE>
|
|
||||||
<TITLE>EekContainer</TITLE>
|
|
||||||
EekCallback
|
|
||||||
EekCompareFunc
|
|
||||||
EekContainer
|
|
||||||
EekContainerClass
|
|
||||||
eek_container_add_child
|
|
||||||
eek_container_find
|
|
||||||
eek_container_foreach_child
|
|
||||||
<SUBSECTION Standard>
|
|
||||||
EEK_CONTAINER
|
|
||||||
EEK_CONTAINER_CLASS
|
|
||||||
EEK_CONTAINER_GET_CLASS
|
|
||||||
EEK_IS_CONTAINER
|
|
||||||
EEK_IS_CONTAINER_CLASS
|
|
||||||
EEK_TYPE_CONTAINER
|
|
||||||
EekContainerPrivate
|
|
||||||
eek_container_get_type
|
|
||||||
</SECTION>
|
|
||||||
|
|
||||||
<SECTION>
|
|
||||||
<FILE>eek-element</FILE>
|
|
||||||
<TITLE>EekElement</TITLE>
|
|
||||||
EekElement
|
|
||||||
EekElementClass
|
|
||||||
eek_element_get_absolute_position
|
|
||||||
eek_element_get_bounds
|
|
||||||
eek_element_get_group
|
|
||||||
eek_element_get_level
|
|
||||||
eek_element_get_name
|
|
||||||
eek_element_get_parent
|
|
||||||
eek_element_get_symbol_index
|
|
||||||
eek_element_set_bounds
|
|
||||||
eek_element_set_group
|
|
||||||
eek_element_set_level
|
|
||||||
eek_element_set_name
|
|
||||||
eek_element_set_parent
|
|
||||||
eek_element_set_position
|
|
||||||
eek_element_set_size
|
|
||||||
eek_element_set_symbol_index
|
|
||||||
<SUBSECTION Standard>
|
|
||||||
EEK_ELEMENT
|
|
||||||
EEK_ELEMENT_CLASS
|
|
||||||
EEK_ELEMENT_GET_CLASS
|
|
||||||
EEK_IS_ELEMENT
|
|
||||||
EEK_IS_ELEMENT_CLASS
|
|
||||||
EEK_TYPE_ELEMENT
|
|
||||||
EekElementPrivate
|
|
||||||
eek_element_get_type
|
|
||||||
</SECTION>
|
|
||||||
|
|
||||||
<SECTION>
|
|
||||||
<FILE>eek-gtk</FILE>
|
|
||||||
|
|
||||||
</SECTION>
|
|
||||||
|
|
||||||
<SECTION>
|
|
||||||
<FILE>eek-gtk-keyboard</FILE>
|
|
||||||
<TITLE>EekGtkKeyboard</TITLE>
|
|
||||||
EekGtkKeyboard
|
|
||||||
EekGtkKeyboardClass
|
|
||||||
eek_gtk_keyboard_new
|
|
||||||
eek_gtk_keyboard_set_theme
|
|
||||||
<SUBSECTION Standard>
|
|
||||||
EEK_GTK_KEYBOARD
|
|
||||||
EEK_GTK_KEYBOARD_CLASS
|
|
||||||
EEK_GTK_KEYBOARD_GET_CLASS
|
|
||||||
EEK_IS_GTK_KEYBOARD
|
|
||||||
EEK_IS_GTK_KEYBOARD_CLASS
|
|
||||||
EEK_TYPE_GTK_KEYBOARD
|
|
||||||
EekGtkKeyboardPrivate
|
|
||||||
eek_gtk_keyboard_get_type
|
|
||||||
</SECTION>
|
|
||||||
|
|
||||||
<SECTION>
|
|
||||||
<FILE>eek-key</FILE>
|
|
||||||
<TITLE>EekKey</TITLE>
|
|
||||||
EekKey
|
|
||||||
EekKeyClass
|
|
||||||
eek_key_get_index
|
|
||||||
eek_key_get_keycode
|
|
||||||
eek_key_get_oref
|
|
||||||
eek_key_get_symbol
|
|
||||||
eek_key_get_symbol_at_index
|
|
||||||
eek_key_get_symbol_matrix
|
|
||||||
eek_key_get_symbol_with_fallback
|
|
||||||
eek_key_is_locked
|
|
||||||
eek_key_is_pressed
|
|
||||||
eek_key_set_index
|
|
||||||
eek_key_set_keycode
|
|
||||||
eek_key_set_oref
|
|
||||||
eek_key_set_symbol_matrix
|
|
||||||
<SUBSECTION Standard>
|
|
||||||
EEK_IS_KEY
|
|
||||||
EEK_IS_KEY_CLASS
|
|
||||||
EEK_KEY
|
|
||||||
EEK_KEY_CLASS
|
|
||||||
EEK_KEY_GET_CLASS
|
|
||||||
EEK_TYPE_KEY
|
|
||||||
EekKeyPrivate
|
|
||||||
eek_key_get_type
|
|
||||||
</SECTION>
|
|
||||||
|
|
||||||
<SECTION>
|
|
||||||
<FILE>eek-keyboard</FILE>
|
|
||||||
<TITLE>EekKeyboard</TITLE>
|
|
||||||
EekKeyboard
|
|
||||||
EekKeyboardClass
|
|
||||||
EekModifierKey
|
|
||||||
eek_keyboard_add_outline
|
|
||||||
eek_keyboard_create_section
|
|
||||||
eek_keyboard_find_key_by_keycode
|
|
||||||
eek_keyboard_get_alt_gr_mask
|
|
||||||
eek_keyboard_get_group
|
|
||||||
eek_keyboard_get_layout
|
|
||||||
eek_keyboard_get_level
|
|
||||||
eek_keyboard_get_locked_keys
|
|
||||||
eek_keyboard_get_modifier_behavior
|
|
||||||
eek_keyboard_get_modifiers
|
|
||||||
eek_keyboard_get_num_lock_mask
|
|
||||||
eek_keyboard_get_outline
|
|
||||||
eek_keyboard_get_pressed_keys
|
|
||||||
eek_keyboard_get_size
|
|
||||||
eek_keyboard_get_symbol_index
|
|
||||||
eek_keyboard_new
|
|
||||||
eek_keyboard_set_alt_gr_mask
|
|
||||||
eek_keyboard_set_group
|
|
||||||
eek_keyboard_set_level
|
|
||||||
eek_keyboard_set_modifier_behavior
|
|
||||||
eek_keyboard_set_modifiers
|
|
||||||
eek_keyboard_set_num_lock_mask
|
|
||||||
eek_keyboard_set_size
|
|
||||||
eek_keyboard_set_symbol_index
|
|
||||||
<SUBSECTION Standard>
|
|
||||||
EEK_IS_KEYBOARD
|
|
||||||
EEK_IS_KEYBOARD_CLASS
|
|
||||||
EEK_KEYBOARD
|
|
||||||
EEK_KEYBOARD_CLASS
|
|
||||||
EEK_KEYBOARD_GET_CLASS
|
|
||||||
EEK_TYPE_KEYBOARD
|
|
||||||
EekKeyboardPrivate
|
|
||||||
eek_keyboard_get_type
|
|
||||||
</SECTION>
|
|
||||||
|
|
||||||
<SECTION>
|
|
||||||
<FILE>eek-keysym</FILE>
|
|
||||||
<TITLE>EekKeysym</TITLE>
|
|
||||||
EekKeysym
|
|
||||||
EekKeysymClass
|
|
||||||
eek_keysym_get_xkeysym
|
|
||||||
eek_keysym_new
|
|
||||||
eek_keysym_new_from_name
|
|
||||||
eek_keysym_new_with_modifier
|
|
||||||
<SUBSECTION Standard>
|
|
||||||
EEK_INVALID_KEYSYM
|
|
||||||
EEK_IS_KEYSYM
|
|
||||||
EEK_IS_KEYSYM_CLASS
|
|
||||||
EEK_KEYSYM
|
|
||||||
EEK_KEYSYM_CLASS
|
|
||||||
EEK_KEYSYM_GET_CLASS
|
|
||||||
EEK_TYPE_KEYSYM
|
|
||||||
EekKeysymPrivate
|
|
||||||
eek_keysym_get_type
|
|
||||||
</SECTION>
|
|
||||||
|
|
||||||
<SECTION>
|
|
||||||
<FILE>eek-layout</FILE>
|
|
||||||
<TITLE>EekLayout</TITLE>
|
|
||||||
EekLayout
|
|
||||||
EekLayoutClass
|
|
||||||
<SUBSECTION Standard>
|
|
||||||
EEK_IS_LAYOUT
|
|
||||||
EEK_IS_LAYOUT_CLASS
|
|
||||||
EEK_LAYOUT
|
|
||||||
EEK_LAYOUT_CLASS
|
|
||||||
EEK_LAYOUT_GET_CLASS
|
|
||||||
EEK_TYPE_LAYOUT
|
|
||||||
eek_layout_get_type
|
|
||||||
</SECTION>
|
|
||||||
|
|
||||||
<SECTION>
|
|
||||||
<FILE>eek-marshalers</FILE>
|
|
||||||
|
|
||||||
</SECTION>
|
|
||||||
|
|
||||||
<SECTION>
|
|
||||||
<FILE>eek-section</FILE>
|
|
||||||
<TITLE>EekSection</TITLE>
|
|
||||||
EekSection
|
|
||||||
EekSectionClass
|
|
||||||
eek_section_add_row
|
|
||||||
eek_section_create_key
|
|
||||||
eek_section_find_key_by_keycode
|
|
||||||
eek_section_get_angle
|
|
||||||
eek_section_get_n_rows
|
|
||||||
eek_section_get_row
|
|
||||||
eek_section_set_angle
|
|
||||||
<SUBSECTION Standard>
|
|
||||||
EEK_IS_SECTION
|
|
||||||
EEK_IS_SECTION_CLASS
|
|
||||||
EEK_SECTION
|
|
||||||
EEK_SECTION_CLASS
|
|
||||||
EEK_SECTION_GET_CLASS
|
|
||||||
EEK_TYPE_SECTION
|
|
||||||
EekSectionPrivate
|
|
||||||
eek_section_get_type
|
|
||||||
</SECTION>
|
|
||||||
|
|
||||||
<SECTION>
|
|
||||||
<FILE>eek-serializable</FILE>
|
|
||||||
<TITLE>EekSerializable</TITLE>
|
|
||||||
EekSerializableIface
|
|
||||||
eek_serializable_deserialize
|
|
||||||
eek_serializable_serialize
|
|
||||||
<SUBSECTION Standard>
|
|
||||||
EEK_IS_SERIALIZABLE
|
|
||||||
EEK_SERIALIZABLE
|
|
||||||
EEK_SERIALIZABLE_GET_IFACE
|
|
||||||
EEK_TYPE_SERIALIZABLE
|
|
||||||
eek_serializable_get_type
|
|
||||||
</SECTION>
|
|
||||||
|
|
||||||
<SECTION>
|
|
||||||
<FILE>eek-special-keysym-entries</FILE>
|
|
||||||
|
|
||||||
</SECTION>
|
|
||||||
|
|
||||||
<SECTION>
|
|
||||||
<FILE>eek-symbol</FILE>
|
|
||||||
<TITLE>EekSymbol</TITLE>
|
|
||||||
EekSymbol
|
|
||||||
EekSymbolCategory
|
|
||||||
EekSymbolClass
|
|
||||||
eek_symbol_category_from_name
|
|
||||||
eek_symbol_category_get_name
|
|
||||||
eek_symbol_get_category
|
|
||||||
eek_symbol_get_icon_name
|
|
||||||
eek_symbol_get_label
|
|
||||||
eek_symbol_get_modifier_mask
|
|
||||||
eek_symbol_get_name
|
|
||||||
eek_symbol_is_modifier
|
|
||||||
eek_symbol_new
|
|
||||||
eek_symbol_set_category
|
|
||||||
eek_symbol_set_icon_name
|
|
||||||
eek_symbol_set_label
|
|
||||||
eek_symbol_set_modifier_mask
|
|
||||||
eek_symbol_set_name
|
|
||||||
<SUBSECTION Standard>
|
|
||||||
EEK_IS_SYMBOL
|
|
||||||
EEK_IS_SYMBOL_CLASS
|
|
||||||
EEK_SYMBOL
|
|
||||||
EEK_SYMBOL_CLASS
|
|
||||||
EEK_SYMBOL_GET_CLASS
|
|
||||||
EEK_TYPE_SYMBOL
|
|
||||||
EekSymbolPrivate
|
|
||||||
eek_symbol_get_type
|
|
||||||
</SECTION>
|
|
||||||
|
|
||||||
<SECTION>
|
|
||||||
<FILE>eek-symbol-matrix</FILE>
|
|
||||||
EekSymbolMatrix
|
|
||||||
eek_symbol_matrix_copy
|
|
||||||
eek_symbol_matrix_free
|
|
||||||
eek_symbol_matrix_get_symbol
|
|
||||||
eek_symbol_matrix_new
|
|
||||||
eek_symbol_matrix_set_symbol
|
|
||||||
<SUBSECTION Standard>
|
|
||||||
EEK_TYPE_SYMBOL_MATRIX
|
|
||||||
eek_symbol_matrix_get_type
|
|
||||||
</SECTION>
|
|
||||||
|
|
||||||
<SECTION>
|
|
||||||
<FILE>eek-text</FILE>
|
|
||||||
<TITLE>EekText</TITLE>
|
|
||||||
EekText
|
|
||||||
EekTextClass
|
|
||||||
eek_text_get_text
|
|
||||||
eek_text_new
|
|
||||||
<SUBSECTION Standard>
|
|
||||||
EEK_IS_TEXT
|
|
||||||
EEK_IS_TEXT_CLASS
|
|
||||||
EEK_TEXT
|
|
||||||
EEK_TEXT_CLASS
|
|
||||||
EEK_TEXT_GET_CLASS
|
|
||||||
EEK_TYPE_TEXT
|
|
||||||
EekTextPrivate
|
|
||||||
eek_text_get_type
|
|
||||||
</SECTION>
|
|
||||||
|
|
||||||
<SECTION>
|
|
||||||
<FILE>eek-theme-context</FILE>
|
|
||||||
EekThemeContextClass
|
|
||||||
eek_theme_context_get_font
|
|
||||||
eek_theme_context_get_resolution
|
|
||||||
eek_theme_context_get_root_node
|
|
||||||
eek_theme_context_get_theme
|
|
||||||
eek_theme_context_new
|
|
||||||
eek_theme_context_set_default_resolution
|
|
||||||
eek_theme_context_set_font
|
|
||||||
eek_theme_context_set_resolution
|
|
||||||
eek_theme_context_set_theme
|
|
||||||
<SUBSECTION Standard>
|
|
||||||
EEK_IS_THEME_CONTEXT
|
|
||||||
EEK_IS_THEME_CONTEXT_CLASS
|
|
||||||
EEK_THEME_CONTEXT
|
|
||||||
EEK_THEME_CONTEXT_CLASS
|
|
||||||
EEK_THEME_CONTEXT_GET_CLASS
|
|
||||||
EEK_TYPE_THEME_CONTEXT
|
|
||||||
eek_theme_context_get_type
|
|
||||||
</SECTION>
|
|
||||||
|
|
||||||
<SECTION>
|
|
||||||
<FILE>eek-theme-private</FILE>
|
|
||||||
|
|
||||||
</SECTION>
|
|
||||||
|
|
||||||
<SECTION>
|
|
||||||
<FILE>eek-types</FILE>
|
|
||||||
EEK_INVALID_KEYCODE
|
|
||||||
EekBounds
|
|
||||||
EekColor
|
|
||||||
EekContainer
|
|
||||||
EekElement
|
|
||||||
EekGradientType
|
|
||||||
EekKey
|
|
||||||
EekKeyboard
|
|
||||||
EekKeysym
|
|
||||||
EekModifierBehavior
|
|
||||||
EekModifierType
|
|
||||||
EekOrientation
|
|
||||||
EekOutline
|
|
||||||
EekPoint
|
|
||||||
EekSection
|
|
||||||
EekSymbol
|
|
||||||
EekSymbolMatrix
|
|
||||||
EekText
|
|
||||||
EekTheme
|
|
||||||
EekThemeContext
|
|
||||||
EekThemeNode
|
|
||||||
I_
|
|
||||||
eek_bounds_copy
|
|
||||||
eek_bounds_free
|
|
||||||
eek_bounds_long_side
|
|
||||||
eek_color_copy
|
|
||||||
eek_color_free
|
|
||||||
eek_color_new
|
|
||||||
eek_outline_copy
|
|
||||||
eek_outline_free
|
|
||||||
eek_point_copy
|
|
||||||
eek_point_free
|
|
||||||
eek_point_rotate
|
|
||||||
<SUBSECTION Standard>
|
|
||||||
EEK_TYPE_BOUNDS
|
|
||||||
EEK_TYPE_COLOR
|
|
||||||
EEK_TYPE_OUTLINE
|
|
||||||
EEK_TYPE_POINT
|
|
||||||
eek_bounds_get_type
|
|
||||||
eek_color_get_type
|
|
||||||
eek_outline_get_type
|
|
||||||
eek_point_get_type
|
|
||||||
</SECTION>
|
|
||||||
|
|
||||||
<SECTION>
|
|
||||||
<FILE>eek-unicode-keysym-entries</FILE>
|
|
||||||
|
|
||||||
</SECTION>
|
|
||||||
|
|
||||||
<SECTION>
|
|
||||||
<FILE>eek-xkb</FILE>
|
|
||||||
|
|
||||||
</SECTION>
|
|
||||||
|
|
||||||
<SECTION>
|
|
||||||
<FILE>eek-xkb-layout</FILE>
|
|
||||||
<TITLE>EekXkbLayout</TITLE>
|
|
||||||
EekXkbLayout
|
|
||||||
EekXkbLayoutClass
|
|
||||||
eek_xkb_layout_get_geometry
|
|
||||||
eek_xkb_layout_get_keycodes
|
|
||||||
eek_xkb_layout_get_symbols
|
|
||||||
eek_xkb_layout_new
|
|
||||||
eek_xkb_layout_set_geometry
|
|
||||||
eek_xkb_layout_set_keycodes
|
|
||||||
eek_xkb_layout_set_names
|
|
||||||
eek_xkb_layout_set_names_full
|
|
||||||
eek_xkb_layout_set_names_full_valist
|
|
||||||
eek_xkb_layout_set_symbols
|
|
||||||
<SUBSECTION Standard>
|
|
||||||
EEK_IS_XKB_LAYOUT
|
|
||||||
EEK_IS_XKB_LAYOUT_CLASS
|
|
||||||
EEK_TYPE_XKB_LAYOUT
|
|
||||||
EEK_XKB_LAYOUT
|
|
||||||
EEK_XKB_LAYOUT_CLASS
|
|
||||||
EEK_XKB_LAYOUT_GET_CLASS
|
|
||||||
EekXkbLayoutPrivate
|
|
||||||
eek_xkb_layout_get_type
|
|
||||||
</SECTION>
|
|
||||||
|
|
||||||
<SECTION>
|
|
||||||
<FILE>eek-xkeysym-keysym-entries</FILE>
|
|
||||||
|
|
||||||
</SECTION>
|
|
||||||
|
|
||||||
<SECTION>
|
|
||||||
<FILE>eek-xkl</FILE>
|
|
||||||
|
|
||||||
</SECTION>
|
|
||||||
|
|
||||||
<SECTION>
|
|
||||||
<FILE>eek-xkl-layout</FILE>
|
|
||||||
<TITLE>EekXklLayout</TITLE>
|
|
||||||
EekXklLayout
|
|
||||||
EekXklLayoutClass
|
|
||||||
eek_xkl_layout_disable_option
|
|
||||||
eek_xkl_layout_enable_option
|
|
||||||
eek_xkl_layout_get_layouts
|
|
||||||
eek_xkl_layout_get_model
|
|
||||||
eek_xkl_layout_get_option
|
|
||||||
eek_xkl_layout_get_options
|
|
||||||
eek_xkl_layout_get_variants
|
|
||||||
eek_xkl_layout_new
|
|
||||||
eek_xkl_layout_set_config
|
|
||||||
eek_xkl_layout_set_config_full
|
|
||||||
eek_xkl_layout_set_layouts
|
|
||||||
eek_xkl_layout_set_model
|
|
||||||
eek_xkl_layout_set_options
|
|
||||||
eek_xkl_layout_set_variants
|
|
||||||
<SUBSECTION Standard>
|
|
||||||
EEK_IS_XKL_LAYOUT
|
|
||||||
EEK_IS_XKL_LAYOUT_CLASS
|
|
||||||
EEK_TYPE_XKL_LAYOUT
|
|
||||||
EEK_XKL_LAYOUT
|
|
||||||
EEK_XKL_LAYOUT_CLASS
|
|
||||||
EEK_XKL_LAYOUT_GET_CLASS
|
|
||||||
EekXklLayoutPrivate
|
|
||||||
eek_xkl_layout_get_type
|
|
||||||
</SECTION>
|
|
||||||
|
|
||||||
<SECTION>
|
|
||||||
<FILE>eek-xml</FILE>
|
|
||||||
EEK_XML_SCHEMA_VERSION
|
|
||||||
eek_keyboard_output
|
|
||||||
</SECTION>
|
|
||||||
|
|
||||||
<SECTION>
|
|
||||||
<FILE>eek-xml-layout</FILE>
|
|
||||||
<TITLE>EekXmlLayout</TITLE>
|
|
||||||
EekXmlLayout
|
|
||||||
EekXmlLayoutClass
|
|
||||||
eek_xml_layout_get_source
|
|
||||||
eek_xml_layout_new
|
|
||||||
eek_xml_layout_set_source
|
|
||||||
<SUBSECTION Standard>
|
|
||||||
EEK_IS_XML_LAYOUT
|
|
||||||
EEK_IS_XML_LAYOUT_CLASS
|
|
||||||
EEK_TYPE_XML_LAYOUT
|
|
||||||
EEK_XML_LAYOUT
|
|
||||||
EEK_XML_LAYOUT_CLASS
|
|
||||||
EEK_XML_LAYOUT_GET_CLASS
|
|
||||||
EekXmlLayoutPrivate
|
|
||||||
eek_xml_layout_get_type
|
|
||||||
</SECTION>
|
|
||||||
|
|
||||||
@ -1,56 +0,0 @@
|
|||||||
<?xml version="1.0"?>
|
|
||||||
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
|
|
||||||
"http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd"
|
|
||||||
[
|
|
||||||
<!ENTITY % local.common.attrib "xmlns:xi CDATA #FIXED 'http://www.w3.org/2003/XInclude'">
|
|
||||||
]>
|
|
||||||
<book id="index">
|
|
||||||
<bookinfo>
|
|
||||||
<title>eekboard Reference Manual</title>
|
|
||||||
<releaseinfo>
|
|
||||||
for eekboard 0.90.0.
|
|
||||||
</releaseinfo>
|
|
||||||
<copyright>
|
|
||||||
<year>2011</year>
|
|
||||||
<holder>Daiki Ueno</holder>
|
|
||||||
</copyright>
|
|
||||||
|
|
||||||
<copyright>
|
|
||||||
<year>2011</year>
|
|
||||||
<holder>Red Hat, Inc.</holder>
|
|
||||||
</copyright>
|
|
||||||
|
|
||||||
<legalnotice>
|
|
||||||
<para>
|
|
||||||
Permission is granted to copy, distribute and/or modify this
|
|
||||||
document under the terms of the GNU Free Documentation License,
|
|
||||||
Version 1.3 or any later version published by the Free Software
|
|
||||||
Foundation; with no Invariant Sections, no Front-Cover Texts and
|
|
||||||
no Back-Cover Texts. A copy of the license is included in the
|
|
||||||
section entitled "GNU Free Documentation License".
|
|
||||||
</para>
|
|
||||||
</legalnotice>
|
|
||||||
</bookinfo>
|
|
||||||
|
|
||||||
<part id="apireference">
|
|
||||||
<title>API Manual</title>
|
|
||||||
<chapter>
|
|
||||||
<title>Client interface to eekboard-server</title>
|
|
||||||
<xi:include href="xml/eekboard-client.xml"/>
|
|
||||||
<xi:include href="xml/eekboard-context.xml"/>
|
|
||||||
</chapter>
|
|
||||||
<chapter>
|
|
||||||
<title>Server interface to implement custom eekboard-server</title>
|
|
||||||
<xi:include href="xml/eekboard-service.xml"/>
|
|
||||||
<xi:include href="xml/eekboard-context-service.xml"/>
|
|
||||||
</chapter>
|
|
||||||
<chapter id="object-tree">
|
|
||||||
<title>Object Hierarchy</title>
|
|
||||||
<xi:include href="xml/tree_index.sgml"/>
|
|
||||||
</chapter>
|
|
||||||
<index id="api-index-full">
|
|
||||||
<title>API Index</title>
|
|
||||||
<xi:include href="xml/api-index-full.xml"><xi:fallback /></xi:include>
|
|
||||||
</index>
|
|
||||||
</part>
|
|
||||||
</book>
|
|
||||||
@ -1,104 +0,0 @@
|
|||||||
<SECTION>
|
|
||||||
<FILE>eekboard-client</FILE>
|
|
||||||
<TITLE>EekboardClient</TITLE>
|
|
||||||
EekboardClient
|
|
||||||
EekboardClientClass
|
|
||||||
eekboard_client_new
|
|
||||||
eekboard_client_create_context
|
|
||||||
eekboard_client_push_context
|
|
||||||
eekboard_client_pop_context
|
|
||||||
eekboard_client_destroy_context
|
|
||||||
EekboardClientPrivate
|
|
||||||
<SUBSECTION Standard>
|
|
||||||
EEKBOARD_CLIENT
|
|
||||||
EEKBOARD_IS_CLIENT
|
|
||||||
EEKBOARD_TYPE_CLIENT
|
|
||||||
eekboard_client_get_type
|
|
||||||
EEKBOARD_CLIENT_CLASS
|
|
||||||
EEKBOARD_IS_CLIENT_CLASS
|
|
||||||
EEKBOARD_CLIENT_GET_CLASS
|
|
||||||
</SECTION>
|
|
||||||
|
|
||||||
<SECTION>
|
|
||||||
<FILE>eekboard-service</FILE>
|
|
||||||
<TITLE>EekboardService</TITLE>
|
|
||||||
EEKBOARD_SERVICE_PATH
|
|
||||||
EEKBOARD_SERVICE_INTERFACE
|
|
||||||
EekboardService
|
|
||||||
EekboardServiceClass
|
|
||||||
eekboard_service_new
|
|
||||||
EekboardServicePrivate
|
|
||||||
<SUBSECTION Standard>
|
|
||||||
EEKBOARD_SERVICE
|
|
||||||
EEKBOARD_IS_SERVICE
|
|
||||||
EEKBOARD_TYPE_SERVICE
|
|
||||||
eekboard_service_get_type
|
|
||||||
EEKBOARD_SERVICE_CLASS
|
|
||||||
EEKBOARD_IS_SERVICE_CLASS
|
|
||||||
EEKBOARD_SERVICE_GET_CLASS
|
|
||||||
</SECTION>
|
|
||||||
|
|
||||||
<SECTION>
|
|
||||||
<FILE>eekboard-context</FILE>
|
|
||||||
<TITLE>EekboardContext</TITLE>
|
|
||||||
EekboardContext
|
|
||||||
EekboardContextClass
|
|
||||||
eekboard_context_new
|
|
||||||
eekboard_context_add_keyboard
|
|
||||||
eekboard_context_remove_keyboard
|
|
||||||
eekboard_context_set_keyboard
|
|
||||||
eekboard_context_show_keyboard
|
|
||||||
eekboard_context_hide_keyboard
|
|
||||||
eekboard_context_set_group
|
|
||||||
eekboard_context_get_group
|
|
||||||
eekboard_context_press_keycode
|
|
||||||
eekboard_context_release_keycode
|
|
||||||
eekboard_context_is_keyboard_visible
|
|
||||||
eekboard_context_set_enabled
|
|
||||||
eekboard_context_is_enabled
|
|
||||||
eekboard_context_set_fullscreen
|
|
||||||
EekboardContextPrivate
|
|
||||||
<SUBSECTION Standard>
|
|
||||||
EEKBOARD_CONTEXT
|
|
||||||
EEKBOARD_IS_CONTEXT
|
|
||||||
EEKBOARD_TYPE_CONTEXT
|
|
||||||
eekboard_context_get_type
|
|
||||||
EEKBOARD_CONTEXT_CLASS
|
|
||||||
EEKBOARD_IS_CONTEXT_CLASS
|
|
||||||
EEKBOARD_CONTEXT_GET_CLASS
|
|
||||||
</SECTION>
|
|
||||||
|
|
||||||
<SECTION>
|
|
||||||
<FILE>eekboard-context-service</FILE>
|
|
||||||
<TITLE>EekboardContextService</TITLE>
|
|
||||||
EEKBOARD_CONTEXT_SERVICE_PATH
|
|
||||||
EEKBOARD_CONTEXT_SERVICE_INTERFACE
|
|
||||||
EekboardContextService
|
|
||||||
EekboardContextServiceClass
|
|
||||||
eekboard_context_service_enable
|
|
||||||
eekboard_context_service_disable
|
|
||||||
eekboard_context_service_get_keyboard
|
|
||||||
eekboard_context_service_get_fullscreen
|
|
||||||
eekboard_context_service_get_client_name
|
|
||||||
EekboardContextServicePrivate
|
|
||||||
<SUBSECTION Standard>
|
|
||||||
EEKBOARD_CONTEXT_SERVICE
|
|
||||||
EEKBOARD_IS_CONTEXT_SERVICE
|
|
||||||
EEKBOARD_TYPE_CONTEXT_SERVICE
|
|
||||||
eekboard_context_service_get_type
|
|
||||||
EEKBOARD_CONTEXT_SERVICE_CLASS
|
|
||||||
EEKBOARD_IS_CONTEXT_SERVICE_CLASS
|
|
||||||
EEKBOARD_CONTEXT_SERVICE_GET_CLASS
|
|
||||||
</SECTION>
|
|
||||||
|
|
||||||
<SECTION>
|
|
||||||
<FILE>eekboard-xklutil</FILE>
|
|
||||||
eekboard_xkl_config_rec_from_string
|
|
||||||
eekboard_xkl_config_rec_to_string
|
|
||||||
eekboard_xkl_list_models
|
|
||||||
eekboard_xkl_list_layouts
|
|
||||||
eekboard_xkl_list_option_groups
|
|
||||||
eekboard_xkl_list_layout_variants
|
|
||||||
eekboard_xkl_list_options
|
|
||||||
</SECTION>
|
|
||||||
|
|
||||||
@ -1,4 +0,0 @@
|
|||||||
eekboard_client_get_type
|
|
||||||
eekboard_context_get_type
|
|
||||||
eekboard_context_service_get_type
|
|
||||||
eekboard_service_get_type
|
|
||||||
Reference in New Issue
Block a user