diff options
Diffstat (limited to 'docs')
-rw-r--r-- | docs/reference/Makefile.am | 5 | ||||
-rw-r--r-- | docs/reference/tmpl/xfconf-binding.sgml | 50 | ||||
-rw-r--r-- | docs/reference/tmpl/xfconf-gtk.sgml | 47 | ||||
-rw-r--r-- | docs/reference/xfconf-docs.sgml | 6 | ||||
-rw-r--r-- | docs/reference/xfconf-sections.txt | 6 |
5 files changed, 55 insertions, 59 deletions
diff --git a/docs/reference/Makefile.am b/docs/reference/Makefile.am index 289fbc7..4ef8479 100644 --- a/docs/reference/Makefile.am +++ b/docs/reference/Makefile.am @@ -23,12 +23,10 @@ FIXXREF_OPTIONS= # Used for dependencies HFILE_GLOB = \ $(top_srcdir)/xfconf/*.h \ - $(top_srcdir)/xfconfd/*.h \ - $(top_srcdir)/xfconf-gtk/*.h + $(top_srcdir)/xfconfd/*.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 @@ -64,7 +62,6 @@ 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-binding.sgml b/docs/reference/tmpl/xfconf-binding.sgml new file mode 100644 index 0000000..e7dba72 --- /dev/null +++ b/docs/reference/tmpl/xfconf-binding.sgml @@ -0,0 +1,50 @@ +<!-- ##### SECTION Title ##### --> +Xfconf-GObject Binding + +<!-- ##### SECTION Short_Description ##### --> +Functions to bind Xfconf properties to GObject properties + +<!-- ##### SECTION Long_Description ##### --> +<para> +Often it may be useful to bind an Xfconf property to a GObject property. +Settings dialogs often display the current value of an Xfconf property, +and a user may edit the value to change the value in the Xfconf store. +If the Xfconf property changes outside the settings dialog, the user will +usually want to see the settings dialog automatically update to reflect +the new value. + +With a single line of code, Xfconf's binding functionality can automate +all this. +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### FUNCTION xfconf_g_property_bind ##### --> +<para> + +</para> + +@channel: +@xfconf_property: +@xfconf_property_type: +@object: +@object_property: + + +<!-- ##### FUNCTION xfconf_g_property_unbind ##### --> +<para> + +</para> + +@channel: +@xfconf_property: +@object: +@object_property: + + diff --git a/docs/reference/tmpl/xfconf-gtk.sgml b/docs/reference/tmpl/xfconf-gtk.sgml deleted file mode 100644 index 298d3e6..0000000 --- a/docs/reference/tmpl/xfconf-gtk.sgml +++ /dev/null @@ -1,47 +0,0 @@ -<!-- ##### 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_editable_bind_property ##### --> -<para> - -</para> - -@editable: -@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 afd3c77..24be72f 100644 --- a/docs/reference/xfconf-docs.sgml +++ b/docs/reference/xfconf-docs.sgml @@ -21,10 +21,6 @@ <title>Xfconf Client Library</title> <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"/> + <xi:include href="xml/xfconf-binding.xml"/> </chapter> </book> diff --git a/docs/reference/xfconf-sections.txt b/docs/reference/xfconf-sections.txt index 7344342..4049e5e 100644 --- a/docs/reference/xfconf-sections.txt +++ b/docs/reference/xfconf-sections.txt @@ -85,7 +85,7 @@ xfconf_g_value_set_uint16 </SECTION> <SECTION> -<FILE>xfconf-gtk</FILE> -xfconf_gtk_editable_bind_property -xfconf_gtk_widget_unbind +<FILE>xfconf-binding</FILE> +xfconf_g_property_bind +xfconf_g_property_unbind </SECTION> |