Debian Codegraph @

clutter/deprecated/clutter-score.h

raw
1 /*
2 * Clutter.
3 *
4 * An OpenGL based 'interactive canvas' library.
5 *
6 * Authored By Matthew Allum <[email protected]>
7 *
8 * Copyright (C) 2006 OpenedHand
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 #if !defined(__CLUTTER_H_INSIDE__) && !defined(CLUTTER_COMPILATION)
25 #error "Only <clutter/clutter.h> can be included directly."
26 #endif
27
28 #ifndef __CLUTTER_SCORE_H__
29 #define __CLUTTER_SCORE_H__
30
31 #include <clutter/clutter-timeline.h>
32
33 G_BEGIN_DECLS
34
35 #define CLUTTER_TYPE_SCORE (clutter_score_get_type ())
36
37 #define CLUTTER_SCORE(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), CLUTTER_TYPE_SCORE, ClutterScore))
38 #define CLUTTER_SCORE_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), CLUTTER_TYPE_SCORE, ClutterScoreClass))
39 #define CLUTTER_IS_SCORE(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), CLUTTER_TYPE_SCORE))
40 #define CLUTTER_IS_SCORE_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), CLUTTER_TYPE_SCORE))
41 #define CLUTTER_SCORE_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), CLUTTER_TYPE_SCORE, ClutterScoreClass))
42
43 typedef struct _ClutterScore ClutterScore;
44 typedef struct _ClutterScorePrivate ClutterScorePrivate;
45 typedef struct _ClutterScoreClass ClutterScoreClass;
46
47 /**
48 * ClutterScore:
49 *
50 * The #ClutterScore structure contains only private data
51 * and should be accessed using the provided API
52 *
53 * Since: 0.6
54 */
55 struct _ClutterScore
56 {
57 /*< private >*/
58 GObject parent;
59 ClutterScorePrivate *priv;
60 };
61
62 /**
63 * ClutterScoreClass:
64 * @timeline_started: handler for the #ClutterScore::timeline-started signal
65 * @timeline_completed: handler for the #ClutterScore::timeline-completed
66 * signal
67 * @started: handler for the #ClutterScore::started signal
68 * @completed: handler for the #ClutterScore::completed signal
69 * @paused: handler for the #ClutterScore::paused signal
70 *
71 * The #ClutterScoreClass structure contains only private data
72 *
73 * Since: 0.6
74 */
75 struct _ClutterScoreClass
76 {
77 /*< private >*/
78 GObjectClass parent_class;
79
80 /*< public >*/
81 void (* timeline_started) (ClutterScore *score,
82 ClutterTimeline *timeline);
83 void (* timeline_completed) (ClutterScore *score,
84 ClutterTimeline *timeline);
85
86 void (* started) (ClutterScore *score);
87 void (* completed) (ClutterScore *score);
88 void (* paused) (ClutterScore *score);
89
90 /*< private >*/
91 /* padding for future expansion */
92 void (*_clutter_score_1) (void);
93 void (*_clutter_score_2) (void);
94 void (*_clutter_score_3) (void);
95 void (*_clutter_score_4) (void);
96 void (*_clutter_score_5) (void);
97 };
98
99 CLUTTER_DEPRECATED_IN_1_8
100 GType clutter_score_get_type (void) G_GNUC_CONST;
101
102 CLUTTER_DEPRECATED_IN_1_8
103 ClutterScore * clutter_score_new (void);
104
105 CLUTTER_DEPRECATED_IN_1_8
106 void clutter_score_set_loop (ClutterScore *score,
107 gboolean loop);
108 CLUTTER_DEPRECATED_IN_1_8
109 gboolean clutter_score_get_loop (ClutterScore *score);
110
111 CLUTTER_DEPRECATED_IN_1_8
112 gulong clutter_score_append (ClutterScore *score,
113 ClutterTimeline *parent,
114 ClutterTimeline *timeline);
115 CLUTTER_DEPRECATED_IN_1_8
116 gulong clutter_score_append_at_marker (ClutterScore *score,
117 ClutterTimeline *parent,
118 const gchar *marker_name,
119 ClutterTimeline *timeline);
120 CLUTTER_DEPRECATED_IN_1_8
121 void clutter_score_remove (ClutterScore *score,
122 gulong id_);
123 CLUTTER_DEPRECATED_IN_1_8
124 void clutter_score_remove_all (ClutterScore *score);
125 CLUTTER_DEPRECATED_IN_1_8
126 ClutterTimeline *clutter_score_get_timeline (ClutterScore *score,
127 gulong id_);
128 CLUTTER_DEPRECATED_IN_1_8
129 GSList * clutter_score_list_timelines (ClutterScore *score);
130
131 CLUTTER_DEPRECATED_IN_1_8
132 void clutter_score_start (ClutterScore *score);
133 CLUTTER_DEPRECATED_IN_1_8
134 void clutter_score_stop (ClutterScore *score);
135 CLUTTER_DEPRECATED_IN_1_8
136 void clutter_score_pause (ClutterScore *score);
137 CLUTTER_DEPRECATED_IN_1_8
138 void clutter_score_rewind (ClutterScore *score);
139 CLUTTER_DEPRECATED_IN_1_8
140 gboolean clutter_score_is_playing (ClutterScore *score);
141
142 G_END_DECLS
143
144 #endif /* __CLUTTER_SCORE_H__ */