1 | /* gbinding.h: Binding for object properties |
2 | * |
3 | * Copyright (C) 2010 Intel Corp. |
4 | * |
5 | * This library is free software; you can redistribute it and/or |
6 | * modify it under the terms of the GNU Lesser General Public |
7 | * License as published by the Free Software Foundation; either |
8 | * version 2.1 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 | * Lesser General Public License for more details. |
14 | * |
15 | * You should have received a copy of the GNU Lesser General |
16 | * Public License along with this library; if not, see <http://www.gnu.org/licenses/>. |
17 | * |
18 | * Author: Emmanuele Bassi <ebassi@linux.intel.com> |
19 | */ |
20 | |
21 | #ifndef __G_BINDING_H__ |
22 | #define __G_BINDING_H__ |
23 | |
24 | #if !defined (__GLIB_GOBJECT_H_INSIDE__) && !defined (GOBJECT_COMPILATION) |
25 | #error "Only <glib-object.h> can be included directly." |
26 | #endif |
27 | |
28 | #include <glib.h> |
29 | #include <gobject/gobject.h> |
30 | |
31 | G_BEGIN_DECLS |
32 | |
33 | #define G_TYPE_BINDING_FLAGS (g_binding_flags_get_type ()) |
34 | |
35 | #define G_TYPE_BINDING (g_binding_get_type ()) |
36 | #define G_BINDING(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), G_TYPE_BINDING, GBinding)) |
37 | #define G_IS_BINDING(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), G_TYPE_BINDING)) |
38 | |
39 | /** |
40 | * GBinding: |
41 | * |
42 | * GBinding is an opaque structure whose members |
43 | * cannot be accessed directly. |
44 | * |
45 | * Since: 2.26 |
46 | */ |
47 | typedef struct _GBinding GBinding; |
48 | |
49 | /** |
50 | * GBindingTransformFunc: |
51 | * @binding: a #GBinding |
52 | * @from_value: the #GValue containing the value to transform |
53 | * @to_value: the #GValue in which to store the transformed value |
54 | * @user_data: data passed to the transform function |
55 | * |
56 | * A function to be called to transform @from_value to @to_value. |
57 | * |
58 | * If this is the @transform_to function of a binding, then @from_value |
59 | * is the @source_property on the @source object, and @to_value is the |
60 | * @target_property on the @target object. If this is the |
61 | * @transform_from function of a %G_BINDING_BIDIRECTIONAL binding, |
62 | * then those roles are reversed. |
63 | * |
64 | * Returns: %TRUE if the transformation was successful, and %FALSE |
65 | * otherwise |
66 | * |
67 | * Since: 2.26 |
68 | */ |
69 | typedef gboolean (* GBindingTransformFunc) (GBinding *binding, |
70 | const GValue *from_value, |
71 | GValue *to_value, |
72 | gpointer user_data); |
73 | |
74 | /** |
75 | * GBindingFlags: |
76 | * @G_BINDING_DEFAULT: The default binding; if the source property |
77 | * changes, the target property is updated with its value. |
78 | * @G_BINDING_BIDIRECTIONAL: Bidirectional binding; if either the |
79 | * property of the source or the property of the target changes, |
80 | * the other is updated. |
81 | * @G_BINDING_SYNC_CREATE: Synchronize the values of the source and |
82 | * target properties when creating the binding; the direction of |
83 | * the synchronization is always from the source to the target. |
84 | * @G_BINDING_INVERT_BOOLEAN: If the two properties being bound are |
85 | * booleans, setting one to %TRUE will result in the other being |
86 | * set to %FALSE and vice versa. This flag will only work for |
87 | * boolean properties, and cannot be used when passing custom |
88 | * transformation functions to g_object_bind_property_full(). |
89 | * |
90 | * Flags to be passed to g_object_bind_property() or |
91 | * g_object_bind_property_full(). |
92 | * |
93 | * This enumeration can be extended at later date. |
94 | * |
95 | * Since: 2.26 |
96 | */ |
97 | typedef enum { /*< prefix=G_BINDING >*/ |
98 | G_BINDING_DEFAULT = 0, |
99 | |
100 | G_BINDING_BIDIRECTIONAL = 1 << 0, |
101 | G_BINDING_SYNC_CREATE = 1 << 1, |
102 | G_BINDING_INVERT_BOOLEAN = 1 << 2 |
103 | } GBindingFlags; |
104 | |
105 | GLIB_AVAILABLE_IN_ALL |
106 | GType g_binding_flags_get_type (void) G_GNUC_CONST; |
107 | GLIB_AVAILABLE_IN_ALL |
108 | GType g_binding_get_type (void) G_GNUC_CONST; |
109 | |
110 | GLIB_AVAILABLE_IN_ALL |
111 | GBindingFlags g_binding_get_flags (GBinding *binding); |
112 | GLIB_DEPRECATED_IN_2_68_FOR(g_binding_dup_source) |
113 | GObject * g_binding_get_source (GBinding *binding); |
114 | GLIB_AVAILABLE_IN_2_68 |
115 | GObject * g_binding_dup_source (GBinding *binding); |
116 | GLIB_DEPRECATED_IN_2_68_FOR(g_binding_dup_target) |
117 | GObject * g_binding_get_target (GBinding *binding); |
118 | GLIB_AVAILABLE_IN_2_68 |
119 | GObject * g_binding_dup_target (GBinding *binding); |
120 | GLIB_AVAILABLE_IN_ALL |
121 | const gchar * g_binding_get_source_property (GBinding *binding); |
122 | GLIB_AVAILABLE_IN_ALL |
123 | const gchar * g_binding_get_target_property (GBinding *binding); |
124 | GLIB_AVAILABLE_IN_2_38 |
125 | void g_binding_unbind (GBinding *binding); |
126 | |
127 | GLIB_AVAILABLE_IN_ALL |
128 | GBinding *g_object_bind_property (gpointer source, |
129 | const gchar *source_property, |
130 | gpointer target, |
131 | const gchar *target_property, |
132 | GBindingFlags flags); |
133 | GLIB_AVAILABLE_IN_ALL |
134 | GBinding *g_object_bind_property_full (gpointer source, |
135 | const gchar *source_property, |
136 | gpointer target, |
137 | const gchar *target_property, |
138 | GBindingFlags flags, |
139 | GBindingTransformFunc transform_to, |
140 | GBindingTransformFunc transform_from, |
141 | gpointer user_data, |
142 | GDestroyNotify notify); |
143 | GLIB_AVAILABLE_IN_ALL |
144 | GBinding *g_object_bind_property_with_closures (gpointer source, |
145 | const gchar *source_property, |
146 | gpointer target, |
147 | const gchar *target_property, |
148 | GBindingFlags flags, |
149 | GClosure *transform_to, |
150 | GClosure *transform_from); |
151 | |
152 | G_END_DECLS |
153 | |
154 | #endif /* __G_BINDING_H__ */ |
155 | |