]> Pileus Git - ~andy/gtk/blob - gdk-pixbuf/gdk-pixbuf-animation.h
Move the documentation for signals inline, to get proper parameter
[~andy/gtk] / gdk-pixbuf / gdk-pixbuf-animation.h
1 /* -*- Mode: C; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 8 -*- */
2 /* GdkPixbuf library - Private declarations
3  *
4  * Copyright (C) 1999 The Free Software Foundation
5  *
6  * Authors: Mark Crichton <crichton@gimp.org>
7  *          Miguel de Icaza <miguel@gnu.org>
8  *          Federico Mena-Quintero <federico@gimp.org>
9  *          Havoc Pennington <hp@redhat.com>
10  *
11  * This library is free software; you can redistribute it and/or
12  * modify it under the terms of the GNU Lesser General Public
13  * License as published by the Free Software Foundation; either
14  * version 2 of the License, or (at your option) any later version.
15  *
16  * This library is distributed in the hope that it will be useful,
17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
19  * Lesser General Public License for more details.
20  *
21  * You should have received a copy of the GNU Lesser General Public
22  * License along with this library; if not, write to the
23  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
24  * Boston, MA 02111-1307, USA.
25  */
26
27 #ifndef GDK_PIXBUF_ANIMATION_H
28 #define GDK_PIXBUF_ANIMATION_H
29
30 #include "gdk-pixbuf/gdk-pixbuf.h"
31
32 G_BEGIN_DECLS
33
34 #ifdef GDK_PIXBUF_ENABLE_BACKEND
35
36 \f
37
38 typedef struct _GdkPixbufAnimationClass GdkPixbufAnimationClass;
39
40 #define GDK_PIXBUF_ANIMATION_CLASS(klass)      (G_TYPE_CHECK_CLASS_CAST ((klass), GDK_TYPE_PIXBUF_ANIMATION, GdkPixbufAnimationClass))
41 #define GDK_IS_PIXBUF_ANIMATION_CLASS(klass)   (G_TYPE_CHECK_CLASS_TYPE ((klass), GDK_TYPE_PIXBUF_ANIMATION))
42 #define GDK_PIXBUF_ANIMATION_GET_CLASS(obj)    (G_TYPE_INSTANCE_GET_CLASS ((obj), GDK_TYPE_PIXBUF_ANIMATION, GdkPixbufAnimationClass))
43
44 /* Private part of the GdkPixbufAnimation structure */
45 struct _GdkPixbufAnimation {
46         GObject parent_instance;
47
48 };
49
50 struct _GdkPixbufAnimationClass {
51         GObjectClass parent_class;
52
53         /*< public >*/
54
55         gboolean                (*is_static_image)  (GdkPixbufAnimation *anim);
56
57         GdkPixbuf*              (*get_static_image) (GdkPixbufAnimation *anim);
58         
59         void                    (*get_size) (GdkPixbufAnimation *anim,
60                                              int                 *width,
61                                              int                 *height);
62         
63         GdkPixbufAnimationIter* (*get_iter) (GdkPixbufAnimation *anim,
64                                              const GTimeVal     *start_time);
65
66 };
67
68 \f
69
70 typedef struct _GdkPixbufAnimationIterClass GdkPixbufAnimationIterClass;
71
72 #define GDK_PIXBUF_ANIMATION_ITER_CLASS(klass)      (G_TYPE_CHECK_CLASS_CAST ((klass), GDK_TYPE_PIXBUF_ANIMATION_ITER, GdkPixbufAnimationIterClass))
73 #define GDK_IS_PIXBUF_ANIMATION_ITER_CLASS(klass)   (G_TYPE_CHECK_CLASS_TYPE ((klass), GDK_TYPE_PIXBUF_ANIMATION_ITER))
74 #define GDK_PIXBUF_ANIMATION_ITER_GET_CLASS(obj)    (G_TYPE_INSTANCE_GET_CLASS ((obj), GDK_TYPE_PIXBUF_ANIMATION_ITER, GdkPixbufAnimationIterClass))
75
76 struct _GdkPixbufAnimationIter {
77         GObject parent_instance;
78
79 };
80
81 struct _GdkPixbufAnimationIterClass {
82         GObjectClass parent_class;
83
84         /*< public >*/
85
86         int        (*get_delay_time)   (GdkPixbufAnimationIter *iter);
87
88         GdkPixbuf* (*get_pixbuf)       (GdkPixbufAnimationIter *iter);
89
90         gboolean (*on_currently_loading_frame) (GdkPixbufAnimationIter *iter);
91
92         gboolean (*advance)            (GdkPixbufAnimationIter *iter,
93                                         const GTimeVal         *current_time);
94 };
95       
96
97 GdkPixbufAnimation* gdk_pixbuf_non_anim_new (GdkPixbuf *pixbuf);
98
99 #endif /* GDK_PIXBUF_ENABLE_BACKEND */
100
101 G_END_DECLS
102
103 #endif /* GDK_PIXBUF_ANIMATION_H */