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_DISABLE_SINGLE_INCLUDES) && !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 typedef enum
  46 {
  47   GTK_BUILDER_ERROR_INVALID_TYPE_FUNCTION,
  48   GTK_BUILDER_ERROR_UNHANDLED_TAG,
  49   GTK_BUILDER_ERROR_MISSING_ATTRIBUTE,
  50   GTK_BUILDER_ERROR_INVALID_ATTRIBUTE,
  51   GTK_BUILDER_ERROR_INVALID_TAG,
  52   GTK_BUILDER_ERROR_MISSING_PROPERTY_VALUE,
  53   GTK_BUILDER_ERROR_INVALID_VALUE,
  54   GTK_BUILDER_ERROR_VERSION_MISMATCH
  55 } GtkBuilderError;
  56
  57 GQuark gtk_builder_error_quark (void);
  58
  59 struct _GtkBuilder
  60 {
  61   GObject parent_instance;
  62
  63   GtkBuilderPrivate *priv;
  64 };
  65
  66 struct _GtkBuilderClass
  67 {
  68   GObjectClass parent_class;
  69
  70   GType (* get_type_from_name) (GtkBuilder *builder,
  71                                 const char *type_name);
  72
  73   /* Padding for future expansion */
  74   void (*_gtk_reserved1) (void);
  75   void (*_gtk_reserved2) (void);
  76   void (*_gtk_reserved3) (void);
  77   void (*_gtk_reserved4) (void);
  78   void (*_gtk_reserved5) (void);
  79   void (*_gtk_reserved6) (void);
  80   void (*_gtk_reserved7) (void);
  81   void (*_gtk_reserved8) (void);
  82 };
  83
  84 typedef void (*GtkBuilderConnectFunc) (GtkBuilder    *builder,
  85                                        GObject       *object,
  86                                        const gchar   *signal_name,
  87                                        const gchar   *handler_name,
  88                                        GObject       *connect_object,
  89                                        GConnectFlags  flags,
  90                                        gpointer       user_data);
  91
  92 GType        gtk_builder_get_type                (void) G_GNUC_CONST;
  93 GtkBuilder*  gtk_builder_new                     (void);
  94
  95 guint        gtk_builder_add_from_file           (GtkBuilder    *builder,
  96                                                   const gchar   *filename,
  97                                                   GError       **error);
  98 guint        gtk_builder_add_from_string         (GtkBuilder    *builder,
  99                                                   const gchar   *buffer,
 100                                                   gsize          length,
 101                                                   GError       **error);
 102 GObject*     gtk_builder_get_object              (GtkBuilder    *builder,
 103                                                   const gchar   *name);
 104 GSList*      gtk_builder_get_objects             (GtkBuilder    *builder);
 105 void         gtk_builder_connect_signals         (GtkBuilder    *builder,
 106                                                   gpointer       user_data);
 107 void         gtk_builder_connect_signals_full    (GtkBuilder    *builder,
 108                                                   GtkBuilderConnectFunc func,
 109                                                   gpointer       user_data);
 110 void         gtk_builder_set_translation_domain  (GtkBuilder    *builder,
 111                                                   const gchar   *domain);
 112 const gchar* gtk_builder_get_translation_domain  (GtkBuilder    *builder);
 113 GType        gtk_builder_get_type_from_name      (GtkBuilder    *builder,
 114                                                   const char    *type_name);
 115
 116 gboolean     gtk_builder_value_from_string       (GtkBuilder    *builder,
 117                                                   GParamSpec    *pspec,
 118                                                   const gchar   *string,
 119                                                   GValue        *value,
 120                                                   GError       **error);
 121 gboolean     gtk_builder_value_from_string_type  (GtkBuilder    *builder,
 122                                                   GType          type,
 123                                                   const gchar   *string,
 124                                                   GValue        *value,
 125                                                   GError       **error);
 126
 127 #define GTK_BUILDER_WARN_INVALID_CHILD_TYPE(object, type) \
 128   g_warning ("'%s' is not a valid child type of '%s'", type, g_type_name (G_OBJECT_TYPE (type)))
 129
 130 G_END_DECLS
 131
 132 #endif /* __GTK_BUILDER_H__ */