1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
|
/*
* Copyright (C) 2008 Tristan Van Berkom
* Copyright (C) 2004 Joaquin Cuenca Abela
* Copyright (C) 2001, 2002, 2003 Ximian, Inc.
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as
* published by the Free Software Foundation; either version 2 of the
* License, or (at your option) any later version.
*
* This program 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 General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*
* Authors:
* Joaquin Cuenca Abela <e98cuenc@yahoo.com>
* Chema Celorio <chema@celorio.com>
* Tristan Van Berkom <tvb@gnome.org>
*/
#ifndef __GLADE_WIDGET_H__
#define __GLADE_WIDGET_H__
#include <gladeui/glade-widget-adaptor.h>
#include <gladeui/glade-widget-action.h>
#include <gladeui/glade-signal.h>
#include <gladeui/glade-property.h>
#include <glib.h>
#include <glib-object.h>
G_BEGIN_DECLS
#define GLADE_TYPE_WIDGET (glade_widget_get_type ())
#define GLADE_WIDGET(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), GLADE_TYPE_WIDGET, GladeWidget))
#define GLADE_WIDGET_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), GLADE_TYPE_WIDGET, GladeWidgetClass))
#define GLADE_IS_WIDGET(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GLADE_TYPE_WIDGET))
#define GLADE_IS_WIDGET_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GLADE_TYPE_WIDGET))
#define GLADE_WIDGET_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), GLADE_TYPE_WIDGET, GladeWidgetClass))
typedef struct _GladeWidgetClass GladeWidgetClass;
typedef struct _GladeWidgetPrivate GladeWidgetPrivate;
G_DEFINE_AUTOPTR_CLEANUP_FUNC(GladeWidget, g_object_unref)
struct _GladeWidget
{
GInitiallyUnowned parent_instance;
GladeWidgetPrivate *priv;
};
struct _GladeWidgetClass
{
GInitiallyUnownedClass parent_class;
void (*add_child) (GladeWidget *parent, GladeWidget *child, gboolean at_mouse);
void (*remove_child) (GladeWidget *parent, GladeWidget *child);
void (*replace_child) (GladeWidget *parent, GObject *old_object, GObject *new_object);
void (*add_signal_handler) (GladeWidget *widget, GladeSignal *signal_handler);
void (*remove_signal_handler) (GladeWidget *widget, GladeSignal *signal_handler);
void (*change_signal_handler) (GladeWidget *widget, GladeSignal *new_signal_handler);
gint (*button_press_event) (GladeWidget *widget, GdkEvent *event);
gint (*button_release_event) (GladeWidget *widget, GdkEvent *event);
gint (*motion_notify_event) (GladeWidget *widget, GdkEvent *event);
gboolean (*event) (GladeWidget *gwidget, GdkEvent *event);
void (* glade_reserved1) (void);
void (* glade_reserved2) (void);
void (* glade_reserved3) (void);
void (* glade_reserved4) (void);
void (* glade_reserved5) (void);
void (* glade_reserved6) (void);
void (* glade_reserved7) (void);
void (* glade_reserved8) (void);
};
/* Nameless widgets in fact have a name, except
* that they are prefixed with this prefix
*/
#define GLADE_UNNAMED_PREFIX "__glade_unnamed_"
#define GLADE_WIDGET_IS_EVENT(event) \
((event) == GDK_BUTTON_PRESS || \
(event) == GDK_BUTTON_RELEASE || \
(event) == GDK_MOTION_NOTIFY)
/*******************************************************************************
General api
*******************************************************************************/
GType glade_widget_get_type (void);
GladeWidget *glade_widget_get_from_gobject (gpointer object);
gboolean glade_widget_add_verify (GladeWidget *widget,
GladeWidget *child,
gboolean user_feedback);
void glade_widget_add_child (GladeWidget *parent,
GladeWidget *child,
gboolean at_mouse);
void glade_widget_remove_child (GladeWidget *parent,
GladeWidget *child);
void glade_widget_replace (GladeWidget *parent,
GObject *old_object,
GObject *new_object);
void glade_widget_rebuild (GladeWidget *gwidget);
GladeWidget *glade_widget_dup (GladeWidget *template_widget,
gboolean exact);
GList *glade_widget_get_signal_list (GladeWidget *widget);
void glade_widget_copy_signals (GladeWidget *widget,
GladeWidget *template_widget);
void glade_widget_copy_properties (GladeWidget *widget,
GladeWidget *template_widget,
gboolean copy_parentless,
gboolean exact);
void glade_widget_set_packing_properties (GladeWidget *widget,
GladeWidget *container);
GList *glade_widget_get_properties (GladeWidget *widget);
GList *glade_widget_get_packing_properties (GladeWidget *widget);
GladeProperty *glade_widget_get_property (GladeWidget *widget,
const gchar *id_property);
GladeProperty *glade_widget_get_pack_property (GladeWidget *widget,
const gchar *id_property);
GList *glade_widget_dup_properties (GladeWidget *dest_widget,
GList *template_props,
gboolean as_load,
gboolean copy_parentless,
gboolean exact);
void glade_widget_remove_property (GladeWidget *widget,
const gchar *id_property);
void glade_widget_show (GladeWidget *widget);
void glade_widget_hide (GladeWidget *widget);
void glade_widget_add_signal_handler (GladeWidget *widget,
const GladeSignal *signal_handler);
void glade_widget_remove_signal_handler (GladeWidget *widget,
const GladeSignal *signal_handler);
void glade_widget_change_signal_handler (GladeWidget *widget,
const GladeSignal *old_signal_handler,
const GladeSignal *new_signal_handler);
GPtrArray * glade_widget_list_signal_handlers (GladeWidget *widget,
const gchar *signal_name);
gboolean glade_widget_has_decendant (GladeWidget *widget,
GType type);
gboolean glade_widget_event (GladeWidget *gwidget,
GdkEvent *event);
gboolean glade_widget_placeholder_relation (GladeWidget *parent,
GladeWidget *widget);
GladeWidgetAction *glade_widget_get_action (GladeWidget *widget,
const gchar *action_path);
GladeWidgetAction *glade_widget_get_pack_action (GladeWidget *widget,
const gchar *action_path);
GList *glade_widget_get_actions (GladeWidget *widget);
GList *glade_widget_get_pack_actions (GladeWidget *widget);
gboolean glade_widget_set_action_sensitive (GladeWidget *widget,
const gchar *action_path,
gboolean sensitive);
gboolean glade_widget_set_pack_action_sensitive (GladeWidget *widget,
const gchar *action_path,
gboolean sensitive);
gboolean glade_widget_set_action_visible (GladeWidget *widget,
const gchar *action_path,
gboolean visible);
gboolean glade_widget_set_pack_action_visible (GladeWidget *widget,
const gchar *action_path,
gboolean visible);
void glade_widget_write (GladeWidget *widget,
GladeXmlContext *context,
GladeXmlNode *node);
void glade_widget_write_child (GladeWidget *widget,
GladeWidget *child,
GladeXmlContext *context,
GladeXmlNode *node);
void glade_widget_write_signals (GladeWidget *widget,
GladeXmlContext *context,
GladeXmlNode *node);
void glade_widget_write_placeholder (GladeWidget *parent,
GObject *object,
GladeXmlContext *context,
GladeXmlNode *node);
GladeWidget *glade_widget_read (GladeProject *project,
GladeWidget *parent,
GladeXmlNode *node,
const gchar *internal);
void glade_widget_read_child (GladeWidget *widget,
GladeXmlNode *node);
void glade_widget_write_special_child_prop (GladeWidget *parent,
GObject *object,
GladeXmlContext *context,
GladeXmlNode *node);
void glade_widget_set_child_type_from_node (GladeWidget *parent,
GObject *child,
GladeXmlNode *node);
GladeEditorProperty *glade_widget_create_editor_property (GladeWidget *widget,
const gchar *property,
gboolean packing,
gboolean use_command);
gchar *glade_widget_generate_path_name (GladeWidget *widget);
gboolean glade_widget_is_ancestor (GladeWidget *widget,
GladeWidget *ancestor);
G_DEPRECATED
gboolean glade_widget_depends (GladeWidget *widget,
GladeWidget *other);
G_DEPRECATED
GdkDevice *glade_widget_get_device_from_event (GdkEvent *event);
void glade_widget_ensure_name (GladeWidget *widget,
GladeProject *project,
gboolean use_command);
/*******************************************************************************
Project, object property references
*******************************************************************************/
void glade_widget_add_prop_ref (GladeWidget *widget,
GladeProperty *property);
void glade_widget_remove_prop_ref (GladeWidget *widget,
GladeProperty *property);
GList *glade_widget_list_prop_refs (GladeWidget *widget);
gboolean glade_widget_has_prop_refs (GladeWidget *widget);
GladeProperty *glade_widget_get_parentless_widget_ref (GladeWidget *widget);
GList *glade_widget_get_parentless_reffed_widgets (GladeWidget *widget);
/*******************************************************************************
Functions that deal with properties on the runtime object
*******************************************************************************/
void glade_widget_object_set_property (GladeWidget *widget,
const gchar *property_name,
const GValue *value);
void glade_widget_object_get_property (GladeWidget *widget,
const gchar *property_name,
GValue *value);
void glade_widget_child_set_property (GladeWidget *widget,
GladeWidget *child,
const gchar *property_name,
const GValue *value);
void glade_widget_child_get_property (GladeWidget *widget,
GladeWidget *child,
const gchar *property_name,
GValue *value);
/*******************************************************************************
GladeProperty api convenience wrappers
*******************************************************************************/
gboolean glade_widget_property_get (GladeWidget *widget,
const gchar *id_property,
...);
gboolean glade_widget_property_set (GladeWidget *widget,
const gchar *id_property,
...);
gboolean glade_widget_pack_property_get (GladeWidget *widget,
const gchar *id_property,
...);
gboolean glade_widget_pack_property_set (GladeWidget *widget,
const gchar *id_property,
...);
gboolean glade_widget_property_reset (GladeWidget *widget,
const gchar *id_property);
gboolean glade_widget_pack_property_reset (GladeWidget *widget,
const gchar *id_property);
gboolean glade_widget_property_default (GladeWidget *widget,
const gchar *id_property);
gboolean glade_widget_property_original_default (GladeWidget *widget,
const gchar *id_property);
gboolean glade_widget_pack_property_default (GladeWidget *widget,
const gchar *id_property);
gboolean glade_widget_property_set_sensitive (GladeWidget *widget,
const gchar *id_property,
gboolean sensitive,
const gchar *reason);
gboolean glade_widget_pack_property_set_sensitive (GladeWidget *widget,
const gchar *id_property,
gboolean sensitive,
const gchar *reason);
gboolean glade_widget_property_set_enabled (GladeWidget *widget,
const gchar *id_property,
gboolean enabled);
gboolean glade_widget_pack_property_set_enabled (GladeWidget *widget,
const gchar *id_property,
gboolean enabled);
gboolean glade_widget_property_set_save_always (GladeWidget *widget,
const gchar *id_property,
gboolean setting);
gboolean glade_widget_pack_property_set_save_always (GladeWidget *widget,
const gchar *id_property,
gboolean setting);
gchar *glade_widget_property_string (GladeWidget *widget,
const gchar *id_property,
const GValue *value);
gchar *glade_widget_pack_property_string (GladeWidget *widget,
const gchar *id_property,
const GValue *value);
/*******************************************************************************
Accessors
*******************************************************************************/
void glade_widget_set_name (GladeWidget *widget,
const gchar *name);
const gchar *glade_widget_get_name (GladeWidget *widget);
const gchar *glade_widget_get_display_name (GladeWidget *widget);
gboolean glade_widget_has_name (GladeWidget *widget);
void glade_widget_set_is_composite (GladeWidget *widget,
gboolean composite);
gboolean glade_widget_get_is_composite (GladeWidget *widget);
void glade_widget_set_internal (GladeWidget *widget,
const gchar *internal);
const gchar *glade_widget_get_internal (GladeWidget *widget);
GObject *glade_widget_get_object (GladeWidget *widget);
void glade_widget_set_project (GladeWidget *widget,
GladeProject *project);
GladeProject *glade_widget_get_project (GladeWidget *widget);
void glade_widget_set_in_project (GladeWidget *widget,
gboolean in_project);
gboolean glade_widget_in_project (GladeWidget *widget);
GladeWidgetAdaptor *glade_widget_get_adaptor (GladeWidget *widget);
GladeWidget *glade_widget_get_parent (GladeWidget *widget);
void glade_widget_set_parent (GladeWidget *widget,
GladeWidget *parent);
GList *glade_widget_get_children (GladeWidget* widget);
GladeWidget *glade_widget_get_toplevel (GladeWidget *widget);
gboolean glade_widget_superuser (void);
void glade_widget_push_superuser (void);
void glade_widget_pop_superuser (void);
void glade_widget_verify (GladeWidget *widget);
void glade_widget_set_support_warning (GladeWidget *widget,
const gchar *warning);
const gchar *glade_widget_support_warning (GladeWidget *widget);
void glade_widget_lock (GladeWidget *widget,
GladeWidget *locked);
void glade_widget_unlock (GladeWidget *widget);
GladeWidget *glade_widget_get_locker (GladeWidget *widget);
GList *glade_widget_list_locked_widgets (GladeWidget *widget);
void glade_widget_support_changed (GladeWidget *widget);
GtkTreeModel *glade_widget_get_signal_model (GladeWidget *widget);
GladeWidget *glade_widget_find_child (GladeWidget *widget,
const gchar *name);
G_END_DECLS
#endif /* __GLADE_WIDGET_H__ */
|
