/* gtkbuildable.c * Copyright (C) 2006-2007 Async Open Source, * Johan Dahlin * * This library is free software; you can redistribute it and/or * modify it under the terms of the GNU Library General Public * License as published by the Free Software Foundation; either * version 2 of the License, or (at your option) any later version. * * This library is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * 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. */ /** * SECTION:gtkbuildable * @Short_description: Interface for objects that can be built by GtkBuilder * @Title: GtkBuildable * * In order to allow construction from a GtkBuilder * UI description, an object class must implement the * GtkBuildable interface. The interface includes methods for setting * names and properties of objects, parsing custom tags, constructing * child objects. * * The GtkBuildable interface is implemented by all widgets and * many of the non-widget objects that are provided by GTK+. The * main user of this interface is #GtkBuilder, there should be * very little need for applications to call any * gtk_buildable_... functions. */ #include "config.h" #include "gtkbuildable.h" #include "gtktypeutils.h" #include "gtkintl.h" #include "gtkalias.h" typedef GtkBuildableIface GtkBuildableInterface; G_DEFINE_INTERFACE (GtkBuildable, gtk_buildable, G_TYPE_OBJECT) static void gtk_buildable_default_init (GtkBuildableInterface *iface) { } /** * gtk_buildable_set_name: * @buildable: a #GtkBuildable * @name: name to set * * Sets the name of the @buildable object. * * Since: 2.12 **/ void gtk_buildable_set_name (GtkBuildable *buildable, const gchar *name) { GtkBuildableIface *iface; g_return_if_fail (GTK_IS_BUILDABLE (buildable)); g_return_if_fail (name != NULL); iface = GTK_BUILDABLE_GET_IFACE (buildable); if (iface->set_name) (* iface->set_name) (buildable, name); else g_object_set_data_full (G_OBJECT (buildable), "gtk-builder-name", g_strdup (name), g_free); } /** * gtk_buildable_get_name: * @buildable: a #GtkBuildable * * Gets the name of the @buildable object. * * #GtkBuilder sets the name based on the the * GtkBuilder UI definition * used to construct the @buildable. * * Returns: the name set with gtk_buildable_set_name() * * Since: 2.12 **/ const gchar * gtk_buildable_get_name (GtkBuildable *buildable) { GtkBuildableIface *iface; g_return_val_if_fail (GTK_IS_BUILDABLE (buildable), NULL); iface = GTK_BUILDABLE_GET_IFACE (buildable); if (iface->get_name) return (* iface->get_name) (buildable); else return (const gchar*)g_object_get_data (G_OBJECT (buildable), "gtk-builder-name"); } /** * gtk_buildable_add_child: * @buildable: a #GtkBuildable * @builder: a #GtkBuilder * @child: child to add * @type: (allow-none): kind of child or %NULL * * Adds a child to @buildable. @type is an optional string * describing how the child should be added. * * Since: 2.12 **/ void gtk_buildable_add_child (GtkBuildable *buildable, GtkBuilder *builder, GObject *child, const gchar *type) { GtkBuildableIface *iface; g_return_if_fail (GTK_IS_BUILDABLE (buildable)); g_return_if_fail (GTK_IS_BUILDER (builder)); iface = GTK_BUILDABLE_GET_IFACE (buildable); g_return_if_fail (iface->add_child != NULL); (* iface->add_child) (buildable, builder, child, type); } /** * gtk_buildable_set_buildable_property: * @buildable: a #GtkBuildable * @builder: a #GtkBuilder * @name: name of property * @value: value of property * * Sets the property name @name to @value on the @buildable object. * * Since: 2.12 **/ void gtk_buildable_set_buildable_property (GtkBuildable *buildable, GtkBuilder *builder, const gchar *name, const GValue *value) { GtkBuildableIface *iface; g_return_if_fail (GTK_IS_BUILDABLE (buildable)); g_return_if_fail (GTK_IS_BUILDER (builder)); g_return_if_fail (name != NULL); g_return_if_fail (value != NULL); iface = GTK_BUILDABLE_GET_IFACE (buildable); if (iface->set_buildable_property) (* iface->set_buildable_property) (buildable, builder, name, value); else g_object_set_property (G_OBJECT (buildable), name, value); } /** * gtk_buildable_parser_finished: * @buildable: a #GtkBuildable * @builder: a #GtkBuilder * * Called when the builder finishes the parsing of a * GtkBuilder UI definition. * Note that this will be called once for each time * gtk_builder_add_from_file() or gtk_builder_add_from_string() * is called on a builder. * * Since: 2.12 **/ void gtk_buildable_parser_finished (GtkBuildable *buildable, GtkBuilder *builder) { GtkBuildableIface *iface; g_return_if_fail (GTK_IS_BUILDABLE (buildable)); g_return_if_fail (GTK_IS_BUILDER (builder)); iface = GTK_BUILDABLE_GET_IFACE (buildable); if (iface->parser_finished) (* iface->parser_finished) (buildable, builder); } /** * gtk_buildable_construct_child: * @buildable: A #GtkBuildable * @builder: #GtkBuilder used to construct this object * @name: name of child to construct * * Constructs a child of @buildable with the name @name. * * #GtkBuilder calls this function if a "constructor" has been * specified in the UI definition. * * Returns: (transfer full): the constructed child * * Since: 2.12 **/ GObject * gtk_buildable_construct_child (GtkBuildable *buildable, GtkBuilder *builder, const gchar *name) { GtkBuildableIface *iface; g_return_val_if_fail (GTK_IS_BUILDABLE (buildable), NULL); g_return_val_if_fail (GTK_IS_BUILDER (builder), NULL); g_return_val_if_fail (name != NULL, NULL); iface = GTK_BUILDABLE_GET_IFACE (buildable); g_return_val_if_fail (iface->construct_child != NULL, NULL); return (* iface->construct_child) (buildable, builder, name); } /** * gtk_buildable_custom_tag_start: * @buildable: a #GtkBuildable * @builder: a #GtkBuilder used to construct this object * @child: (allow-none): child object or %NULL for non-child tags * @tagname: name of tag * @parser: a #GMarkupParser structure to fill in * @data: return location for user data that will be passed in * to parser functions * * This is called for each unknown element under <child>. * * Returns: %TRUE if a object has a custom implementation, %FALSE * if it doesn't. * * Since: 2.12 **/ gboolean gtk_buildable_custom_tag_start (GtkBuildable *buildable, GtkBuilder *builder, GObject *child, const gchar *tagname, GMarkupParser *parser, gpointer *data) { GtkBuildableIface *iface; g_return_val_if_fail (GTK_IS_BUILDABLE (buildable), FALSE); g_return_val_if_fail (GTK_IS_BUILDER (builder), FALSE); g_return_val_if_fail (tagname != NULL, FALSE); iface = GTK_BUILDABLE_GET_IFACE (buildable); g_return_val_if_fail (iface->custom_tag_start != NULL, FALSE); return (* iface->custom_tag_start) (buildable, builder, child, tagname, parser, data); } /** * gtk_buildable_custom_tag_end: * @buildable: A #GtkBuildable * @builder: #GtkBuilder used to construct this object * @child: (allow-none): child object or %NULL for non-child tags * @tagname: name of tag * @data: user data that will be passed in to parser functions * * This is called at the end of each custom element handled by * the buildable. * * Since: 2.12 **/ void gtk_buildable_custom_tag_end (GtkBuildable *buildable, GtkBuilder *builder, GObject *child, const gchar *tagname, gpointer *data) { GtkBuildableIface *iface; g_return_if_fail (GTK_IS_BUILDABLE (buildable)); g_return_if_fail (GTK_IS_BUILDER (builder)); g_return_if_fail (tagname != NULL); iface = GTK_BUILDABLE_GET_IFACE (buildable); if (iface->custom_tag_end) (* iface->custom_tag_end) (buildable, builder, child, tagname, data); } /** * gtk_buildable_custom_finished: * @buildable: a #GtkBuildable * @builder: a #GtkBuilder * @child: (allow-none): child object or %NULL for non-child tags * @tagname: the name of the tag * @data: user data created in custom_tag_start * * This is similar to gtk_buildable_parser_finished() but is * called once for each custom tag handled by the @buildable. * * Since: 2.12 **/ void gtk_buildable_custom_finished (GtkBuildable *buildable, GtkBuilder *builder, GObject *child, const gchar *tagname, gpointer data) { GtkBuildableIface *iface; g_return_if_fail (GTK_IS_BUILDABLE (buildable)); g_return_if_fail (GTK_IS_BUILDER (builder)); iface = GTK_BUILDABLE_GET_IFACE (buildable); if (iface->custom_finished) (* iface->custom_finished) (buildable, builder, child, tagname, data); } /** * gtk_buildable_get_internal_child: * @buildable: a #GtkBuildable * @builder: a #GtkBuilder * @childname: name of child * * Get the internal child called @childname of the @buildable object. * * Returns: (transfer none): the internal child of the buildable object * * Since: 2.12 **/ GObject * gtk_buildable_get_internal_child (GtkBuildable *buildable, GtkBuilder *builder, const gchar *childname) { GtkBuildableIface *iface; g_return_val_if_fail (GTK_IS_BUILDABLE (buildable), NULL); g_return_val_if_fail (GTK_IS_BUILDER (builder), NULL); g_return_val_if_fail (childname != NULL, NULL); iface = GTK_BUILDABLE_GET_IFACE (buildable); if (!iface->get_internal_child) return NULL; return (* iface->get_internal_child) (buildable, builder, childname); } #define __GTK_BUILDABLE_C__ #include "gtkaliasdef.c"