diff options
Diffstat (limited to 'mate-dictionary/docs/reference/gdict/tmpl')
12 files changed, 2085 insertions, 0 deletions
diff --git a/mate-dictionary/docs/reference/gdict/tmpl/gdict-client-context.sgml b/mate-dictionary/docs/reference/gdict/tmpl/gdict-client-context.sgml new file mode 100644 index 00000000..bc5ac1dd --- /dev/null +++ b/mate-dictionary/docs/reference/gdict/tmpl/gdict-client-context.sgml @@ -0,0 +1,146 @@ +<!-- ##### SECTION Title ##### --> +GdictClientContext + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### STRUCT GdictClientContext ##### --> +<para> + +</para> + + +<!-- ##### SIGNAL GdictClientContext::connected ##### --> +<para> + +</para> + +@gdictclientcontext: the object which received the signal. + +<!-- ##### SIGNAL GdictClientContext::disconnected ##### --> +<para> + +</para> + +@gdictclientcontext: the object which received the signal. + +<!-- ##### ARG GdictClientContext:client-name ##### --> +<para> + +</para> + +<!-- ##### ARG GdictClientContext:hostname ##### --> +<para> + +</para> + +<!-- ##### ARG GdictClientContext:port ##### --> +<para> + +</para> + +<!-- ##### ARG GdictClientContext:status ##### --> +<para> + +</para> + +<!-- ##### STRUCT GdictClientContextClass ##### --> +<para> + +</para> + +@connected: +@disconnected: + +<!-- ##### ENUM GdictClientContextError ##### --> +<para> + +</para> + +@GDICT_CLIENT_CONTEXT_ERROR_SOCKET: +@GDICT_CLIENT_CONTEXT_ERROR_LOOKUP: +@GDICT_CLIENT_CONTEXT_ERROR_NO_CONNECTION: +@GDICT_CLIENT_CONTEXT_ERROR_SERVER_DOWN: + +<!-- ##### FUNCTION gdict_client_context_new ##### --> +<para> + +</para> + +@hostname: +@port: +@Returns: + + +<!-- ##### FUNCTION gdict_client_context_set_hostname ##### --> +<para> + +</para> + +@context: +@hostname: + + +<!-- ##### FUNCTION gdict_client_context_get_hostname ##### --> +<para> + +</para> + +@context: +@Returns: + + +<!-- ##### FUNCTION gdict_client_context_set_port ##### --> +<para> + +</para> + +@context: +@port: + + +<!-- ##### FUNCTION gdict_client_context_get_port ##### --> +<para> + +</para> + +@context: +@Returns: + + +<!-- ##### FUNCTION gdict_client_context_set_client ##### --> +<para> + +</para> + +@context: +@client: + + +<!-- ##### FUNCTION gdict_client_context_get_client ##### --> +<para> + +</para> + +@context: +@Returns: + + diff --git a/mate-dictionary/docs/reference/gdict/tmpl/gdict-context.sgml b/mate-dictionary/docs/reference/gdict/tmpl/gdict-context.sgml new file mode 100644 index 00000000..67fe6dee --- /dev/null +++ b/mate-dictionary/docs/reference/gdict/tmpl/gdict-context.sgml @@ -0,0 +1,300 @@ +<!-- ##### SECTION Title ##### --> +GdictContext + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### STRUCT GdictContextIface ##### --> +<para> + +</para> + +@get_databases: +@get_strategies: +@match_word: +@define_word: +@lookup_start: +@lookup_end: +@database_found: +@strategy_found: +@match_found: +@definition_found: +@error: + +<!-- ##### ENUM GdictContextError ##### --> +<para> + +</para> + +@GDICT_CONTEXT_ERROR_PARSE: +@GDICT_CONTEXT_ERROR_NOT_IMPLEMENTED: +@GDICT_CONTEXT_ERROR_INVALID_DATABASE: +@GDICT_CONTEXT_ERROR_INVALID_STRATEGY: +@GDICT_CONTEXT_ERROR_INVALID_COMMAND: +@GDICT_CONTEXT_ERROR_NO_MATCH: +@GDICT_CONTEXT_ERROR_NO_DATABASES: +@GDICT_CONTEXT_ERROR_NO_STRATEGIES: + +<!-- ##### FUNCTION gdict_context_set_local_only ##### --> +<para> + +</para> + +@context: +@local_only: + + +<!-- ##### FUNCTION gdict_context_get_local_only ##### --> +<para> + +</para> + +@context: +@Returns: + + +<!-- ##### FUNCTION gdict_context_lookup_databases ##### --> +<para> + +</para> + +@context: +@error: +@Returns: + + +<!-- ##### FUNCTION gdict_context_lookup_strategies ##### --> +<para> + +</para> + +@context: +@error: +@Returns: + + +<!-- ##### FUNCTION gdict_context_match_word ##### --> +<para> + +</para> + +@context: +@database: +@strategy: +@word: +@error: +@Returns: + + +<!-- ##### FUNCTION gdict_context_define_word ##### --> +<para> + +</para> + +@context: +@database: +@word: +@error: +@Returns: + + +<!-- ##### STRUCT GdictDatabase ##### --> +<para> + +</para> + + +<!-- ##### FUNCTION gdict_database_ref ##### --> +<para> + +</para> + +@db: +@Returns: + + +<!-- ##### FUNCTION gdict_database_unref ##### --> +<para> + +</para> + +@db: + + +<!-- ##### FUNCTION gdict_database_get_name ##### --> +<para> + +</para> + +@db: +@Returns: + + +<!-- ##### FUNCTION gdict_database_get_full_name ##### --> +<para> + +</para> + +@db: +@Returns: + + +<!-- ##### STRUCT GdictStrategy ##### --> +<para> + +</para> + + +<!-- ##### FUNCTION gdict_strategy_ref ##### --> +<para> + +</para> + +@strat: +@Returns: + + +<!-- ##### FUNCTION gdict_strategy_unref ##### --> +<para> + +</para> + +@strat: + + +<!-- ##### FUNCTION gdict_strategy_get_name ##### --> +<para> + +</para> + +@strat: +@Returns: + + +<!-- ##### FUNCTION gdict_strategy_get_description ##### --> +<para> + +</para> + +@strat: +@Returns: + + +<!-- ##### STRUCT GdictMatch ##### --> +<para> + +</para> + + +<!-- ##### FUNCTION gdict_match_ref ##### --> +<para> + +</para> + +@match: +@Returns: + + +<!-- ##### FUNCTION gdict_match_unref ##### --> +<para> + +</para> + +@match: + + +<!-- ##### FUNCTION gdict_match_get_word ##### --> +<para> + +</para> + +@match: +@Returns: + + +<!-- ##### FUNCTION gdict_match_get_database ##### --> +<para> + +</para> + +@match: +@Returns: + + +<!-- ##### STRUCT GdictDefinition ##### --> +<para> + +</para> + + +<!-- ##### FUNCTION gdict_definition_ref ##### --> +<para> + +</para> + +@def: +@Returns: + + +<!-- ##### FUNCTION gdict_definition_unref ##### --> +<para> + +</para> + +@def: + + +<!-- ##### FUNCTION gdict_definition_get_total ##### --> +<para> + +</para> + +@def: +@Returns: + + +<!-- ##### FUNCTION gdict_definition_get_word ##### --> +<para> + +</para> + +@def: +@Returns: + + +<!-- ##### FUNCTION gdict_definition_get_database ##### --> +<para> + +</para> + +@def: +@Returns: + + +<!-- ##### FUNCTION gdict_definition_get_text ##### --> +<para> + +</para> + +@def: +@Returns: + + diff --git a/mate-dictionary/docs/reference/gdict/tmpl/gdict-database-chooser.sgml b/mate-dictionary/docs/reference/gdict/tmpl/gdict-database-chooser.sgml new file mode 100644 index 00000000..ad828acc --- /dev/null +++ b/mate-dictionary/docs/reference/gdict/tmpl/gdict-database-chooser.sgml @@ -0,0 +1,194 @@ +<!-- ##### SECTION Title ##### --> +GdictDatabaseChooser + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### STRUCT GdictDatabaseChooser ##### --> +<para> + +</para> + + +<!-- ##### SIGNAL GdictDatabaseChooser::database-activated ##### --> +<para> + +</para> + +@gdictdatabasechooser: the object which received the signal. +@arg1: +@arg2: + +<!-- ##### SIGNAL GdictDatabaseChooser::selection-changed ##### --> +<para> + +</para> + +@gdictdatabasechooser: the object which received the signal. + +<!-- ##### ARG GdictDatabaseChooser:context ##### --> +<para> + +</para> + +<!-- ##### ARG GdictDatabaseChooser:count ##### --> +<para> + +</para> + +<!-- ##### STRUCT GdictDatabaseChooserClass ##### --> +<para> + +</para> + +@database_activated: +@selection_changed: + +<!-- ##### FUNCTION gdict_database_chooser_new ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION gdict_database_chooser_new_with_context ##### --> +<para> + +</para> + +@context: +@Returns: + + +<!-- ##### FUNCTION gdict_database_chooser_get_context ##### --> +<para> + +</para> + +@chooser: +@Returns: + + +<!-- ##### FUNCTION gdict_database_chooser_set_context ##### --> +<para> + +</para> + +@chooser: +@context: + + +<!-- ##### FUNCTION gdict_database_chooser_get_databases ##### --> +<para> + +</para> + +@chooser: +@length: +@Returns: + + +<!-- ##### FUNCTION gdict_database_chooser_count_databases ##### --> +<para> + +</para> + +@chooser: +@Returns: + + +<!-- ##### FUNCTION gdict_database_chooser_has_database ##### --> +<para> + +</para> + +@chooser: +@database: +@Returns: + + +<!-- ##### FUNCTION gdict_database_chooser_refresh ##### --> +<para> + +</para> + +@chooser: + + +<!-- ##### FUNCTION gdict_database_chooser_clear ##### --> +<para> + +</para> + +@chooser: + + +<!-- ##### FUNCTION gdict_database_chooser_add_button ##### --> +<para> + +</para> + +@chooser: +@button_text: +@Returns: + + +<!-- ##### FUNCTION gdict_database_chooser_get_current_database ##### --> +<para> + +</para> + +@chooser: +@Returns: + + +<!-- ##### FUNCTION gdict_database_chooser_select_database ##### --> +<para> + +</para> + +@chooser: +@db_name: +@Returns: + + +<!-- ##### FUNCTION gdict_database_chooser_set_current_database ##### --> +<para> + +</para> + +@chooser: +@db_name: +@Returns: + + +<!-- ##### FUNCTION gdict_database_chooser_unselect_database ##### --> +<para> + +</para> + +@chooser: +@db_name: +@Returns: + + diff --git a/mate-dictionary/docs/reference/gdict/tmpl/gdict-defbox.sgml b/mate-dictionary/docs/reference/gdict/tmpl/gdict-defbox.sgml new file mode 100644 index 00000000..5ca025f2 --- /dev/null +++ b/mate-dictionary/docs/reference/gdict/tmpl/gdict-defbox.sgml @@ -0,0 +1,288 @@ +<!-- ##### SECTION Title ##### --> +GdictDefbox + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### STRUCT GdictDefbox ##### --> +<para> + +</para> + + +<!-- ##### SIGNAL GdictDefbox::find-next ##### --> +<para> + +</para> + +@gdictdefbox: the object which received the signal. + +<!-- ##### SIGNAL GdictDefbox::find-previous ##### --> +<para> + +</para> + +@gdictdefbox: the object which received the signal. + +<!-- ##### SIGNAL GdictDefbox::hide-find ##### --> +<para> + +</para> + +@gdictdefbox: the object which received the signal. + +<!-- ##### SIGNAL GdictDefbox::link-clicked ##### --> +<para> + +</para> + +@gdictdefbox: the object which received the signal. +@arg1: + +<!-- ##### SIGNAL GdictDefbox::show-find ##### --> +<para> + +</para> + +@gdictdefbox: the object which received the signal. + +<!-- ##### ARG GdictDefbox:context ##### --> +<para> + +</para> + +<!-- ##### ARG GdictDefbox:database ##### --> +<para> + +</para> + +<!-- ##### ARG GdictDefbox:font-name ##### --> +<para> + +</para> + +<!-- ##### ARG GdictDefbox:word ##### --> +<para> + +</para> + +<!-- ##### STRUCT GdictDefboxClass ##### --> +<para> + +</para> + +@parent_class: +@show_find: +@hide_find: +@find_previous: +@find_next: +@link_clicked: +@_gdict_defbox_1: +@_gdict_defbox_2: +@_gdict_defbox_3: +@_gdict_defbox_4: + +<!-- ##### FUNCTION gdict_defbox_new ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION gdict_defbox_new_with_context ##### --> +<para> + +</para> + +@context: +@Returns: + + +<!-- ##### FUNCTION gdict_defbox_set_context ##### --> +<para> + +</para> + +@defbox: +@context: + + +<!-- ##### FUNCTION gdict_defbox_get_context ##### --> +<para> + +</para> + +@defbox: +@Returns: + + +<!-- ##### FUNCTION gdict_defbox_set_database ##### --> +<para> + +</para> + +@defbox: +@database: + + +<!-- ##### FUNCTION gdict_defbox_get_database ##### --> +<para> + +</para> + +@defbox: +@Returns: + + +<!-- ##### FUNCTION gdict_defbox_get_text ##### --> +<para> + +</para> + +@defbox: +@length: +@Returns: + + +<!-- ##### FUNCTION gdict_defbox_select_all ##### --> +<para> + +</para> + +@defbox: + + +<!-- ##### FUNCTION gdict_defbox_copy_to_clipboard ##### --> +<para> + +</para> + +@defbox: +@clipboard: + + +<!-- ##### FUNCTION gdict_defbox_clear ##### --> +<para> + +</para> + +@defbox: + + +<!-- ##### FUNCTION gdict_defbox_lookup ##### --> +<para> + +</para> + +@defbox: +@word: + + +<!-- ##### FUNCTION gdict_defbox_get_word ##### --> +<para> + +</para> + +@defbox: +@Returns: + + +<!-- ##### FUNCTION gdict_defbox_count_definitions ##### --> +<para> + +</para> + +@defbox: +@Returns: + + +<!-- ##### FUNCTION gdict_defbox_jump_to_definition ##### --> +<para> + +</para> + +@defbox: +@number: + + +<!-- ##### FUNCTION gdict_defbox_set_show_find ##### --> +<para> + +</para> + +@defbox: +@show_find: + + +<!-- ##### FUNCTION gdict_defbox_get_show_find ##### --> +<para> + +</para> + +@defbox: +@Returns: + + +<!-- ##### FUNCTION gdict_defbox_find_next ##### --> +<para> + +</para> + +@defbox: + + +<!-- ##### FUNCTION gdict_defbox_find_previous ##### --> +<para> + +</para> + +@defbox: + + +<!-- ##### FUNCTION gdict_defbox_set_font_name ##### --> +<para> + +</para> + +@defbox: +@font_name: + + +<!-- ##### FUNCTION gdict_defbox_get_font_name ##### --> +<para> + +</para> + +@defbox: +@Returns: + + +<!-- ##### FUNCTION gdict_defbox_get_selected_word ##### --> +<para> + +</para> + +@defbox: +@Returns: + + diff --git a/mate-dictionary/docs/reference/gdict/tmpl/gdict-source-chooser.sgml b/mate-dictionary/docs/reference/gdict/tmpl/gdict-source-chooser.sgml new file mode 100644 index 00000000..baafc187 --- /dev/null +++ b/mate-dictionary/docs/reference/gdict/tmpl/gdict-source-chooser.sgml @@ -0,0 +1,186 @@ +<!-- ##### SECTION Title ##### --> +GdictSourceChooser + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### STRUCT GdictSourceChooser ##### --> +<para> + +</para> + + +<!-- ##### SIGNAL GdictSourceChooser::selection-changed ##### --> +<para> + +</para> + +@gdictsourcechooser: the object which received the signal. + +<!-- ##### SIGNAL GdictSourceChooser::source-activated ##### --> +<para> + +</para> + +@gdictsourcechooser: the object which received the signal. +@arg1: +@arg2: + +<!-- ##### ARG GdictSourceChooser:count ##### --> +<para> + +</para> + +<!-- ##### ARG GdictSourceChooser:loader ##### --> +<para> + +</para> + +<!-- ##### STRUCT GdictSourceChooserClass ##### --> +<para> + +</para> + +@source_activated: +@selection_changed: + +<!-- ##### FUNCTION gdict_source_chooser_new ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION gdict_source_chooser_new_with_loader ##### --> +<para> + +</para> + +@loader: +@Returns: + + +<!-- ##### FUNCTION gdict_source_chooser_get_loader ##### --> +<para> + +</para> + +@chooser: +@Returns: + + +<!-- ##### FUNCTION gdict_source_chooser_set_loader ##### --> +<para> + +</para> + +@chooser: +@loader: + + +<!-- ##### FUNCTION gdict_source_chooser_get_sources ##### --> +<para> + +</para> + +@chooser: +@length: +@Returns: + + +<!-- ##### FUNCTION gdict_source_chooser_count_sources ##### --> +<para> + +</para> + +@chooser: +@Returns: + + +<!-- ##### FUNCTION gdict_source_chooser_has_source ##### --> +<para> + +</para> + +@chooser: +@source_name: +@Returns: + + +<!-- ##### FUNCTION gdict_source_chooser_refresh ##### --> +<para> + +</para> + +@chooser: + + +<!-- ##### FUNCTION gdict_source_chooser_select_source ##### --> +<para> + +</para> + +@chooser: +@source_name: +@Returns: + + +<!-- ##### FUNCTION gdict_source_chooser_unselect_source ##### --> +<para> + +</para> + +@chooser: +@source_name: +@Returns: + + +<!-- ##### FUNCTION gdict_source_chooser_get_current_source ##### --> +<para> + +</para> + +@chooser: +@Returns: + + +<!-- ##### FUNCTION gdict_source_chooser_set_current_source ##### --> +<para> + +</para> + +@chooser: +@source_name: +@Returns: + + +<!-- ##### FUNCTION gdict_source_chooser_add_button ##### --> +<para> + +</para> + +@chooser: +@button_text: +@Returns: + + diff --git a/mate-dictionary/docs/reference/gdict/tmpl/gdict-source-loader.sgml b/mate-dictionary/docs/reference/gdict/tmpl/gdict-source-loader.sgml new file mode 100644 index 00000000..f9f2349b --- /dev/null +++ b/mate-dictionary/docs/reference/gdict/tmpl/gdict-source-loader.sgml @@ -0,0 +1,144 @@ +<!-- ##### SECTION Title ##### --> +GdictSourceLoader + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### STRUCT GdictSourceLoader ##### --> +<para> + +</para> + + +<!-- ##### SIGNAL GdictSourceLoader::source-loaded ##### --> +<para> + +</para> + +@gdictsourceloader: the object which received the signal. +@arg1: + +<!-- ##### ARG GdictSourceLoader:paths ##### --> +<para> + +</para> + +<!-- ##### ARG GdictSourceLoader:sources ##### --> +<para> + +</para> + +<!-- ##### STRUCT GdictSourceLoaderClass ##### --> +<para> + +</para> + +@parent_class: +@source_loaded: +@_gdict_source_1: +@_gdict_source_2: +@_gdict_source_3: +@_gdict_source_4: + +<!-- ##### FUNCTION gdict_source_loader_new ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION gdict_source_loader_update ##### --> +<para> + +</para> + +@loader: + + +<!-- ##### FUNCTION gdict_source_loader_add_search_path ##### --> +<para> + +</para> + +@loader: +@path: + + +<!-- ##### FUNCTION gdict_source_loader_get_paths ##### --> +<para> + +</para> + +@loader: +@Returns: + + +<!-- ##### FUNCTION gdict_source_loader_get_names ##### --> +<para> + +</para> + +@loader: +@length: +@Returns: + + +<!-- ##### FUNCTION gdict_source_loader_get_sources ##### --> +<para> + +</para> + +@loader: +@Returns: + + +<!-- ##### FUNCTION gdict_source_loader_get_source ##### --> +<para> + +</para> + +@loader: +@name: +@Returns: + + +<!-- ##### FUNCTION gdict_source_loader_remove_source ##### --> +<para> + +</para> + +@loader: +@name: +@Returns: + + +<!-- ##### FUNCTION gdict_source_loader_has_source ##### --> +<para> + +</para> + +@loader: +@source_name: +@Returns: + + diff --git a/mate-dictionary/docs/reference/gdict/tmpl/gdict-source.sgml b/mate-dictionary/docs/reference/gdict/tmpl/gdict-source.sgml new file mode 100644 index 00000000..f0117047 --- /dev/null +++ b/mate-dictionary/docs/reference/gdict/tmpl/gdict-source.sgml @@ -0,0 +1,253 @@ +<!-- ##### SECTION Title ##### --> +GdictSource + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### ENUM GdictSourceError ##### --> +<para> + +</para> + +@GDICT_SOURCE_ERROR_PARSE: +@GDICT_SOURCE_ERROR_INVALID_NAME: +@GDICT_SOURCE_ERROR_INVALID_TRANSPORT: +@GDICT_SOURCE_ERROR_INVALID_BAD_PARAMETER: + +<!-- ##### STRUCT GdictSource ##### --> +<para> + +</para> + + +<!-- ##### ARG GdictSource:context ##### --> +<para> + +</para> + +<!-- ##### ARG GdictSource:database ##### --> +<para> + +</para> + +<!-- ##### ARG GdictSource:description ##### --> +<para> + +</para> + +<!-- ##### ARG GdictSource:filename ##### --> +<para> + +</para> + +<!-- ##### ARG GdictSource:name ##### --> +<para> + +</para> + +<!-- ##### ARG GdictSource:strategy ##### --> +<para> + +</para> + +<!-- ##### ARG GdictSource:transport ##### --> +<para> + +</para> + +<!-- ##### STRUCT GdictSourceClass ##### --> +<para> + +</para> + + +<!-- ##### FUNCTION gdict_source_new ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION gdict_source_load_from_file ##### --> +<para> + +</para> + +@source: +@filename: +@error: +@Returns: + + +<!-- ##### FUNCTION gdict_source_load_from_data ##### --> +<para> + +</para> + +@source: +@data: +@length: +@error: +@Returns: + + +<!-- ##### FUNCTION gdict_source_to_data ##### --> +<para> + +</para> + +@source: +@length: +@error: +@Returns: + + +<!-- ##### FUNCTION gdict_source_set_name ##### --> +<para> + +</para> + +@source: +@name: + + +<!-- ##### FUNCTION gdict_source_get_name ##### --> +<para> + +</para> + +@source: +@Returns: + + +<!-- ##### FUNCTION gdict_source_set_description ##### --> +<para> + +</para> + +@source: +@description: + + +<!-- ##### FUNCTION gdict_source_get_description ##### --> +<para> + +</para> + +@source: +@Returns: + + +<!-- ##### FUNCTION gdict_source_set_database ##### --> +<para> + +</para> + +@source: +@database: + + +<!-- ##### FUNCTION gdict_source_get_database ##### --> +<para> + +</para> + +@source: +@Returns: + + +<!-- ##### FUNCTION gdict_source_set_strategy ##### --> +<para> + +</para> + +@source: +@strategy: + + +<!-- ##### FUNCTION gdict_source_get_strategy ##### --> +<para> + +</para> + +@source: +@Returns: + + +<!-- ##### ENUM GdictSourceTransport ##### --> +<para> + +</para> + +@GDICT_SOURCE_TRANSPORT_DICTD: +@GDICT_SOURCE_TRANSPORT_INVALID: + +<!-- ##### FUNCTION gdict_source_set_transport ##### --> +<para> + +</para> + +@source: +@transport: +@first_transport_property: +@Varargs: + + +<!-- ##### FUNCTION gdict_source_set_transportv ##### --> +<para> + +</para> + +@source: +@transport: +@first_transport_property: +@var_args: + + +<!-- ##### FUNCTION gdict_source_get_transport ##### --> +<para> + +</para> + +@source: +@Returns: + + +<!-- ##### FUNCTION gdict_source_get_context ##### --> +<para> + +</para> + +@source: +@Returns: + + +<!-- ##### FUNCTION gdict_source_peek_context ##### --> +<para> + +</para> + +@source: +@Returns: + + diff --git a/mate-dictionary/docs/reference/gdict/tmpl/gdict-speller.sgml b/mate-dictionary/docs/reference/gdict/tmpl/gdict-speller.sgml new file mode 100644 index 00000000..98c06fbe --- /dev/null +++ b/mate-dictionary/docs/reference/gdict/tmpl/gdict-speller.sgml @@ -0,0 +1,174 @@ +<!-- ##### SECTION Title ##### --> +GdictSpeller + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### STRUCT GdictSpeller ##### --> +<para> + +</para> + + +<!-- ##### SIGNAL GdictSpeller::word-activated ##### --> +<para> + +</para> + +@gdictspeller: the object which received the signal. +@arg1: +@arg2: + +<!-- ##### ARG GdictSpeller:context ##### --> +<para> + +</para> + +<!-- ##### ARG GdictSpeller:database ##### --> +<para> + +</para> + +<!-- ##### ARG GdictSpeller:strategy ##### --> +<para> + +</para> + +<!-- ##### STRUCT GdictSpellerClass ##### --> +<para> + +</para> + +@parent_class: +@word_activated: +@_gdict_speller_1: +@_gdict_speller_2: +@_gdict_speller_3: +@_gdict_speller_4: + +<!-- ##### FUNCTION gdict_speller_new ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION gdict_speller_new_with_context ##### --> +<para> + +</para> + +@context: +@Returns: + + +<!-- ##### FUNCTION gdict_speller_set_context ##### --> +<para> + +</para> + +@speller: +@context: + + +<!-- ##### FUNCTION gdict_speller_get_context ##### --> +<para> + +</para> + +@speller: +@Returns: + + +<!-- ##### FUNCTION gdict_speller_set_database ##### --> +<para> + +</para> + +@speller: +@database: + + +<!-- ##### FUNCTION gdict_speller_get_database ##### --> +<para> + +</para> + +@speller: +@Returns: + + +<!-- ##### FUNCTION gdict_speller_set_strategy ##### --> +<para> + +</para> + +@speller: +@strategy: + + +<!-- ##### FUNCTION gdict_speller_get_strategy ##### --> +<para> + +</para> + +@speller: +@Returns: + + +<!-- ##### FUNCTION gdict_speller_clear ##### --> +<para> + +</para> + +@speller: + + +<!-- ##### FUNCTION gdict_speller_match ##### --> +<para> + +</para> + +@speller: +@word: + + +<!-- ##### FUNCTION gdict_speller_count_matches ##### --> +<para> + +</para> + +@speller: +@Returns: + + +<!-- ##### FUNCTION gdict_speller_get_matches ##### --> +<para> + +</para> + +@speller: +@length: +@Returns: + + diff --git a/mate-dictionary/docs/reference/gdict/tmpl/gdict-strategy-chooser.sgml b/mate-dictionary/docs/reference/gdict/tmpl/gdict-strategy-chooser.sgml new file mode 100644 index 00000000..f909feed --- /dev/null +++ b/mate-dictionary/docs/reference/gdict/tmpl/gdict-strategy-chooser.sgml @@ -0,0 +1,188 @@ +<!-- ##### SECTION Title ##### --> +GdictStrategyChooser + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### STRUCT GdictStrategyChooser ##### --> +<para> + +</para> + + +<!-- ##### SIGNAL GdictStrategyChooser::strategy-activated ##### --> +<para> + +</para> + +@gdictstrategychooser: the object which received the signal. +@arg1: +@arg2: + +<!-- ##### ARG GdictStrategyChooser:context ##### --> +<para> + +</para> + +<!-- ##### STRUCT GdictStrategyChooserClass ##### --> +<para> + +</para> + +@parent_class: +@strategy_activated: +@_gdict_padding1: +@_gdict_padding2: +@_gdict_padding3: +@_gdict_padding4: +@_gdict_padding5: +@_gdict_padding6: + +<!-- ##### FUNCTION gdict_strategy_chooser_new ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION gdict_strategy_chooser_new_with_context ##### --> +<para> + +</para> + +@context: +@Returns: + + +<!-- ##### FUNCTION gdict_strategy_chooser_get_context ##### --> +<para> + +</para> + +@chooser: +@Returns: + + +<!-- ##### FUNCTION gdict_strategy_chooser_set_context ##### --> +<para> + +</para> + +@chooser: +@context: + + +<!-- ##### FUNCTION gdict_strategy_chooser_get_strategies ##### --> +<para> + +</para> + +@chooser: +@length: +@Returns: + + +<!-- ##### FUNCTION gdict_strategy_chooser_has_strategy ##### --> +<para> + +</para> + +@chooser: +@strategy: +@Returns: + + +<!-- ##### FUNCTION gdict_strategy_chooser_add_button ##### --> +<para> + +</para> + +@chooser: +@button_text: +@Returns: + + +<!-- ##### FUNCTION gdict_strategy_chooser_clear ##### --> +<para> + +</para> + +@chooser: + + +<!-- ##### FUNCTION gdict_strategy_chooser_count_strategies ##### --> +<para> + +</para> + +@chooser: +@Returns: + + +<!-- ##### FUNCTION gdict_strategy_chooser_get_current_strategy ##### --> +<para> + +</para> + +@chooser: +@Returns: + + +<!-- ##### FUNCTION gdict_strategy_chooser_refresh ##### --> +<para> + +</para> + +@chooser: + + +<!-- ##### FUNCTION gdict_strategy_chooser_select_strategy ##### --> +<para> + +</para> + +@chooser: +@strat_name: +@Returns: + + +<!-- ##### FUNCTION gdict_strategy_chooser_set_current_strategy ##### --> +<para> + +</para> + +@chooser: +@strat_name: +@Returns: + + +<!-- ##### FUNCTION gdict_strategy_chooser_unselect_strategy ##### --> +<para> + +</para> + +@chooser: +@strat_name: +@Returns: + + diff --git a/mate-dictionary/docs/reference/gdict/tmpl/gdict-unused.sgml b/mate-dictionary/docs/reference/gdict/tmpl/gdict-unused.sgml new file mode 100644 index 00000000..e69de29b --- /dev/null +++ b/mate-dictionary/docs/reference/gdict/tmpl/gdict-unused.sgml diff --git a/mate-dictionary/docs/reference/gdict/tmpl/gdict-utils.sgml b/mate-dictionary/docs/reference/gdict/tmpl/gdict-utils.sgml new file mode 100644 index 00000000..60582b6e --- /dev/null +++ b/mate-dictionary/docs/reference/gdict/tmpl/gdict-utils.sgml @@ -0,0 +1,107 @@ +<!-- ##### SECTION Title ##### --> +Gdict Utilities + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### MACRO GDICT_DEFAULT_DATABASE ##### --> +<para> + +</para> + + + +<!-- ##### MACRO GDICT_DEFAULT_STRATEGY ##### --> +<para> + +</para> + + + +<!-- ##### MACRO GDICT_DEFAULT_FONT_NAME ##### --> +<para> + +</para> + + + +<!-- ##### ENUM GdictContextProp ##### --> +<para> + +</para> + +@GDICT_CONTEXT_PROP_FIRST: +@GDICT_CONTEXT_PROP_LOCAL_ONLY: +@GDICT_CONTEXT_PROP_LAST: + +<!-- ##### ENUM GdictStatusCode ##### --> +<para> + +</para> + +@GDICT_STATUS_INVALID: +@GDICT_STATUS_N_DATABASES_PRESENT: +@GDICT_STATUS_N_STRATEGIES_PRESENT: +@GDICT_STATUS_DATABASE_INFO: +@GDICT_STATUS_HELP_TEXT: +@GDICT_STATUS_SERVER_INFO: +@GDICT_STATUS_CHALLENGE: +@GDICT_STATUS_N_DEFINITIONS_RETRIEVED: +@GDICT_STATUS_WORD_DB_NAME: +@GDICT_STATUS_N_MATCHES_FOUND: +@GDICT_STATUS_CONNECT: +@GDICT_STATUS_QUIT: +@GDICT_STATUS_AUTH_OK: +@GDICT_STATUS_OK: +@GDICT_STATUS_SEND_RESPONSE: +@GDICT_STATUS_SERVER_DOWN: +@GDICT_STATUS_SHUTDOWN: +@GDICT_STATUS_BAD_COMMAND: +@GDICT_STATUS_BAD_PARAMETERS: +@GDICT_STATUS_COMMAND_NOT_IMPLEMENTED: +@GDICT_STATUS_PARAMETER_NOT_IMPLEMENTED: +@GDICT_STATUS_NO_ACCESS: +@GDICT_STATUS_USE_SHOW_INFO: +@GDICT_STATUS_UNKNOWN_MECHANISM: +@GDICT_STATUS_BAD_DATABASE: +@GDICT_STATUS_BAD_STRATEGY: +@GDICT_STATUS_NO_MATCH: +@GDICT_STATUS_NO_DATABASES_PRESENT: +@GDICT_STATUS_NO_STRATEGIES_PRESENT: + +<!-- ##### FUNCTION gdict_debug_init ##### --> +<para> + +</para> + +@argc: +@argv: + + +<!-- ##### FUNCTION gdict_get_option_group ##### --> +<para> + +</para> + +@void: +@Returns: + + diff --git a/mate-dictionary/docs/reference/gdict/tmpl/gdict-version.sgml b/mate-dictionary/docs/reference/gdict/tmpl/gdict-version.sgml new file mode 100644 index 00000000..8d3cb5ce --- /dev/null +++ b/mate-dictionary/docs/reference/gdict/tmpl/gdict-version.sgml @@ -0,0 +1,105 @@ +<!-- ##### SECTION Title ##### --> +Gdict Version Checking + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### MACRO GDICT_MAJOR_VERSION ##### --> +<para> + +</para> + + + +<!-- ##### MACRO GDICT_MINOR_VERSION ##### --> +<para> + +</para> + + + +<!-- ##### MACRO GDICT_MICRO_VERSION ##### --> +<para> + +</para> + + + +<!-- ##### MACRO GDICT_VERSION ##### --> +<para> + +</para> + + + +<!-- ##### MACRO GDICT_VERSION_S ##### --> +<para> + +</para> + + + +<!-- ##### MACRO GDICT_VERSION_HEX ##### --> +<para> + +</para> + + + +<!-- ##### MACRO GDICT_CHECK_VERSION ##### --> +<para> + +</para> + +@major: +@minor: +@micro: + + +<!-- ##### VARIABLE gdict_major ##### --> +<para> + +</para> + + +<!-- ##### VARIABLE gdict_minor ##### --> +<para> + +</para> + + +<!-- ##### VARIABLE gdict_micro ##### --> +<para> + +</para> + + +<!-- ##### FUNCTION gdict_check_version ##### --> +<para> + +</para> + +@required_major: +@required_minor: +@required_micro: +@Returns: + + |