X-Git-Url: http://pileus.org/git/?a=blobdiff_plain;f=gtk%2Fgtkbuildable.h;h=f9809a1936bef5b4b9f3a48bc5bcd89ea62eda32;hb=0ba92bc26d1b716f2f9c0543593f13cd5a92c521;hp=ee18fe8db5402487fa2ae44352fefdab627df71b;hpb=d5dca93c58112e1966d22430d1612e87a7334fff;p=~andy%2Fgtk

diff --git a/gtk/gtkbuildable.h b/gtk/gtkbuildable.h
index ee18fe8db..f9809a193 100644
--- a/gtk/gtkbuildable.h
+++ b/gtk/gtkbuildable.h
@@ -13,17 +13,17 @@
  * Library General Public License for more details.
  *
  * You should have received a copy of the GNU Library General Public
- * License along with this library; if not, write to the
- * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
- * Boston, MA 02111-1307, USA.
+ * License along with this library. If not, see <http://www.gnu.org/licenses/>.
  */
 
 #ifndef __GTK_BUILDABLE_H__
 #define __GTK_BUILDABLE_H__
 
-#include <glib.h>
+#if !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
+#error "Only <gtk/gtk.h> can be included directly."
+#endif
+
 #include <gtk/gtkbuilder.h>
-#include <gtk/gtktypeutils.h>
 
 G_BEGIN_DECLS
 
@@ -33,9 +33,59 @@ G_BEGIN_DECLS
 #define GTK_IS_BUILDABLE(obj)         (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_BUILDABLE))
 #define GTK_BUILDABLE_GET_IFACE(obj)  (G_TYPE_INSTANCE_GET_INTERFACE ((obj), GTK_TYPE_BUILDABLE, GtkBuildableIface))
 
+
 typedef struct _GtkBuildable      GtkBuildable; /* Dummy typedef */
 typedef struct _GtkBuildableIface GtkBuildableIface;
 
+/**
+ * GtkBuildableIface:
+ * @g_iface: the parent class
+ * @set_name: Stores the name attribute given in the GtkBuilder UI definition.
+ *  #GtkWidget stores the name as object data. Implement this method if your
+ *  object has some notion of "name" and it makes sense to map the XML name
+ *  attribute to it.
+ * @get_name: The getter corresponding to @set_name. Implement this
+ *  if you implement @set_name.
+ * @add_child: Adds a child. The @type parameter can be used to
+ *  differentiate the kind of child. #GtkContainer implements this
+ *  to add add a child widget to the container, #GtkNotebook uses
+ *  the @type to distinguish between page labels (of type "page-label")
+ *  and normal children.
+ * @set_buildable_property: Sets a property of a buildable object.
+ *  It is normally not necessary to implement this, g_object_set_property()
+ *  is used by default. #GtkWindow implements this to delay showing itself
+ *  (i.e. setting the #GtkWidget:visible property) until the whole interface
+ *  is created.
+ * @construct_child: Constructs a child of a buildable that has been
+ *  specified as "constructor" in the UI definition. #GtkUIManager implements
+ *  this to reference to a widget created in a &lt;ui&gt; tag which is outside
+ *  of the normal GtkBuilder UI definition hierarchy.  A reference to the
+ *  constructed object is returned and becomes owned by the caller.
+ * @custom_tag_start: Implement this if the buildable needs to parse
+ *  content below &lt;child&gt;. To handle an element, the implementation
+ *  must fill in the @parser structure and @user_data and return %TRUE.
+ *  #GtkWidget implements this to parse keyboard accelerators specified
+ *  in &lt;accelerator&gt; elements. #GtkContainer implements it to map
+ *  properties defined via &lt;packing&gt; elements to child properties.
+ *  Note that @user_data must be freed in @custom_tag_end or @custom_finished.
+ * @custom_tag_end: Called for the end tag of each custom element that is
+ *  handled by the buildable (see @custom_tag_start).
+ * @custom_finished: Called for each custom tag handled by the buildable
+ *  when the builder finishes parsing (see @custom_tag_start)
+ * @parser_finished: Called when a builder finishes the parsing
+ *  of a UI definition. It is normally not necessary to implement this,
+ *  unless you need to perform special cleanup actions. #GtkWindow sets
+ *  the #GtkWidget:visible property here.
+ * @get_internal_child: Returns an internal child of a buildable.
+ *  #GtkDialog implements this to give access to its @vbox, making
+ *  it possible to add children to the vbox in a UI definition.
+ *  Implement this if the buildable has internal children that may
+ *  need to be accessed from a UI definition.
+ *
+ * The GtkBuildableIface interface contains method that are
+ * necessary to allow #GtkBuilder to construct an object from
+ * a GtkBuilder UI definition.
+ */
 struct _GtkBuildableIface
 {
   GTypeInterface g_iface;