gtkscale.h 5.26 KB
Newer Older
Cody Russell's avatar
Cody Russell committed
1
/* GTK - The GIMP Toolkit
Elliot Lee's avatar
Elliot Lee committed
2
3
4
 * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
 *
 * This library is free software; you can redistribute it and/or
5
 * modify it under the terms of the GNU Lesser General Public
Elliot Lee's avatar
Elliot Lee committed
6
7
8
9
10
11
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12
 * Lesser General Public License for more details.
Elliot Lee's avatar
Elliot Lee committed
13
 *
14
 * You should have received a copy of the GNU Lesser General Public
Javier Jardón's avatar
Javier Jardón committed
15
 * License along with this library. If not, see <http://www.gnu.org/licenses/>.
Elliot Lee's avatar
Elliot Lee committed
16
 */
17
18

/*
19
 * Modified by the GTK+ Team and others 1997-2000.  See the AUTHORS
20
21
 * file for a list of people on the GTK+ Team.  See the ChangeLog
 * files for a list of changes.  These files are distributed with
22
 * GTK+ at ftp://ftp.gtk.org/pub/gtk/.
23
24
 */

Elliot Lee's avatar
Elliot Lee committed
25
26
27
28
#ifndef __GTK_SCALE_H__
#define __GTK_SCALE_H__


29
30
31
32
#if !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
#error "Only <gtk/gtk.h> can be included directly."
#endif

Elliot Lee's avatar
Elliot Lee committed
33
34
35
#include <gtk/gtkrange.h>


36
G_BEGIN_DECLS
Elliot Lee's avatar
Elliot Lee committed
37

38
#define GTK_TYPE_SCALE            (gtk_scale_get_type ())
Manish Singh's avatar
Manish Singh committed
39
40
41
42
43
#define GTK_SCALE(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_SCALE, GtkScale))
#define GTK_SCALE_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_SCALE, GtkScaleClass))
#define GTK_IS_SCALE(obj)         (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_SCALE))
#define GTK_IS_SCALE_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_SCALE))
#define GTK_SCALE_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_SCALE, GtkScaleClass))
Elliot Lee's avatar
Elliot Lee committed
44
45


46
47
typedef struct _GtkScale              GtkScale;
typedef struct _GtkScaleClass         GtkScaleClass;
Elliot Lee's avatar
Elliot Lee committed
48
49
50

struct _GtkScale
{
Timm Bäder's avatar
Timm Bäder committed
51
  GtkRange parent_instance;
Elliot Lee's avatar
Elliot Lee committed
52
53
54
55
56
57
};

struct _GtkScaleClass
{
  GtkRangeClass parent_class;

58
  void (* get_layout_offsets) (GtkScale *scale,
Benjamin Otte's avatar
Benjamin Otte committed
59
60
                               int      *x,
                               int      *y);
61

Matthias Clasen's avatar
Matthias Clasen committed
62
63
64
  /*< private >*/

  gpointer padding[8];
Elliot Lee's avatar
Elliot Lee committed
65
66
};

67
68
69

/**
 * GtkScaleFormatValueFunc:
Matthias Clasen's avatar
Matthias Clasen committed
70
 * @scale: The `GtkScale`
71
72
73
74
75
76
77
78
79
80
81
 * @value: The numeric value to format
 * @user_data: (closure): user data
 *
 * Returns: (not nullable): A newly allocated string describing a textual representation
 *   of the given numerical value.
 */
typedef char * (*GtkScaleFormatValueFunc) (GtkScale *scale,
                                           double    value,
                                           gpointer  user_data);


82
GDK_AVAILABLE_IN_ALL
83
GType             gtk_scale_get_type           (void) G_GNUC_CONST;
84
GDK_AVAILABLE_IN_ALL
85
86
GtkWidget       * gtk_scale_new                (GtkOrientation   orientation,
                                                GtkAdjustment   *adjustment);
87
GDK_AVAILABLE_IN_ALL
88
GtkWidget       * gtk_scale_new_with_range     (GtkOrientation   orientation,
89
90
91
                                                double           min,
                                                double           max,
                                                double           step);
92
GDK_AVAILABLE_IN_ALL
93
void              gtk_scale_set_digits         (GtkScale        *scale,
Benjamin Otte's avatar
Benjamin Otte committed
94
                                                int              digits);
95
GDK_AVAILABLE_IN_ALL
Benjamin Otte's avatar
Benjamin Otte committed
96
int               gtk_scale_get_digits         (GtkScale        *scale);
97
GDK_AVAILABLE_IN_ALL
98
99
void              gtk_scale_set_draw_value     (GtkScale        *scale,
                                                gboolean         draw_value);
100
GDK_AVAILABLE_IN_ALL
101
gboolean          gtk_scale_get_draw_value     (GtkScale        *scale);
Matthias Clasen's avatar
Matthias Clasen committed
102
GDK_AVAILABLE_IN_ALL
103
104
void              gtk_scale_set_has_origin     (GtkScale        *scale,
                                                gboolean         has_origin);
Matthias Clasen's avatar
Matthias Clasen committed
105
GDK_AVAILABLE_IN_ALL
106
gboolean          gtk_scale_get_has_origin     (GtkScale        *scale);
107
GDK_AVAILABLE_IN_ALL
108
109
void              gtk_scale_set_value_pos      (GtkScale        *scale,
                                                GtkPositionType  pos);
110
GDK_AVAILABLE_IN_ALL
111
112
GtkPositionType   gtk_scale_get_value_pos      (GtkScale        *scale);

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,
Benjamin Otte's avatar
Benjamin Otte committed
117
118
                                                int             *x,
                                                int             *y);
119

120
GDK_AVAILABLE_IN_ALL
121
void              gtk_scale_add_mark           (GtkScale        *scale,
122
                                                double           value,
123
                                                GtkPositionType  position,
Benjamin Otte's avatar
Benjamin Otte committed
124
                                                const char      *markup);
125
GDK_AVAILABLE_IN_ALL
126
127
void              gtk_scale_clear_marks        (GtkScale        *scale);

128
129
130
GDK_AVAILABLE_IN_ALL
void              gtk_scale_set_format_value_func (GtkScale                *scale,
                                                   GtkScaleFormatValueFunc  func,
131
132
                                                   gpointer                 user_data,
                                                   GDestroyNotify           destroy_notify);
Havoc Pennington's avatar
Havoc Pennington committed
133

134
G_END_DECLS
Elliot Lee's avatar
Elliot Lee committed
135
136

#endif /* __GTK_SCALE_H__ */