glade-property.h 8.28 KB
Newer Older
Jose Maria Celorio's avatar
Jose Maria Celorio committed
1 2 3 4
/* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*- */
#ifndef __GLADE_PROPERTY_H__
#define __GLADE_PROPERTY_H__

5 6
#include <glib-object.h>

Jose Maria Celorio's avatar
Jose Maria Celorio committed
7 8
G_BEGIN_DECLS

9 10
#define GLADE_TYPE_PROPERTY            (glade_property_get_type())
#define GLADE_PROPERTY(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj), GLADE_TYPE_PROPERTY, GladeProperty))
11
#define GLADE_PROPERTY_KLASS(klass)    (G_TYPE_CHECK_CLASS_CAST ((klass), GLADE_TYPE_PROPERTY, GladePropertyKlass))
12
#define GLADE_IS_PROPERTY(obj)         (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GLADE_TYPE_PROPERTY))
13 14
#define GLADE_IS_PROPERTY_KLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GLADE_TYPE_PROPERTY))
#define GLADE_PROPERTY_GET_KLASS(o)    (G_TYPE_INSTANCE_GET_CLASS ((o), GLADE_PROPERTY, GladePropertyKlass))
15

16
typedef struct _GladePropertyKlass GladePropertyKlass;
Tristan Van Berkom's avatar
Tristan Van Berkom committed
17

18 19 20 21 22 23 24 25
typedef enum {
	GLADE_STATE_NORMAL = 0,
	GLADE_STATE_CHANGED,
	GLADE_STATE_UNSUPPORTED,	
	GLADE_STATE_UNSUPPORTED_CHANGED,
	GLADE_N_STATES
} GladePropertyState;

Jose Maria Celorio's avatar
Jose Maria Celorio committed
26 27 28 29
/* A GladeProperty is an instance of a GladePropertyClass.
 * There will be one GladePropertyClass for "GtkLabel->label" but one
 * GladeProperty for each GtkLabel in the GladeProject.
 */
30 31
struct _GladeProperty
{
32 33
	GObject             parent_instance;

34
	GladePropertyClass *klass;     /* A pointer to the GladeProperty that this
35 36
					* setting specifies
					*/
37
	GladeWidget        *widget;    /* A pointer to the GladeWidget that this
38 39
					* GladeProperty is modifying
					*/
40 41 42

	GladePropertyState  state;     /* Current property state, used by editing widgets.
					*/
43 44 45 46 47 48 49
	
	GValue             *value;     /* The value of the property
					*/

	gboolean            sensitive; /* Whether this property is sensitive (if the
					* property is "optional" this takes precedence).
					*/
50
	gchar              *insensitive_tooltip; /* Tooltip to display when in insensitive state
51 52
						  * (used to explain why the property is 
						  *  insensitive)
53
						  */
54

55 56 57 58 59 60
	gchar              *support_warning; /* Tooltip to display when the property
					      * has format problems
					      * (used to explain why the property is 
					      *  insensitive)
					      */

61 62
	gboolean            enabled;   /* Enabled is a flag that is used for GladeProperties
					* that have the optional flag set to let us know
63
					* if this widget has this setting enabled or
64 65 66 67 68
					* not. (Like default size, it can be specified or
					* unspecified). This flag also sets the state
					* of the property->input state for the loaded
					* widget.
					*/
69

70 71 72 73 74 75 76
	gboolean            save_always; /* Used to make a special case exception and always
					  * save this property regardless of what the default
					  * value is (used for some special cases like properties
					  * that are assigned initial values in composite widgets
					  * or derived widget code).
					  */

77 78 79 80 81
	/* Used only for translatable strings. */
	gboolean  i18n_translatable;
	gboolean  i18n_has_context;
	gchar    *i18n_comment;
		
82 83
	gboolean     syncing;    /* Avoid recursion while synchronizing object with value.
				  */
84 85 86
};


87
struct _GladePropertyKlass
88 89 90 91
{
	GObjectClass  parent_class;

	/* Class methods */
92
	GladeProperty *         (* dup)                   (GladeProperty *, GladeWidget *);
93
	gboolean                (* equals_value)          (GladeProperty *, const GValue *);
94
	gboolean                (* set_value)             (GladeProperty *, const GValue *);
95
	void                    (* get_value)             (GladeProperty *, GValue *);
96
	void                    (* get_default)           (GladeProperty *, GValue *);
97
	void                    (* sync)                  (GladeProperty *);
98
	void                    (* load)                  (GladeProperty *);
99 100

	/* Signals */
101
	void             (* value_changed)         (GladeProperty *, GValue *, GValue *);
102 103
	void             (* tooltip_changed)       (GladeProperty *, const gchar *, 
						    const gchar   *, const gchar *);
104
};
Chema Celorio's avatar
Chema Celorio committed
105

106

107
GType                   glade_property_get_type              (void) G_GNUC_CONST;
108

109
GladeProperty          *glade_property_new                   (GladePropertyClass *klass,
110
							      GladeWidget        *widget,
111
							      GValue             *value);
112

113
GladeProperty          *glade_property_dup                   (GladeProperty      *template_prop,
114
							      GladeWidget        *widget);
115

116
void                    glade_property_reset                 (GladeProperty      *property);
117

118
void                    glade_property_original_reset        (GladeProperty      *property);
119

120
gboolean                glade_property_default               (GladeProperty      *property);
121

122
gboolean                glade_property_original_default      (GladeProperty      *property);
123

124
gboolean                glade_property_equals_value          (GladeProperty      *property, 
125
							      const GValue       *value);
126

127 128
gboolean                glade_property_equals                (GladeProperty      *property, 
							      ...);
129

130
gboolean                glade_property_set_value             (GladeProperty      *property, 
131
							      const GValue       *value);
132

133
gboolean                glade_property_set_va_list           (GladeProperty      *property,
134
							      va_list             vl);
135

136
gboolean                glade_property_set                   (GladeProperty      *property,
137
							      ...);
138

139 140
void                    glade_property_get_value             (GladeProperty      *property, 
							      GValue             *value);
141

142 143
void                    glade_property_get_default           (GladeProperty      *property, 
							      GValue             *value);
144

145 146
void                    glade_property_get_va_list           (GladeProperty      *property,
							      va_list             vl);
147

148 149
void                    glade_property_get                   (GladeProperty      *property, 
							      ...);
150

Tristan Van Berkom's avatar
Tristan Van Berkom committed
151 152
void                    glade_property_add_object            (GladeProperty      *property,
							      GObject            *object);
153

Tristan Van Berkom's avatar
Tristan Van Berkom committed
154 155
void                    glade_property_remove_object         (GladeProperty      *property,
							      GObject            *object);
156

157
void                    glade_property_sync                  (GladeProperty      *property);
158

159
void                    glade_property_load                  (GladeProperty      *property);
160

161
void                    glade_property_read                  (GladeProperty      *property,
Tristan Van Berkom's avatar
Tristan Van Berkom committed
162
							      GladeProject       *project,
163
							      GladeXmlNode       *node);
164

165 166 167
void                    glade_property_write                 (GladeProperty      *property,	
							      GladeXmlContext    *context,
							      GladeXmlNode       *node);
168

169 170 171
void                    glade_property_set_sensitive         (GladeProperty      *property,
							      gboolean            sensitive,
							      const gchar        *reason);
172

173 174 175
void                    glade_property_set_support_warning   (GladeProperty      *property,
							      const gchar        *reason);

176
gboolean                glade_property_get_sensitive         (GladeProperty      *property);
177

178

179 180
void                    glade_property_set_save_always       (GladeProperty      *property,
							      gboolean            setting);
181

182 183
gboolean                glade_property_get_save_always       (GladeProperty      *property);

184

185 186
void                    glade_property_set_enabled           (GladeProperty      *property,
							      gboolean            enabled);
187

188 189
gboolean                glade_property_get_enabled           (GladeProperty      *property);

190

191 192
void                    glade_property_i18n_set_comment      (GladeProperty      *property, 
							      const gchar        *str);
193

194
G_CONST_RETURN gchar   *glade_property_i18n_get_comment      (GladeProperty      *property);
195

196 197
void                    glade_property_i18n_set_translatable (GladeProperty      *property,
							      gboolean            translatable);
198

199
gboolean                glade_property_i18n_get_translatable (GladeProperty      *property);
200

201 202
void                    glade_property_i18n_set_has_context  (GladeProperty      *property,
							      gboolean            has_context);
203

204
gboolean                glade_property_i18n_get_has_context  (GladeProperty      *property);
Jose Maria Celorio's avatar
Jose Maria Celorio committed
205

206

207
void                    glade_property_push_superuser        (void);
208

209
void                    glade_property_pop_superuser         (void);
210

211 212
gboolean                glade_property_superuser             (void);

Jose Maria Celorio's avatar
Jose Maria Celorio committed
213 214 215
G_END_DECLS

#endif /* __GLADE_PROPERTY_H__ */