summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorBrian Tarricone <brian@tarricone.org>2008-04-09 05:30:06 +0000
committerBrian Tarricone <brian@tarricone.org>2008-04-09 05:30:06 +0000
commitd932d6dfb450c2f795780757845fb3afb7730456 (patch)
tree2cfeeba65c29c6934dbba4f3d5c0518b476675f0 /docs
parenteb82448feb78c651a59d504c19dcde0ea5b2e227 (diff)
downloadxfconf-d932d6dfb450c2f795780757845fb3afb7730456.tar.gz
add first pass at xfconf-gtk convenience library
it only supports widgets that implement GtkEditable, but more to come soon (Old svn revision: 26803)
Diffstat (limited to 'docs')
-rw-r--r--docs/reference/Makefile.am5
-rw-r--r--docs/reference/tmpl/xfconf-gtk.sgml47
-rw-r--r--docs/reference/xfconf-docs.sgml5
-rw-r--r--docs/reference/xfconf-sections.txt6
4 files changed, 62 insertions, 1 deletions
diff --git a/docs/reference/Makefile.am b/docs/reference/Makefile.am
index 4ef8479..289fbc7 100644
--- a/docs/reference/Makefile.am
+++ b/docs/reference/Makefile.am
@@ -23,10 +23,12 @@ FIXXREF_OPTIONS=
# Used for dependencies
HFILE_GLOB = \
$(top_srcdir)/xfconf/*.h \
- $(top_srcdir)/xfconfd/*.h
+ $(top_srcdir)/xfconfd/*.h \
+ $(top_srcdir)/xfconf-gtk/*.h
CFILE_GLOB = \
$(top_srcdir)/xfconf/*.c \
$(top_srcdir)/xfconfd/*.c \
+ $(top_srcdir)/xfconf-gtk/*.c \
$(top_srcdir)/common/xfconf-errors.c
# Header files to ignore when scanning
@@ -62,6 +64,7 @@ INCLUDES = \
GTKDOC_LIBS = \
$(top_builddir)/xfconf/libxfconf-$(LIBXFCONF_VERSION_API).la \
+ $(top_builddir)/xfconf-gtk/libxfconf-gtk-$(LIBXFCONF_GTK_VERSION_API).la \
$(top_builddir)/xfconfd/xfconfd-xfconf-backend.o
include $(top_srcdir)/gtk-doc.make
diff --git a/docs/reference/tmpl/xfconf-gtk.sgml b/docs/reference/tmpl/xfconf-gtk.sgml
new file mode 100644
index 0000000..45e88e4
--- /dev/null
+++ b/docs/reference/tmpl/xfconf-gtk.sgml
@@ -0,0 +1,47 @@
+<!-- ##### SECTION Title ##### -->
+Xfconf-Gtk Library
+
+<!-- ##### SECTION Short_Description ##### -->
+Xfconf Gtk widget binding convenience library
+
+<!-- ##### SECTION Long_Description ##### -->
+<para>
+Often applications will have configuration dialogs that allow users
+to modify settings that are retrieved from and stored to an Xfconf
+configuration store. This library makes creating configuration dialogs
+a breeze by allowing developers to bind a normal Gtk widget (such as a
+GtkEntry or GtkSpinButton) to an Xfconf channel and property string.
+The Gtk widget is automatically populated with the current value in
+Xfconf, and if that value changes, the widget will be automatically
+updated. If the Gtk widget is editable and the user edits the value
+in the widget, the binding will also automatically set the new value
+in the Xfconf store.
+</para>
+
+<!-- ##### SECTION See_Also ##### -->
+<para>
+
+</para>
+
+<!-- ##### SECTION Stability_Level ##### -->
+
+
+<!-- ##### FUNCTION xfconf_gtk_widget_bind_property ##### -->
+<para>
+
+</para>
+
+@widget:
+@channel:
+@property:
+@property_type:
+
+
+<!-- ##### FUNCTION xfconf_gtk_widget_unbind ##### -->
+<para>
+
+</para>
+
+@widget:
+
+
diff --git a/docs/reference/xfconf-docs.sgml b/docs/reference/xfconf-docs.sgml
index 91ada57..afd3c77 100644
--- a/docs/reference/xfconf-docs.sgml
+++ b/docs/reference/xfconf-docs.sgml
@@ -22,4 +22,9 @@
<xi:include href="xml/xfconf.xml"/>
<xi:include href="xml/xfconf-channel.xml"/>
</chapter>
+
+ <chapter>
+ <title>Xfconf Gtk Convenience Library</title>
+ <xi:include href="xml/xfconf-gtk.xml"/>
+ </chapter>
</book>
diff --git a/docs/reference/xfconf-sections.txt b/docs/reference/xfconf-sections.txt
index cc48d23..01b8d10 100644
--- a/docs/reference/xfconf-sections.txt
+++ b/docs/reference/xfconf-sections.txt
@@ -83,3 +83,9 @@ xfconf_g_value_get_uint16
xfconf_g_value_set_int16
xfconf_g_value_set_uint16
</SECTION>
+
+<SECTION>
+<FILE>xfconf-gtk</FILE>
+xfconf_gtk_widget_bind_property
+xfconf_gtk_widget_unbind
+</SECTION>