summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorHavoc Pennington <hp@pobox.com>1999-11-15 22:29:51 +0000
committerHavoc Pennington <hp@src.gnome.org>1999-11-15 22:29:51 +0000
commitdbe4b062631b25bac10ba8fa426cda549f12668d (patch)
treee2610dee09bee28ce454ee2bdb3cf95aa8b1b2ee
parent8fd6d2b1d87cd6c3100a90c6e26dfd5250cea4f6 (diff)
downloadgconf-dbe4b062631b25bac10ba8fa426cda549f12668d.tar.gz
write GConfClient docs.
1999-11-15 Havoc Pennington <hp@pobox.com> * doc/gconf/tmpl/gconf-client.sgml: write GConfClient docs. * wrappers/gtk/gconf-client.c (gconf_client_new_with_engine): change this to increment the #GConfEngine reference count. * doc/gconf/gconf.sgml: Add GConfClient entity * doc/gconf/gconf-sections.txt: Add GConfClient stuff, add set_list and set_pair for GConfChangeSet * doc/gconf/gconf.types: New file gtk-doc requires * doc/gconf/Makefile.am (scan): Scan GConfClient as well. Uses a bad, probably nonportable hack, but this stuff isn't built by default anyway. * wrappers/Makefile.am: Build GConfClient if we have GNOME
-rw-r--r--ChangeLog20
-rw-r--r--doc/gconf/Makefile.am8
-rw-r--r--doc/gconf/gconf-sections.txt51
-rw-r--r--doc/gconf/gconf.sgml9
-rw-r--r--doc/gconf/gconf.types4
-rw-r--r--doc/gconf/tmpl/gconf-changeset.sgml49
-rw-r--r--doc/gconf/tmpl/gconf-engine.sgml2
-rw-r--r--doc/gconf/tmpl/gconf-error.sgml1
-rw-r--r--gconf/gconf-client.c3
-rw-r--r--gconf/gconf-client.h3
-rw-r--r--wrappers/Makefile.am8
-rw-r--r--wrappers/gtk/gconf-client.c3
-rw-r--r--wrappers/gtk/gconf-client.h3
13 files changed, 144 insertions, 20 deletions
diff --git a/ChangeLog b/ChangeLog
index 6bf65e7f..ea1a4dc6 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,5 +1,25 @@
1999-11-15 Havoc Pennington <hp@pobox.com>
+ * doc/gconf/tmpl/gconf-client.sgml: write GConfClient docs.
+
+ * wrappers/gtk/gconf-client.c (gconf_client_new_with_engine):
+ change this to increment the #GConfEngine reference count.
+
+ * doc/gconf/gconf.sgml: Add GConfClient entity
+
+ * doc/gconf/gconf-sections.txt: Add GConfClient stuff, add
+ set_list and set_pair for GConfChangeSet
+
+ * doc/gconf/gconf.types: New file gtk-doc requires
+
+ * doc/gconf/Makefile.am (scan): Scan GConfClient as well.
+ Uses a bad, probably nonportable hack, but this stuff isn't
+ built by default anyway.
+
+ * wrappers/Makefile.am: Build GConfClient if we have GNOME
+
+1999-11-15 Havoc Pennington <hp@pobox.com>
+
* gconf/gconf.c (gconf_get): Fix it to use the current
locale as documented.
diff --git a/doc/gconf/Makefile.am b/doc/gconf/Makefile.am
index c631fc39..aad6a588 100644
--- a/doc/gconf/Makefile.am
+++ b/doc/gconf/Makefile.am
@@ -9,8 +9,14 @@ DOC_MAIN_SGML_FILE=gconf.sgml
TARGET_DIR=$(HTML_DIR)/$(DOC_MODULE)
+# not sure this will work...
+LDFLAGS=$(ORBIT_LIBS) $(GNOME_LIBS) $(top_builddir)/wrappers/gtk/.libs/libgconf-gtk.a $(top_builddir)/gconf/.libs/libgconf.a
+
+CFLAGS=$(GMODULE_CFLAGS) $(ORBIT_CFLAGS) $(GNOME_CFLAGS) -I$(top_srcdir)/wrappers/gtk -I$(top_srcdir)
+
scan:
- gtkdoc-scan --module=$(DOC_MODULE) --source-dir=$(top_srcdir)/gconf
+ env CFLAGS="$(CFLAGS)" LDFLAGS="$(LDFLAGS)" gtkdoc-scanobj --module=$(DOC_MODULE)
+ gtkdoc-scan --module=$(DOC_MODULE) --source-dir=$(top_srcdir)
templates: scan
gtkdoc-mktmpl --module=$(DOC_MODULE)
diff --git a/doc/gconf/gconf-sections.txt b/doc/gconf/gconf-sections.txt
index b895ffcb..5f4e92d3 100644
--- a/doc/gconf/gconf-sections.txt
+++ b/doc/gconf/gconf-sections.txt
@@ -1,4 +1,53 @@
<SECTION>
+<FILE>gconf-client</FILE>
+GConfClientPreloadType
+GConfClientErrorHandlingMode
+GConfClientNotifyFunc
+GConfClientParentWindowFunc
+GCONF_CLIENT
+<TITLE>GConfClient</TITLE>
+gconf_client_new
+gconf_client_new_with_engine
+gconf_client_add_dir
+gconf_client_remove_dir
+gconf_client_notify_add
+gconf_client_notify_remove
+gconf_client_set_error_handling
+gconf_client_clear_cache
+gconf_client_preload
+gconf_client_set
+gconf_client_get
+gconf_client_unset
+gconf_client_all_entries
+gconf_client_all_dirs
+gconf_client_suggest_sync
+gconf_client_dir_exists
+gconf_client_get_float
+gconf_client_get_int
+gconf_client_get_string
+gconf_client_get_bool
+gconf_client_get_schema
+gconf_client_get_list
+gconf_client_get_pair
+gconf_client_set_float
+gconf_client_set_int
+gconf_client_set_string
+gconf_client_set_bool
+gconf_client_set_schema
+gconf_client_set_list
+gconf_client_set_pair
+gconf_client_error
+gconf_client_unreturned_error
+gconf_client_value_changed
+<SUBSECTION Standard>
+GCONF_TYPE_CLIENT
+GCONF_IS_CLIENT
+gconf_client_get_type
+GCONF_CLIENT_CLASS
+GCONF_IS_CLIENT_CLASS
+</SECTION>
+
+<SECTION>
<FILE>gconf-backend</FILE>
GConfBackendVTable
GConfBackend
@@ -238,5 +287,7 @@ gconf_change_set_set_int
gconf_change_set_set_string
gconf_change_set_set_bool
gconf_change_set_set_schema
+gconf_change_set_set_list
+gconf_change_set_set_pair
</SECTION>
diff --git a/doc/gconf/gconf.sgml b/doc/gconf/gconf.sgml
index a340f601..e6375863 100644
--- a/doc/gconf/gconf.sgml
+++ b/doc/gconf/gconf.sgml
@@ -1,4 +1,5 @@
<!DOCTYPE BOOK PUBLIC "-//Davenport//DTD DocBook V3.0//EN" [
+<!entity GConfClient SYSTEM "sgml/gconf-client.sgml">
<!entity gconf-gconf-backend SYSTEM "sgml/gconf-backend.sgml">
<!entity gconf-gconf-engine SYSTEM "sgml/gconf-engine.sgml">
<!entity gconf-gconf-error SYSTEM "sgml/gconf-error.sgml">
@@ -911,6 +912,14 @@ print_value(GConfValue* value)
</chapter>
+ <!-- GConfClient reference -->
+ <chapter id="gconf-client-reference">
+ <title><structname>GtkObject</structname> Wrapper Reference (<structname>GConfClient</structname>)</title>
+
+ &GConfClient;
+
+ </chapter>
+
<!-- GConf Internals Reference -->
<chapter id="gconf-internals-reference">
<title>GConf Internal Reference</title>
diff --git a/doc/gconf/gconf.types b/doc/gconf/gconf.types
new file mode 100644
index 00000000..d35a4f56
--- /dev/null
+++ b/doc/gconf/gconf.types
@@ -0,0 +1,4 @@
+#include <gtk/gtk.h>
+#include <gconf-client.h>
+
+gconf_client_get_type \ No newline at end of file
diff --git a/doc/gconf/tmpl/gconf-changeset.sgml b/doc/gconf/tmpl/gconf-changeset.sgml
index 4eae5294..6414d59f 100644
--- a/doc/gconf/tmpl/gconf-changeset.sgml
+++ b/doc/gconf/tmpl/gconf-changeset.sgml
@@ -37,6 +37,7 @@ An opaque data type representing a set of changes to be made.
A change set can contain "set" and "unset" operations.
</para>
+
<!-- ##### USER_FUNCTION GConfChangeSetForeachFunc ##### -->
<para>
The type of a function passed to gconf_change_set_foreach().
@@ -73,7 +74,7 @@ occurred will have been removed from the set. If any error occurs,
@conf: a #GConfEngine.
@cs: a #GConfChangeSet.
@remove_committed: whether to remove successfully-committed changes from the set
-@err: the return location for an allocated #GConfError, or <symbol>NULL</symbol> to ignore errors.
+@err: the return location for an allocated #GConfError, or <symbol>NULL</symbol> to ignore errors.
@Returns: <symbol>TRUE</symbol> on success, <symbol>FALSE</symbol> if an error occurs.
@@ -179,8 +180,8 @@ creating a #GConfValue.
</para>
@cs: a #GConfChangeSet.
-@key: the key to set.
-@val: the new value of @key.
+@key: the key to set.
+@val: the new value of @key.
<!-- ##### FUNCTION gconf_change_set_set_int ##### -->
@@ -190,8 +191,8 @@ creating a #GConfValue.
</para>
@cs: a #GConfChangeSet.
-@key: the key to set.
-@val: the new value of @key.
+@key: the key to set.
+@val: the new value of @key.
<!-- ##### FUNCTION gconf_change_set_set_string ##### -->
@@ -201,8 +202,8 @@ creating a #GConfValue.
</para>
@cs: a #GConfChangeSet.
-@key: the key to set.
-@val: the new value of @key.
+@key: the key to set.
+@val: the new value of @key.
<!-- ##### FUNCTION gconf_change_set_set_bool ##### -->
@@ -212,8 +213,8 @@ creating a #GConfValue.
</para>
@cs: a #GConfChangeSet.
-@key: the key to set.
-@val: the new value of @key.
+@key: the key to set.
+@val: the new value of @key.
<!-- ##### FUNCTION gconf_change_set_set_schema ##### -->
@@ -224,5 +225,31 @@ unmodified.
</para>
@cs: a #GConfChangeSet.
-@key: the key to set.
-@val: the new value of @key.
+@key: the key to set.
+@val: the new value of @key.
+
+
+<!-- ##### FUNCTION gconf_change_set_set_list ##### -->
+<para>
+
+</para>
+
+@cs:
+@key:
+@list_type:
+@list:
+
+
+<!-- ##### FUNCTION gconf_change_set_set_pair ##### -->
+<para>
+
+</para>
+
+@cs:
+@key:
+@car_type:
+@cdr_type:
+@address_of_car:
+@address_of_cdr:
+
+
diff --git a/doc/gconf/tmpl/gconf-engine.sgml b/doc/gconf/tmpl/gconf-engine.sgml
index 8df5380f..db8e3ad8 100644
--- a/doc/gconf/tmpl/gconf-engine.sgml
+++ b/doc/gconf/tmpl/gconf-engine.sgml
@@ -55,7 +55,7 @@ unreferenced by the caller of this function.
</para>
@address: a configuration source address.
-@err: the return location for an allocated #GConfError, or <symbol>NULL</symbol> to ignore errors.
+@err: the return location for an allocated #GConfError, or <symbol>NULL</symbol> to ignore errors.
@Returns: a new #GConfEngine.
diff --git a/doc/gconf/tmpl/gconf-error.sgml b/doc/gconf/tmpl/gconf-error.sgml
index 5022cd8d..69b8a19f 100644
--- a/doc/gconf/tmpl/gconf-error.sgml
+++ b/doc/gconf/tmpl/gconf-error.sgml
@@ -139,6 +139,7 @@ functions.
@err: a #GConfError to destroy.
+
<!-- ##### FUNCTION gconf_set_error ##### -->
<para>
Internal function.
diff --git a/gconf/gconf-client.c b/gconf/gconf-client.c
index 131068b8..a31e2b15 100644
--- a/gconf/gconf-client.c
+++ b/gconf/gconf-client.c
@@ -350,8 +350,9 @@ gconf_client_new_with_engine (GConfEngine* engine)
client = gtk_type_new (gconf_client_get_type ());
- /* take over a ref count */
client->engine = engine;
+
+ gconf_engine_ref(client->engine);
return client;
}
diff --git a/gconf/gconf-client.h b/gconf/gconf-client.h
index 311033a6..507b2ff1 100644
--- a/gconf/gconf-client.h
+++ b/gconf/gconf-client.h
@@ -144,8 +144,7 @@ GtkType gconf_client_get_type (void);
/* use the default engine */
GConfClient* gconf_client_new (void);
-/* specify an engine; you pass a reference count to the engine,
- i.e. the client now owns your reference. */
+/* refcount on engine is incremented, you still own your ref */
GConfClient* gconf_client_new_with_engine (GConfEngine* engine);
/* Add a directory to monitor and emit the value_changed signal and
diff --git a/wrappers/Makefile.am b/wrappers/Makefile.am
index 32e3156a..978e2f2b 100644
--- a/wrappers/Makefile.am
+++ b/wrappers/Makefile.am
@@ -4,5 +4,11 @@ else
GUILE_SUBDIRS=
endif
-SUBDIRS = $(GUILE_SUBDIRS)
+if GNOME
+GNOME_SUBDIRS=gtk
+else
+GNOME_SUBDIRS=
+endif
+
+SUBDIRS = $(GNOME_SUBDIRS) $(GUILE_SUBDIRS)
diff --git a/wrappers/gtk/gconf-client.c b/wrappers/gtk/gconf-client.c
index 131068b8..a31e2b15 100644
--- a/wrappers/gtk/gconf-client.c
+++ b/wrappers/gtk/gconf-client.c
@@ -350,8 +350,9 @@ gconf_client_new_with_engine (GConfEngine* engine)
client = gtk_type_new (gconf_client_get_type ());
- /* take over a ref count */
client->engine = engine;
+
+ gconf_engine_ref(client->engine);
return client;
}
diff --git a/wrappers/gtk/gconf-client.h b/wrappers/gtk/gconf-client.h
index 311033a6..507b2ff1 100644
--- a/wrappers/gtk/gconf-client.h
+++ b/wrappers/gtk/gconf-client.h
@@ -144,8 +144,7 @@ GtkType gconf_client_get_type (void);
/* use the default engine */
GConfClient* gconf_client_new (void);
-/* specify an engine; you pass a reference count to the engine,
- i.e. the client now owns your reference. */
+/* refcount on engine is incremented, you still own your ref */
GConfClient* gconf_client_new_with_engine (GConfEngine* engine);
/* Add a directory to monitor and emit the value_changed signal and