Pileus Git - ~andy/gtk/blob - gtk/gtkbuilder.h

   1 /* GTK - The GIMP Toolkit
   2  * Copyright (C) 2006-2007 Async Open Source,
   3  *                         Johan Dahlin <jdahlin@async.com.br>
   4  *
   5  * This library is free software; you can redistribute it and/or
   6  * modify it under the terms of the GNU Library General Public
   7  * License as published by the Free Software Foundation; either
   8  * version 2 of the License, or (at your option) any later version.
   9  *
  10  * This library is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  * Library General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU Library General Public
  16  * License along with this library; if not, write to the
  17  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  18  * Boston, MA 02111-1307, USA.
  19  */
  20
  21 #if !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
  22 #error "Only <gtk/gtk.h> can be included directly."
  23 #endif
  24
  25 #ifndef __GTK_BUILDER_H__
  26 #define __GTK_BUILDER_H__
  27
  28 #include <glib-object.h>
  29
  30 G_BEGIN_DECLS
  31
  32 #define GTK_TYPE_BUILDER                 (gtk_builder_get_type ())
  33 #define GTK_BUILDER(obj)                 (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_BUILDER, GtkBuilder))
  34 #define GTK_BUILDER_CLASS(klass)         (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_BUILDER, GtkBuilderClass))
  35 #define GTK_IS_BUILDER(obj)              (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_BUILDER))
  36 #define GTK_IS_BUILDER_CLASS(klass)      (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_BUILDER))
  37 #define GTK_BUILDER_GET_CLASS(obj)       (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_BUILDER, GtkBuilderClass))
  38
  39 #define GTK_BUILDER_ERROR                (gtk_builder_error_quark ())
  40
  41 typedef struct _GtkBuilder        GtkBuilder;
  42 typedef struct _GtkBuilderClass   GtkBuilderClass;
  43 typedef struct _GtkBuilderPrivate GtkBuilderPrivate;
  44
  45 /**
  46  * GtkBuilderError:
  47  * @GTK_BUILDER_ERROR_INVALID_TYPE_FUNCTION: A type-func attribute didn't name
  48  *  a function that returns a #GType.
  49  * @GTK_BUILDER_ERROR_UNHANDLED_TAG: The input contained a tag that #GtkBuilder
  50  *  can't handle.
  51  * @GTK_BUILDER_ERROR_MISSING_ATTRIBUTE: An attribute that is required by
  52  *  #GtkBuilder was missing.
  53  * @GTK_BUILDER_ERROR_INVALID_ATTRIBUTE: #GtkBuilder found an attribute that
  54  *  it doesn't understand.
  55  * @GTK_BUILDER_ERROR_INVALID_TAG: #GtkBuilder found a tag that
  56  *  it doesn't understand.
  57  * @GTK_BUILDER_ERROR_MISSING_PROPERTY_VALUE: A required property value was
  58  *  missing.
  59  * @GTK_BUILDER_ERROR_INVALID_VALUE: #GtkBuilder couldn't parse
  60  *  some attribute value.
  61  * @GTK_BUILDER_ERROR_VERSION_MISMATCH: The input file requires a newer version
  62  *  of GTK+.
  63  * @GTK_BUILDER_ERROR_DUPLICATE_ID: An object id occurred twice.
  64  *
  65  * Error codes that identify various errors that can occur while using
  66  * #GtkBuilder.
  67  */
  68 typedef enum
  69 {
  70   GTK_BUILDER_ERROR_INVALID_TYPE_FUNCTION,
  71   GTK_BUILDER_ERROR_UNHANDLED_TAG,
  72   GTK_BUILDER_ERROR_MISSING_ATTRIBUTE,
  73   GTK_BUILDER_ERROR_INVALID_ATTRIBUTE,
  74   GTK_BUILDER_ERROR_INVALID_TAG,
  75   GTK_BUILDER_ERROR_MISSING_PROPERTY_VALUE,
  76   GTK_BUILDER_ERROR_INVALID_VALUE,
  77   GTK_BUILDER_ERROR_VERSION_MISMATCH,
  78   GTK_BUILDER_ERROR_DUPLICATE_ID
  79 } GtkBuilderError;
  80
  81 GQuark gtk_builder_error_quark (void);
  82
  83 struct _GtkBuilder
  84 {
  85   GObject parent_instance;
  86
  87   GtkBuilderPrivate *priv;
  88 };
  89
  90 struct _GtkBuilderClass
  91 {
  92   GObjectClass parent_class;
  93
  94   GType (* get_type_from_name) (GtkBuilder *builder,
  95                                 const char *type_name);
  96
  97   /* Padding for future expansion */
  98   void (*_gtk_reserved1) (void);
  99   void (*_gtk_reserved2) (void);
 100   void (*_gtk_reserved3) (void);
 101   void (*_gtk_reserved4) (void);
 102   void (*_gtk_reserved5) (void);
 103   void (*_gtk_reserved6) (void);
 104   void (*_gtk_reserved7) (void);
 105   void (*_gtk_reserved8) (void);
 106 };
 107
 108 typedef void (*GtkBuilderConnectFunc) (GtkBuilder    *builder,
 109                                        GObject       *object,
 110                                        const gchar   *signal_name,
 111                                        const gchar   *handler_name,
 112                                        GObject       *connect_object,
 113                                        GConnectFlags  flags,
 114                                        gpointer       user_data);
 115
 116 GType        gtk_builder_get_type                (void) G_GNUC_CONST;
 117 GtkBuilder*  gtk_builder_new                     (void);
 118
 119 guint        gtk_builder_add_from_file           (GtkBuilder    *builder,
 120                                                   const gchar   *filename,
 121                                                   GError       **error);
 122 guint        gtk_builder_add_from_resource       (GtkBuilder    *builder,
 123                                                   const gchar   *resource_path,
 124                                                   GError       **error);
 125 guint        gtk_builder_add_from_string         (GtkBuilder    *builder,
 126                                                   const gchar   *buffer,
 127                                                   gsize          length,
 128                                                   GError       **error);
 129 guint        gtk_builder_add_objects_from_file   (GtkBuilder    *builder,
 130                                                   const gchar   *filename,
 131                                                   gchar        **object_ids,
 132                                                   GError       **error);
 133 guint        gtk_builder_add_objects_from_resource(GtkBuilder    *builder,
 134                                                   const gchar   *resource_path,
 135                                                   gchar        **object_ids,
 136                                                   GError       **error);
 137 guint        gtk_builder_add_objects_from_string (GtkBuilder    *builder,
 138                                                   const gchar   *buffer,
 139                                                   gsize          length,
 140                                                   gchar        **object_ids,
 141                                                   GError       **error);
 142 GObject*     gtk_builder_get_object              (GtkBuilder    *builder,
 143                                                   const gchar   *name);
 144 GSList*      gtk_builder_get_objects             (GtkBuilder    *builder);
 145 void         gtk_builder_connect_signals         (GtkBuilder    *builder,
 146                                                   gpointer       user_data);
 147 void         gtk_builder_connect_signals_full    (GtkBuilder    *builder,
 148                                                   GtkBuilderConnectFunc func,
 149                                                   gpointer       user_data);
 150 void         gtk_builder_set_translation_domain  (GtkBuilder    *builder,
 151                                                   const gchar   *domain);
 152 const gchar* gtk_builder_get_translation_domain  (GtkBuilder    *builder);
 153 GType        gtk_builder_get_type_from_name      (GtkBuilder    *builder,
 154                                                   const char    *type_name);
 155
 156 gboolean     gtk_builder_value_from_string       (GtkBuilder    *builder,
 157                                                   GParamSpec    *pspec,
 158                                                   const gchar   *string,
 159                                                   GValue        *value,
 160                                                   GError       **error);
 161 gboolean     gtk_builder_value_from_string_type  (GtkBuilder    *builder,
 162                                                   GType          type,
 163                                                   const gchar   *string,
 164                                                   GValue        *value,
 165                                                   GError       **error);
 166
 167 /**
 168  * GTK_BUILDER_WARN_INVALID_CHILD_TYPE:
 169  * @object: the #GtkBuildable on which the warning ocurred
 170  * @type: the unexpected type value
 171  *
 172  * This macro should be used to emit a warning about and unexpected @type value
 173  * in a #GtkBuildable add_child implementation.
 174  */
 175 #define GTK_BUILDER_WARN_INVALID_CHILD_TYPE(object, type) \
 176   g_warning ("'%s' is not a valid child type of '%s'", type, g_type_name (G_OBJECT_TYPE (object)))
 177
 178 G_END_DECLS
 179
 180 #endif /* __GTK_BUILDER_H__ */