diff options
author | Sergey Udaltsov <svu@gnome.org> | 2008-04-27 13:51:11 +0000 |
---|---|---|
committer | Sergey Udaltsov <svu@gnome.org> | 2008-04-27 13:51:11 +0000 |
commit | b472e2c5d6044b57eddd97f853ac7c4908748c2f (patch) | |
tree | b351a3e9e3f357859a92c0c3adcf246c9c5f0e08 /doc | |
parent | b18e6175109cbc30f3b44a3473ce4a926cf3bfd4 (diff) | |
download | libxklavier-b472e2c5d6044b57eddd97f853ac7c4908748c2f.tar.gz |
a bit of cleanup for gtkdoc
Diffstat (limited to 'doc')
-rw-r--r-- | doc/reference/libxklavier-sections.txt | 293 | ||||
-rw-r--r-- | doc/reference/libxklavier.types | 4 | ||||
-rw-r--r-- | doc/reference/tmpl/libxklavier-unused.sgml | 49 | ||||
-rw-r--r-- | doc/reference/tmpl/xkl_config_item.sgml | 38 | ||||
-rw-r--r-- | doc/reference/tmpl/xkl_config_rec.sgml | 16 | ||||
-rw-r--r-- | doc/reference/tmpl/xkl_config_registry.sgml | 72 | ||||
-rw-r--r-- | doc/reference/tmpl/xkl_engine.sgml | 89 | ||||
-rw-r--r-- | doc/reference/tmpl/xkl_engine_marshal.sgml | 19 | ||||
-rw-r--r-- | doc/reference/tmpl/xklavier.sgml | 2 | ||||
-rw-r--r-- | doc/reference/tmpl/xklavier_private.sgml | 31 | ||||
-rw-r--r-- | doc/reference/tmpl/xklavier_private_xkb.sgml | 19 | ||||
-rw-r--r-- | doc/reference/tmpl/xklavier_private_xmm.sgml | 19 |
12 files changed, 577 insertions, 74 deletions
diff --git a/doc/reference/libxklavier-sections.txt b/doc/reference/libxklavier-sections.txt new file mode 100644 index 0000000..303b103 --- /dev/null +++ b/doc/reference/libxklavier-sections.txt @@ -0,0 +1,293 @@ +<SECTION> +<FILE>xkl_engine</FILE> +XklEnginePrivate +XklEngineStateChange +XklEngineFeatures +XklState +<TITLE>XklEngine</TITLE> +XklEngine +xkl_engine_get_instance +xkl_engine_get_backend_name +xkl_engine_get_features +xkl_engine_get_max_num_groups +XklEngineListenModes +xkl_engine_start_listen +xkl_engine_stop_listen +xkl_engine_pause_listen +xkl_engine_resume_listen +xkl_engine_grab_key +xkl_engine_ungrab_key +xkl_engine_filter_events +xkl_engine_allow_one_switch_to_secondary_group +xkl_engine_get_current_window +xkl_engine_get_current_state +xkl_engine_get_window_title +xkl_engine_get_state +xkl_engine_delete_state +xkl_engine_save_state +xkl_engine_set_window_transparent +xkl_engine_is_window_transparent +xkl_engine_is_window_from_same_toplevel_window +xkl_engine_get_num_groups +xkl_engine_get_groups_names +xkl_engine_get_indicators_names +xkl_engine_get_next_group +xkl_engine_get_prev_group +xkl_engine_get_current_window_group +xkl_engine_lock_group +xkl_engine_set_group_per_toplevel_window +xkl_engine_is_group_per_toplevel_window +xkl_engine_set_indicators_handling +xkl_engine_get_indicators_handling +xkl_engine_set_secondary_groups_mask +xkl_engine_get_secondary_groups_mask +xkl_engine_set_default_group +xkl_engine_get_default_group +<SUBSECTION Standard> +XKL_ENGINE +XKL_IS_ENGINE +XKL_TYPE_ENGINE +xkl_engine_get_type +XKL_ENGINE_CLASS +XKL_IS_ENGINE_CLASS +XKL_ENGINE_GET_CLASS +</SECTION> + +<SECTION> +<FILE>xkl_config_item</FILE> +<TITLE>XklConfigItem</TITLE> +XKL_MAX_CI_NAME_LENGTH +XKL_MAX_CI_SHORT_DESC_LENGTH +XKL_MAX_CI_DESC_LENGTH +XCI_PROP_ALLOW_MULTIPLE_SELECTION +XCI_PROP_VENDOR +XCI_PROP_COUNTRY_LIST +XCI_PROP_LANGUAGE_LIST +XklConfigItem +xkl_config_item_new +<SUBSECTION Standard> +XKL_CONFIG_ITEM +XKL_IS_CONFIG_ITEM +XKL_TYPE_CONFIG_ITEM +xkl_config_item_get_type +XKL_CONFIG_ITEM_CLASS +XKL_IS_CONFIG_ITEM_CLASS +XKL_CONFIG_ITEM_GET_CLASS +</SECTION> + +<SECTION> +<FILE>xkl_config_rec</FILE> +<TITLE>XklConfigRec</TITLE> +XklConfigRec +xkl_config_rec_new +xkl_config_rec_activate +xkl_config_rec_get_from_server +xkl_config_rec_get_from_backup +xkl_config_rec_write_to_file +xkl_config_rec_get_from_root_window_property +xkl_config_rec_set_to_root_window_property +xkl_engine_backup_names_prop +xkl_restore_names_prop +xkl_config_rec_reset +xkl_config_rec_equals +<SUBSECTION Standard> +XKL_CONFIG_REC +XKL_IS_CONFIG_REC +XKL_TYPE_CONFIG_REC +xkl_config_rec_get_type +XKL_CONFIG_REC_CLASS +XKL_IS_CONFIG_REC_CLASS +XKL_CONFIG_REC_GET_CLASS +</SECTION> + +<SECTION> +<FILE>xkl_config_registry</FILE> +<TITLE>XklConfigRegistry</TITLE> +XklConfigRegistryPrivate +XklConfigRegistry +xkl_config_registry_load +ConfigItemProcessFunc +TwoConfigItemsProcessFunc +xkl_config_registry_foreach_model +xkl_config_registry_foreach_layout +xkl_config_registry_foreach_layout_variant +xkl_config_registry_foreach_option_group +xkl_config_registry_foreach_option +xkl_config_registry_find_model +xkl_config_registry_find_layout +xkl_config_registry_find_variant +xkl_config_registry_find_option_group +xkl_config_registry_find_option +xkl_config_registry_foreach_country +xkl_config_registry_foreach_country_variant +xkl_config_registry_foreach_language +xkl_config_registry_foreach_language_variant +<SUBSECTION Standard> +XKL_CONFIG_REGISTRY +XKL_IS_CONFIG_REGISTRY +XKL_TYPE_CONFIG_REGISTRY +xkl_config_registry_get_type +XKL_CONFIG_REGISTRY_CLASS +XKL_IS_CONFIG_REGISTRY_CLASS +XKL_CONFIG_REGISTRY_GET_CLASS +</SECTION> + +<SECTION> +<FILE>xklavier_private_xkb</FILE> +ForPhysIndicators +XklXkb +xkl_engine_dump_xkb_desc +xkl_xkb_multiple_layouts_supported +xkl_xkb_event_get_name +xkl_xkb_config_native_prepare +xkl_xkb_config_native_cleanup +xkl_xkb_set_indicator +xkl_xkb_activate_config_rec +xkl_xkb_init_config_registry +xkl_xkb_load_config_registry +xkl_xkb_write_config_rec_to_file +xkl_xkb_process_x_event +xkl_xkb_free_all_info +xkl_xkb_get_groups_names +xkl_xkb_get_max_num_groups +xkl_xkb_get_num_groups +xkl_xkb_get_server_state +xkl_xkb_if_cached_info_equals_actual +xkl_xkb_load_all_info +xkl_xkb_lock_group +xkl_xkb_pause_listen +xkl_xkb_resume_listen +xkl_xkb_set_indicators +xkl_xkb_term +</SECTION> + +<SECTION> +<FILE>xklavier_private</FILE> +XklEnginePrivate +xkl_get_the_engine +XklConfigRegistryPrivate +xkl_engine_ensure_vtable_inited +xkl_engine_process_focus_in_evt +xkl_engine_process_focus_out_evt +xkl_engine_process_property_evt +xkl_engine_process_create_window_evt +xkl_process_error +xkl_engine_process_state_modification +xkl_engine_get_registered_parent +xkl_engine_reset_all_info +xkl_engine_load_window_tree +xkl_engine_load_subtree +xkl_engine_if_window_has_wm_state +xkl_engine_add_toplevel_window +xkl_engine_find_toplevel_window_bottom_to_top +xkl_engine_find_toplevel_window +xkl_engine_is_toplevel_window_transparent +xkl_engine_set_toplevel_window_transparent +xkl_engine_get_toplevel_window_state +xkl_engine_remove_toplevel_window_state +xkl_engine_save_toplevel_window_state +xkl_engine_select_input_merging +xkl_get_debug_window_title +xkl_engine_query_tree +xkl_engine_try_call_state_func +xkl_engine_get_ruleset_name +xkl_config_rec_get_full_from_server +xkl_strings_concat_comma_separated +xkl_strings_split_comma_separated +xkl_config_rec_merge_layouts +xkl_config_rec_merge_variants +xkl_config_rec_merge_options +xkl_config_rec_split_layouts +xkl_config_rec_split_variants +xkl_config_rec_split_options +xkl_config_rec_dump +xkl_event_get_name +xkl_engine_update_current_state +xkl_xkb_init +xkl_xmm_init +xkl_engine_is_one_switch_to_secondary_group_allowed +xkl_engine_one_switch_to_secondary_group_performed +xkl_config_registry_load_from_file +xkl_config_registry_free +xkl_locale_from_utf8 +xkl_config_registry_load_helper +XKLAVIER_STATE_PROP_LENGTH +XKB_RF_NAMES_PROP_MAXLEN +WINID_FORMAT +xkl_engine_priv +xkl_engine_backend +xkl_engine_get_display +xkl_engine_vcall +xkl_config_registry_is_initialized +xkl_config_registry_priv +xkl_config_registry_get_engine +XKBCR_MODEL_PATH +XKBCR_LAYOUT_PATH +XKBCR_VARIANT_PATH +XKBCR_GROUP_PATH +XKBCR_OPTION_PATH +XML_TAG_DESCR +XML_TAG_SHORT_DESCR +XML_TAG_VENDOR +XML_TAG_COUNTRY_LIST +XML_TAG_LANGUAGE_LIST +XML_TAG_ISO3166ID +XML_TAG_ISO639ID +xkl_config_registry_foreach_in_xpath_with_param +xkl_config_registry_foreach_in_xpath +xkl_read_config_item +xkl_debug_level +xkl_last_error_message +</SECTION> + +<SECTION> +<FILE>xklavier</FILE> +xkl_get_last_error +XklLogAppender +xkl_default_log_appender +xkl_set_log_appender +xkl_set_debug_level +xkl_debug +</SECTION> + +<SECTION> +<FILE>xklavier_private_xmm</FILE> +XmmShortcut +MAX_SHORTCUTS_PER_OPTION +XmmSwitchOption +XklXmm +xkl_xmm_grab_ignoring_indicators +xkl_xmm_ungrab_ignoring_indicators +xkl_xmm_shortcuts_grab +xkl_xmm_shortcuts_ungrab +xkl_xmm_shortcut_get_current_option_name +xkl_xmm_shortcut_get_current +xkl_xmm_actualize_group +xkl_xmm_find_switch_option +xkl_xmm_init_switch_options +xkl_xmm_term_switch_options +xkl_xmm_activate_config_rec +xkl_xmm_init_config_registry +xkl_xmm_load_config_registry +xkl_xmm_process_x_event +xkl_xmm_free_all_info +xkl_xmm_get_groups_names +xkl_xmm_get_max_num_groups +xkl_xmm_get_num_groups +xkl_xmm_lock_group +xkl_xmm_get_server_state +xkl_xmm_if_cached_info_equals_actual +xkl_xmm_load_all_info +xkl_xmm_listen_pause +xkl_xmm_listen_resume +xkl_xmm_set_indicators +xkl_xmm_term +</SECTION> + +<SECTION> +<FILE>xkl_engine_marshal</FILE> +xkl_engine_VOID__VOID +xkl_engine_INT__LONG_LONG +xkl_engine_VOID__FLAGS_INT_BOOLEAN +</SECTION> + diff --git a/doc/reference/libxklavier.types b/doc/reference/libxklavier.types index e69de29..822f603 100644 --- a/doc/reference/libxklavier.types +++ b/doc/reference/libxklavier.types @@ -0,0 +1,4 @@ +xkl_engine_get_type +xkl_config_item_get_type +xkl_config_rec_get_type +xkl_config_registry_get_type diff --git a/doc/reference/tmpl/libxklavier-unused.sgml b/doc/reference/tmpl/libxklavier-unused.sgml index 0c29e4e..e69de29 100644 --- a/doc/reference/tmpl/libxklavier-unused.sgml +++ b/doc/reference/tmpl/libxklavier-unused.sgml @@ -1,49 +0,0 @@ -<!-- ##### USER_FUNCTION GroupProcessFunc ##### --> -<para> - -</para> - -@item: -@allow_multiple_selection: -@data: - -<!-- ##### FUNCTION xkl_backup_names_prop ##### --> -<para> - -</para> - -@engine: -@Returns: - -<!-- ##### FUNCTION xkl_config_registry_free ##### --> -<para> - -</para> - -@config: - -<!-- ##### FUNCTION xkl_config_registry_load_from_file ##### --> -<para> - -</para> - -@config: -@file_name: -@Returns: - -<!-- ##### FUNCTION xkl_engine_group_get_default ##### --> -<para> - -</para> - -@engine: -@Returns: - -<!-- ##### FUNCTION xkl_engine_group_set_default ##### --> -<para> - -</para> - -@engine: -@group: - diff --git a/doc/reference/tmpl/xkl_config_item.sgml b/doc/reference/tmpl/xkl_config_item.sgml index 16d87c4..d8e6d72 100644 --- a/doc/reference/tmpl/xkl_config_item.sgml +++ b/doc/reference/tmpl/xkl_config_item.sgml @@ -2,7 +2,7 @@ XklConfigItem <!-- ##### SECTION Short_Description ##### --> -X keyboard configuration registry item + <!-- ##### SECTION Long_Description ##### --> <para> @@ -38,31 +38,45 @@ X keyboard configuration registry item -<!-- ##### STRUCT XklConfigItem ##### --> +<!-- ##### MACRO XCI_PROP_ALLOW_MULTIPLE_SELECTION ##### --> <para> </para> -@parent: -@name: -@short_description: -@description: -<!-- ##### FUNCTION xkl_config_item_new ##### --> + +<!-- ##### MACRO XCI_PROP_VENDOR ##### --> <para> </para> -@Returns: -<!-- ##### USER_FUNCTION ConfigItemProcessFunc ##### --> +<!-- ##### MACRO XCI_PROP_COUNTRY_LIST ##### --> <para> </para> -@config: -@item: -@data: + + +<!-- ##### MACRO XCI_PROP_LANGUAGE_LIST ##### --> +<para> + +</para> + + + +<!-- ##### STRUCT XklConfigItem ##### --> +<para> + +</para> + + +<!-- ##### FUNCTION xkl_config_item_new ##### --> +<para> + +</para> + +@Returns: diff --git a/doc/reference/tmpl/xkl_config_rec.sgml b/doc/reference/tmpl/xkl_config_rec.sgml index 042d921..d33cf23 100644 --- a/doc/reference/tmpl/xkl_config_rec.sgml +++ b/doc/reference/tmpl/xkl_config_rec.sgml @@ -2,7 +2,7 @@ XklConfigRec <!-- ##### SECTION Short_Description ##### --> -X keyboard configuration container + <!-- ##### SECTION Long_Description ##### --> <para> @@ -22,11 +22,6 @@ X keyboard configuration container </para> -@parent: -@model: -@layouts: -@variants: -@options: <!-- ##### FUNCTION xkl_config_rec_new ##### --> <para> @@ -102,6 +97,15 @@ X keyboard configuration container @Returns: +<!-- ##### FUNCTION xkl_engine_backup_names_prop ##### --> +<para> + +</para> + +@engine: +@Returns: + + <!-- ##### FUNCTION xkl_restore_names_prop ##### --> <para> diff --git a/doc/reference/tmpl/xkl_config_registry.sgml b/doc/reference/tmpl/xkl_config_registry.sgml index fe3be3e..5547d5d 100644 --- a/doc/reference/tmpl/xkl_config_registry.sgml +++ b/doc/reference/tmpl/xkl_config_registry.sgml @@ -2,7 +2,7 @@ XklConfigRegistry <!-- ##### SECTION Short_Description ##### --> -X keyboard configuration registry + <!-- ##### SECTION Long_Description ##### --> <para> @@ -28,8 +28,11 @@ X keyboard configuration registry </para> -@parent: -@priv: + +<!-- ##### ARG XklConfigRegistry:engine ##### --> +<para> + +</para> <!-- ##### FUNCTION xkl_config_registry_load ##### --> <para> @@ -40,6 +43,27 @@ X keyboard configuration registry @Returns: +<!-- ##### USER_FUNCTION ConfigItemProcessFunc ##### --> +<para> + +</para> + +@config: +@item: +@data: + + +<!-- ##### USER_FUNCTION TwoConfigItemsProcessFunc ##### --> +<para> + +</para> + +@config: +@item: +@subitem: +@data: + + <!-- ##### FUNCTION xkl_config_registry_foreach_model ##### --> <para> @@ -144,3 +168,45 @@ X keyboard configuration registry @Returns: +<!-- ##### FUNCTION xkl_config_registry_foreach_country ##### --> +<para> + +</para> + +@config: +@Param2: +@data: + + +<!-- ##### FUNCTION xkl_config_registry_foreach_country_variant ##### --> +<para> + +</para> + +@config: +@country_code: +@Param3: +@data: + + +<!-- ##### FUNCTION xkl_config_registry_foreach_language ##### --> +<para> + +</para> + +@config: +@Param2: +@data: + + +<!-- ##### FUNCTION xkl_config_registry_foreach_language_variant ##### --> +<para> + +</para> + +@config: +@language_code: +@Param3: +@data: + + diff --git a/doc/reference/tmpl/xkl_engine.sgml b/doc/reference/tmpl/xkl_engine.sgml index 2fd12c0..85bf84e 100644 --- a/doc/reference/tmpl/xkl_engine.sgml +++ b/doc/reference/tmpl/xkl_engine.sgml @@ -2,7 +2,7 @@ XklEngine <!-- ##### SECTION Short_Description ##### --> -Base X keyboard configuration and access engine + <!-- ##### SECTION Long_Description ##### --> <para> @@ -55,8 +55,73 @@ Base X keyboard configuration and access engine </para> -@parent: -@priv: + +<!-- ##### SIGNAL XklEngine::X-config-changed ##### --> +<para> + +</para> + +@xklengine: the object which received the signal. + +<!-- ##### SIGNAL XklEngine::X-state-changed ##### --> +<para> + +</para> + +@xklengine: the object which received the signal. +@arg1: +@arg2: +@arg3: + +<!-- ##### SIGNAL XklEngine::new-toplevel-window ##### --> +<para> + +</para> + +@xklengine: the object which received the signal. +@arg1: +@arg2: +@Returns: + +<!-- ##### ARG XklEngine:backendName ##### --> +<para> + +</para> + +<!-- ##### ARG XklEngine:default-group ##### --> +<para> + +</para> + +<!-- ##### ARG XklEngine:display ##### --> +<para> + +</para> + +<!-- ##### ARG XklEngine:features ##### --> +<para> + +</para> + +<!-- ##### ARG XklEngine:indicators-handling ##### --> +<para> + +</para> + +<!-- ##### ARG XklEngine:max-num-groups ##### --> +<para> + +</para> + +<!-- ##### ARG XklEngine:num-groups ##### --> +<para> + +</para> + +<!-- ##### ARG XklEngine:secondary-groups-mask ##### --> +<para> + +</para> <!-- ##### FUNCTION xkl_engine_get_instance ##### --> <para> @@ -386,3 +451,21 @@ Base X keyboard configuration and access engine @Returns: +<!-- ##### FUNCTION xkl_engine_set_default_group ##### --> +<para> + +</para> + +@engine: +@group: + + +<!-- ##### FUNCTION xkl_engine_get_default_group ##### --> +<para> + +</para> + +@engine: +@Returns: + + diff --git a/doc/reference/tmpl/xkl_engine_marshal.sgml b/doc/reference/tmpl/xkl_engine_marshal.sgml new file mode 100644 index 0000000..93aa3a5 --- /dev/null +++ b/doc/reference/tmpl/xkl_engine_marshal.sgml @@ -0,0 +1,19 @@ +<!-- ##### SECTION Title ##### --> +xkl_engine_marshal + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + diff --git a/doc/reference/tmpl/xklavier.sgml b/doc/reference/tmpl/xklavier.sgml index f0154e2..f9183bd 100644 --- a/doc/reference/tmpl/xklavier.sgml +++ b/doc/reference/tmpl/xklavier.sgml @@ -2,7 +2,7 @@ xklavier <!-- ##### SECTION Short_Description ##### --> -Utility functions + <!-- ##### SECTION Long_Description ##### --> <para> diff --git a/doc/reference/tmpl/xklavier_private.sgml b/doc/reference/tmpl/xklavier_private.sgml new file mode 100644 index 0000000..8e7f4d1 --- /dev/null +++ b/doc/reference/tmpl/xklavier_private.sgml @@ -0,0 +1,31 @@ +<!-- ##### SECTION Title ##### --> +xklavier_private + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### STRUCT XklEnginePrivate ##### --> +<para> + +</para> + + +<!-- ##### STRUCT XklConfigRegistryPrivate ##### --> +<para> + +</para> + + diff --git a/doc/reference/tmpl/xklavier_private_xkb.sgml b/doc/reference/tmpl/xklavier_private_xkb.sgml new file mode 100644 index 0000000..4bb2ba4 --- /dev/null +++ b/doc/reference/tmpl/xklavier_private_xkb.sgml @@ -0,0 +1,19 @@ +<!-- ##### SECTION Title ##### --> +xklavier_private_xkb + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + diff --git a/doc/reference/tmpl/xklavier_private_xmm.sgml b/doc/reference/tmpl/xklavier_private_xmm.sgml new file mode 100644 index 0000000..6aab67f --- /dev/null +++ b/doc/reference/tmpl/xklavier_private_xmm.sgml @@ -0,0 +1,19 @@ +<!-- ##### SECTION Title ##### --> +xklavier_private_xmm + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + |