From 4d638bf0c15c363f2c28cafc1485cf4066885383 Mon Sep 17 00:00:00 2001 From: Johan Dahlin Date: Fri, 15 Jun 2007 17:53:46 +0000 Subject: Add GtkBuilder, fixes #172535 2007-06-15 Johan Dahlin * demos/gtk-demo/Makefile.am: * demos/gtk-demo/builder.c: (quit_activate), (about_activate), (do_builder): * demos/gtk-demo/demo.ui: * docs/reference/gtk/gtk-docs.sgml: * docs/reference/gtk/gtk-sections.txt: * docs/reference/gtk/gtk.types: * docs/reference/gtk/tmpl/gtkbuildable.sgml: * docs/reference/gtk/tmpl/gtkbuilder.sgml: * gtk/Makefile.am: * gtk/gtk.h: * gtk/gtk.symbols: * gtk/gtkaction.c: (gtk_action_buildable_init), (gtk_action_buildable_set_name), (gtk_action_buildable_get_name): * gtk/gtkactiongroup.c: (gtk_action_group_get_type), (gtk_action_group_buildable_init), (gtk_action_group_buildable_add), (gtk_action_group_buildable_set_name), (gtk_action_group_buildable_get_name): * gtk/gtkbuildable.c: (gtk_buildable_get_type), (gtk_buildable_set_name), (gtk_buildable_get_name), (gtk_buildable_add), (gtk_buildable_set_property), (gtk_buildable_parser_finished), (gtk_buildable_construct_child), (gtk_buildable_custom_tag_start), (gtk_buildable_custom_tag_end), (gtk_buildable_custom_finished), (gtk_buildable_get_internal_child): * gtk/gtkbuildable.h: * gtk/gtkbuilder.c: (gtk_builder_class_init), (gtk_builder_init), (gtk_builder_finalize), (gtk_builder_set_property), (gtk_builder_get_property), (_gtk_builder_resolve_type_lazily), (gtk_builder_real_get_type_from_name), (gtk_builder_get_parameters), (gtk_builder_get_internal_child), (_gtk_builder_construct), (_gtk_builder_add), (apply_delayed_properties), (_gtk_builder_finish), (gtk_builder_new), (gtk_builder_add_from_file), (gtk_builder_add_from_string), (gtk_builder_get_object), (object_add_to_list), (gtk_builder_get_objects), (gtk_builder_set_translation_domain), (gtk_builder_get_translation_domain), (gtk_builder_connect_signals_default), (gtk_builder_connect_signals), (gtk_builder_connect_signals_full), (gtk_builder_value_from_string), (gtk_builder_value_from_string_type), (_gtk_builder_enum_from_string), (_gtk_builder_flags_from_string), (gtk_builder_get_type_from_name), (gtk_builder_error_quark): * gtk/gtkbuilder.h: * gtk/gtkbuilderparser.c: (state_push), (state_peek), (state_pop), (error_missing_attribute), (error_invalid_attribute), (error_invalid_tag), (builder_construct), (parse_object), (free_object_info), (_get_type_by_symbol), (parse_child), (free_child_info), (parse_property), (free_property_info), (parse_signal), (_free_signal_info), (parse_interface), (create_subparser), (free_subparser), (subparser_start), (subparser_end), (parse_custom), (start_element), (end_element), (text), (_gtk_builder_parser_parse_buffer): * gtk/gtkbuilderprivate.h: * gtk/gtkcelllayout.c: (attributes_start_element), (attributes_text_element), (_gtk_cell_layout_buildable_custom_tag_start), (_gtk_cell_layout_buildable_custom_tag_end), (_gtk_cell_layout_buildable_add): * gtk/gtkcelllayout.h: * gtk/gtkcellview.c: (gtk_cell_view_buildable_init), (gtk_cell_view_buildable_custom_tag_start), (gtk_cell_view_buildable_custom_tag_end): * gtk/gtkcolorseldialog.c: (gtk_color_selection_dialog_buildable_interface_init), (gtk_color_selection_dialog_buildable_get_internal_child): * gtk/gtkcombobox.c: (gtk_combo_box_buildable_init), (gtk_combo_box_buildable_custom_tag_start), (gtk_combo_box_buildable_custom_tag_end): * gtk/gtkcomboboxentry.c: (gtk_combo_box_entry_buildable_interface_init), (gtk_combo_box_entry_buildable_get_internal_child): * gtk/gtkcontainer.c: (gtk_container_get_type), (gtk_container_buildable_init), (gtk_container_buildable_add), (gtk_container_buildable_set_child_property), (attributes_start_element), (attributes_text_element), (gtk_container_buildable_custom_tag_start), (gtk_container_buildable_custom_tag_end): * gtk/gtkdebug.h: * gtk/gtkdialog.c: (gtk_dialog_buildable_interface_init), (gtk_dialog_buildable_get_internal_child), (attributes_start_element), (attributes_text_element), (gtk_dialog_buildable_custom_tag_start), (gtk_dialog_buildable_custom_finished): * gtk/gtkentrycompletion.c: (gtk_entry_completion_buildable_init): * gtk/gtkexpander.c: (gtk_expander_buildable_add), (gtk_expander_buildable_init): * gtk/gtkfontsel.c: (gtk_font_selection_dialog_buildable_interface_init), (gtk_font_selection_dialog_buildable_get_internal_child): * gtk/gtkframe.c: (gtk_frame_buildable_init), (gtk_frame_buildable_add): * gtk/gtkiconview.c: (gtk_icon_view_buildable_init), (gtk_icon_view_buildable_custom_tag_start), (gtk_icon_view_buildable_custom_tag_end): * gtk/gtkliststore.c: (gtk_list_store_buildable_init), (list_store_start_element), (list_store_end_element), (list_store_text), (gtk_list_store_buildable_custom_tag_start), (gtk_list_store_buildable_custom_tag_end): * gtk/gtkmain.c: * gtk/gtknotebook.c: (gtk_notebook_buildable_init), (gtk_notebook_buildable_add): * gtk/gtksizegroup.c: (gtk_size_group_buildable_init), (size_group_start_element), (gtk_size_group_buildable_custom_tag_start), (gtk_size_group_buildable_custom_finished): * gtk/gtktreestore.c: (gtk_tree_store_buildable_init), (tree_model_start_element), (gtk_tree_store_buildable_custom_tag_start), (gtk_tree_store_buildable_custom_finished): * gtk/gtktreeview.c: (gtk_tree_view_buildable_init), (gtk_tree_view_buildable_add): * gtk/gtktreeviewcolumn.c: (gtk_tree_view_column_buildable_init): * gtk/gtkuimanager.c: (gtk_ui_manager_buildable_init), (gtk_ui_manager_buildable_add), (gtk_ui_manager_buildable_construct_child), (gtk_ui_manager_buildable_custom_tag_start), (gtk_ui_manager_buildable_custom_tag_end): * gtk/gtkwidget.c: (gtk_widget_get_type), (gtk_widget_buildable_interface_init), (gtk_widget_buildable_set_name), (gtk_widget_buildable_get_name), (gtk_widget_buildable_set_property), (gtk_widget_buildable_parser_finshed), (accel_group_start_element), (gtk_widget_buildable_custom_tag_start), (gtk_widget_buildable_custom_finshed): * gtk/gtkwindow.c: (gtk_window_buildable_interface_init), (gtk_window_buildable_set_property), (gtk_window_buildable_parser_finished): * tests/Makefile.am: * tests/buildertest.c: (builder_new_from_string), (test_parser), (signal_normal), (signal_after), (signal_object), (signal_object_after), (signal_first), (signal_second), (signal_extra), (signal_extra2), (test_connect_signals), (test_uimanager_simple), (test_domain), (test_translation), (test_sizegroup), (test_list_store), (test_tree_store), (test_types), (test_spin_button), (test_notebook), (test_construct_only_property), (test_children), (test_child_properties), (test_treeview_column), (test_icon_view), (test_combo_box), (test_combo_box_entry), (test_cell_view), (test_dialog), (test_accelerators), (test_widget), (main): Add GtkBuilder, fixes #172535 svn path=/trunk/; revision=18141 --- gtk/gtkbuildable.c | 372 +++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 372 insertions(+) create mode 100644 gtk/gtkbuildable.c (limited to 'gtk/gtkbuildable.c') diff --git a/gtk/gtkbuildable.c b/gtk/gtkbuildable.c new file mode 100644 index 0000000000..ee3934ec27 --- /dev/null +++ b/gtk/gtkbuildable.c @@ -0,0 +1,372 @@ +/* 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. + */ + + +#include +#include "gtkbuildable.h" +#include "gtktypeutils.h" +#include "gtkintl.h" +#include "gtkalias.h" + +GType +gtk_buildable_get_type (void) +{ + static GType buildable_type = 0; + + if (!buildable_type) + buildable_type = + g_type_register_static_simple (G_TYPE_INTERFACE, I_("GtkBuildable"), + sizeof (GtkBuildableIface), + NULL, 0, NULL, 0); + + return buildable_type; +} + +/** + * gtk_buildable_set_name: + * @buildable: a #GtkBuildable + * @name: name to set + * + * Sets the name of the buildable object, it's used to synchronize the name + * if the object already has it's own concept of name. + * + * #GtkWidget implements this to map the buildable name to the widget name + * + * 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 + * + * Returns: the buildable name, the name which was set in + * the GtkBuilder UI definition used to + * construct the @buildable. + * + * #GtkWidget implements this to map the buildable name to the widget 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: + * @buildable: a #GtkBuildable + * @builder: a #GtkBuilder + * @child: child to add + * @type: kind of child or %NULL + * + * Add a child to a buildable. type is an optional string + * describing how the child should be added. + * + * #GtkContainer implements this to be able to add a child widget + * to the container. #GtkNotebook uses the @type to distinguish between + * page labels (@type = "page-label") and normal children. + * + * Since: 2.12 + **/ +void +gtk_buildable_add (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 != NULL); + + (* iface->add) (buildable, builder, child, type); +} + +/** + * gtk_buildable_set_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 @buildable + * which is created by the @builder. + * + * This is optional to implement and is normally not needed. + * g_object_set_property() is used as a fallback. + * + * #GtkWindow implements this to delay showing (::visible) itself until + * the whole interface is fully created. + * + * Since: 2.12 + **/ +void +gtk_buildable_set_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_property) + (* iface->set_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 + * + * Finish the parsing of a GtkBuilder UI definition + * snippet. 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. + * + * #GtkWindow implements this to delay showing (::visible) itself until + * the whole interface is fully created. + * + * 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 + * + * Construct a child of @buildable with the name @name. + * + * #GtkUIManager implements this to reference to a widget created in a <ui> tag + * which is outside of the normal GtkBuilder UI definition + * object hierarchy. + * + * 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: child object or %NULL for non-child tags + * @tagname: name of tag + * @parser: a #GMarkupParser structure + * @data: user data that will be passed in to parser functions + * + * This is called when an unknown tag under <child> tag is found. + * + * Called when an unknown tag is present under a <child> tag. + * If the buildable implementation wishes to handle the tag it should + * return %TRUE and fill in the @parser structure. Remember to either + * implement custom_tag_end or custom_tag_finish to free + * the user data allocated here. + * + * #GtkWidget implements this and parsers all <accelerator> tags to + * keyboard accelerators. + * #GtkContainer implements this to map properties defined under + * <packing> tag to child properties. + * + * 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: 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 for each custom tag handled by the buildable. + * It will be called when the end of the tag is reached. + * + * 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: 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 @child of the @buildable object. + * + * Return: 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" -- cgit v1.2.1