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.
24 #include <errno.h> /* errno */
25 #include <stdlib.h> /* strtol, strtoul */
26 #include <string.h> /* strlen */
28 #include "gtkbuilder.h"
29 #include "gtkbuildable.h"
30 #include "gtkbuilderprivate.h"
33 #include "gtkprivate.h"
34 #include "gtktypebuiltins.h"
35 #include "gtkwindow.h"
36 #include "gtkicontheme.h"
40 static void gtk_builder_class_init (GtkBuilderClass *klass);
41 static void gtk_builder_init (GtkBuilder *builder);
42 static void gtk_builder_finalize (GObject *object);
43 static void gtk_builder_set_property (GObject *object,
47 static void gtk_builder_get_property (GObject *object,
51 static GType gtk_builder_real_get_type_from_name (GtkBuilder *builder,
52 const gchar *type_name);
53 static gboolean _gtk_builder_enum_from_string (GType type,
61 PROP_TRANSLATION_DOMAIN,
64 struct _GtkBuilderPrivate
68 GSList *delayed_properties;
73 G_DEFINE_TYPE (GtkBuilder, gtk_builder, G_TYPE_OBJECT)
76 gtk_builder_class_init (GtkBuilderClass *klass)
78 GObjectClass *gobject_class;
80 gobject_class = G_OBJECT_CLASS (klass);
82 gobject_class->finalize = gtk_builder_finalize;
83 gobject_class->set_property = gtk_builder_set_property;
84 gobject_class->get_property = gtk_builder_get_property;
86 klass->get_type_from_name = gtk_builder_real_get_type_from_name;
89 * GtkBuilder:translation-domain:
91 * The translation domain used when translating property values that
92 * have been marked as translatable in interface descriptions.
93 * If the translation domain is %NULL, #GtkBuilder uses gettext(),
94 * otherwise dgettext().
98 g_object_class_install_property (gobject_class,
99 PROP_TRANSLATION_DOMAIN,
100 g_param_spec_string ("translation-domain",
101 P_("Translation Domain"),
102 P_("The translation domain used by gettext"),
104 GTK_PARAM_READWRITE));
106 g_type_class_add_private (gobject_class, sizeof (GtkBuilderPrivate));
110 gtk_builder_init (GtkBuilder *builder)
112 builder->priv = G_TYPE_INSTANCE_GET_PRIVATE (builder, GTK_TYPE_BUILDER,
114 builder->priv->domain = NULL;
115 builder->priv->objects = g_hash_table_new_full (g_str_hash, g_str_equal,
116 g_free, g_object_unref);
121 * GObject virtual methods
125 gtk_builder_finalize (GObject *object)
127 GtkBuilderPrivate *priv = GTK_BUILDER (object)->priv;
129 g_free (priv->domain);
130 g_free (priv->filename);
132 g_hash_table_destroy (priv->objects);
134 g_slist_foreach (priv->signals, (GFunc) _free_signal_info, NULL);
135 g_slist_free (priv->signals);
137 G_OBJECT_CLASS (gtk_builder_parent_class)->finalize (object);
141 gtk_builder_set_property (GObject *object,
146 GtkBuilder *builder = GTK_BUILDER (object);
150 case PROP_TRANSLATION_DOMAIN:
151 gtk_builder_set_translation_domain (builder, g_value_get_string (value));
154 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
160 gtk_builder_get_property (GObject *object,
165 GtkBuilder *builder = GTK_BUILDER (object);
169 case PROP_TRANSLATION_DOMAIN:
170 g_value_set_string (value, builder->priv->domain);
173 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
180 * Try to map a type name to a _get_type function
183 * GtkWindow -> gtk_window_get_type
184 * GtkHBox -> gtk_hbox_get_type
185 * GtkUIManager -> gtk_ui_manager_get_type
189 _gtk_builder_resolve_type_lazily (const gchar *name)
191 static GModule *module = NULL;
193 GString *symbol_name = g_string_new ("");
196 GType gtype = G_TYPE_INVALID;
199 module = g_module_open (NULL, 0);
201 for (i = 0; name[i] != '\0'; i++)
204 /* skip if uppercase, first or previous is uppercase */
205 if ((c == g_ascii_toupper (c) &&
206 i > 0 && name[i-1] != g_ascii_toupper (name[i-1])) ||
207 (i > 2 && name[i] == g_ascii_toupper (name[i]) &&
208 name[i-1] == g_ascii_toupper (name[i-1]) &&
209 name[i-2] == g_ascii_toupper (name[i-2])))
210 g_string_append_c (symbol_name, '_');
211 g_string_append_c (symbol_name, g_ascii_tolower (c));
213 g_string_append (symbol_name, "_get_type");
215 symbol = g_string_free (symbol_name, FALSE);
217 if (g_module_symbol (module, symbol, (gpointer)&func))
226 * GtkBuilder virtual methods
230 gtk_builder_real_get_type_from_name (GtkBuilder *builder,
231 const gchar *type_name)
235 gtype = g_type_from_name (type_name);
236 if (gtype != G_TYPE_INVALID)
239 return _gtk_builder_resolve_type_lazily (type_name);
250 gtk_builder_get_parameters (GtkBuilder *builder,
252 const gchar *object_name,
255 GArray **construct_parameters)
259 GObjectClass *oclass;
260 DelayedProperty *property;
261 GError *error = NULL;
263 oclass = g_type_class_ref (object_type);
264 g_assert (oclass != NULL);
266 *parameters = g_array_new (FALSE, FALSE, sizeof (GParameter));
267 *construct_parameters = g_array_new (FALSE, FALSE, sizeof (GParameter));
269 for (l = properties; l; l = l->next)
271 PropertyInfo *prop = (PropertyInfo*)l->data;
272 GParameter parameter = { NULL };
274 pspec = g_object_class_find_property (G_OBJECT_CLASS (oclass),
278 g_warning ("Unknown property: %s.%s",
279 g_type_name (object_type), prop->name);
283 parameter.name = prop->name;
285 if (G_IS_PARAM_SPEC_OBJECT (pspec) &&
286 (G_PARAM_SPEC_VALUE_TYPE (pspec) != GDK_TYPE_PIXBUF))
288 if (pspec->flags & G_PARAM_CONSTRUCT_ONLY)
291 object = gtk_builder_get_object (builder, prop->data);
294 g_warning ("Failed to get constuct only property "
295 "%s of %s with value `%s'",
296 prop->name, object_name, prop->data);
299 g_value_init (¶meter.value, G_OBJECT_TYPE (object));
300 g_value_set_object (¶meter.value, object);
304 property = g_slice_new (DelayedProperty);
305 property->object = g_strdup (object_name);
306 property->name = g_strdup (prop->name);
307 property->value = g_strdup (prop->data);
308 builder->priv->delayed_properties =
309 g_slist_prepend (builder->priv->delayed_properties, property);
314 else if (!gtk_builder_value_from_string (builder, pspec,
315 prop->data, ¶meter.value, &error))
317 g_warning ("Failed to set property %s.%s to %s: %s",
318 g_type_name (object_type), prop->name, prop->data,
320 g_error_free (error);
325 if (pspec->flags & G_PARAM_CONSTRUCT_ONLY)
326 g_array_append_val (*construct_parameters, parameter);
328 g_array_append_val (*parameters, parameter);
331 g_type_class_unref (oclass);
335 gtk_builder_get_internal_child (GtkBuilder *builder,
337 const gchar *childname,
347 info = (ObjectInfo*)((ChildInfo*)info->parent)->parent;
352 g_print ("Trying to get internal child %s from %s\n",
354 gtk_buildable_get_name (GTK_BUILDABLE (info->object))));
356 if (GTK_IS_BUILDABLE (info->object))
357 obj = gtk_buildable_get_internal_child (GTK_BUILDABLE (info->object),
366 GTK_BUILDER_ERROR_INVALID_VALUE,
367 "Unknown internal child: %s", childname);
373 _gtk_builder_construct (GtkBuilder *builder,
377 GArray *parameters, *construct_parameters;
381 GtkBuildableIface *iface;
382 gboolean custom_set_property;
383 GtkBuildable *buildable;
385 g_assert (info->class_name != NULL);
386 object_type = gtk_builder_get_type_from_name (builder, info->class_name);
387 if (object_type == G_TYPE_INVALID)
391 GTK_BUILDER_ERROR_INVALID_VALUE,
392 "Invalid object type `%s'",
397 gtk_builder_get_parameters (builder, object_type,
401 &construct_parameters);
403 if (info->constructor)
405 GObject *constructor;
407 constructor = gtk_builder_get_object (builder, info->constructor);
408 if (constructor == NULL)
412 GTK_BUILDER_ERROR_INVALID_VALUE,
413 "Unknown object constructor for %s: %s",
416 g_array_free (parameters, TRUE);
417 g_array_free (construct_parameters, TRUE);
420 obj = gtk_buildable_construct_child (GTK_BUILDABLE (constructor),
423 g_assert (obj != NULL);
424 if (construct_parameters->len)
425 g_warning ("Can't pass in construct-only parameters to %s", info->id);
427 else if (info->parent && ((ChildInfo*)info->parent)->internal_child != NULL)
429 gchar *childname = ((ChildInfo*)info->parent)->internal_child;
430 obj = gtk_builder_get_internal_child (builder, info, childname, error);
433 g_array_free (parameters, TRUE);
434 g_array_free (construct_parameters, TRUE);
437 if (construct_parameters->len)
438 g_warning ("Can't pass in construct-only parameters to %s", childname);
443 obj = g_object_newv (object_type,
444 construct_parameters->len,
445 (GParameter *)construct_parameters->data);
447 /* No matter what, make sure we have a reference.
449 * If it's an initially unowned object, sink it.
450 * If it's not initially unowned then we have the reference already.
452 * In the case that this is a window it will be sunk already and
453 * this is effectively a call to g_object_ref(). That's what
456 if (G_IS_INITIALLY_UNOWNED (obj))
457 g_object_ref_sink (obj);
460 g_print ("created %s of type %s\n", info->id, info->class_name));
462 for (i = 0; i < construct_parameters->len; i++)
464 GParameter *param = &g_array_index (construct_parameters,
466 g_value_unset (¶m->value);
469 g_array_free (construct_parameters, TRUE);
471 custom_set_property = FALSE;
474 if (GTK_IS_BUILDABLE (obj))
476 buildable = GTK_BUILDABLE (obj);
477 iface = GTK_BUILDABLE_GET_IFACE (obj);
478 if (iface->set_buildable_property)
479 custom_set_property = TRUE;
482 for (i = 0; i < parameters->len; i++)
484 GParameter *param = &g_array_index (parameters, GParameter, i);
485 if (custom_set_property)
486 iface->set_buildable_property (buildable, builder, param->name, ¶m->value);
488 g_object_set_property (obj, param->name, ¶m->value);
491 if (gtk_debug_flags & GTK_DEBUG_BUILDER)
493 gchar *str = g_strdup_value_contents ((const GValue*)¶m->value);
494 g_print ("set %s: %s = %s\n", info->id, param->name, str);
498 g_value_unset (¶m->value);
500 g_array_free (parameters, TRUE);
502 if (GTK_IS_BUILDABLE (obj))
503 gtk_buildable_set_name (buildable, info->id);
505 g_object_set_data_full (obj,
510 /* we already own a reference to obj. put it in the hash table. */
511 g_hash_table_insert (builder->priv->objects, g_strdup (info->id), obj);
518 _gtk_builder_add (GtkBuilder *builder,
519 ChildInfo *child_info)
524 /* Internal children are already added
525 * Also prevent us from being called twice.
528 child_info->internal_child ||
532 object = child_info->object;
536 if (!child_info->parent)
538 g_warning ("%s: Not adding, No parent",
539 gtk_buildable_get_name (GTK_BUILDABLE (object)));
543 g_assert (object != NULL);
545 parent = ((ObjectInfo*)child_info->parent)->object;
546 g_assert (GTK_IS_BUILDABLE (parent));
549 g_print ("adding %s to %s\n",
550 gtk_buildable_get_name (GTK_BUILDABLE (object)),
551 gtk_buildable_get_name (GTK_BUILDABLE (parent))));
553 gtk_buildable_add_child (GTK_BUILDABLE (parent), builder, object,
556 child_info->added = TRUE;
560 _gtk_builder_add_signals (GtkBuilder *builder,
563 builder->priv->signals = g_slist_concat (builder->priv->signals,
564 g_slist_copy (signals));
568 gtk_builder_apply_delayed_properties (GtkBuilder *builder)
571 DelayedProperty *property;
574 GObjectClass *oclass;
577 /* take the list over from the builder->priv.
579 * g_slist_reverse does not copy the list, so the list now
580 * belongs to us (and we free it at the end of this function).
582 props = g_slist_reverse (builder->priv->delayed_properties);
583 builder->priv->delayed_properties = NULL;
585 for (l = props; l; l = l->next)
587 property = (DelayedProperty*)l->data;
588 object = g_hash_table_lookup (builder->priv->objects, property->object);
589 g_assert (object != NULL);
591 object_type = G_OBJECT_TYPE (object);
592 g_assert (object_type != G_TYPE_INVALID);
594 oclass = g_type_class_ref (object_type);
595 g_assert (oclass != NULL);
597 pspec = g_object_class_find_property (G_OBJECT_CLASS (oclass),
600 g_warning ("Unknown property: %s.%s", g_type_name (object_type),
606 obj = g_hash_table_lookup (builder->priv->objects, property->value);
608 g_warning ("No object called: %s", property->value);
610 g_object_set (object, property->name, obj, NULL);
612 g_free (property->value);
613 g_free (property->object);
614 g_free (property->name);
615 g_slice_free (DelayedProperty, property);
616 g_type_class_unref (oclass);
618 g_slist_free (props);
622 _gtk_builder_finish (GtkBuilder *builder)
624 gtk_builder_apply_delayed_properties (builder);
630 * Creates a new builder object.
632 * Return value: a new #GtkBuilder object
637 gtk_builder_new (void)
639 return g_object_new (GTK_TYPE_BUILDER, NULL);
643 * gtk_builder_add_from_file:
644 * @builder: a #GtkBuilder
645 * @filename: the name of the file to parse
646 * @error: return location for an error, or %NULL
648 * Parses a file containing a <link linkend="BUILDER-UI">GtkBuilder
649 * UI definition</link> and merges it with the current contents of @builder.
651 * Returns: A positive value on success, 0 if an error occurred
656 gtk_builder_add_from_file (GtkBuilder *builder,
657 const gchar *filename,
664 g_return_val_if_fail (GTK_IS_BUILDER (builder), 0);
665 g_return_val_if_fail (filename != NULL, 0);
666 g_return_val_if_fail (error == NULL || *error == NULL, FALSE);
670 if (!g_file_get_contents (filename, &buffer, &length, &tmp_error))
672 g_propagate_error (error, tmp_error);
676 g_free (builder->priv->filename);
677 builder->priv->filename = g_strdup (filename);
679 _gtk_builder_parser_parse_buffer (builder, filename,
685 if (tmp_error != NULL)
687 g_propagate_error (error, tmp_error);
695 * gtk_builder_add_from_string:
696 * @builder: a #GtkBuilder
697 * @buffer: the string to parse
698 * @length: the length of @buffer (may be -1 if @buffer is nul-terminated)
699 * @error: return location for an error, or %NULL
701 * Parses a string containing a <link linkend="BUILDER-UI">GtkBuilder
702 * UI definition</link> and merges it with the current contents of @builder.
704 * Returns: A positive value on success, 0 if an error occurred
709 gtk_builder_add_from_string (GtkBuilder *builder,
716 g_return_val_if_fail (GTK_IS_BUILDER (builder), 0);
717 g_return_val_if_fail (buffer != NULL, 0);
718 g_return_val_if_fail (error == NULL || *error == NULL, FALSE);
722 g_free (builder->priv->filename);
723 builder->priv->filename = g_strdup (".");
725 _gtk_builder_parser_parse_buffer (builder, "<input>",
728 if (tmp_error != NULL)
730 g_propagate_error (error, tmp_error);
738 * gtk_builder_get_object:
739 * @builder: a #GtkBuilder
740 * @name: name of object to get
742 * Gets the object named @name. Note that this function does not
743 * increment the reference count of the returned object.
745 * Return value: the object named @name or %NULL if it could not be
746 * found in the object tree.
751 gtk_builder_get_object (GtkBuilder *builder,
754 g_return_val_if_fail (GTK_IS_BUILDER (builder), NULL);
755 g_return_val_if_fail (name != NULL, NULL);
757 return g_hash_table_lookup (builder->priv->objects, name);
761 object_add_to_list (gchar *object_id,
765 *list = g_slist_prepend (*list, object);
769 * gtk_builder_get_objects:
770 * @builder: a #GtkBuilder
772 * Gets all objects that have been constructed by @builder. Note that
773 * this function does not increment the reference counts of the returned
776 * Return value: a newly-allocated #GSList containing all the objects
777 * constructed by the #GtkBuilder instance. It should be freed by
783 gtk_builder_get_objects (GtkBuilder *builder)
785 GSList *objects = NULL;
787 g_return_val_if_fail (GTK_IS_BUILDER (builder), NULL);
789 g_hash_table_foreach (builder->priv->objects, (GHFunc)object_add_to_list, &objects);
791 return g_slist_reverse (objects);
795 * gtk_builder_set_translation_domain:
796 * @builder: a #GtkBuilder
797 * @domain: the translation domain or %NULL
799 * Sets the translation domain of @builder.
800 * See #GtkBuilder:translation-domain.
805 gtk_builder_set_translation_domain (GtkBuilder *builder,
810 g_return_if_fail (GTK_IS_BUILDER (builder));
812 new_domain = g_strdup (domain);
813 g_free (builder->priv->domain);
814 builder->priv->domain = new_domain;
816 g_object_notify (G_OBJECT (builder), "translation-domain");
820 * gtk_builder_get_translation_domain:
821 * @builder: a #GtkBuilder
823 * Gets the translation domain of @builder.
825 * Return value: the translation domain. This string is owned
826 * by the builder object and must not be modified or freed.
831 gtk_builder_get_translation_domain (GtkBuilder *builder)
833 g_return_val_if_fail (GTK_IS_BUILDER (builder), NULL);
835 return builder->priv->domain;
844 gtk_builder_connect_signals_default (GtkBuilder *builder,
846 const gchar *signal_name,
847 const gchar *handler_name,
848 GObject *connect_object,
853 connect_args *args = (connect_args*)user_data;
855 if (!g_module_symbol (args->module, handler_name, (gpointer)&func))
857 g_warning ("Could not find signal handler '%s'", handler_name);
862 g_signal_connect_object (object, signal_name, func, connect_object, flags);
864 g_signal_connect_data (object, signal_name, func, args->data, NULL, flags);
869 * gtk_builder_connect_signals:
870 * @builder: a #GtkBuilder
871 * @user_data: a pointer to a structure sent in as user data to all signals
873 * This method is a simpler variation of gtk_builder_connect_signals_full().
874 * It uses #GModule's introspective features (by opening the module %NULL)
875 * to look at the application's symbol table. From here it tries to match
876 * the signal handler names given in the interface description with
877 * symbols in the application and connects the signals.
879 * Note that this function will not work correctly if #GModule is not
880 * supported on the platform.
882 * When compiling applications for Windows, you must declare signal callbacks
883 * with #G_MODULE_EXPORT, or they will not be put in the symbol table.
884 * On Linux and Unices, this is not necessary; applications should instead
885 * be compiled with the -Wl,--export-dynamic CFLAGS, and linked against
886 * gmodule-export-2.0.
891 gtk_builder_connect_signals (GtkBuilder *builder,
896 g_return_if_fail (GTK_IS_BUILDER (builder));
898 if (!g_module_supported ())
899 g_error ("gtk_builder_connect_signals() requires working GModule");
901 args = g_slice_new0 (connect_args);
902 args->module = g_module_open (NULL, G_MODULE_BIND_LAZY);
903 args->data = user_data;
905 gtk_builder_connect_signals_full (builder,
906 gtk_builder_connect_signals_default,
908 g_module_close (args->module);
910 g_slice_free (connect_args, args);
914 * GtkBuilderConnectFunc:
915 * @builder: a #GtkBuilder
916 * @object: object to connect a signal to
917 * @signal_name: name of the signal
918 * @handler_name: name of the handler
919 * @connect_object: a #GObject, if non-%NULL, use g_signal_connect_object()
920 * @flags: #GConnectFlags to use
921 * @user_data: user data
923 * This is the signature of a function used to connect signals. It is used
924 * by the gtk_builder_connect_signals() and gtk_builder_connect_signals_full()
925 * methods. It is mainly intended for interpreted language bindings, but
926 * could be useful where the programmer wants more control over the signal
927 * connection process.
933 * gtk_builder_connect_signals_full:
934 * @builder: a #GtkBuilder
935 * @func: the function used to connect the signals
936 * @user_data: arbitrary data that will be passed to the connection function
938 * This function can be thought of the interpreted language binding
939 * version of gtk_builder_connect_signals(), except that it does not
940 * require GModule to function correctly.
945 gtk_builder_connect_signals_full (GtkBuilder *builder,
946 GtkBuilderConnectFunc func,
951 GObject *connect_object;
953 g_return_if_fail (GTK_IS_BUILDER (builder));
954 g_return_if_fail (func != NULL);
956 if (!builder->priv->signals)
959 builder->priv->signals = g_slist_reverse (builder->priv->signals);
960 for (l = builder->priv->signals; l; l = l->next)
962 SignalInfo *signal = (SignalInfo*)l->data;
964 g_assert (signal != NULL);
965 g_assert (signal->name != NULL);
967 object = g_hash_table_lookup (builder->priv->objects,
968 signal->object_name);
969 g_assert (object != NULL);
971 connect_object = NULL;
973 if (signal->connect_object_name)
975 connect_object = g_hash_table_lookup (builder->priv->objects,
976 signal->connect_object_name);
978 g_warning ("Could not lookup object %s on signal %s of object %s",
979 signal->connect_object_name, signal->name,
980 signal->object_name);
983 func (builder, object, signal->name, signal->handler,
984 connect_object, signal->flags, user_data);
987 g_slist_foreach (builder->priv->signals, (GFunc)_free_signal_info, NULL);
988 g_slist_free (builder->priv->signals);
989 builder->priv->signals = NULL;
993 * gtk_builder_value_from_string:
994 * @builder: a #GtkBuilder
995 * @pspec: the #GParamSpec for the property
996 * @string: the string representation of the value
997 * @value: the #GValue to store the result in
998 * @error: return location for an error, or %NULL
1000 * This function demarshals a value from a string. This function
1001 * calls g_value_init() on the @value argument, so it need not be
1002 * initialised beforehand.
1004 * This function can handle char, uchar, boolean, int, uint, long,
1005 * ulong, enum, flags, float, double, string, #GdkColor and
1006 * #GtkAdjustment type values. Support for #GtkWidget type values is
1009 * Returns: %TRUE on success
1014 gtk_builder_value_from_string (GtkBuilder *builder,
1016 const gchar *string,
1020 g_return_val_if_fail (GTK_IS_BUILDER (builder), FALSE);
1021 g_return_val_if_fail (G_IS_PARAM_SPEC (pspec), FALSE);
1022 g_return_val_if_fail (string != NULL, FALSE);
1023 g_return_val_if_fail (value != NULL, FALSE);
1024 g_return_val_if_fail (error == NULL || *error == NULL, FALSE);
1027 * GParamSpecUnichar has the internal type G_TYPE_UINT,
1028 * so we cannot handle this in the switch, do it separately
1030 if (G_IS_PARAM_SPEC_UNICHAR (pspec))
1033 g_value_init (value, G_TYPE_UINT);
1034 c = g_utf8_get_char_validated (string, strlen (string));
1036 g_value_set_uint (value, c);
1040 return gtk_builder_value_from_string_type (builder,
1041 G_PARAM_SPEC_VALUE_TYPE (pspec),
1042 string, value, error);
1046 * gtk_builder_value_from_string_type:
1047 * @builder: a #GtkBuilder
1048 * @type: the #GType of the value
1049 * @string: the string representation of the value
1050 * @value: the #GValue to store the result in
1051 * @error: return location for an error, or %NULL
1053 * Like gtk_builder_value_from_string(), this function demarshals
1054 * a value from a string, but takes a #GType instead of #GParamSpec.
1055 * This function calls g_value_init() on the @value argument, so it
1056 * need not be initialised beforehand.
1058 * Returns: %TRUE on success
1063 gtk_builder_value_from_string_type (GtkBuilder *builder,
1065 const gchar *string,
1069 gboolean ret = TRUE;
1071 g_return_val_if_fail (type != G_TYPE_INVALID, FALSE);
1072 g_return_val_if_fail (string != NULL, FALSE);
1073 g_return_val_if_fail (error == NULL || *error == NULL, FALSE);
1075 g_value_init (value, type);
1077 switch (G_TYPE_FUNDAMENTAL (type))
1080 g_value_set_char (value, string[0]);
1083 g_value_set_uchar (value, (guchar)string[0]);
1085 case G_TYPE_BOOLEAN:
1089 if (!_gtk_builder_boolean_from_string (string, &b, error))
1094 g_value_set_boolean (value, b);
1103 l = strtol (string, &endptr, 0);
1104 if (errno || endptr == string)
1108 GTK_BUILDER_ERROR_INVALID_VALUE,
1109 "Could not parse integer `%s'",
1114 if (G_VALUE_HOLDS_INT (value))
1115 g_value_set_int (value, l);
1117 g_value_set_long (value, l);
1126 ul = strtoul (string, &endptr, 0);
1127 if (errno || endptr == string)
1131 GTK_BUILDER_ERROR_INVALID_VALUE,
1132 "Could not parse unsigned integer `%s'",
1137 if (G_VALUE_HOLDS_UINT (value))
1138 g_value_set_uint (value, ul);
1140 g_value_set_ulong (value, ul);
1146 if (!_gtk_builder_enum_from_string (type, string, &enum_value, error))
1151 g_value_set_enum (value, enum_value);
1158 if (!_gtk_builder_flags_from_string (type, string, &flags_value, error))
1163 g_value_set_flags (value, flags_value);
1172 d = g_ascii_strtod (string, &endptr);
1173 if (errno || endptr == string)
1177 GTK_BUILDER_ERROR_INVALID_VALUE,
1178 "Could not parse double `%s'",
1183 if (G_VALUE_HOLDS_FLOAT (value))
1184 g_value_set_float (value, d);
1186 g_value_set_double (value, d);
1190 g_value_set_string (value, string);
1193 if (G_VALUE_HOLDS (value, GDK_TYPE_COLOR))
1195 GdkColor colour = { 0, };
1197 if (gdk_color_parse (string, &colour) &&
1198 gdk_colormap_alloc_color (gtk_widget_get_default_colormap (),
1199 &colour, FALSE, TRUE))
1200 g_value_set_boxed (value, &colour);
1205 GTK_BUILDER_ERROR_INVALID_VALUE,
1206 "Could not parse color `%s'",
1211 else if (G_VALUE_HOLDS (value, G_TYPE_STRV))
1213 gchar **vector = g_strsplit (string, "\n", 0);
1214 g_value_take_boxed (value, vector);
1220 if (G_VALUE_HOLDS (value, GDK_TYPE_PIXBUF))
1223 GError *tmp_error = NULL;
1226 if (gtk_builder_get_object (builder, string))
1230 GTK_BUILDER_ERROR_INVALID_VALUE,
1231 "Could not load image '%s': "
1232 " '%s' is already used as object id",
1237 filename = _gtk_builder_get_absolute_filename (builder, string);
1238 pixbuf = gdk_pixbuf_new_from_file (filename, &tmp_error);
1242 GtkIconTheme *theme;
1244 g_warning ("Could not load image '%s': %s",
1245 string, tmp_error->message);
1246 g_error_free (tmp_error);
1248 /* fall back to a missing image */
1249 theme = gtk_icon_theme_get_default ();
1250 pixbuf = gtk_icon_theme_load_icon (theme,
1251 GTK_STOCK_MISSING_IMAGE,
1253 GTK_ICON_LOOKUP_USE_BUILTIN,
1259 g_value_set_object (value, pixbuf);
1260 g_object_unref (G_OBJECT (pixbuf));
1273 GTK_BUILDER_ERROR_INVALID_VALUE,
1274 "Unsupported GType `%s'",
1275 g_type_name (type));
1284 _gtk_builder_enum_from_string (GType type,
1285 const gchar *string,
1295 g_return_val_if_fail (G_TYPE_IS_ENUM (type), FALSE);
1296 g_return_val_if_fail (string != NULL, FALSE);
1300 value = strtoul (string, &endptr, 0);
1301 if (endptr != string) /* parsed a number */
1302 *enum_value = value;
1305 eclass = g_type_class_ref (type);
1306 ev = g_enum_get_value_by_name (eclass, string);
1308 ev = g_enum_get_value_by_nick (eclass, string);
1311 *enum_value = ev->value;
1316 GTK_BUILDER_ERROR_INVALID_VALUE,
1317 "Could not parse enum: `%s'",
1322 g_type_class_unref (eclass);
1329 _gtk_builder_flags_from_string (GType type,
1330 const gchar *string,
1334 GFlagsClass *fclass;
1335 gchar *endptr, *prevptr;
1343 g_return_val_if_fail (G_TYPE_IS_FLAGS (type), FALSE);
1344 g_return_val_if_fail (string != 0, FALSE);
1348 value = strtoul (string, &endptr, 0);
1349 if (endptr != string) /* parsed a number */
1350 *flags_value = value;
1353 fclass = g_type_class_ref (type);
1355 flagstr = g_strdup (string);
1356 for (value = i = j = 0; ; i++)
1359 eos = flagstr[i] == '\0';
1361 if (!eos && flagstr[i] != '|')
1365 endptr = &flagstr[i];
1369 flagstr[i++] = '\0';
1376 ch = g_utf8_get_char (flag);
1377 if (!g_unichar_isspace (ch))
1379 flag = g_utf8_next_char (flag);
1382 while (endptr > flag)
1384 prevptr = g_utf8_prev_char (endptr);
1385 ch = g_utf8_get_char (prevptr);
1386 if (!g_unichar_isspace (ch))
1394 fv = g_flags_get_value_by_name (fclass, flag);
1397 fv = g_flags_get_value_by_nick (fclass, flag);
1405 GTK_BUILDER_ERROR_INVALID_VALUE,
1406 "Unknown flag: `%s'",
1415 *flags_value = value;
1422 g_type_class_unref (fclass);
1429 * gtk_builder_get_type_from_name:
1430 * @builder: a #GtkBuilder
1431 * @type_name: type name to lookup
1433 * Looks up a type by name, using the virtual function that
1434 * #GtkBuilder has for that purpose. This is mainly used when
1435 * implementing the #GtkBuildable interface on a type.
1437 * Returns: the #GType found for @type_name or #G_TYPE_INVALID
1438 * if no type was found
1443 gtk_builder_get_type_from_name (GtkBuilder *builder,
1444 const gchar *type_name)
1446 g_return_val_if_fail (GTK_IS_BUILDER (builder), G_TYPE_INVALID);
1447 g_return_val_if_fail (type_name != NULL, G_TYPE_INVALID);
1449 return GTK_BUILDER_GET_CLASS (builder)->get_type_from_name (builder, type_name);
1453 gtk_builder_error_quark (void)
1455 return g_quark_from_static_string ("gtk-builder-error-quark");
1459 _gtk_builder_get_absolute_filename (GtkBuilder *builder, const gchar *string)
1462 gchar *dirname = NULL;
1464 if (g_path_is_absolute (string))
1465 return g_strdup (string);
1467 if (builder->priv->filename &&
1468 strcmp (builder->priv->filename, ".") != 0)
1469 dirname = g_path_get_dirname (builder->priv->filename);
1471 dirname = g_get_current_dir ();
1473 filename = g_build_filename (dirname, string, NULL);
1479 #define __GTK_BUILDER_C__
1480 #include "gtkaliasdef.c"