Amending GtkBuildable documentation.

GtkBuildable documentation has forever stated that "only
objects which implement GtkBuildable can parsed by GtkBuilder" fixed.
This commit is contained in:
Tristan Van Berkom 2010-05-20 00:30:13 -04:00
parent 68701c828c
commit 80ee7f793a

View File

@ -23,17 +23,19 @@
* @Short_description: Interface for objects that can be built by GtkBuilder * @Short_description: Interface for objects that can be built by GtkBuilder
* @Title: GtkBuildable * @Title: GtkBuildable
* *
* In order to allow construction from a <link linkend="BUILDER-UI">GtkBuilder * GtkBuildable allows objects to extend and customize thier deserialization
* UI description</link>, an object class must implement the * from <link linkend="BUILDER-UI">GtkBuilder UI descriptions</link>.
* GtkBuildable interface. The interface includes methods for setting * The interface includes methods for setting names and properties of objects,
* names and properties of objects, parsing custom tags, constructing * parsing custom tags and constructing child objects.
* child objects.
* *
* The GtkBuildable interface is implemented by all widgets and * The GtkBuildable interface is implemented by all widgets and
* many of the non-widget objects that are provided by GTK+. The * many of the non-widget objects that are provided by GTK+. The
* main user of this interface is #GtkBuilder, there should be * main user of this interface is #GtkBuilder, there should be
* very little need for applications to call any * very little need for applications to call any
* <function>gtk_buildable_...</function> functions. * <function>gtk_buildable_...</function> functions.
*
* <note><para>An object only needs to implement this interface if it needs
* to extend the #GtkBuilder format or run any extra routines at deserialization time</para></note>
*/ */
#include "config.h" #include "config.h"