1 /* GTK - The GIMP Toolkit
2  * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
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 
18 /*
19  * Modified by the GTK+ Team and others 1997-2000.  See the AUTHORS
20  * file for a list of people on the GTK+ Team.  See the ChangeLog
21  * files for a list of changes.  These files are distributed with
22  * GTK+ at ftp://ftp.gtk.org/pub/gtk/.
23  */
24 
25 #ifndef __GTK_SCALE_H__
26 #define __GTK_SCALE_H__
27 
28 
29 #if !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
30 #error "Only <gtk/gtk.h> can be included directly."
31 #endif
32 
33 #include <gtk/gtkrange.h>
34 
35 
36 G_BEGIN_DECLS
37 
38 #define GTK_TYPE_SCALE            (gtk_scale_get_type ())
39 #define GTK_SCALE(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_SCALE, GtkScale))
40 #define GTK_SCALE_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_SCALE, GtkScaleClass))
41 #define GTK_IS_SCALE(obj)         (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_SCALE))
42 #define GTK_IS_SCALE_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_SCALE))
43 #define GTK_SCALE_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_SCALE, GtkScaleClass))
44 
45 
46 typedef struct _GtkScale              GtkScale;
47 typedef struct _GtkScaleClass         GtkScaleClass;
48 
49 struct _GtkScale
50 {
51   GtkRange parent_instance;
52 };
53 
54 struct _GtkScaleClass
55 {
56   GtkRangeClass parent_class;
57 
58   void (* get_layout_offsets) (GtkScale *scale,
59                                int      *x,
60                                int      *y);
61 
62   /*< private >*/
63 
64   gpointer padding[8];
65 };
66 
67 
68 /**
69  * GtkScaleFormatValueFunc:
70  * @scale: The `GtkScale`
71  * @value: The numeric value to format
72  * @user_data: (closure): user data
73  *
74  * Returns: (not nullable): A newly allocated string describing a textual representation
75  *   of the given numerical value.
76  */
77 typedef char * (*GtkScaleFormatValueFunc) (GtkScale *scale,
78                                            double    value,
79                                            gpointer  user_data);
80 
81 
82 GDK_AVAILABLE_IN_ALL
83 GType             gtk_scale_get_type           (void) G_GNUC_CONST;
84 GDK_AVAILABLE_IN_ALL
85 GtkWidget       * gtk_scale_new                (GtkOrientation   orientation,
86                                                 GtkAdjustment   *adjustment);
87 GDK_AVAILABLE_IN_ALL
88 GtkWidget       * gtk_scale_new_with_range     (GtkOrientation   orientation,
89                                                 double           min,
90                                                 double           max,
91                                                 double           step);
92 GDK_AVAILABLE_IN_ALL
93 void              gtk_scale_set_digits         (GtkScale        *scale,
94                                                 int              digits);
95 GDK_AVAILABLE_IN_ALL
96 int               gtk_scale_get_digits         (GtkScale        *scale);
97 GDK_AVAILABLE_IN_ALL
98 void              gtk_scale_set_draw_value     (GtkScale        *scale,
99                                                 gboolean         draw_value);
100 GDK_AVAILABLE_IN_ALL
101 gboolean          gtk_scale_get_draw_value     (GtkScale        *scale);
102 GDK_AVAILABLE_IN_ALL
103 void              gtk_scale_set_has_origin     (GtkScale        *scale,
104                                                 gboolean         has_origin);
105 GDK_AVAILABLE_IN_ALL
106 gboolean          gtk_scale_get_has_origin     (GtkScale        *scale);
107 GDK_AVAILABLE_IN_ALL
108 void              gtk_scale_set_value_pos      (GtkScale        *scale,
109                                                 GtkPositionType  pos);
110 GDK_AVAILABLE_IN_ALL
111 GtkPositionType   gtk_scale_get_value_pos      (GtkScale        *scale);
112 
113 GDK_AVAILABLE_IN_ALL
114 PangoLayout     * gtk_scale_get_layout         (GtkScale        *scale);
115 GDK_AVAILABLE_IN_ALL
116 void              gtk_scale_get_layout_offsets (GtkScale        *scale,
117                                                 int             *x,
118                                                 int             *y);
119 
120 GDK_AVAILABLE_IN_ALL
121 void              gtk_scale_add_mark           (GtkScale        *scale,
122                                                 double           value,
123                                                 GtkPositionType  position,
124                                                 const char      *markup);
125 GDK_AVAILABLE_IN_ALL
126 void              gtk_scale_clear_marks        (GtkScale        *scale);
127 
128 GDK_AVAILABLE_IN_ALL
129 void              gtk_scale_set_format_value_func (GtkScale                *scale,
130                                                    GtkScaleFormatValueFunc  func,
131                                                    gpointer                 user_data,
132                                                    GDestroyNotify           destroy_notify);
133 
134 G_END_DECLS
135 
136 #endif /* __GTK_SCALE_H__ */
137