]> Pileus Git - ~andy/gtk/blob - gtk/gtklevelbar.h
level-bar: introduce GtkLevelBar
[~andy/gtk] / gtk / gtklevelbar.h
1 /* GTK - The GIMP Toolkit
2  * Copyright © 2012 Red Hat, Inc.
3  *
4  * This library is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU Lesser General Public
6  * License as published by the Free Software Foundation; either
7  * version 2 of the License, or (at your option) any later version.
8  *
9  * This library is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12  * Lesser General Public License for more details.
13  *
14  * You should have received a copy of the GNU Lesser General Public
15  * License along with this library. If not, see <http://www.gnu.org/licenses/>.
16  *
17  * Author: Cosimo Cecchi <cosimoc@gnome.org>
18  *
19  */
20
21 #if !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
22 #error "Only <gtk/gtk.h> can be included directly."
23 #endif
24
25 #ifndef __GTK_LEVEL_BAR_H__
26 #define __GTK_LEVEL_BAR_H__
27
28 #include <gtk/gtkwidget.h>
29
30 G_BEGIN_DECLS
31
32 #define GTK_TYPE_LEVEL_BAR            (gtk_level_bar_get_type ())
33 #define GTK_LEVEL_BAR(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_LEVEL_BAR, GtkLevelBar))
34 #define GTK_LEVEL_BAR_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_LEVEL_BAR, GtkLevelBarClass))
35 #define GTK_IS_LEVEL_BAR(obj)         (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_LEVEL_BAR))
36 #define GTK_IS_LEVEL_BAR_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_LEVEL_BAR))
37 #define GTK_LEVEL_BAR_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_LEVEL_BAR, GtkLevelBarClass))
38
39 #define GTK_LEVEL_BAR_OFFSET_LOW  "low"
40 #define GTK_LEVEL_BAR_OFFSET_HIGH "high"
41
42 typedef struct _GtkLevelBarClass   GtkLevelBarClass;
43 typedef struct _GtkLevelBar        GtkLevelBar;
44 typedef struct _GtkLevelBarPrivate GtkLevelBarPrivate;
45
46 struct _GtkLevelBar {
47   /*< private >*/
48   GtkWidget parent;
49
50   GtkLevelBarPrivate *priv;
51 };
52
53 struct _GtkLevelBarClass {
54   /*< private >*/
55   GtkWidgetClass parent_class;
56
57   void (* offset_changed) (GtkLevelBar *self,
58                            const gchar *name);
59
60   /* padding for future class expansion */
61   gpointer padding[16];
62 };
63
64 GDK_AVAILABLE_IN_3_6
65 GType      gtk_level_bar_get_type           (void) G_GNUC_CONST;
66
67 GDK_AVAILABLE_IN_3_6
68 GtkWidget *gtk_level_bar_new                (void);
69
70 GDK_AVAILABLE_IN_3_6
71 GtkWidget *gtk_level_bar_new_for_interval   (gdouble      min_value,
72                                              gdouble      max_value);
73
74 GDK_AVAILABLE_IN_3_6
75 void       gtk_level_bar_set_mode           (GtkLevelBar *self,
76                                              GtkLevelBarMode mode);
77 GDK_AVAILABLE_IN_3_6
78 GtkLevelBarMode gtk_level_bar_get_mode      (GtkLevelBar *self);
79
80 GDK_AVAILABLE_IN_3_6
81 void       gtk_level_bar_set_value          (GtkLevelBar *self,
82                                              gdouble      value);
83 GDK_AVAILABLE_IN_3_6
84 gdouble    gtk_level_bar_get_value          (GtkLevelBar *self);
85
86 GDK_AVAILABLE_IN_3_6
87 void       gtk_level_bar_set_min_value      (GtkLevelBar *self,
88                                              gdouble      value);
89 GDK_AVAILABLE_IN_3_6
90 gdouble    gtk_level_bar_get_min_value      (GtkLevelBar *self);
91
92 GDK_AVAILABLE_IN_3_6
93 void       gtk_level_bar_set_max_value      (GtkLevelBar *self,
94                                              gdouble      value);
95 GDK_AVAILABLE_IN_3_6
96 gdouble    gtk_level_bar_get_max_value      (GtkLevelBar *self);
97
98 GDK_AVAILABLE_IN_3_6
99 void       gtk_level_bar_add_offset_value   (GtkLevelBar *self,
100                                              const gchar *name,
101                                              gdouble      value);
102 GDK_AVAILABLE_IN_3_6
103 void       gtk_level_bar_remove_offset_value (GtkLevelBar *self,
104                                               const gchar *name);
105 GDK_AVAILABLE_IN_3_6
106 gdouble    gtk_level_bar_get_offset_value   (GtkLevelBar *self,
107                                              const gchar *name);
108
109 G_END_DECLS
110
111 #endif /* __GTK_LEVEL_BAR_H__ */