1 /* GTK - The GIMP Toolkit
2 * Copyright (C) 1998-2002 James Henstridge <james@daa.com.au>
3 * Copyright (C) 2006-2007 Async Open Source,
4 * Johan Dahlin <jdahlin@async.com.br>,
5 * Henrique Romano <henrique@async.com.br>
7 * This library is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU Library General Public
9 * License as published by the Free Software Foundation; either
10 * version 2 of the License, or (at your option) any later version.
12 * This library is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * Library General Public License for more details.
17 * You should have received a copy of the GNU Library General Public
18 * License along with this library; if not, write to the
19 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
20 * Boston, MA 02111-1307, USA.
25 * @Short_description: Build an interface from an XML UI definition
28 * A GtkBuilder is an auxiliary object that reads textual descriptions
29 * of a user interface and instantiates the described objects. To pass a
30 * description to a GtkBuilder, call gtk_builder_add_from_file() or
31 * gtk_builder_add_from_string(). These functions can be called multiple
32 * times; the builder merges the content of all descriptions.
34 * A GtkBuilder holds a reference to all objects that it has constructed
35 * and drops these references when it is finalized. This finalization can
36 * cause the destruction of non-widget objects or widgets which are not
37 * contained in a toplevel window. For toplevel windows constructed by a
38 * builder, it is the responsibility of the user to call gtk_widget_destroy()
39 * to get rid of them and all the widgets they contain.
41 * The functions gtk_builder_get_object() and gtk_builder_get_objects()
42 * can be used to access the widgets in the interface by the names assigned
43 * to them inside the UI description. Toplevel windows returned by these
44 * functions will stay around until the user explicitly destroys them
45 * with gtk_widget_destroy(). Other widgets will either be part of a
46 * larger hierarchy constructed by the builder (in which case you should
47 * not have to worry about their lifecycle), or without a parent, in which
48 * case they have to be added to some container to make use of them.
49 * Non-widget objects need to be reffed with g_object_ref() to keep them
50 * beyond the lifespan of the builder.
52 * The function gtk_builder_connect_signals() and variants thereof can be
53 * used to connect handlers to the named signals in the description.
55 * <refsect2 id="BUILDER-UI">
56 * <title>GtkBuilder UI Definitions</title>
58 * GtkBuilder parses textual descriptions of user interfaces which are specified
59 * in an XML format which can be roughly described by the DTD below. We refer to
60 * these descriptions as <firstterm>GtkBuilder UI definitions</firstterm> or
61 * just <firstterm>UI definitions</firstterm> if the context is clear. Do not
62 * confuse GtkBuilder UI Definitions with
63 * <link linkend="XML-UI">GtkUIManager UI Definitions</link>, which are more
66 * <programlisting><![CDATA[
67 * <!ELEMENT interface (requires|object)* >
68 * <!ELEMENT object (property|signal|child|ANY)* >
69 * <!ELEMENT property PCDATA >
70 * <!ELEMENT signal EMPTY >
71 * <!ELEMENT requires EMPTY >
72 * <!ELEMENT child (object|ANY*) >
74 * <!ATTLIST interface domain #IMPLIED >
75 * <!ATTLIST object id #REQUIRED
78 * constructor #IMPLIED >
79 * <!ATTLIST requires lib #REQUIRED
81 * <!ATTLIST property name #REQUIRED
82 * translatable #IMPLIED
85 * <!ATTLIST signal name #REQUIRED
90 * last_modification_time #IMPLIED >
91 * <!ATTLIST child type #IMPLIED
92 * internal-child #IMPLIED >
93 * ]]></programlisting>
95 * The toplevel element is <interface>. It optionally takes a "domain"
96 * attribute, which will make the builder look for translated strings using
97 * dgettext() in the domain specified. This can also be done by calling
98 * gtk_builder_set_translation_domain() on the builder. Objects are described by
99 * <object> elements, which can contain <property> elements to set
100 * properties, <signal> elements which connect signals to handlers, and
101 * <child> elements, which describe child objects (most often widgets
102 * inside a container, but also e.g. actions in an action group, or columns in a
103 * tree model). A <child> element contains an <object> element which
104 * describes the child object. The target toolkit version(s) are described by
105 * <requires> elements, the "lib" attribute specifies the widget library
106 * in question (currently the only supported value is "gtk+") and the "version"
107 * attribute specifies the target version in the form
108 * "<major>.<minor>". The builder will error out if the version
109 * requirements are not met.
111 * Typically, the specific kind of object represented by an <object>
112 * element is specified by the "class" attribute. If the type has not been
113 * loaded yet, GTK+ tries to find the <function>_get_type()</function> from the
114 * class name by applying heuristics. This works in most cases, but if
115 * necessary, it is possible to specify the name of the
116 * <function>_get_type()</function> explictly with the "type-func" attribute.
117 * As a special case, GtkBuilder allows to use an object that has been
118 * constructed by a #GtkUIManager in another part of the UI definition by
119 * specifying the id of the #GtkUIManager in the "constructor" attribute and the
120 * name of the object in the "id" attribute.
122 * Objects must be given a name with the "id" attribute, which allows the
123 * application to retrieve them from the builder with gtk_builder_get_object().
124 * An id is also necessary to use the object as property value in other parts of
128 * Prior to 2.20, GtkBuilder was setting the "name" property of constructed widgets to the
129 * "id" attribute. In GTK+ 2.20 or newer, you have to use gtk_buildable_get_name() instead
130 * of gtk_widget_get_name() to obtain the "id", or set the "name" property in your UI
134 * Setting properties of objects is pretty straightforward with the
135 * <property> element: the "name" attribute specifies the name of the
136 * property, and the content of the element specifies the value. If the
137 * "translatable" attribute is set to a true value, GTK+ uses gettext() (or
138 * dgettext() if the builder has a translation domain set) to find a translation
139 * for the value. This happens before the value is parsed, so it can be used for
140 * properties of any type, but it is probably most useful for string properties.
141 * It is also possible to specify a context to disambiguate short strings, and
142 * comments which may help the translators.
144 * GtkBuilder can parse textual representations for the most common property
145 * types: characters, strings, integers, floating-point numbers, booleans
146 * (strings like "TRUE", "t", "yes", "y", "1" are interpreted as %TRUE, strings
147 * like "FALSE, "f", "no", "n", "0" are interpreted as %FALSE), enumerations
148 * (can be specified by their name, nick or integer value), flags (can be
149 * specified by their name, nick, integer value, optionally combined with "|",
150 * e.g. "GTK_VISIBLE|GTK_REALIZED") and colors (in a format understood by
151 * gdk_color_parse()). Objects can be referred to by their name. Pixbufs can be
152 * specified as a filename of an image file to load. In general, GtkBuilder
153 * allows forward references to objects — an object doesn't have to be
154 * constructed before it can be referred to. The exception to this rule is that
155 * an object has to be constructed before it can be used as the value of a
156 * construct-only property.
158 * Signal handlers are set up with the <signal> element. The "name"
159 * attribute specifies the name of the signal, and the "handler" attribute
160 * specifies the function to connect to the signal. By default, GTK+ tries to
161 * find the handler using g_module_symbol(), but this can be changed by passing
162 * a custom #GtkBuilderConnectFunc to gtk_builder_connect_signals_full(). The
163 * remaining attributes, "after", "swapped" and "object", have the same meaning
164 * as the corresponding parameters of the g_signal_connect_object() or
165 * g_signal_connect_data() functions. A "last_modification_time" attribute
166 * is also allowed, but it does not have a meaning to the builder.
168 * Sometimes it is necessary to refer to widgets which have implicitly been
169 * constructed by GTK+ as part of a composite widget, to set properties on them
170 * or to add further children (e.g. the @vbox of a #GtkDialog). This can be
171 * achieved by setting the "internal-child" propery of the <child> element
172 * to a true value. Note that GtkBuilder still requires an <object>
173 * element for the internal child, even if it has already been constructed.
175 * A number of widgets have different places where a child can be added (e.g.
176 * tabs vs. page content in notebooks). This can be reflected in a UI definition
177 * by specifying the "type" attribute on a <child>. The possible values
178 * for the "type" attribute are described in the sections describing the
179 * widget-specific portions of UI definitions.
182 * <title>A GtkBuilder UI Definition</title>
183 * <programlisting><![CDATA[
185 * <object class="GtkDialog" id="dialog1">
186 * <child internal-child="vbox">
187 * <object class="GtkVBox" id="vbox1">
188 * <property name="border-width">10</property>
189 * <child internal-child="action_area">
190 * <object class="GtkHButtonBox" id="hbuttonbox1">
191 * <property name="border-width">20</property>
193 * <object class="GtkButton" id="ok_button">
194 * <property name="label">gtk-ok</property>
195 * <property name="use-stock">TRUE</property>
196 * <signal name="clicked" handler="ok_button_clicked"/>
205 * ]]></programlisting>
208 * Beyond this general structure, several object classes define their own XML
209 * DTD fragments for filling in the ANY placeholders in the DTD above. Note that
210 * a custom element in a <child> element gets parsed by the custom tag
211 * handler of the parent object, while a custom element in an <object>
212 * element gets parsed by the custom tag handler of the object.
214 * These XML fragments are explained in the documentation of the respective
216 * <link linkend="GtkWidget-BUILDER-UI">GtkWidget</link>,
217 * <link linkend="GtkLabel-BUILDER-UI">GtkLabel</link>,
218 * <link linkend="GtkWindow-BUILDER-UI">GtkWindow</link>,
219 * <link linkend="GtkContainer-BUILDER-UI">GtkContainer</link>,
220 * <link linkend="GtkDialog-BUILDER-UI">GtkDialog</link>,
221 * <link linkend="GtkCellLayout-BUILDER-UI">GtkCellLayout</link>,
222 * <link linkend="GtkColorSelectionDialog-BUILDER-UI">GtkColorSelectionDialog</link>,
223 * <link linkend="GtkFontSelectionDialog-BUILDER-UI">GtkFontSelectionDialog</link>,
224 * <link linkend="GtkExpander-BUILDER-UI">GtkExpander</link>,
225 * <link linkend="GtkFrame-BUILDER-UI">GtkFrame</link>,
226 * <link linkend="GtkListStore-BUILDER-UI">GtkListStore</link>,
227 * <link linkend="GtkTreeStore-BUILDER-UI">GtkTreeStore</link>,
228 * <link linkend="GtkNotebook-BUILDER-UI">GtkNotebook</link>,
229 * <link linkend="GtkSizeGroup-BUILDER-UI">GtkSizeGroup</link>,
230 * <link linkend="GtkTreeView-BUILDER-UI">GtkTreeView</link>,
231 * <link linkend="GtkUIManager-BUILDER-UI">GtkUIManager</link>,
232 * <link linkend="GtkActionGroup-BUILDER-UI">GtkActionGroup</link>.
233 * <link linkend="GtkMenuItem-BUILDER-UI">GtkMenuItem</link>,
234 * <link linkend="GtkMenuToolButton-BUILDER-UI">GtkMenuToolButton</link>,
235 * <link linkend="GtkAssistant-BUILDER-UI">GtkAssistant</link>,
236 * <link linkend="GtkScale-BUILDER-UI">GtkScale</link>,
237 * <link linkend="GtkComboBoxText-BUILDER-UI">GtkComboBoxText</link>,
238 * <link linkend="GtkRecentFilter-BUILDER-UI">GtkRecentFilter</link>,
239 * <link linkend="GtkFileFilter-BUILDER-UI">GtkFileFilter</link>,
240 * <link linkend="GtkTextTagTable-BUILDER-UI">GtkTextTagTable</link>.
244 * <title>Embedding other XML</title>
246 * Apart from the language for UI descriptions that has been explained
247 * in the previous section, GtkBuilder can also parse XML fragments
248 * of <link linkend="gio-GMenu-Markup">GMenu markup</link>. The resulting
249 * #GMenu object and its named submenus are available via
250 * gtk_builder_get_object() like other constructed objects.
256 #include <errno.h> /* errno */
258 #include <string.h> /* strlen */
260 #include "gtkbuilder.h"
261 #include "gtkbuildable.h"
262 #include "gtkbuilderprivate.h"
263 #include "gtkdebug.h"
266 #include "gtkprivate.h"
267 #include "gtktypebuiltins.h"
268 #include "gtkwindow.h"
269 #include "gtkicontheme.h"
270 #include "gtkstock.h"
273 static void gtk_builder_class_init (GtkBuilderClass *klass);
274 static void gtk_builder_init (GtkBuilder *builder);
275 static void gtk_builder_finalize (GObject *object);
276 static void gtk_builder_set_property (GObject *object,
280 static void gtk_builder_get_property (GObject *object,
284 static GType gtk_builder_real_get_type_from_name (GtkBuilder *builder,
285 const gchar *type_name);
289 PROP_TRANSLATION_DOMAIN,
292 struct _GtkBuilderPrivate
296 GSList *delayed_properties;
299 gchar *resource_prefix;
302 G_DEFINE_TYPE (GtkBuilder, gtk_builder, G_TYPE_OBJECT)
305 gtk_builder_class_init (GtkBuilderClass *klass)
307 GObjectClass *gobject_class;
309 gobject_class = G_OBJECT_CLASS (klass);
311 gobject_class->finalize = gtk_builder_finalize;
312 gobject_class->set_property = gtk_builder_set_property;
313 gobject_class->get_property = gtk_builder_get_property;
315 klass->get_type_from_name = gtk_builder_real_get_type_from_name;
318 * GtkBuilder:translation-domain:
320 * The translation domain used when translating property values that
321 * have been marked as translatable in interface descriptions.
322 * If the translation domain is %NULL, #GtkBuilder uses gettext(),
323 * otherwise g_dgettext().
327 g_object_class_install_property (gobject_class,
328 PROP_TRANSLATION_DOMAIN,
329 g_param_spec_string ("translation-domain",
330 P_("Translation Domain"),
331 P_("The translation domain used by gettext"),
333 GTK_PARAM_READWRITE));
335 g_type_class_add_private (gobject_class, sizeof (GtkBuilderPrivate));
339 gtk_builder_init (GtkBuilder *builder)
341 builder->priv = G_TYPE_INSTANCE_GET_PRIVATE (builder, GTK_TYPE_BUILDER,
343 builder->priv->domain = NULL;
344 builder->priv->objects = g_hash_table_new_full (g_str_hash, g_str_equal,
345 g_free, g_object_unref);
350 * GObject virtual methods
354 gtk_builder_finalize (GObject *object)
356 GtkBuilderPrivate *priv = GTK_BUILDER (object)->priv;
358 g_free (priv->domain);
359 g_free (priv->filename);
360 g_free (priv->resource_prefix);
362 g_hash_table_destroy (priv->objects);
364 g_slist_foreach (priv->signals, (GFunc) _free_signal_info, NULL);
365 g_slist_free (priv->signals);
367 G_OBJECT_CLASS (gtk_builder_parent_class)->finalize (object);
371 gtk_builder_set_property (GObject *object,
376 GtkBuilder *builder = GTK_BUILDER (object);
380 case PROP_TRANSLATION_DOMAIN:
381 gtk_builder_set_translation_domain (builder, g_value_get_string (value));
384 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
390 gtk_builder_get_property (GObject *object,
395 GtkBuilder *builder = GTK_BUILDER (object);
399 case PROP_TRANSLATION_DOMAIN:
400 g_value_set_string (value, builder->priv->domain);
403 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
410 * Try to map a type name to a _get_type function
413 * GtkWindow -> gtk_window_get_type
414 * GtkHBox -> gtk_hbox_get_type
415 * GtkUIManager -> gtk_ui_manager_get_type
419 _gtk_builder_resolve_type_lazily (const gchar *name)
421 static GModule *module = NULL;
423 GString *symbol_name = g_string_new ("");
426 GType gtype = G_TYPE_INVALID;
429 module = g_module_open (NULL, 0);
431 for (i = 0; name[i] != '\0'; i++)
434 /* skip if uppercase, first or previous is uppercase */
435 if ((c == g_ascii_toupper (c) &&
436 i > 0 && name[i-1] != g_ascii_toupper (name[i-1])) ||
437 (i > 2 && name[i] == g_ascii_toupper (name[i]) &&
438 name[i-1] == g_ascii_toupper (name[i-1]) &&
439 name[i-2] == g_ascii_toupper (name[i-2])))
440 g_string_append_c (symbol_name, '_');
441 g_string_append_c (symbol_name, g_ascii_tolower (c));
443 g_string_append (symbol_name, "_get_type");
445 symbol = g_string_free (symbol_name, FALSE);
447 if (g_module_symbol (module, symbol, (gpointer)&func))
456 * GtkBuilder virtual methods
460 gtk_builder_real_get_type_from_name (GtkBuilder *builder,
461 const gchar *type_name)
465 gtype = g_type_from_name (type_name);
466 if (gtype != G_TYPE_INVALID)
469 return _gtk_builder_resolve_type_lazily (type_name);
480 gtk_builder_get_parameters (GtkBuilder *builder,
482 const gchar *object_name,
485 GArray **construct_parameters)
489 GObjectClass *oclass;
490 DelayedProperty *property;
491 GError *error = NULL;
493 oclass = g_type_class_ref (object_type);
494 g_assert (oclass != NULL);
496 *parameters = g_array_new (FALSE, FALSE, sizeof (GParameter));
497 *construct_parameters = g_array_new (FALSE, FALSE, sizeof (GParameter));
499 for (l = properties; l; l = l->next)
501 PropertyInfo *prop = (PropertyInfo*)l->data;
502 GParameter parameter = { NULL };
504 pspec = g_object_class_find_property (G_OBJECT_CLASS (oclass),
508 g_warning ("Unknown property: %s.%s",
509 g_type_name (object_type), prop->name);
513 parameter.name = prop->name;
515 if (G_IS_PARAM_SPEC_OBJECT (pspec) &&
516 (G_PARAM_SPEC_VALUE_TYPE (pspec) != GDK_TYPE_PIXBUF))
518 GObject *object = gtk_builder_get_object (builder, prop->data);
522 g_value_init (¶meter.value, G_OBJECT_TYPE (object));
523 g_value_set_object (¶meter.value, object);
527 if (pspec->flags & G_PARAM_CONSTRUCT_ONLY)
529 g_warning ("Failed to get constuct only property "
530 "%s of %s with value `%s'",
531 prop->name, object_name, prop->data);
534 /* Delay setting property */
535 property = g_slice_new (DelayedProperty);
536 property->object = g_strdup (object_name);
537 property->name = g_strdup (prop->name);
538 property->value = g_strdup (prop->data);
539 builder->priv->delayed_properties =
540 g_slist_prepend (builder->priv->delayed_properties, property);
544 else if (!gtk_builder_value_from_string (builder, pspec,
545 prop->data, ¶meter.value, &error))
547 g_warning ("Failed to set property %s.%s to %s: %s",
548 g_type_name (object_type), prop->name, prop->data,
550 g_error_free (error);
555 if (pspec->flags & (G_PARAM_CONSTRUCT | G_PARAM_CONSTRUCT_ONLY))
556 g_array_append_val (*construct_parameters, parameter);
558 g_array_append_val (*parameters, parameter);
561 g_type_class_unref (oclass);
565 gtk_builder_get_internal_child (GtkBuilder *builder,
567 const gchar *childname,
577 info = (ObjectInfo*)((ChildInfo*)info->parent)->parent;
582 g_print ("Trying to get internal child %s from %s\n",
584 gtk_buildable_get_name (GTK_BUILDABLE (info->object))));
586 if (GTK_IS_BUILDABLE (info->object))
587 obj = gtk_buildable_get_internal_child (GTK_BUILDABLE (info->object),
596 GTK_BUILDER_ERROR_INVALID_VALUE,
597 "Unknown internal child: %s", childname);
603 _gtk_builder_construct (GtkBuilder *builder,
607 GArray *parameters, *construct_parameters;
611 GtkBuildableIface *iface;
612 gboolean custom_set_property;
613 GtkBuildable *buildable;
615 g_assert (info->class_name != NULL);
616 object_type = gtk_builder_get_type_from_name (builder, info->class_name);
617 if (object_type == G_TYPE_INVALID)
621 GTK_BUILDER_ERROR_INVALID_VALUE,
622 "Invalid object type `%s'",
627 gtk_builder_get_parameters (builder, object_type,
631 &construct_parameters);
633 if (info->constructor)
635 GObject *constructor;
637 constructor = gtk_builder_get_object (builder, info->constructor);
638 if (constructor == NULL)
642 GTK_BUILDER_ERROR_INVALID_VALUE,
643 "Unknown object constructor for %s: %s",
646 g_array_free (parameters, TRUE);
647 g_array_free (construct_parameters, TRUE);
650 obj = gtk_buildable_construct_child (GTK_BUILDABLE (constructor),
653 g_assert (obj != NULL);
654 if (construct_parameters->len)
655 g_warning ("Can't pass in construct-only parameters to %s", info->id);
657 else if (info->parent && ((ChildInfo*)info->parent)->internal_child != NULL)
659 gchar *childname = ((ChildInfo*)info->parent)->internal_child;
660 obj = gtk_builder_get_internal_child (builder, info, childname, error);
663 g_array_free (parameters, TRUE);
664 g_array_free (construct_parameters, TRUE);
667 if (construct_parameters->len)
668 g_warning ("Can't pass in construct-only parameters to %s", childname);
673 obj = g_object_newv (object_type,
674 construct_parameters->len,
675 (GParameter *)construct_parameters->data);
677 /* No matter what, make sure we have a reference.
679 * If it's an initially unowned object, sink it.
680 * If it's not initially unowned then we have the reference already.
682 * In the case that this is a window it will be sunk already and
683 * this is effectively a call to g_object_ref(). That's what
686 if (G_IS_INITIALLY_UNOWNED (obj))
687 g_object_ref_sink (obj);
690 g_print ("created %s of type %s\n", info->id, info->class_name));
692 for (i = 0; i < construct_parameters->len; i++)
694 GParameter *param = &g_array_index (construct_parameters,
696 g_value_unset (¶m->value);
699 g_array_free (construct_parameters, TRUE);
701 custom_set_property = FALSE;
704 if (GTK_IS_BUILDABLE (obj))
706 buildable = GTK_BUILDABLE (obj);
707 iface = GTK_BUILDABLE_GET_IFACE (obj);
708 if (iface->set_buildable_property)
709 custom_set_property = TRUE;
712 for (i = 0; i < parameters->len; i++)
714 GParameter *param = &g_array_index (parameters, GParameter, i);
715 if (custom_set_property)
716 iface->set_buildable_property (buildable, builder, param->name, ¶m->value);
718 g_object_set_property (obj, param->name, ¶m->value);
721 if (gtk_get_debug_flags () & GTK_DEBUG_BUILDER)
723 gchar *str = g_strdup_value_contents ((const GValue*)¶m->value);
724 g_print ("set %s: %s = %s\n", info->id, param->name, str);
728 g_value_unset (¶m->value);
730 g_array_free (parameters, TRUE);
732 if (GTK_IS_BUILDABLE (obj))
733 gtk_buildable_set_name (buildable, info->id);
735 g_object_set_data_full (obj,
740 /* we already own a reference to obj. put it in the hash table. */
741 g_hash_table_insert (builder->priv->objects, g_strdup (info->id), obj);
747 _gtk_builder_add_object (GtkBuilder *builder,
751 g_hash_table_insert (builder->priv->objects, g_strdup (id), g_object_ref (object));
755 _gtk_builder_add (GtkBuilder *builder,
756 ChildInfo *child_info)
761 /* Internal children are already added
762 * Also prevent us from being called twice.
765 child_info->internal_child ||
769 object = child_info->object;
773 if (!child_info->parent)
775 g_warning ("%s: Not adding, No parent",
776 gtk_buildable_get_name (GTK_BUILDABLE (object)));
780 g_assert (object != NULL);
782 parent = ((ObjectInfo*)child_info->parent)->object;
783 g_assert (GTK_IS_BUILDABLE (parent));
786 g_print ("adding %s to %s\n",
787 gtk_buildable_get_name (GTK_BUILDABLE (object)),
788 gtk_buildable_get_name (GTK_BUILDABLE (parent))));
790 gtk_buildable_add_child (GTK_BUILDABLE (parent), builder, object,
793 child_info->added = TRUE;
797 _gtk_builder_add_signals (GtkBuilder *builder,
800 builder->priv->signals = g_slist_concat (builder->priv->signals,
801 g_slist_copy (signals));
805 gtk_builder_apply_delayed_properties (GtkBuilder *builder)
808 DelayedProperty *property;
811 GObjectClass *oclass;
814 /* take the list over from the builder->priv.
816 * g_slist_reverse does not copy the list, so the list now
817 * belongs to us (and we free it at the end of this function).
819 props = g_slist_reverse (builder->priv->delayed_properties);
820 builder->priv->delayed_properties = NULL;
822 for (l = props; l; l = l->next)
824 property = (DelayedProperty*)l->data;
825 object = g_hash_table_lookup (builder->priv->objects, property->object);
826 g_assert (object != NULL);
828 object_type = G_OBJECT_TYPE (object);
829 g_assert (object_type != G_TYPE_INVALID);
831 oclass = g_type_class_ref (object_type);
832 g_assert (oclass != NULL);
834 pspec = g_object_class_find_property (G_OBJECT_CLASS (oclass),
837 g_warning ("Unknown property: %s.%s", g_type_name (object_type),
843 obj = g_hash_table_lookup (builder->priv->objects, property->value);
845 g_warning ("No object called: %s", property->value);
847 g_object_set (object, property->name, obj, NULL);
849 g_free (property->value);
850 g_free (property->object);
851 g_free (property->name);
852 g_slice_free (DelayedProperty, property);
853 g_type_class_unref (oclass);
855 g_slist_free (props);
859 _gtk_builder_finish (GtkBuilder *builder)
861 gtk_builder_apply_delayed_properties (builder);
867 * Creates a new builder object.
869 * Return value: a new #GtkBuilder object
874 gtk_builder_new (void)
876 return g_object_new (GTK_TYPE_BUILDER, NULL);
880 * gtk_builder_add_from_file:
881 * @builder: a #GtkBuilder
882 * @filename: the name of the file to parse
883 * @error: (allow-none): return location for an error, or %NULL
885 * Parses a file containing a <link linkend="BUILDER-UI">GtkBuilder
886 * UI definition</link> and merges it with the current contents of @builder.
888 * Upon errors 0 will be returned and @error will be assigned a
889 * #GError from the #GTK_BUILDER_ERROR, #G_MARKUP_ERROR or #G_FILE_ERROR
892 * Returns: A positive value on success, 0 if an error occurred
897 gtk_builder_add_from_file (GtkBuilder *builder,
898 const gchar *filename,
905 g_return_val_if_fail (GTK_IS_BUILDER (builder), 0);
906 g_return_val_if_fail (filename != NULL, 0);
907 g_return_val_if_fail (error == NULL || *error == NULL, 0);
911 if (!g_file_get_contents (filename, &buffer, &length, &tmp_error))
913 g_propagate_error (error, tmp_error);
917 g_free (builder->priv->filename);
918 g_free (builder->priv->resource_prefix);
919 builder->priv->filename = g_strdup (filename);
920 builder->priv->resource_prefix = NULL;
922 _gtk_builder_parser_parse_buffer (builder, filename,
929 if (tmp_error != NULL)
931 g_propagate_error (error, tmp_error);
939 * gtk_builder_add_objects_from_file:
940 * @builder: a #GtkBuilder
941 * @filename: the name of the file to parse
942 * @object_ids: (array zero-terminated=1) (element-type utf8): nul-terminated array of objects to build
943 * @error: (allow-none): return location for an error, or %NULL
945 * Parses a file containing a <link linkend="BUILDER-UI">GtkBuilder
946 * UI definition</link> building only the requested objects and merges
947 * them with the current contents of @builder.
949 * Upon errors 0 will be returned and @error will be assigned a
950 * #GError from the #GTK_BUILDER_ERROR, #G_MARKUP_ERROR or #G_FILE_ERROR
954 * If you are adding an object that depends on an object that is not
955 * its child (for instance a #GtkTreeView that depends on its
956 * #GtkTreeModel), you have to explicitely list all of them in @object_ids.
959 * Returns: A positive value on success, 0 if an error occurred
964 gtk_builder_add_objects_from_file (GtkBuilder *builder,
965 const gchar *filename,
973 g_return_val_if_fail (GTK_IS_BUILDER (builder), 0);
974 g_return_val_if_fail (filename != NULL, 0);
975 g_return_val_if_fail (object_ids != NULL && object_ids[0] != NULL, 0);
976 g_return_val_if_fail (error == NULL || *error == NULL, 0);
980 if (!g_file_get_contents (filename, &buffer, &length, &tmp_error))
982 g_propagate_error (error, tmp_error);
986 g_free (builder->priv->filename);
987 g_free (builder->priv->resource_prefix);
988 builder->priv->filename = g_strdup (filename);
989 builder->priv->resource_prefix = NULL;
991 _gtk_builder_parser_parse_buffer (builder, filename,
998 if (tmp_error != NULL)
1000 g_propagate_error (error, tmp_error);
1008 * gtk_builder_add_from_resource:
1009 * @builder: a #GtkBuilder
1010 * @resource_path: the path of the resource file to parse
1011 * @error: (allow-none): return location for an error, or %NULL
1013 * Parses a resource file containing a <link linkend="BUILDER-UI">GtkBuilder
1014 * UI definition</link> and merges it with the current contents of @builder.
1016 * Upon errors 0 will be returned and @error will be assigned a
1017 * #GError from the #GTK_BUILDER_ERROR, #G_MARKUP_ERROR or #G_RESOURCE_ERROR
1020 * Returns: A positive value on success, 0 if an error occurred
1025 gtk_builder_add_from_resource (GtkBuilder *builder,
1026 const gchar *resource_path,
1031 char *filename_for_errors;
1034 g_return_val_if_fail (GTK_IS_BUILDER (builder), 0);
1035 g_return_val_if_fail (resource_path != NULL, 0);
1036 g_return_val_if_fail (error == NULL || *error == NULL, 0);
1040 data = g_resources_lookup_data (resource_path, 0, &tmp_error);
1043 g_propagate_error (error, tmp_error);
1047 g_free (builder->priv->filename);
1048 g_free (builder->priv->resource_prefix);
1049 builder->priv->filename = g_strdup (".");
1051 slash = strrchr (resource_path, '/');
1053 builder->priv->resource_prefix =
1054 g_strndup (resource_path, slash - resource_path + 1);
1056 builder->priv->resource_prefix =
1059 filename_for_errors = g_strconcat ("<resource>", resource_path, NULL);
1061 _gtk_builder_parser_parse_buffer (builder, filename_for_errors,
1062 g_bytes_get_data (data, NULL), g_bytes_get_size (data),
1066 g_free (filename_for_errors);
1067 g_bytes_unref (data);
1069 if (tmp_error != NULL)
1071 g_propagate_error (error, tmp_error);
1079 * gtk_builder_add_objects_from_resource:
1080 * @builder: a #GtkBuilder
1081 * @resource_path: the path of the resource file to parse
1082 * @object_ids: (array zero-terminated=1) (element-type utf8): nul-terminated array of objects to build
1083 * @error: (allow-none): return location for an error, or %NULL
1085 * Parses a resource file containing a <link linkend="BUILDER-UI">GtkBuilder
1086 * UI definition</link> building only the requested objects and merges
1087 * them with the current contents of @builder.
1089 * Upon errors 0 will be returned and @error will be assigned a
1090 * #GError from the #GTK_BUILDER_ERROR, #G_MARKUP_ERROR or #G_RESOURCE_ERROR
1094 * If you are adding an object that depends on an object that is not
1095 * its child (for instance a #GtkTreeView that depends on its
1096 * #GtkTreeModel), you have to explicitely list all of them in @object_ids.
1099 * Returns: A positive value on success, 0 if an error occurred
1104 gtk_builder_add_objects_from_resource (GtkBuilder *builder,
1105 const gchar *resource_path,
1111 char *filename_for_errors;
1114 g_return_val_if_fail (GTK_IS_BUILDER (builder), 0);
1115 g_return_val_if_fail (resource_path != NULL, 0);
1116 g_return_val_if_fail (object_ids != NULL && object_ids[0] != NULL, 0);
1117 g_return_val_if_fail (error == NULL || *error == NULL, 0);
1121 data = g_resources_lookup_data (resource_path, 0, &tmp_error);
1124 g_propagate_error (error, tmp_error);
1128 g_free (builder->priv->filename);
1129 g_free (builder->priv->resource_prefix);
1130 builder->priv->filename = g_strdup (".");
1132 slash = strrchr (resource_path, '/');
1134 builder->priv->resource_prefix =
1135 g_strndup (resource_path, slash - resource_path + 1);
1137 builder->priv->resource_prefix =
1140 filename_for_errors = g_strconcat ("<resource>", resource_path, NULL);
1142 _gtk_builder_parser_parse_buffer (builder, filename_for_errors,
1143 g_bytes_get_data (data, NULL), g_bytes_get_size (data),
1146 g_free (filename_for_errors);
1147 g_bytes_unref (data);
1149 if (tmp_error != NULL)
1151 g_propagate_error (error, tmp_error);
1159 * gtk_builder_add_from_string:
1160 * @builder: a #GtkBuilder
1161 * @buffer: the string to parse
1162 * @length: the length of @buffer (may be -1 if @buffer is nul-terminated)
1163 * @error: (allow-none): return location for an error, or %NULL
1165 * Parses a string containing a <link linkend="BUILDER-UI">GtkBuilder
1166 * UI definition</link> and merges it with the current contents of @builder.
1168 * Upon errors 0 will be returned and @error will be assigned a
1169 * #GError from the #GTK_BUILDER_ERROR or #G_MARKUP_ERROR domain.
1171 * Returns: A positive value on success, 0 if an error occurred
1176 gtk_builder_add_from_string (GtkBuilder *builder,
1177 const gchar *buffer,
1183 g_return_val_if_fail (GTK_IS_BUILDER (builder), 0);
1184 g_return_val_if_fail (buffer != NULL, 0);
1185 g_return_val_if_fail (error == NULL || *error == NULL, 0);
1189 g_free (builder->priv->filename);
1190 g_free (builder->priv->resource_prefix);
1191 builder->priv->filename = g_strdup (".");
1192 builder->priv->resource_prefix = NULL;
1194 _gtk_builder_parser_parse_buffer (builder, "<input>",
1198 if (tmp_error != NULL)
1200 g_propagate_error (error, tmp_error);
1208 * gtk_builder_add_objects_from_string:
1209 * @builder: a #GtkBuilder
1210 * @buffer: the string to parse
1211 * @length: the length of @buffer (may be -1 if @buffer is nul-terminated)
1212 * @object_ids: (array zero-terminated=1) (element-type utf8): nul-terminated array of objects to build
1213 * @error: (allow-none): return location for an error, or %NULL
1215 * Parses a string containing a <link linkend="BUILDER-UI">GtkBuilder
1216 * UI definition</link> building only the requested objects and merges
1217 * them with the current contents of @builder.
1219 * Upon errors 0 will be returned and @error will be assigned a
1220 * #GError from the #GTK_BUILDER_ERROR or #G_MARKUP_ERROR domain.
1223 * If you are adding an object that depends on an object that is not
1224 * its child (for instance a #GtkTreeView that depends on its
1225 * #GtkTreeModel), you have to explicitely list all of them in @object_ids.
1228 * Returns: A positive value on success, 0 if an error occurred
1233 gtk_builder_add_objects_from_string (GtkBuilder *builder,
1234 const gchar *buffer,
1241 g_return_val_if_fail (GTK_IS_BUILDER (builder), 0);
1242 g_return_val_if_fail (buffer != NULL, 0);
1243 g_return_val_if_fail (object_ids != NULL && object_ids[0] != NULL, 0);
1244 g_return_val_if_fail (error == NULL || *error == NULL, 0);
1248 g_free (builder->priv->filename);
1249 g_free (builder->priv->resource_prefix);
1250 builder->priv->filename = g_strdup (".");
1251 builder->priv->resource_prefix = NULL;
1253 _gtk_builder_parser_parse_buffer (builder, "<input>",
1258 if (tmp_error != NULL)
1260 g_propagate_error (error, tmp_error);
1268 * gtk_builder_get_object:
1269 * @builder: a #GtkBuilder
1270 * @name: name of object to get
1272 * Gets the object named @name. Note that this function does not
1273 * increment the reference count of the returned object.
1275 * Return value: (transfer none): the object named @name or %NULL if
1276 * it could not be found in the object tree.
1281 gtk_builder_get_object (GtkBuilder *builder,
1284 g_return_val_if_fail (GTK_IS_BUILDER (builder), NULL);
1285 g_return_val_if_fail (name != NULL, NULL);
1287 return g_hash_table_lookup (builder->priv->objects, name);
1291 object_add_to_list (gchar *object_id,
1295 *list = g_slist_prepend (*list, object);
1299 * gtk_builder_get_objects:
1300 * @builder: a #GtkBuilder
1302 * Gets all objects that have been constructed by @builder. Note that
1303 * this function does not increment the reference counts of the returned
1306 * Return value: (element-type GObject) (transfer container): a newly-allocated #GSList containing all the objects
1307 * constructed by the #GtkBuilder instance. It should be freed by
1313 gtk_builder_get_objects (GtkBuilder *builder)
1315 GSList *objects = NULL;
1317 g_return_val_if_fail (GTK_IS_BUILDER (builder), NULL);
1319 g_hash_table_foreach (builder->priv->objects, (GHFunc)object_add_to_list, &objects);
1321 return g_slist_reverse (objects);
1325 * gtk_builder_set_translation_domain:
1326 * @builder: a #GtkBuilder
1327 * @domain: (allow-none): the translation domain or %NULL
1329 * Sets the translation domain of @builder.
1330 * See #GtkBuilder:translation-domain.
1335 gtk_builder_set_translation_domain (GtkBuilder *builder,
1336 const gchar *domain)
1340 g_return_if_fail (GTK_IS_BUILDER (builder));
1342 new_domain = g_strdup (domain);
1343 g_free (builder->priv->domain);
1344 builder->priv->domain = new_domain;
1346 g_object_notify (G_OBJECT (builder), "translation-domain");
1350 * gtk_builder_get_translation_domain:
1351 * @builder: a #GtkBuilder
1353 * Gets the translation domain of @builder.
1355 * Return value: the translation domain. This string is owned
1356 * by the builder object and must not be modified or freed.
1361 gtk_builder_get_translation_domain (GtkBuilder *builder)
1363 g_return_val_if_fail (GTK_IS_BUILDER (builder), NULL);
1365 return builder->priv->domain;
1374 gtk_builder_connect_signals_default (GtkBuilder *builder,
1376 const gchar *signal_name,
1377 const gchar *handler_name,
1378 GObject *connect_object,
1379 GConnectFlags flags,
1383 connect_args *args = (connect_args*)user_data;
1385 if (!g_module_symbol (args->module, handler_name, (gpointer)&func))
1387 g_warning ("Could not find signal handler '%s'", handler_name);
1392 g_signal_connect_object (object, signal_name, func, connect_object, flags);
1394 g_signal_connect_data (object, signal_name, func, args->data, NULL, flags);
1399 * gtk_builder_connect_signals:
1400 * @builder: a #GtkBuilder
1401 * @user_data: a pointer to a structure sent in as user data to all signals
1403 * This method is a simpler variation of gtk_builder_connect_signals_full().
1404 * It uses #GModule's introspective features (by opening the module %NULL)
1405 * to look at the application's symbol table. From here it tries to match
1406 * the signal handler names given in the interface description with
1407 * symbols in the application and connects the signals. Note that this
1408 * function can only be called once, subsequent calls will do nothing.
1410 * Note that this function will not work correctly if #GModule is not
1411 * supported on the platform.
1413 * When compiling applications for Windows, you must declare signal callbacks
1414 * with #G_MODULE_EXPORT, or they will not be put in the symbol table.
1415 * On Linux and Unices, this is not necessary; applications should instead
1416 * be compiled with the -Wl,--export-dynamic CFLAGS, and linked against
1417 * gmodule-export-2.0.
1422 gtk_builder_connect_signals (GtkBuilder *builder,
1427 g_return_if_fail (GTK_IS_BUILDER (builder));
1429 if (!g_module_supported ())
1430 g_error ("gtk_builder_connect_signals() requires working GModule");
1432 args = g_slice_new0 (connect_args);
1433 args->module = g_module_open (NULL, G_MODULE_BIND_LAZY);
1434 args->data = user_data;
1436 gtk_builder_connect_signals_full (builder,
1437 gtk_builder_connect_signals_default,
1439 g_module_close (args->module);
1441 g_slice_free (connect_args, args);
1445 * GtkBuilderConnectFunc:
1446 * @builder: a #GtkBuilder
1447 * @object: object to connect a signal to
1448 * @signal_name: name of the signal
1449 * @handler_name: name of the handler
1450 * @connect_object: a #GObject, if non-%NULL, use g_signal_connect_object()
1451 * @flags: #GConnectFlags to use
1452 * @user_data: user data
1454 * This is the signature of a function used to connect signals. It is used
1455 * by the gtk_builder_connect_signals() and gtk_builder_connect_signals_full()
1456 * methods. It is mainly intended for interpreted language bindings, but
1457 * could be useful where the programmer wants more control over the signal
1458 * connection process. Note that this function can only be called once,
1459 * subsequent calls will do nothing.
1465 * gtk_builder_connect_signals_full:
1466 * @builder: a #GtkBuilder
1467 * @func: (scope call): the function used to connect the signals
1468 * @user_data: arbitrary data that will be passed to the connection function
1470 * This function can be thought of the interpreted language binding
1471 * version of gtk_builder_connect_signals(), except that it does not
1472 * require GModule to function correctly.
1477 gtk_builder_connect_signals_full (GtkBuilder *builder,
1478 GtkBuilderConnectFunc func,
1483 GObject *connect_object;
1485 g_return_if_fail (GTK_IS_BUILDER (builder));
1486 g_return_if_fail (func != NULL);
1488 if (!builder->priv->signals)
1491 builder->priv->signals = g_slist_reverse (builder->priv->signals);
1492 for (l = builder->priv->signals; l; l = l->next)
1494 SignalInfo *signal = (SignalInfo*)l->data;
1496 g_assert (signal != NULL);
1497 g_assert (signal->name != NULL);
1499 object = g_hash_table_lookup (builder->priv->objects,
1500 signal->object_name);
1501 g_assert (object != NULL);
1503 connect_object = NULL;
1505 if (signal->connect_object_name)
1507 connect_object = g_hash_table_lookup (builder->priv->objects,
1508 signal->connect_object_name);
1509 if (!connect_object)
1510 g_warning ("Could not lookup object %s on signal %s of object %s",
1511 signal->connect_object_name, signal->name,
1512 signal->object_name);
1515 func (builder, object, signal->name, signal->handler,
1516 connect_object, signal->flags, user_data);
1519 g_slist_foreach (builder->priv->signals, (GFunc)_free_signal_info, NULL);
1520 g_slist_free (builder->priv->signals);
1521 builder->priv->signals = NULL;
1525 * gtk_builder_value_from_string:
1526 * @builder: a #GtkBuilder
1527 * @pspec: the #GParamSpec for the property
1528 * @string: the string representation of the value
1529 * @value: (out): the #GValue to store the result in
1530 * @error: (allow-none): return location for an error, or %NULL
1532 * This function demarshals a value from a string. This function
1533 * calls g_value_init() on the @value argument, so it need not be
1534 * initialised beforehand.
1536 * This function can handle char, uchar, boolean, int, uint, long,
1537 * ulong, enum, flags, float, double, string, #GdkColor, #GdkRGBA and
1538 * #GtkAdjustment type values. Support for #GtkWidget type values is
1541 * Upon errors %FALSE will be returned and @error will be assigned a
1542 * #GError from the #GTK_BUILDER_ERROR domain.
1544 * Returns: %TRUE on success
1549 gtk_builder_value_from_string (GtkBuilder *builder,
1551 const gchar *string,
1555 g_return_val_if_fail (GTK_IS_BUILDER (builder), FALSE);
1556 g_return_val_if_fail (G_IS_PARAM_SPEC (pspec), FALSE);
1557 g_return_val_if_fail (string != NULL, FALSE);
1558 g_return_val_if_fail (value != NULL, FALSE);
1559 g_return_val_if_fail (error == NULL || *error == NULL, FALSE);
1562 * GParamSpecUnichar has the internal type G_TYPE_UINT,
1563 * so we cannot handle this in the switch, do it separately
1565 if (G_IS_PARAM_SPEC_UNICHAR (pspec))
1568 g_value_init (value, G_TYPE_UINT);
1569 c = g_utf8_get_char_validated (string, strlen (string));
1571 g_value_set_uint (value, c);
1576 * GParamSpecVariant can specify a GVariantType which can help with
1577 * parsing, so we need to take care of that here.
1579 if (G_IS_PARAM_SPEC_VARIANT (pspec))
1581 GParamSpecVariant *variant_pspec = G_PARAM_SPEC_VARIANT (pspec);
1582 const GVariantType *type;
1585 g_value_init (value, G_TYPE_VARIANT);
1587 /* The GVariant parser doesn't deal with indefinite types */
1588 if (g_variant_type_is_definite (variant_pspec->type))
1589 type = variant_pspec->type;
1593 variant = g_variant_parse (type, string, NULL, NULL, error);
1594 if (variant == NULL)
1596 g_value_take_variant (value, variant);
1600 return gtk_builder_value_from_string_type (builder,
1601 G_PARAM_SPEC_VALUE_TYPE (pspec),
1602 string, value, error);
1606 * gtk_builder_value_from_string_type:
1607 * @builder: a #GtkBuilder
1608 * @type: the #GType of the value
1609 * @string: the string representation of the value
1610 * @value: (out): the #GValue to store the result in
1611 * @error: (allow-none): return location for an error, or %NULL
1613 * Like gtk_builder_value_from_string(), this function demarshals
1614 * a value from a string, but takes a #GType instead of #GParamSpec.
1615 * This function calls g_value_init() on the @value argument, so it
1616 * need not be initialised beforehand.
1618 * Upon errors %FALSE will be returned and @error will be assigned a
1619 * #GError from the #GTK_BUILDER_ERROR domain.
1621 * Returns: %TRUE on success
1626 gtk_builder_value_from_string_type (GtkBuilder *builder,
1628 const gchar *string,
1632 gboolean ret = TRUE;
1634 g_return_val_if_fail (type != G_TYPE_INVALID, FALSE);
1635 g_return_val_if_fail (string != NULL, FALSE);
1636 g_return_val_if_fail (error == NULL || *error == NULL, FALSE);
1638 g_value_init (value, type);
1640 switch (G_TYPE_FUNDAMENTAL (type))
1643 g_value_set_schar (value, string[0]);
1646 g_value_set_uchar (value, (guchar)string[0]);
1648 case G_TYPE_BOOLEAN:
1652 if (!_gtk_builder_boolean_from_string (string, &b, error))
1657 g_value_set_boolean (value, b);
1664 gchar *endptr = NULL;
1666 l = g_ascii_strtoll (string, &endptr, 0);
1667 if (errno || endptr == string)
1671 GTK_BUILDER_ERROR_INVALID_VALUE,
1672 "Could not parse integer `%s'",
1677 if (G_VALUE_HOLDS_INT (value))
1678 g_value_set_int (value, l);
1680 g_value_set_long (value, l);
1687 gchar *endptr = NULL;
1689 ul = g_ascii_strtoull (string, &endptr, 0);
1690 if (errno || endptr == string)
1694 GTK_BUILDER_ERROR_INVALID_VALUE,
1695 "Could not parse unsigned integer `%s'",
1700 if (G_VALUE_HOLDS_UINT (value))
1701 g_value_set_uint (value, ul);
1703 g_value_set_ulong (value, ul);
1709 if (!_gtk_builder_enum_from_string (type, string, &enum_value, error))
1714 g_value_set_enum (value, enum_value);
1721 if (!_gtk_builder_flags_from_string (type, string, &flags_value, error))
1726 g_value_set_flags (value, flags_value);
1733 gchar *endptr = NULL;
1735 d = g_ascii_strtod (string, &endptr);
1736 if (errno || endptr == string)
1740 GTK_BUILDER_ERROR_INVALID_VALUE,
1741 "Could not parse double `%s'",
1746 if (G_VALUE_HOLDS_FLOAT (value))
1747 g_value_set_float (value, d);
1749 g_value_set_double (value, d);
1753 g_value_set_string (value, string);
1755 case G_TYPE_VARIANT:
1759 variant = g_variant_parse (NULL, string, NULL, NULL, error);
1761 g_value_take_variant (value, variant);
1767 if (G_VALUE_HOLDS (value, GDK_TYPE_COLOR))
1769 GdkColor color = { 0, };
1771 if (gdk_color_parse (string, &color))
1772 g_value_set_boxed (value, &color);
1777 GTK_BUILDER_ERROR_INVALID_VALUE,
1778 "Could not parse color `%s'",
1783 else if (G_VALUE_HOLDS (value, GDK_TYPE_RGBA))
1785 GdkRGBA rgba = { 0 };
1787 if (gdk_rgba_parse (&rgba, string))
1788 g_value_set_boxed (value, &rgba);
1793 GTK_BUILDER_ERROR_INVALID_VALUE,
1794 "Could not parse RGBA color '%s'",
1799 else if (G_VALUE_HOLDS (value, G_TYPE_STRV))
1801 gchar **vector = g_strsplit (string, "\n", 0);
1802 g_value_take_boxed (value, vector);
1808 GTK_BUILDER_ERROR_INVALID_VALUE,
1809 "Could not parse '%s' as a %s",
1810 string, G_VALUE_TYPE_NAME (value));
1815 if (G_VALUE_HOLDS (value, GDK_TYPE_PIXBUF))
1818 GError *tmp_error = NULL;
1819 GdkPixbuf *pixbuf = NULL;
1821 if (gtk_builder_get_object (builder, string))
1825 GTK_BUILDER_ERROR_INVALID_VALUE,
1826 "Could not load image '%s': "
1827 " '%s' is already used as object id",
1832 filename = _gtk_builder_get_resource_path (builder, string);
1833 if (filename != NULL)
1835 GInputStream *stream = g_resources_open_stream (filename, 0, &tmp_error);
1838 pixbuf = gdk_pixbuf_new_from_stream (stream, NULL, &tmp_error);
1839 g_object_unref (stream);
1844 filename = _gtk_builder_get_absolute_filename (builder, string);
1845 pixbuf = gdk_pixbuf_new_from_file (filename, &tmp_error);
1850 GtkIconTheme *theme;
1852 g_warning ("Could not load image '%s': %s",
1853 string, tmp_error->message);
1854 g_error_free (tmp_error);
1856 /* fall back to a missing image */
1857 theme = gtk_icon_theme_get_default ();
1858 pixbuf = gtk_icon_theme_load_icon (theme,
1859 GTK_STOCK_MISSING_IMAGE,
1861 GTK_ICON_LOOKUP_USE_BUILTIN,
1867 g_value_set_object (value, pixbuf);
1868 g_object_unref (G_OBJECT (pixbuf));
1883 /* Catch unassigned error for object types as well as any unsupported types.
1884 * While parsing GtkBuilder; object types are deserialized
1885 * without calling gtk_builder_value_from_string_type().
1887 if (!ret && error && *error == NULL)
1890 GTK_BUILDER_ERROR_INVALID_VALUE,
1891 "Unsupported GType `%s'", g_type_name (type));
1897 _gtk_builder_enum_from_string (GType type,
1898 const gchar *string,
1908 g_return_val_if_fail (G_TYPE_IS_ENUM (type), FALSE);
1909 g_return_val_if_fail (string != NULL, FALSE);
1915 value = g_ascii_strtoull (string, &endptr, 0);
1916 if (errno == 0 && endptr != string) /* parsed a number */
1917 *enum_value = value;
1920 eclass = g_type_class_ref (type);
1921 ev = g_enum_get_value_by_name (eclass, string);
1923 ev = g_enum_get_value_by_nick (eclass, string);
1926 *enum_value = ev->value;
1931 GTK_BUILDER_ERROR_INVALID_VALUE,
1932 "Could not parse enum: `%s'",
1937 g_type_class_unref (eclass);
1944 _gtk_builder_flags_from_string (GType type,
1945 const gchar *string,
1949 GFlagsClass *fclass;
1950 gchar *endptr, *prevptr;
1958 g_return_val_if_fail (G_TYPE_IS_FLAGS (type), FALSE);
1959 g_return_val_if_fail (string != 0, FALSE);
1965 value = g_ascii_strtoull (string, &endptr, 0);
1966 if (errno == 0 && endptr != string) /* parsed a number */
1967 *flags_value = value;
1970 fclass = g_type_class_ref (type);
1972 flagstr = g_strdup (string);
1973 for (value = i = j = 0; ; i++)
1976 eos = flagstr[i] == '\0';
1978 if (!eos && flagstr[i] != '|')
1982 endptr = &flagstr[i];
1986 flagstr[i++] = '\0';
1993 ch = g_utf8_get_char (flag);
1994 if (!g_unichar_isspace (ch))
1996 flag = g_utf8_next_char (flag);
1999 while (endptr > flag)
2001 prevptr = g_utf8_prev_char (endptr);
2002 ch = g_utf8_get_char (prevptr);
2003 if (!g_unichar_isspace (ch))
2011 fv = g_flags_get_value_by_name (fclass, flag);
2014 fv = g_flags_get_value_by_nick (fclass, flag);
2022 GTK_BUILDER_ERROR_INVALID_VALUE,
2023 "Unknown flag: `%s'",
2032 *flags_value = value;
2039 g_type_class_unref (fclass);
2046 * gtk_builder_get_type_from_name:
2047 * @builder: a #GtkBuilder
2048 * @type_name: type name to lookup
2050 * Looks up a type by name, using the virtual function that
2051 * #GtkBuilder has for that purpose. This is mainly used when
2052 * implementing the #GtkBuildable interface on a type.
2054 * Returns: the #GType found for @type_name or #G_TYPE_INVALID
2055 * if no type was found
2060 gtk_builder_get_type_from_name (GtkBuilder *builder,
2061 const gchar *type_name)
2063 g_return_val_if_fail (GTK_IS_BUILDER (builder), G_TYPE_INVALID);
2064 g_return_val_if_fail (type_name != NULL, G_TYPE_INVALID);
2066 return GTK_BUILDER_GET_CLASS (builder)->get_type_from_name (builder, type_name);
2070 gtk_builder_error_quark (void)
2072 return g_quark_from_static_string ("gtk-builder-error-quark");
2076 _gtk_builder_get_resource_path (GtkBuilder *builder, const gchar *string)
2078 if (g_str_has_prefix (string, "resource:///"))
2079 return g_uri_unescape_string (string + 11, "/");
2081 if (g_path_is_absolute (string) ||
2082 builder->priv->resource_prefix == NULL)
2085 return g_build_path ("/", builder->priv->resource_prefix, string, NULL);
2089 _gtk_builder_get_absolute_filename (GtkBuilder *builder, const gchar *string)
2092 gchar *dirname = NULL;
2094 if (g_path_is_absolute (string))
2095 return g_strdup (string);
2097 if (builder->priv->filename &&
2098 strcmp (builder->priv->filename, ".") != 0)
2100 dirname = g_path_get_dirname (builder->priv->filename);
2102 if (strcmp (dirname, ".") == 0)
2105 dirname = g_get_current_dir ();
2109 dirname = g_get_current_dir ();
2111 filename = g_build_filename (dirname, string, NULL);