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 #ifndef __GTK_BUILDER_H__
  21 #define __GTK_BUILDER_H__
  22
  23 #include <glib-object.h>
  24
  25 G_BEGIN_DECLS
  26
  27 #define GTK_TYPE_BUILDER                 (gtk_builder_get_type ())
  28 #define GTK_BUILDER(obj)                 (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_BUILDER, GtkBuilder))
  29 #define GTK_BUILDER_CLASS(klass)         (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_BUILDER, GtkBuilderClass))
  30 #define GTK_IS_BUILDER(obj)              (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_BUILDER))
  31 #define GTK_IS_BUILDER_CLASS(klass)      (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_BUILDER))
  32 #define GTK_BUILDER_GET_CLASS(obj)       (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_BUILDER, GtkBuilderClass))
  33
  34 #define GTK_BUILDER_ERROR                (gtk_builder_error_quark ())
  35
  36 typedef struct _GtkBuilder        GtkBuilder;
  37 typedef struct _GtkBuilderClass   GtkBuilderClass;
  38 typedef struct _GtkBuilderPrivate GtkBuilderPrivate;
  39
  40 typedef enum
  41 {
  42   GTK_BUILDER_ERROR_INVALID_TYPE_FUNCTION,
  43   GTK_BUILDER_ERROR_UNHANDLED_TAG,
  44   GTK_BUILDER_ERROR_MISSING_ATTRIBUTE,
  45   GTK_BUILDER_ERROR_INVALID_ATTRIBUTE,
  46   GTK_BUILDER_ERROR_INVALID_TAG,
  47   GTK_BUILDER_ERROR_MISSING_PROPERTY_VALUE,
  48   GTK_BUILDER_ERROR_INVALID_VALUE
  49 } GtkBuilderError;
  50
  51 GQuark gtk_builder_error_quark (void);
  52
  53 struct _GtkBuilder
  54 {
  55   GObject parent_instance;
  56
  57   GtkBuilderPrivate *priv;
  58 };
  59
  60 struct _GtkBuilderClass
  61 {
  62   GObjectClass parent_class;
  63
  64   GType (* get_type_from_name) (GtkBuilder *builder,
  65                                 const char *type_name);
  66
  67   /* Padding for future expansion */
  68   void (*_gtk_reserved1) (void);
  69   void (*_gtk_reserved2) (void);
  70   void (*_gtk_reserved3) (void);
  71   void (*_gtk_reserved4) (void);
  72   void (*_gtk_reserved5) (void);
  73   void (*_gtk_reserved6) (void);
  74   void (*_gtk_reserved7) (void);
  75   void (*_gtk_reserved8) (void);
  76 };
  77
  78 typedef void (*GtkBuilderConnectFunc) (GtkBuilder    *builder,
  79                                        GObject       *object,
  80                                        const gchar   *signal_name,
  81                                        const gchar   *handler_name,
  82                                        GObject       *connect_object,
  83                                        GConnectFlags  flags,
  84                                        gpointer       user_data);
  85
  86 GType        gtk_builder_get_type                (void) G_GNUC_CONST;
  87 GtkBuilder*  gtk_builder_new                     (void);
  88
  89 guint        gtk_builder_add_from_file           (GtkBuilder    *builder,
  90                                                   const gchar   *filename,
  91                                                   GError       **error);
  92 guint        gtk_builder_add_from_string         (GtkBuilder    *builder,
  93                                                   const gchar   *buffer,
  94                                                   gsize          length,
  95                                                   GError       **error);
  96 GObject*     gtk_builder_get_object              (GtkBuilder    *builder,
  97                                                   const gchar   *name);
  98 GSList*      gtk_builder_get_objects             (GtkBuilder    *builder);
  99 void         gtk_builder_connect_signals         (GtkBuilder    *builder,
 100                                                   gpointer       user_data);
 101 void         gtk_builder_connect_signals_full    (GtkBuilder    *builder,
 102                                                   GtkBuilderConnectFunc func,
 103                                                   gpointer       user_data);
 104 void         gtk_builder_set_translation_domain  (GtkBuilder    *builder,
 105                                                   const gchar   *domain);
 106 const gchar* gtk_builder_get_translation_domain  (GtkBuilder    *builder);
 107 GType        gtk_builder_get_type_from_name      (GtkBuilder    *builder,
 108                                                   const char    *type_name);
 109
 110 gboolean     gtk_builder_value_from_string       (GtkBuilder    *builder,
 111                                                   GParamSpec    *pspec,
 112                                                   const gchar   *string,
 113                                                   GValue        *value,
 114                                                   GError       **error);
 115 gboolean     gtk_builder_value_from_string_type  (GtkBuilder    *builder,
 116                                                   GType          type,
 117                                                   const gchar   *string,
 118                                                   GValue        *value,
 119                                                   GError       **error);
 120
 121 #define GTK_BUILDER_WARN_INVALID_CHILD_TYPE(object, type) \
 122   g_warning ("'%s' is not a valid child type of '%s'", type, g_type_name (G_OBJECT_TYPE (type)))
 123
 124 G_END_DECLS
 125
 126 #endif /* __GTK_BUILDER_H__ */