gntslider.h
Go to the documentation of this file.
1 
5 /*
6  * GNT - The GLib Ncurses Toolkit
7  *
8  * GNT is the legal property of its developers, whose names are too numerous
9  * to list here. Please refer to the COPYRIGHT file distributed with this
10  * source distribution.
11  *
12  * This library is free software; you can redistribute it and/or modify
13  * it under the terms of the GNU General Public License as published by
14  * the Free Software Foundation; either version 2 of the License, or
15  * (at your option) any later version.
16  *
17  * This program is distributed in the hope that it will be useful,
18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20  * GNU General Public License for more details.
21  *
22  * You should have received a copy of the GNU General Public License
23  * along with this program; if not, write to the Free Software
24  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02111-1301 USA
25  */
26 
27 #ifndef GNT_SLIDER_H
28 #define GNT_SLIDER_H
29 
30 #include "gntwidget.h"
31 #include "gnt.h"
32 #include "gntlabel.h"
33 
34 #define GNT_TYPE_SLIDER (gnt_slider_get_gtype())
35 #define GNT_SLIDER(obj) (G_TYPE_CHECK_INSTANCE_CAST((obj), GNT_TYPE_SLIDER, GntSlider))
36 #define GNT_SLIDER_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST((klass), GNT_TYPE_SLIDER, GntSliderClass))
37 #define GNT_IS_SLIDER(obj) (G_TYPE_CHECK_INSTANCE_TYPE((obj), GNT_TYPE_SLIDER))
38 #define GNT_IS_SLIDER_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE((klass), GNT_TYPE_SLIDER))
39 #define GNT_SLIDER_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS((obj), GNT_TYPE_SLIDER, GntSliderClass))
40 
41 #define GNT_SLIDER_FLAGS(obj) (GNT_SLIDER(obj)->priv.flags)
42 #define GNT_SLIDER_SET_FLAGS(obj, flags) (GNT_SLIDER_FLAGS(obj) |= flags)
43 #define GNT_SLIDER_UNSET_FLAGS(obj, flags) (GNT_SLIDER_FLAGS(obj) &= ~(flags))
44 
45 typedef struct _GntSlider GntSlider;
46 typedef struct _GntSliderPriv GntSliderPriv;
47 typedef struct _GntSliderClass GntSliderClass;
48 
49 struct _GntSlider
50 {
51  GntWidget parent;
52 
53  gboolean vertical;
54 
55  int max; /* maximum value */
56  int min; /* minimum value */
57  int step; /* amount to change at each step */
58  int current; /* current value */
59  int smallstep;
60  int largestep;
61 };
62 
64 {
65  GntWidgetClass parent;
66 
67  void (*changed)(GntSlider *slider, int);
68  void (*gnt_reserved1)(void);
69  void (*gnt_reserved2)(void);
70  void (*gnt_reserved3)(void);
71  void (*gnt_reserved4)(void);
72 };
73 
74 G_BEGIN_DECLS
75 
81 GType gnt_slider_get_gtype(void);
82 
83 #define gnt_hslider_new(max, min) gnt_slider_new(FALSE, max, min)
84 #define gnt_vslider_new(max, min) gnt_slider_new(TRUE, max, min)
85 
97 GntWidget * gnt_slider_new(gboolean orient, int max, int min);
98 
108 void gnt_slider_set_range(GntSlider *slider, int max, int min);
109 
118 void gnt_slider_set_step(GntSlider *slider, int step);
119 
128 void gnt_slider_set_small_step(GntSlider *slider, int step);
129 
138 void gnt_slider_set_large_step(GntSlider *slider, int step);
139 
151 int gnt_slider_advance_step(GntSlider *slider, int steps);
152 
161 void gnt_slider_set_value(GntSlider *slider, int value);
162 
171 int gnt_slider_get_value(GntSlider *slider);
172 
181 void gnt_slider_reflect_label(GntSlider *slider, GntLabel *label);
182 
183 
184 G_END_DECLS
185 
186 #endif /* GNT_SLIDER_H */
G_BEGIN_DECLS GType gnt_slider_get_gtype(void)
void gnt_slider_reflect_label(GntSlider *slider, GntLabel *label)
Update a label with the value of the slider whenever the value changes.
void gnt_slider_set_step(GntSlider *slider, int step)
Sets the amount of change at each step.
Widget API.
void gnt_slider_set_small_step(GntSlider *slider, int step)
Sets the amount of change a small step.
GNT API.
GntWidget * gnt_slider_new(gboolean orient, int max, int min)
Create a new slider.
Label API.
int gnt_slider_get_value(GntSlider *slider)
Get the current value for the slider.
void gnt_slider_set_large_step(GntSlider *slider, int step)
Sets the amount of change a large step.
void gnt_slider_set_range(GntSlider *slider, int max, int min)
Set the range of the slider.
int gnt_slider_advance_step(GntSlider *slider, int steps)
Advance the slider forward or backward.
void gnt_slider_set_value(GntSlider *slider, int value)
Set the current value for the slider.