Debian Codegraph @

clutter/deprecated/clutter-state.h

raw
1 /*
2 * Clutter.
3 *
4 * An OpenGL based 'interactive canvas' library.
5 *
6 * Authored By Øyvind Kolås <[email protected]>
7 *
8 * Copyright (C) 2009 Intel Corporation
9 *
10 * This library is free software; you can redistribute it and/or
11 * modify it under the terms of the GNU Lesser General Public
12 * License as published by the Free Software Foundation; either
13 * version 2 of the License, or (at your option) any later version.
14 *
15 * This library is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
18 * Lesser General Public License for more details.
19 *
20 * You should have received a copy of the GNU Lesser General Public
21 * License along with this library. If not, see <http://www.gnu.org/licenses/>.
22 */
23
24 #ifndef __CLUTTER_STATE_H__
25 #define __CLUTTER_STATE_H__
26
27 #include <clutter/clutter-types.h>
28
29 G_BEGIN_DECLS
30
31 #define CLUTTER_TYPE_STATE_KEY (clutter_state_key_get_type ())
32 #define CLUTTER_TYPE_STATE (clutter_state_get_type ())
33 #define CLUTTER_STATE(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), CLUTTER_TYPE_STATE, ClutterState))
34 #define CLUTTER_STATE_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), CLUTTER_TYPE_STATE, ClutterStateClass))
35 #define CLUTTER_IS_STATE(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), CLUTTER_TYPE_STATE))
36 #define CLUTTER_IS_STATE_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), CLUTTER_TYPE_STATE))
37 #define CLUTTER_STATE_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), CLUTTER_TYPE_STATE, ClutterStateClass))
38
39 typedef struct _ClutterStatePrivate ClutterStatePrivate;
40 typedef struct _ClutterStateClass ClutterStateClass;
41
42 /**
43 * ClutterStateKey:
44 *
45 * #ClutterStateKey is an opaque structure whose
46 * members cannot be accessed directly
47 *
48 * Since: 1.4
49 */
50 typedef struct _ClutterStateKey ClutterStateKey;
51
52 /**
53 * ClutterState:
54 *
55 * The #ClutterState structure contains only
56 * private data and should be accessed using the provided API
57 *
58 * Since: 1.4
59 */
60 struct _ClutterState
61 {
62 /*< private >*/
63 GObject parent;
64 ClutterStatePrivate *priv;
65 };
66
67 /**
68 * ClutterStateClass:
69 * @completed: class handler for the #ClutterState::completed signal
70 *
71 * The #ClutterStateClass structure contains
72 * only private data
73 *
74 * Since: 1.4
75 *
76 * Deprecated: 1.12
77 */
78 struct _ClutterStateClass
79 {
80 /*< private >*/
81 GObjectClass parent_class;
82
83 /*< public >*/
84 void (* completed) (ClutterState *state);
85
86 /*< private >*/
87 /* padding for future expansion */
88 gpointer _padding_dummy[8];
89 };
90
91 CLUTTER_DEPRECATED_IN_1_12
92 GType clutter_state_get_type (void) G_GNUC_CONST;
93
94 CLUTTER_DEPRECATED_IN_1_12
95 ClutterState *clutter_state_new (void);
96
97
98 CLUTTER_DEPRECATED_IN_1_12
99 ClutterTimeline * clutter_state_set_state (ClutterState *state,
100 const gchar *target_state_name);
101 CLUTTER_DEPRECATED_IN_1_12
102 ClutterTimeline * clutter_state_warp_to_state (ClutterState *state,
103 const gchar *target_state_name);
104 CLUTTER_DEPRECATED_IN_1_12
105 ClutterState * clutter_state_set_key (ClutterState *state,
106 const gchar *source_state_name,
107 const gchar *target_state_name,
108 GObject *object,
109 const gchar *property_name,
110 guint mode,
111 const GValue *value,
112 gdouble pre_delay,
113 gdouble post_delay);
114 CLUTTER_DEPRECATED_IN_1_12
115 void clutter_state_set_duration (ClutterState *state,
116 const gchar *source_state_name,
117 const gchar *target_state_name,
118 guint duration);
119 CLUTTER_DEPRECATED_IN_1_12
120 guint clutter_state_get_duration (ClutterState *state,
121 const gchar *source_state_name,
122 const gchar *target_state_name);
123 CLUTTER_DEPRECATED_IN_1_12
124 void clutter_state_set (ClutterState *state,
125 const gchar *source_state_name,
126 const gchar *target_state_name,
127 gpointer first_object,
128 const gchar *first_property_name,
129 gulong first_mode,
130 ...) G_GNUC_NULL_TERMINATED;
131 CLUTTER_DEPRECATED_IN_1_12
132 GList * clutter_state_get_states (ClutterState *state);
133 CLUTTER_DEPRECATED_IN_1_12
134 GList * clutter_state_get_keys (ClutterState *state,
135 const gchar *source_state_name,
136 const gchar *target_state_name,
137 GObject *object,
138 const gchar *property_name);
139 CLUTTER_DEPRECATED_IN_1_12
140 void clutter_state_remove_key (ClutterState *state,
141 const gchar *source_state_name,
142 const gchar *target_state_name,
143 GObject *object,
144 const gchar *property_name);
145 CLUTTER_DEPRECATED_IN_1_12
146 ClutterTimeline * clutter_state_get_timeline (ClutterState *state);
147 CLUTTER_DEPRECATED_IN_1_12
148 void clutter_state_set_animator (ClutterState *state,
149 const gchar *source_state_name,
150 const gchar *target_state_name,
151 ClutterAnimator *animator);
152 CLUTTER_DEPRECATED_IN_1_12
153 ClutterAnimator * clutter_state_get_animator (ClutterState *state,
154 const gchar *source_state_name,
155 const gchar *target_state_name);
156 CLUTTER_DEPRECATED_IN_1_12
157 const gchar * clutter_state_get_state (ClutterState *state);
158
159 /*
160 * ClutterStateKey
161 */
162
163 CLUTTER_DEPRECATED_IN_1_12
164 GType clutter_state_key_get_type (void) G_GNUC_CONST;
165 CLUTTER_DEPRECATED_IN_1_12
166 gdouble clutter_state_key_get_pre_delay (const ClutterStateKey *state_key);
167 CLUTTER_DEPRECATED_IN_1_12
168 gdouble clutter_state_key_get_post_delay (const ClutterStateKey *state_key);
169 CLUTTER_DEPRECATED_IN_1_12
170 gulong clutter_state_key_get_mode (const ClutterStateKey *state_key);
171 CLUTTER_DEPRECATED_IN_1_12
172 gboolean clutter_state_key_get_value (const ClutterStateKey *state_key,
173 GValue *value);
174 CLUTTER_DEPRECATED_IN_1_12
175 GType clutter_state_key_get_property_type (const ClutterStateKey *key);
176 CLUTTER_DEPRECATED_IN_1_12
177 GObject * clutter_state_key_get_object (const ClutterStateKey *state_key);
178 CLUTTER_DEPRECATED_IN_1_12
179 const gchar * clutter_state_key_get_property_name (const ClutterStateKey *state_key);
180 CLUTTER_DEPRECATED_IN_1_12
181 const gchar * clutter_state_key_get_source_state_name (const ClutterStateKey *state_key);
182 CLUTTER_DEPRECATED_IN_1_12
183 const gchar * clutter_state_key_get_target_state_name (const ClutterStateKey *state_key);
184
185 G_END_DECLS
186
187 #endif /* __CLUTTER_STATE_H__ */