gtk2/gtk/gtkbuilderprivate.h
Matthias Clasen df455db2e3 GtkBuilder: Make IDs optional
One requirement of .ui files is that each object must have an ID,
even if it is never referred to or directly loaded from the code.
This makes editing .ui files much more onerous than it has to be,
due to the frequent need to invent new IDs, while avoiding
clashes.

This commit makes IDs optional in the XML. They only need to
be provided for objects which are referred to or explictly loaded
from the code. Since GtkBuilder needs IDs for its own internal
accounting, we create IDs of the form ___object_N___ if not
specified in the XML.

https://bugzilla.gnome.org/show_bug.cgi?id=712553
2013-11-18 06:00:02 -05:00

177 lines
5.2 KiB
C

/* gtkbuilderprivate.h
* Copyright (C) 2006-2007 Async Open Source,
* Johan Dahlin <jdahlin@async.com.br>
*
* 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, see <http://www.gnu.org/licenses/>.
*/
#ifndef __GTK_BUILDER_PRIVATE_H__
#define __GTK_BUILDER_PRIVATE_H__
#include "gtkbuilder.h"
typedef struct {
const gchar *name;
} TagInfo;
typedef struct {
TagInfo tag;
} CommonInfo;
typedef struct {
TagInfo tag;
gchar *class_name;
gchar *id;
gchar *constructor;
GSList *properties;
GSList *signals;
GObject *object;
CommonInfo *parent;
gboolean applied_properties;
} ObjectInfo;
typedef struct {
TagInfo tag;
gchar *id;
GHashTable *objects;
} MenuInfo;
typedef struct {
TagInfo tag;
GSList *packing_properties;
GObject *object;
CommonInfo *parent;
gchar *type;
gchar *internal_child;
gboolean added;
} ChildInfo;
typedef struct {
TagInfo tag;
gchar *name;
GString *text;
gchar *data;
gboolean translatable;
gchar *context;
} PropertyInfo;
typedef struct {
TagInfo tag;
gchar *object_name;
gchar *name;
gchar *handler;
GConnectFlags flags;
gchar *connect_object_name;
} SignalInfo;
typedef struct {
TagInfo tag;
gchar *library;
gint major;
gint minor;
} RequiresInfo;
typedef struct {
GMarkupParser *parser;
gchar *tagname;
const gchar *start;
gpointer data;
GObject *object;
GObject *child;
} SubParser;
typedef struct {
const gchar *last_element;
GtkBuilder *builder;
gchar *domain;
GSList *stack;
SubParser *subparser;
GMarkupParseContext *ctx;
const gchar *filename;
GSList *finalizers;
GSList *custom_finalizers;
GSList *requested_objects; /* NULL if all the objects are requested */
gboolean inside_requested_object;
gint requested_object_level;
gint cur_object_level;
gint object_counter;
GHashTable *object_ids;
} ParserData;
typedef GType (*GTypeGetFunc) (void);
/* Things only GtkBuilder should use */
void _gtk_builder_parser_parse_buffer (GtkBuilder *builder,
const gchar *filename,
const gchar *buffer,
gsize length,
gchar **requested_objs,
GError **error);
GObject * _gtk_builder_construct (GtkBuilder *builder,
ObjectInfo *info,
GError **error);
void _gtk_builder_apply_properties (GtkBuilder *builder,
ObjectInfo *info,
GError **error);
void _gtk_builder_add_object (GtkBuilder *builder,
const gchar *id,
GObject *object);
void _gtk_builder_add (GtkBuilder *builder,
ChildInfo *child_info);
void _gtk_builder_add_signals (GtkBuilder *builder,
GSList *signals);
void _gtk_builder_finish (GtkBuilder *builder);
void _free_signal_info (SignalInfo *info,
gpointer user_data);
/* Internal API which might be made public at some point */
gboolean _gtk_builder_boolean_from_string (const gchar *string,
gboolean *value,
GError **error);
gboolean _gtk_builder_enum_from_string (GType type,
const gchar *string,
gint *enum_value,
GError **error);
gboolean _gtk_builder_flags_from_string (GType type,
const char *string,
guint *value,
GError **error);
const gchar * _gtk_builder_parser_translate (const gchar *domain,
const gchar *context,
const gchar *text);
gchar * _gtk_builder_get_resource_path (GtkBuilder *builder,
const gchar *string);
gchar * _gtk_builder_get_absolute_filename (GtkBuilder *builder,
const gchar *string);
void _gtk_builder_menu_start (ParserData *parser_data,
const gchar *element_name,
const gchar **attribute_names,
const gchar **attribute_values,
GError **error);
void _gtk_builder_menu_end (ParserData *parser_data);
GType _gtk_builder_get_template_type (GtkBuilder *builder);
guint _gtk_builder_extend_with_template (GtkBuilder *builder,
GtkWidget *widget,
GType template_type,
const gchar *buffer,
gsize length,
GError **error);
#endif /* __GTK_BUILDER_PRIVATE_H__ */