summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorEmmanuele Bassi <ebassi@src.gnome.org>2005-12-16 17:11:41 +0000
committerEmmanuele Bassi <ebassi@src.gnome.org>2005-12-16 17:11:41 +0000
commitc30a188646ec2e97ca2dfbd3eedaad90d430bfe8 (patch)
treee309e8f98051c96e8d1a756e1f7d8d781ce8b213 /docs
parent534986269461b29337c38ba152f4f7111e20dd3c (diff)
downloadgnome-dictionary-c30a188646ec2e97ca2dfbd3eedaad90d430bfe8.tar.gz
Adding templates
Diffstat (limited to 'docs')
-rw-r--r--docs/reference/gdict/tmpl/gdict-client-context.sgml111
-rw-r--r--docs/reference/gdict/tmpl/gdict-defbox.sgml156
-rw-r--r--docs/reference/gdict/tmpl/gdict-source-loader.sgml98
-rw-r--r--docs/reference/gdict/tmpl/gdict-source.sgml188
4 files changed, 553 insertions, 0 deletions
diff --git a/docs/reference/gdict/tmpl/gdict-client-context.sgml b/docs/reference/gdict/tmpl/gdict-client-context.sgml
new file mode 100644
index 0000000..eb78913
--- /dev/null
+++ b/docs/reference/gdict/tmpl/gdict-client-context.sgml
@@ -0,0 +1,111 @@
+<!-- ##### SECTION Title ##### -->
+GdictClientContext
+
+<!-- ##### SECTION Short_Description ##### -->
+Dictionary context implementing a RFC2229 compliant client.
+
+<!-- ##### SECTION Long_Description ##### -->
+<para>
+#GdictClientContext is an implementation of the #GdictContext interface. It
+uses the Dictionary Protocol as defined by the RFC 2229 in order to connect to
+a dictionary server.
+</para>
+
+<para>
+You should rarely instantiate this object directely: use an appropriate
+#GdictSource instead.
+</para>
+
+<!-- ##### SECTION See_Also ##### -->
+<para>
+
+</para>
+
+<!-- ##### SECTION Stability_Level ##### -->
+
+
+<!-- ##### STRUCT GdictClientContext ##### -->
+<para>
+The #GdictClientContext struct contains private data only.
+</para>
+
+
+<!-- ##### ENUM GdictClientContextError ##### -->
+<para>
+These identify the various errors that can occur while calling
+#GdictClientContext functions.
+</para>
+
+@GDICT_CLIENT_CONTEXT_ERROR_SOCKET: Indicates an error occurred while accessing
+the communications socket.
+@GDICT_CLIENT_CONTEXT_ERROR_LOOKUP: Indicates an error occurred when looking up
+the dictionary server hostname.
+@GDICT_CLIENT_CONTEXT_ERROR_NO_CONNECTION: Indicates an error occurred while
+trying to establish the connection.
+@GDICT_CLIENT_CONTEXT_ERROR_SERVER_DOWN: Indicates that the server is
+unavailable at the moment.
+
+<!-- ##### FUNCTION gdict_client_context_new ##### -->
+<para>
+
+</para>
+
+@hostname:
+@port:
+@Returns:
+
+
+<!-- ##### FUNCTION gdict_client_context_get_client ##### -->
+<para>
+
+</para>
+
+@context:
+@Returns:
+
+
+<!-- ##### FUNCTION gdict_client_context_get_hostname ##### -->
+<para>
+
+</para>
+
+@context:
+@Returns:
+
+
+<!-- ##### FUNCTION gdict_client_context_get_port ##### -->
+<para>
+
+</para>
+
+@context:
+@Returns:
+
+
+<!-- ##### FUNCTION gdict_client_context_set_client ##### -->
+<para>
+
+</para>
+
+@context:
+@client:
+
+
+<!-- ##### FUNCTION gdict_client_context_set_hostname ##### -->
+<para>
+
+</para>
+
+@context:
+@hostname:
+
+
+<!-- ##### FUNCTION gdict_client_context_set_port ##### -->
+<para>
+
+</para>
+
+@context:
+@port:
+
+
diff --git a/docs/reference/gdict/tmpl/gdict-defbox.sgml b/docs/reference/gdict/tmpl/gdict-defbox.sgml
new file mode 100644
index 0000000..4c85f39
--- /dev/null
+++ b/docs/reference/gdict/tmpl/gdict-defbox.sgml
@@ -0,0 +1,156 @@
+<!-- ##### SECTION Title ##### -->
+GdictDefbox
+
+<!-- ##### SECTION Short_Description ##### -->
+
+
+<!-- ##### SECTION Long_Description ##### -->
+<para>
+
+</para>
+
+<!-- ##### SECTION See_Also ##### -->
+<para>
+
+</para>
+
+<!-- ##### SECTION Stability_Level ##### -->
+
+
+<!-- ##### STRUCT GdictDefbox ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### FUNCTION gdict_defbox_new ##### -->
+<para>
+
+</para>
+
+@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_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_count_definitions ##### -->
+<para>
+
+</para>
+
+@defbox:
+@Returns:
+
+
+<!-- ##### FUNCTION gdict_defbox_jump_to_definition ##### -->
+<para>
+
+</para>
+
+@defbox:
+@number:
+
+
+<!-- ##### FUNCTION gdict_defbox_get_show_find ##### -->
+<para>
+
+</para>
+
+@defbox:
+@Returns:
+
+
+<!-- ##### FUNCTION gdict_defbox_set_show_find ##### -->
+<para>
+
+</para>
+
+@defbox:
+@show_find:
+
+
+<!-- ##### FUNCTION gdict_defbox_find_next ##### -->
+<para>
+
+</para>
+
+@defbox:
+
+
+<!-- ##### FUNCTION gdict_defbox_find_previous ##### -->
+<para>
+
+</para>
+
+@defbox:
+
+
diff --git a/docs/reference/gdict/tmpl/gdict-source-loader.sgml b/docs/reference/gdict/tmpl/gdict-source-loader.sgml
new file mode 100644
index 0000000..4ba77c4
--- /dev/null
+++ b/docs/reference/gdict/tmpl/gdict-source-loader.sgml
@@ -0,0 +1,98 @@
+<!-- ##### SECTION Title ##### -->
+GdictSourceLoader
+
+<!-- ##### SECTION Short_Description ##### -->
+
+
+<!-- ##### SECTION Long_Description ##### -->
+<para>
+
+</para>
+
+<!-- ##### SECTION See_Also ##### -->
+<para>
+
+</para>
+
+<!-- ##### SECTION Stability_Level ##### -->
+
+
+<!-- ##### STRUCT GdictSourceLoader ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### FUNCTION gdict_source_loader_new ##### -->
+<para>
+
+</para>
+
+@Returns:
+
+
+<!-- ##### FUNCTION gdict_source_loader_add_search_path ##### -->
+<para>
+
+</para>
+
+@loader:
+@path:
+
+
+<!-- ##### FUNCTION gdict_source_loader_get_names ##### -->
+<para>
+
+</para>
+
+@loader:
+@length:
+@Returns:
+
+
+<!-- ##### FUNCTION gdict_source_loader_get_paths ##### -->
+<para>
+
+</para>
+
+@loader:
+@Returns:
+
+
+<!-- ##### FUNCTION gdict_source_loader_get_source ##### -->
+<para>
+
+</para>
+
+@loader:
+@name:
+@Returns:
+
+
+<!-- ##### FUNCTION gdict_source_loader_get_sources ##### -->
+<para>
+
+</para>
+
+@loader:
+@Returns:
+
+
+<!-- ##### FUNCTION gdict_source_loader_remove_source ##### -->
+<para>
+
+</para>
+
+@loader:
+@name:
+@Returns:
+
+
+<!-- ##### FUNCTION gdict_source_loader_update ##### -->
+<para>
+
+</para>
+
+@loader:
+
+
diff --git a/docs/reference/gdict/tmpl/gdict-source.sgml b/docs/reference/gdict/tmpl/gdict-source.sgml
new file mode 100644
index 0000000..b233201
--- /dev/null
+++ b/docs/reference/gdict/tmpl/gdict-source.sgml
@@ -0,0 +1,188 @@
+<!-- ##### SECTION Title ##### -->
+GdictSource
+
+<!-- ##### SECTION Short_Description ##### -->
+
+
+<!-- ##### SECTION Long_Description ##### -->
+<para>
+
+</para>
+
+<!-- ##### SECTION See_Also ##### -->
+<para>
+
+</para>
+
+<!-- ##### SECTION Stability_Level ##### -->
+
+
+<!-- ##### STRUCT GdictSource ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### FUNCTION gdict_source_new ##### -->
+<para>
+
+</para>
+
+@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_get_context ##### -->
+<para>
+
+</para>
+
+@source:
+@Returns:
+
+
+<!-- ##### FUNCTION gdict_source_get_database ##### -->
+<para>
+
+</para>
+
+@source:
+@Returns:
+
+
+<!-- ##### FUNCTION gdict_source_get_description ##### -->
+<para>
+
+</para>
+
+@source:
+@Returns:
+
+
+<!-- ##### FUNCTION gdict_source_get_name ##### -->
+<para>
+
+</para>
+
+@source:
+@Returns:
+
+
+<!-- ##### FUNCTION gdict_source_get_strategy ##### -->
+<para>
+
+</para>
+
+@source:
+@Returns:
+
+
+<!-- ##### FUNCTION gdict_source_get_transport ##### -->
+<para>
+
+</para>
+
+@source:
+@Returns:
+
+
+<!-- ##### FUNCTION gdict_source_peek_context ##### -->
+<para>
+
+</para>
+
+@source:
+@Returns:
+
+
+<!-- ##### FUNCTION gdict_source_set_database ##### -->
+<para>
+
+</para>
+
+@source:
+@database:
+
+
+<!-- ##### FUNCTION gdict_source_set_description ##### -->
+<para>
+
+</para>
+
+@source:
+@description:
+
+
+<!-- ##### FUNCTION gdict_source_set_name ##### -->
+<para>
+
+</para>
+
+@source:
+@name:
+
+
+<!-- ##### FUNCTION gdict_source_set_strategy ##### -->
+<para>
+
+</para>
+
+@source:
+@strategy:
+
+
+<!-- ##### 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:
+
+