From ef0467789bfc8406b57ba553e4d59f4d6c3f9be8 Mon Sep 17 00:00:00 2001 From: Stefano Karapetsas Date: Wed, 14 Dec 2011 10:13:54 +0100 Subject: Moved from Mate-Extra repository --- mate-dictionary/docs/Makefile.am | 3 + mate-dictionary/docs/reference/Makefile.am | 1 + mate-dictionary/docs/reference/gdict/ChangeLog | 71 +++++ mate-dictionary/docs/reference/gdict/Makefile.am | 75 +++++ .../docs/reference/gdict/gdict-docs.sgml | 159 ++++++++++ .../docs/reference/gdict/gdict-overrides.txt | 0 .../docs/reference/gdict/gdict-sections.txt | 336 +++++++++++++++++++++ mate-dictionary/docs/reference/gdict/gdict.types | 9 + .../reference/gdict/tmpl/gdict-client-context.sgml | 146 +++++++++ .../docs/reference/gdict/tmpl/gdict-context.sgml | 300 ++++++++++++++++++ .../gdict/tmpl/gdict-database-chooser.sgml | 194 ++++++++++++ .../docs/reference/gdict/tmpl/gdict-defbox.sgml | 288 ++++++++++++++++++ .../reference/gdict/tmpl/gdict-source-chooser.sgml | 186 ++++++++++++ .../reference/gdict/tmpl/gdict-source-loader.sgml | 144 +++++++++ .../docs/reference/gdict/tmpl/gdict-source.sgml | 253 ++++++++++++++++ .../docs/reference/gdict/tmpl/gdict-speller.sgml | 174 +++++++++++ .../gdict/tmpl/gdict-strategy-chooser.sgml | 188 ++++++++++++ .../docs/reference/gdict/tmpl/gdict-unused.sgml | 0 .../docs/reference/gdict/tmpl/gdict-utils.sgml | 107 +++++++ .../docs/reference/gdict/tmpl/gdict-version.sgml | 105 +++++++ .../docs/reference/gdict/version.xml.in | 1 + mate-dictionary/docs/source-configuration.txt | 65 ++++ 22 files changed, 2805 insertions(+) create mode 100644 mate-dictionary/docs/Makefile.am create mode 100644 mate-dictionary/docs/reference/Makefile.am create mode 100644 mate-dictionary/docs/reference/gdict/ChangeLog create mode 100644 mate-dictionary/docs/reference/gdict/Makefile.am create mode 100644 mate-dictionary/docs/reference/gdict/gdict-docs.sgml create mode 100644 mate-dictionary/docs/reference/gdict/gdict-overrides.txt create mode 100644 mate-dictionary/docs/reference/gdict/gdict-sections.txt create mode 100644 mate-dictionary/docs/reference/gdict/gdict.types create mode 100644 mate-dictionary/docs/reference/gdict/tmpl/gdict-client-context.sgml create mode 100644 mate-dictionary/docs/reference/gdict/tmpl/gdict-context.sgml create mode 100644 mate-dictionary/docs/reference/gdict/tmpl/gdict-database-chooser.sgml create mode 100644 mate-dictionary/docs/reference/gdict/tmpl/gdict-defbox.sgml create mode 100644 mate-dictionary/docs/reference/gdict/tmpl/gdict-source-chooser.sgml create mode 100644 mate-dictionary/docs/reference/gdict/tmpl/gdict-source-loader.sgml create mode 100644 mate-dictionary/docs/reference/gdict/tmpl/gdict-source.sgml create mode 100644 mate-dictionary/docs/reference/gdict/tmpl/gdict-speller.sgml create mode 100644 mate-dictionary/docs/reference/gdict/tmpl/gdict-strategy-chooser.sgml create mode 100644 mate-dictionary/docs/reference/gdict/tmpl/gdict-unused.sgml create mode 100644 mate-dictionary/docs/reference/gdict/tmpl/gdict-utils.sgml create mode 100644 mate-dictionary/docs/reference/gdict/tmpl/gdict-version.sgml create mode 100644 mate-dictionary/docs/reference/gdict/version.xml.in create mode 100644 mate-dictionary/docs/source-configuration.txt (limited to 'mate-dictionary/docs') diff --git a/mate-dictionary/docs/Makefile.am b/mate-dictionary/docs/Makefile.am new file mode 100644 index 00000000..fcc10bfd --- /dev/null +++ b/mate-dictionary/docs/Makefile.am @@ -0,0 +1,3 @@ +SUBDIRS = reference + +EXTRA_DIST = source-configuration.txt diff --git a/mate-dictionary/docs/reference/Makefile.am b/mate-dictionary/docs/reference/Makefile.am new file mode 100644 index 00000000..20467a8e --- /dev/null +++ b/mate-dictionary/docs/reference/Makefile.am @@ -0,0 +1 @@ +SUBDIRS = gdict diff --git a/mate-dictionary/docs/reference/gdict/ChangeLog b/mate-dictionary/docs/reference/gdict/ChangeLog new file mode 100644 index 00000000..6648e039 --- /dev/null +++ b/mate-dictionary/docs/reference/gdict/ChangeLog @@ -0,0 +1,71 @@ +2007-08-13 Emmanuele Bassi + + * gdict-sections.txt: Remove undefined symbols and add the + last undocumented one. + +2007-08-13 Emmanuele Bassi + + * gdict-sections.txt: Add undocumented symbols. + + * gdict-docs.sgml: Use parts instead of sections and add + the utilities and version checking pages. + +2007-08-13 Emmanuele Bassi + + * tmpl/*: Remove templates. + + * gdict-docs.sgml: + * gdict-sections.txt: Update and clean up. + +2007-08-13 Emmanuele Bassi + + * gdict.types: Add types + + * Makefile.am: + * gdict-sections.txt: + * gdict-docs.sgml: Remove GdictEntry. + +2006-01-27 Emmanuele Bassi + + * gdict-sections.txt: add new GdictDefbox functions: + gdict_defbox_get_font_name and gdict_defbox_set_font_name. + +2006-01-16 Emmanuele Bassi + + D gdict-decl.txt + + * gdict-decl.txt: remove this auto-generated file + +2006-01-16 Emmanuele Bassi + + D gdict-decl-list.txt + D gdict-undocumented.txt + A gdict-context.sgml + + * gdict-decl-list.txt, gdict-undocumented.txt: remove these + auto-generated files. + + * .cvsignore: add gdict-decl-list.txt to the list of ignored + files + + * tmpl/gdict-context.sgml: add documentation of the GdictContext + GInterface and the boxed types defined in gdict-context.h + + * tmpl/gdict-source.sgml: add a description of the GdictSource object + +2005-12-30 Emmanuele Bassi + + * gdict-docs.sgml: flesh out the text. + + * gdict-sections.txt: add new functions and data structures. + +2005-12-19 Emmanuele Bassi + + A .cvsignore + A tmpl/.cvsignore + + * .cvsignore, tmpl/.cvsignore: added .cvsignore files. + +2005-11-12 Emmanuele Bassi + + * Makefile.am: build against ../../../libgdict diff --git a/mate-dictionary/docs/reference/gdict/Makefile.am b/mate-dictionary/docs/reference/gdict/Makefile.am new file mode 100644 index 00000000..8dab089e --- /dev/null +++ b/mate-dictionary/docs/reference/gdict/Makefile.am @@ -0,0 +1,75 @@ +## Process this file with automake to produce Makefile.in + +AUTOMAKE_OPTIONS = 1.6 + +# The name of the module, e.g. 'glib'. +DOC_MODULE=mate-dict + +# The top-level SGML file. Change it if you want. +DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.sgml + +# The directory containing the source code. Relative to $(srcdir). +# gtk-doc will search all .c & .h files beneath here for inline comments +# documenting functions and macros. +DOC_SOURCE_DIR=../../../libgdict + +# Extra options to supply to gtkdoc-scan. +SCAN_OPTIONS= + +# Extra options to pass to gtkdoc-scangobj +SCANGOBJ_OPTIONS=--type-init-func="g_type_init()" + +# Extra options to supply to gtkdoc-mkdb. +MKDB_OPTIONS=--sgml-mode --output-format=xml + +# Extra options to supply to gtkdoc-fixref. +FIXXREF_OPTIONS= + +# Used for dependencies. +HFILE_GLOB=$(top_srcdir)/mate-dictionary/libgdict/*.h +CFILE_GLOB=$(top_srcdir)/mate-dictionary/libgdict/*.c + +# Header files to ignore when scanning. +IGNORE_HFILES = \ + gdict-enum-types.h \ + gdict-marshal.h \ + gdict-context-private.h \ + gdict-debug.h \ + gdict-private.h \ + stamp-gdict-enum-types.h \ + stamp-gdict-marshal.h + +# Images to copy into HTML directory. +HTML_IMAGES = + +# Extra SGML files that are included by $(DOC_MAIN_SGML_FILE). +content_files = version.xml + +# Other files to distribute. +extra_files = + +# CFLAGS and LDFLAGS for compiling scan program. Only needed if your app/lib +# contains GtkObjects/GObjects and you want to document signals and properties. +GTKDOC_CFLAGS = \ + $(CFLAGS) \ + $(CPPFLAGS) \ + $(LIBGDICT_CFLAGS) \ + -I$(srcdir)/../../../libgdict \ + -I$(top_builddir)/mate-dictionary/libgdict + +GTKDOC_LIBS = \ + $(LDFLAGS) \ + $(LIBGDICT_LIBS) \ + ../../../libgdict/libmatedict.la + +include $(top_srcdir)/gtk-doc.make + +# Other files to distribute +# e.g. EXTRA_DIST += version.xml.in +EXTRA_DIST += version.xml.in + +#dist-hook-local: +# mkdir $(distdir)/TEXT; \ +# for f in $(srcdir)/TEXT/* ; do \ +# test -f $$f && cp -p $$f $(distdir)/TEXT; \ +# done diff --git a/mate-dictionary/docs/reference/gdict/gdict-docs.sgml b/mate-dictionary/docs/reference/gdict/gdict-docs.sgml new file mode 100644 index 00000000..19c4555a --- /dev/null +++ b/mate-dictionary/docs/reference/gdict/gdict-docs.sgml @@ -0,0 +1,159 @@ + + +]> + + + + MATE Dictionary Library Reference Manual + + + Emmanuele + Bassi + +
+ ebassi@gnome.org +
+ + + + + + 2005 + Emmanuele Bassi + + + + + + This manual documents the &version; release of the Dictionary + Library for MATE 2.x + + + + + + + + Introduction + + + + The MATE Dictionary Library is a simple yet powerful collection of + classes that can be used to access various dictionary sources. + + + + It was created for the MATE Dictionary application, but it has been + made available for each developer whom wishes to access and display + definitions stored inside language dictionaries. + + + + + + + + The MATE Dictionary Library + + + Dictionary Context + + A dictionary context is a representation of a transport method, + that is a way to access a dictionary source. + + A dictionary source is any digital representation of a language + dictionary which provides a way to programmatically query its contents + for the available definitions of a word, phrase or any kind of + text. + + A dictionary source might use files encoded using the DICT or the + StarDict formats, and offer an interface for queries compliant to the + Dictionary Protocol as defined by the RFC 2229. + + + + + + + Context Implementations + + The only context implementation currently available is a client + for the Dictionary Protocol. + + + + + + + Dictionary Source + + A dictionary source is repesented using a specially crafted file, + and can be accessed using the GdictSource class. + + Dictionary sources can be created at runtime or stored inside a + file and loaded directly using its path. Usually, sources files are + stored inside a predefined path and loaded using the GdictSourceLoader + class. + + + + + + + + Gdict Utilities + + + + + + + + + + The MATE Dictionary Library Widgets + + + + + Apart from the low-level classes, the MATE Dictionary library + offers a set of widgets for accessing the dictionary sources and showing + the results of queries. + + + + + + Base widgets + + + + + + + Advanced widgets + + + + + + + + + + Index + + + Index of deprecated symbols + + + Index of new symbols in 0.10 + + + Index of new symbols in 0.12 + + + diff --git a/mate-dictionary/docs/reference/gdict/gdict-overrides.txt b/mate-dictionary/docs/reference/gdict/gdict-overrides.txt new file mode 100644 index 00000000..e69de29b diff --git a/mate-dictionary/docs/reference/gdict/gdict-sections.txt b/mate-dictionary/docs/reference/gdict/gdict-sections.txt new file mode 100644 index 00000000..51adbf41 --- /dev/null +++ b/mate-dictionary/docs/reference/gdict/gdict-sections.txt @@ -0,0 +1,336 @@ +
+gdict-client-context +GdictClientContext +GdictClientContext +GdictClientContextClass +GdictClientContextError +gdict_client_context_new +gdict_client_context_set_hostname +gdict_client_context_get_hostname +gdict_client_context_set_port +gdict_client_context_get_port +gdict_client_context_set_client +gdict_client_context_get_client + +GdictContext +GDICT_CLIENT_CONTEXT +GDICT_IS_CLIENT_CONTEXT +GDICT_TYPE_CLIENT_CONTEXT +gdict_client_context_get_type +GDICT_CLIENT_CONTEXT_CLASS +GDICT_CLIENT_CONTEXT_GET_CLASS +GDICT_CLIENT_CONTEXT_ERROR +gdict_client_context_error_quark + +GdictClientContextPrivate +
+ +
+gdict-context +GdictContext +GdictContextIface +GdictContextError +gdict_context_set_local_only +gdict_context_get_local_only +gdict_context_lookup_databases +gdict_context_lookup_strategies +gdict_context_match_word +gdict_context_define_word + +GdictDatabase +gdict_database_ref +gdict_database_unref +gdict_database_get_name +gdict_database_get_full_name + +GdictStrategy +gdict_strategy_ref +gdict_strategy_unref +gdict_strategy_get_name +gdict_strategy_get_description + +GdictMatch +gdict_match_ref +gdict_match_unref +gdict_match_get_word +gdict_match_get_database + +GdictDefinition +gdict_definition_ref +gdict_definition_unref +gdict_definition_get_total +gdict_definition_get_word +gdict_definition_get_database +gdict_definition_get_text + +GDICT_TYPE_DATABASE +GDICT_TYPE_STRATEGY +GDICT_TYPE_MATCH +GDICT_TYPE_DEFINITION +GDICT_CONTEXT +GDICT_IS_CONTEXT +GDICT_TYPE_CONTEXT +gdict_context_get_type +gdict_database_get_type +gdict_definition_get_type +gdict_match_get_type +gdict_strategy_get_type +GDICT_CONTEXT_GET_IFACE +GDICT_CONTEXT_ERROR +gdict_context_error_quark +
+ +
+gdict-database-chooser +GdictDatabaseChooser +GdictDatabaseChooser +GdictDatabaseChooserClass +gdict_database_chooser_new +gdict_database_chooser_new_with_context +gdict_database_chooser_get_context +gdict_database_chooser_set_context +gdict_database_chooser_get_databases +gdict_database_chooser_count_databases +gdict_database_chooser_has_database +gdict_database_chooser_refresh +gdict_database_chooser_clear +gdict_database_chooser_add_button +gdict_database_chooser_get_current_database +gdict_database_chooser_select_database +gdict_database_chooser_set_current_database +gdict_database_chooser_unselect_database + +GDICT_DATABASE_CHOOSER +GDICT_IS_DATABASE_CHOOSER +GDICT_TYPE_DATABASE_CHOOSER +gdict_database_chooser_get_type +GDICT_DATABASE_CHOOSER_CLASS +GDICT_IS_DATABASE_CHOOSER_CLASS +GDICT_DATABASE_CHOOSER_GET_CLASS + +GdictDatabaseChooserPrivate +
+ +
+gdict-defbox +GdictDefbox +GdictDefbox +GdictDefboxClass +gdict_defbox_new +gdict_defbox_new_with_context +gdict_defbox_set_context +gdict_defbox_get_context +gdict_defbox_set_database +gdict_defbox_get_database +gdict_defbox_get_text +gdict_defbox_select_all +gdict_defbox_copy_to_clipboard +gdict_defbox_clear +gdict_defbox_lookup +gdict_defbox_get_word +gdict_defbox_count_definitions +gdict_defbox_jump_to_definition +gdict_defbox_set_show_find +gdict_defbox_get_show_find +gdict_defbox_find_next +gdict_defbox_find_previous +gdict_defbox_set_font_name +gdict_defbox_get_font_name +gdict_defbox_get_selected_word + +GDICT_DEFBOX +GDICT_IS_DEFBOX +GDICT_TYPE_DEFBOX +gdict_defbox_get_type +GDICT_DEFBOX_CLASS +GDICT_IS_DEFBOX_CLASS +GDICT_DEFBOX_GET_CLASS + +GdictDefboxPrivate +
+ +
+gdict-source-loader +GdictSourceLoader +GdictSourceLoader +GdictSourceLoaderClass +gdict_source_loader_new +gdict_source_loader_update +gdict_source_loader_add_search_path +gdict_source_loader_get_paths +gdict_source_loader_get_names +gdict_source_loader_get_sources +gdict_source_loader_get_source +gdict_source_loader_remove_source +gdict_source_loader_has_source + +GDICT_SOURCE_LOADER +GDICT_IS_SOURCE_LOADER +GDICT_TYPE_SOURCE_LOADER +gdict_source_loader_get_type +GDICT_SOURCE_LOADER_CLASS +GDICT_IS_SOURCE_LOADER_CLASS +GDICT_SOURCE_LOADER_GET_CLASS + +GdictSourceLoaderPrivate +
+ +
+gdict-source +GdictSource +GdictSourceError +GdictSource +GdictSourceClass +gdict_source_new +gdict_source_load_from_file +gdict_source_load_from_data +gdict_source_to_data +gdict_source_set_name +gdict_source_get_name +gdict_source_set_description +gdict_source_get_description +gdict_source_set_database +gdict_source_get_database +gdict_source_set_strategy +gdict_source_get_strategy +GdictSourceTransport +gdict_source_set_transport +gdict_source_set_transportv +gdict_source_get_transport +gdict_source_get_context +gdict_source_peek_context + +GDICT_SOURCE +GDICT_IS_SOURCE +GDICT_TYPE_SOURCE +gdict_source_get_type +GDICT_SOURCE_CLASS +GDICT_IS_SOURCE_CLASS +GDICT_SOURCE_GET_CLASS +GDICT_SOURCE_ERROR +gdict_source_error_quark + +GdictSourcePrivate +
+ +
+gdict-speller +GdictSpeller +GdictSpeller +GdictSpellerClass +gdict_speller_new +gdict_speller_new_with_context +gdict_speller_set_context +gdict_speller_get_context +gdict_speller_set_database +gdict_speller_get_database +gdict_speller_set_strategy +gdict_speller_get_strategy +gdict_speller_clear +gdict_speller_match +gdict_speller_count_matches +gdict_speller_get_matches + +GDICT_SPELLER +GDICT_IS_SPELLER +GDICT_TYPE_SPELLER +gdict_speller_get_type +GDICT_SPELLER_CLASS +GDICT_IS_SPELLER_CLASS +GDICT_SPELLER_GET_CLASS + +GdictSpellerPrivate +
+ +
+gdict-strategy-chooser +GdictStrategyChooser +GdictStrategyChooser +GdictStrategyChooserClass +gdict_strategy_chooser_new +gdict_strategy_chooser_new_with_context +gdict_strategy_chooser_get_context +gdict_strategy_chooser_set_context +gdict_strategy_chooser_get_strategies +gdict_strategy_chooser_has_strategy +gdict_strategy_chooser_add_button +gdict_strategy_chooser_clear +gdict_strategy_chooser_count_strategies +gdict_strategy_chooser_get_current_strategy +gdict_strategy_chooser_refresh +gdict_strategy_chooser_select_strategy +gdict_strategy_chooser_set_current_strategy +gdict_strategy_chooser_unselect_strategy + +GDICT_STRATEGY_CHOOSER +GDICT_IS_STRATEGY_CHOOSER +GDICT_TYPE_STRATEGY_CHOOSER +gdict_strategy_chooser_get_type +GDICT_STRATEGY_CHOOSER_CLASS +GDICT_IS_STRATEGY_CHOOSER_CLASS +GDICT_STRATEGY_CHOOSER_GET_CLASS + +GdictStrategyChooserPrivate +
+ +
+gdict-source-chooser +GdictSourceChooser +GdictSourceChooser +GdictSourceChooserClass +gdict_source_chooser_new +gdict_source_chooser_new_with_loader +gdict_source_chooser_get_loader +gdict_source_chooser_set_loader +gdict_source_chooser_get_sources +gdict_source_chooser_count_sources +gdict_source_chooser_has_source +gdict_source_chooser_refresh +gdict_source_chooser_select_source +gdict_source_chooser_unselect_source +gdict_source_chooser_get_current_source +gdict_source_chooser_set_current_source +gdict_source_chooser_add_button + +GDICT_SOURCE_CHOOSER +GDICT_SOURCE_CHOOSER_CLASS +GDICT_SOURCE_CHOOSER_GET_CLASS +GDICT_TYPE_SOURCE_CHOOSER +GDICT_IS_SOURCE_CHOOSER +GDICT_IS_SOURCE_CHOOSER_CLASS +gdict_source_chooser_get_type + +GdictSourceChooserPrivate +
+ +
+gdict-utils +Gdict Utilities +GDICT_DEFAULT_DATABASE +GDICT_DEFAULT_STRATEGY +GDICT_DEFAULT_FONT_NAME +GdictContextProp +GdictStatusCode +gdict_debug_init +gdict_get_option_group + +GDICT_IS_VALID_STATUS_CODE +
+ +
+gdict-version +Gdict Version Checking +GDICT_MAJOR_VERSION +GDICT_MINOR_VERSION +GDICT_MICRO_VERSION +GDICT_VERSION +GDICT_VERSION_S +GDICT_VERSION_HEX +GDICT_CHECK_VERSION + +gdict_major +gdict_minor +gdict_micro +gdict_check_version +
+ diff --git a/mate-dictionary/docs/reference/gdict/gdict.types b/mate-dictionary/docs/reference/gdict/gdict.types new file mode 100644 index 00000000..aa5a3f92 --- /dev/null +++ b/mate-dictionary/docs/reference/gdict/gdict.types @@ -0,0 +1,9 @@ +gdict_client_context_get_type +gdict_context_get_type +gdict_database_chooser_get_type +gdict_defbox_get_type +gdict_source_get_type +gdict_source_chooser_get_type +gdict_source_loader_get_type +gdict_speller_get_type +gdict_strategy_chooser_get_type 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 @@ + +GdictClientContext + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +@gdictclientcontext: the object which received the signal. + + + + + + +@gdictclientcontext: the object which received the signal. + + + + + + + + + + + + + + + + + + + + + + + + + + +@connected: +@disconnected: + + + + + + +@GDICT_CLIENT_CONTEXT_ERROR_SOCKET: +@GDICT_CLIENT_CONTEXT_ERROR_LOOKUP: +@GDICT_CLIENT_CONTEXT_ERROR_NO_CONNECTION: +@GDICT_CLIENT_CONTEXT_ERROR_SERVER_DOWN: + + + + + + +@hostname: +@port: +@Returns: + + + + + + + +@context: +@hostname: + + + + + + + +@context: +@Returns: + + + + + + + +@context: +@port: + + + + + + + +@context: +@Returns: + + + + + + + +@context: +@client: + + + + + + + +@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 @@ + +GdictContext + + + + + + + + + + + + + + + + + + + + + + + + + + + +@get_databases: +@get_strategies: +@match_word: +@define_word: +@lookup_start: +@lookup_end: +@database_found: +@strategy_found: +@match_found: +@definition_found: +@error: + + + + + + +@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: + + + + + + +@context: +@local_only: + + + + + + + +@context: +@Returns: + + + + + + + +@context: +@error: +@Returns: + + + + + + + +@context: +@error: +@Returns: + + + + + + + +@context: +@database: +@strategy: +@word: +@error: +@Returns: + + + + + + + +@context: +@database: +@word: +@error: +@Returns: + + + + + + + + + + + + + +@db: +@Returns: + + + + + + + +@db: + + + + + + + +@db: +@Returns: + + + + + + + +@db: +@Returns: + + + + + + + + + + + + + +@strat: +@Returns: + + + + + + + +@strat: + + + + + + + +@strat: +@Returns: + + + + + + + +@strat: +@Returns: + + + + + + + + + + + + + +@match: +@Returns: + + + + + + + +@match: + + + + + + + +@match: +@Returns: + + + + + + + +@match: +@Returns: + + + + + + + + + + + + + +@def: +@Returns: + + + + + + + +@def: + + + + + + + +@def: +@Returns: + + + + + + + +@def: +@Returns: + + + + + + + +@def: +@Returns: + + + + + + + +@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 @@ + +GdictDatabaseChooser + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +@gdictdatabasechooser: the object which received the signal. +@arg1: +@arg2: + + + + + + +@gdictdatabasechooser: the object which received the signal. + + + + + + + + + + + + + + + + +@database_activated: +@selection_changed: + + + + + + +@void: +@Returns: + + + + + + + +@context: +@Returns: + + + + + + + +@chooser: +@Returns: + + + + + + + +@chooser: +@context: + + + + + + + +@chooser: +@length: +@Returns: + + + + + + + +@chooser: +@Returns: + + + + + + + +@chooser: +@database: +@Returns: + + + + + + + +@chooser: + + + + + + + +@chooser: + + + + + + + +@chooser: +@button_text: +@Returns: + + + + + + + +@chooser: +@Returns: + + + + + + + +@chooser: +@db_name: +@Returns: + + + + + + + +@chooser: +@db_name: +@Returns: + + + + + + + +@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 @@ + +GdictDefbox + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +@gdictdefbox: the object which received the signal. + + + + + + +@gdictdefbox: the object which received the signal. + + + + + + +@gdictdefbox: the object which received the signal. + + + + + + +@gdictdefbox: the object which received the signal. +@arg1: + + + + + + +@gdictdefbox: the object which received the signal. + + + + + + + + + + + + + + + + + + + + + + + + + + +@parent_class: +@show_find: +@hide_find: +@find_previous: +@find_next: +@link_clicked: +@_gdict_defbox_1: +@_gdict_defbox_2: +@_gdict_defbox_3: +@_gdict_defbox_4: + + + + + + +@void: +@Returns: + + + + + + + +@context: +@Returns: + + + + + + + +@defbox: +@context: + + + + + + + +@defbox: +@Returns: + + + + + + + +@defbox: +@database: + + + + + + + +@defbox: +@Returns: + + + + + + + +@defbox: +@length: +@Returns: + + + + + + + +@defbox: + + + + + + + +@defbox: +@clipboard: + + + + + + + +@defbox: + + + + + + + +@defbox: +@word: + + + + + + + +@defbox: +@Returns: + + + + + + + +@defbox: +@Returns: + + + + + + + +@defbox: +@number: + + + + + + + +@defbox: +@show_find: + + + + + + + +@defbox: +@Returns: + + + + + + + +@defbox: + + + + + + + +@defbox: + + + + + + + +@defbox: +@font_name: + + + + + + + +@defbox: +@Returns: + + + + + + + +@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 @@ + +GdictSourceChooser + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +@gdictsourcechooser: the object which received the signal. + + + + + + +@gdictsourcechooser: the object which received the signal. +@arg1: +@arg2: + + + + + + + + + + + + + + + + +@source_activated: +@selection_changed: + + + + + + +@void: +@Returns: + + + + + + + +@loader: +@Returns: + + + + + + + +@chooser: +@Returns: + + + + + + + +@chooser: +@loader: + + + + + + + +@chooser: +@length: +@Returns: + + + + + + + +@chooser: +@Returns: + + + + + + + +@chooser: +@source_name: +@Returns: + + + + + + + +@chooser: + + + + + + + +@chooser: +@source_name: +@Returns: + + + + + + + +@chooser: +@source_name: +@Returns: + + + + + + + +@chooser: +@Returns: + + + + + + + +@chooser: +@source_name: +@Returns: + + + + + + + +@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 @@ + +GdictSourceLoader + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +@gdictsourceloader: the object which received the signal. +@arg1: + + + + + + + + + + + + + + + + +@parent_class: +@source_loaded: +@_gdict_source_1: +@_gdict_source_2: +@_gdict_source_3: +@_gdict_source_4: + + + + + + +@void: +@Returns: + + + + + + + +@loader: + + + + + + + +@loader: +@path: + + + + + + + +@loader: +@Returns: + + + + + + + +@loader: +@length: +@Returns: + + + + + + + +@loader: +@Returns: + + + + + + + +@loader: +@name: +@Returns: + + + + + + + +@loader: +@name: +@Returns: + + + + + + + +@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 @@ + +GdictSource + + + + + + + + + + + + + + + + + + + + + + + + + + + +@GDICT_SOURCE_ERROR_PARSE: +@GDICT_SOURCE_ERROR_INVALID_NAME: +@GDICT_SOURCE_ERROR_INVALID_TRANSPORT: +@GDICT_SOURCE_ERROR_INVALID_BAD_PARAMETER: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +@void: +@Returns: + + + + + + + +@source: +@filename: +@error: +@Returns: + + + + + + + +@source: +@data: +@length: +@error: +@Returns: + + + + + + + +@source: +@length: +@error: +@Returns: + + + + + + + +@source: +@name: + + + + + + + +@source: +@Returns: + + + + + + + +@source: +@description: + + + + + + + +@source: +@Returns: + + + + + + + +@source: +@database: + + + + + + + +@source: +@Returns: + + + + + + + +@source: +@strategy: + + + + + + + +@source: +@Returns: + + + + + + + +@GDICT_SOURCE_TRANSPORT_DICTD: +@GDICT_SOURCE_TRANSPORT_INVALID: + + + + + + +@source: +@transport: +@first_transport_property: +@Varargs: + + + + + + + +@source: +@transport: +@first_transport_property: +@var_args: + + + + + + + +@source: +@Returns: + + + + + + + +@source: +@Returns: + + + + + + + +@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 @@ + +GdictSpeller + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +@gdictspeller: the object which received the signal. +@arg1: +@arg2: + + + + + + + + + + + + + + + + + + + + + +@parent_class: +@word_activated: +@_gdict_speller_1: +@_gdict_speller_2: +@_gdict_speller_3: +@_gdict_speller_4: + + + + + + +@void: +@Returns: + + + + + + + +@context: +@Returns: + + + + + + + +@speller: +@context: + + + + + + + +@speller: +@Returns: + + + + + + + +@speller: +@database: + + + + + + + +@speller: +@Returns: + + + + + + + +@speller: +@strategy: + + + + + + + +@speller: +@Returns: + + + + + + + +@speller: + + + + + + + +@speller: +@word: + + + + + + + +@speller: +@Returns: + + + + + + + +@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 @@ + +GdictStrategyChooser + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +@gdictstrategychooser: the object which received the signal. +@arg1: +@arg2: + + + + + + + + + + + +@parent_class: +@strategy_activated: +@_gdict_padding1: +@_gdict_padding2: +@_gdict_padding3: +@_gdict_padding4: +@_gdict_padding5: +@_gdict_padding6: + + + + + + +@void: +@Returns: + + + + + + + +@context: +@Returns: + + + + + + + +@chooser: +@Returns: + + + + + + + +@chooser: +@context: + + + + + + + +@chooser: +@length: +@Returns: + + + + + + + +@chooser: +@strategy: +@Returns: + + + + + + + +@chooser: +@button_text: +@Returns: + + + + + + + +@chooser: + + + + + + + +@chooser: +@Returns: + + + + + + + +@chooser: +@Returns: + + + + + + + +@chooser: + + + + + + + +@chooser: +@strat_name: +@Returns: + + + + + + + +@chooser: +@strat_name: +@Returns: + + + + + + + +@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 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 @@ + +Gdict Utilities + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +@GDICT_CONTEXT_PROP_FIRST: +@GDICT_CONTEXT_PROP_LOCAL_ONLY: +@GDICT_CONTEXT_PROP_LAST: + + + + + + +@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: + + + + + + +@argc: +@argv: + + + + + + + +@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 @@ + +Gdict Version Checking + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +@major: +@minor: +@micro: + + + + + + + + + + + + + + + + + + + + + + + + + +@required_major: +@required_minor: +@required_micro: +@Returns: + + diff --git a/mate-dictionary/docs/reference/gdict/version.xml.in b/mate-dictionary/docs/reference/gdict/version.xml.in new file mode 100644 index 00000000..181a09ca --- /dev/null +++ b/mate-dictionary/docs/reference/gdict/version.xml.in @@ -0,0 +1 @@ +@GDICT_VERSION@ diff --git a/mate-dictionary/docs/source-configuration.txt b/mate-dictionary/docs/source-configuration.txt new file mode 100644 index 00000000..3b815cae --- /dev/null +++ b/mate-dictionary/docs/source-configuration.txt @@ -0,0 +1,65 @@ +Thoughts on Source Configuration +================================ + +Since there has been a request for multiple back-end support inside MATE +Dictionary, and since Gdict makes the addition of such back-ends a possibility, +we need a way to configure these back-ends. + +My plan is to use .desktop files in a standard location, such as +/usr/share/mate-dictionary and $HOME/.mate2/mate-dictionary. By dropping a +correctly-formatted .desktop file inside these locations, you can enable a new +dictionary source inside MATE Dictionary. + +* Syntax +======== + +** General keys +=============== + +A .desktop file is parsable using the GKeyFile class of GLib. Please remember +that a .desktop file is case sensitive. A standard .desktop file for +Dictionary must have the "Dictionary" group; only this group should be parsed, +and other groups should be ignored. + +The mandatory name of the dictionary source is specified by the "Name" key; +it may be localized. + +An optional description of the dictionary source is specified by the +"Description" key; also this may be localized. + +The type of back-end to use is specified by the mandatory "Transport" key; at +this moment, only the "dictd" value is permitted. + +An optional default database to be used with the dictionary source is specified +by the "Database" key; if no default database is specified, assume the default +database for the transport. + +An option default match strategy to be used with the dictionary source is +specified by the "Strategy" key; if no default strategy is specified, assume +the default strategy for the transport. + +** Transport-specific keys +========================== + +These are the keys defined for the "dictd" transport: + +"Hostname" [mandatory] + holds the hostname of the dictionary server to connect to; + +"Port" [optional] + holds the port of the dictionary server to connect to; if omitted, + the default port should be used. + +** Example +========== + +Dictionary source for dict.org: + + [Dictionary] + _Name: Default + _Description: Default dictionary server + Transport: dictd + Hostname: dict.org + Port: 2628 + +$ Last updated: 2005-12-07 19:00 (+0100) ebassi $ -- cgit v1.2.1