]> Pileus Git - ~andy/gtk/blob - gtk/gtkspinner.h
Fix gtk-doc markup: /* <private> */ should be /*< private >*/
[~andy/gtk] / gtk / gtkspinner.h
1 /* GTK - The GIMP Toolkit
2  *
3  * Copyright (C) 2007 John Stowers, Neil Jagdish Patel.
4  * Copyright (C) 2009 Bastien Nocera, David Zeuthen
5  *
6  * This library is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU Lesser General Public
8  * License as published by the Free Software Foundation; either
9  * version 2 of the License, or (at your option) any later version.
10  *
11  * This library is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14  * Lesser General Public License for more details.
15  *
16  * You should have received a copy of the GNU Lesser General Public
17  * License along with this library; if not, write to the
18  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
19  * Boston, MA  02111-1307, USA.
20  *
21  * Code adapted from egg-spinner
22  * by Christian Hergert <christian.hergert@gmail.com>
23  */
24
25 #if !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
26 #error "Only <gtk/gtk.h> can be included directly."
27 #endif
28
29 #ifndef __GTK_SPINNER_H__
30 #define __GTK_SPINNER_H__
31
32 #include <gtk/gtkwidget.h>
33
34 G_BEGIN_DECLS
35
36 #define GTK_TYPE_SPINNER           (gtk_spinner_get_type ())
37 #define GTK_SPINNER(obj)           (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_SPINNER, GtkSpinner))
38 #define GTK_SPINNER_CLASS(obj)     (G_TYPE_CHECK_CLASS_CAST ((obj), GTK_SPINNER,  GtkSpinnerClass))
39 #define GTK_IS_SPINNER(obj)        (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_SPINNER))
40 #define GTK_IS_SPINNER_CLASS(obj)  (G_TYPE_CHECK_CLASS_TYPE ((obj), GTK_TYPE_SPINNER))
41 #define GTK_SPINNER_GET_CLASS      (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_SPINNER, GtkSpinnerClass))
42
43 typedef struct _GtkSpinner      GtkSpinner;
44 typedef struct _GtkSpinnerClass GtkSpinnerClass;
45 typedef struct _GtkSpinnerPrivate  GtkSpinnerPrivate;
46
47 struct _GtkSpinner
48 {
49   GtkWidget parent;
50
51   /*< private >*/
52   GtkSpinnerPrivate *priv;
53 };
54
55 struct _GtkSpinnerClass
56 {
57   GtkWidgetClass parent_class;
58
59   /* Padding for future expansion */
60   void (*_gtk_reserved1) (void);
61   void (*_gtk_reserved2) (void);
62   void (*_gtk_reserved3) (void);
63   void (*_gtk_reserved4) (void);
64 };
65
66 GType      gtk_spinner_get_type  (void) G_GNUC_CONST;
67 GtkWidget *gtk_spinner_new (void);
68 void       gtk_spinner_start      (GtkSpinner *spinner);
69 void       gtk_spinner_stop       (GtkSpinner *spinner);
70
71 G_END_DECLS
72
73 #endif /* __GTK_SPINNER_H__ */