1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
|
// SPDX-License-Identifier: GPL-2.0-or-later
/*
* Authors:
* Carl Hetherington <inkscape@carlh.net>
* Derek P. Moore <derekm@hackunix.org>
* Bryce Harrington <bryce@bryceharrington.org>
*
* Copyright (C) 2004 Carl Hetherington
*
* Released under GNU GPL v2+, read the file 'COPYING' for more information.
*/
#ifndef INKSCAPE_UI_WIDGET_SCALAR_H
#define INKSCAPE_UI_WIDGET_SCALAR_H
#include "labelled.h"
namespace Inkscape {
namespace UI {
namespace Widget {
/**
* A labelled text box, with spin buttons and optional
* icon or suffix, for entering arbitrary number values.
*/
class Scalar : public Labelled
{
public:
/**
* Construct a Scalar Widget.
*
* @param label Label.
* @param suffix Suffix, placed after the widget (defaults to "").
* @param icon Icon filename, placed before the label (defaults to "").
* @param mnemonic Mnemonic toggle; if true, an underscore (_) in the label
* indicates the next character should be used for the
* mnemonic accelerator key (defaults to false).
*/
Scalar(Glib::ustring const &label,
Glib::ustring const &tooltip,
Glib::ustring const &suffix = "",
Glib::ustring const &icon = "",
bool mnemonic = true);
/**
* Construct a Scalar Widget.
*
* @param label Label.
* @param digits Number of decimal digits to display.
* @param suffix Suffix, placed after the widget (defaults to "").
* @param icon Icon filename, placed before the label (defaults to "").
* @param mnemonic Mnemonic toggle; if true, an underscore (_) in the label
* indicates the next character should be used for the
* mnemonic accelerator key (defaults to false).
*/
Scalar(Glib::ustring const &label,
Glib::ustring const &tooltip,
unsigned digits,
Glib::ustring const &suffix = "",
Glib::ustring const &icon = "",
bool mnemonic = true);
/**
* Construct a Scalar Widget.
*
* @param label Label.
* @param adjust Adjustment to use for the SpinButton.
* @param digits Number of decimal digits to display (defaults to 0).
* @param suffix Suffix, placed after the widget (defaults to "").
* @param icon Icon filename, placed before the label (defaults to "").
* @param mnemonic Mnemonic toggle; if true, an underscore (_) in the label
* indicates the next character should be used for the
* mnemonic accelerator key (defaults to true).
*/
Scalar(Glib::ustring const &label,
Glib::ustring const &tooltip,
Glib::RefPtr<Gtk::Adjustment> &adjust,
unsigned digits = 0,
Glib::ustring const &suffix = "",
Glib::ustring const &icon = "",
bool mnemonic = true);
/**
* Fetches the precision of the spin button.
*/
unsigned getDigits() const;
/**
* Gets the current step increment used by the spin button.
*/
double getStep() const;
/**
* Gets the current page increment used by the spin button.
*/
double getPage() const;
/**
* Gets the minimum range value allowed for the spin button.
*/
double getRangeMin() const;
/**
* Gets the maximum range value allowed for the spin button.
*/
double getRangeMax() const;
bool getSnapToTicks() const;
/**
* Get the value in the spin_button.
*/
double getValue() const;
/**
* Get the value spin_button represented as an integer.
*/
int getValueAsInt() const;
/**
* Sets the precision to be displayed by the spin button.
*/
void setDigits(unsigned digits);
/**
* Sets the step and page increments for the spin button.
* @todo Remove the second parameter - deprecated
*/
void setIncrements(double step, double page);
/**
* Sets the minimum and maximum range allowed for the spin button.
*/
void setRange(double min, double max);
/**
* Sets the value of the spin button.
*/
void setValue(double value, bool setProg = true);
/**
* Sets the width of the spin button by number of characters.
*/
void setWidthChars(unsigned chars);
/**
* Manually forces an update of the spin button.
*/
void update();
/**
* Adds a slider (HScale) to the left of the spinbox.
*/
void addSlider();
/**
* Signal raised when the spin button's value changes.
*/
Glib::SignalProxy0<void> signal_value_changed();
/**
* Signal raised when the spin button's pressed.
*/
Glib::SignalProxy1<bool, GdkEventButton*> signal_button_release_event();
/**
* true if the value was set by setValue, not changed by the user;
* if a callback checks it, it must reset it back to false.
*/
bool setProgrammatically;
// permanently hide label part
void hide_label();
};
} // namespace Widget
} // namespace UI
} // namespace Inkscape
#endif // INKSCAPE_UI_WIDGET_SCALAR_H
/*
Local Variables:
mode:c++
c-file-style:"stroustrup"
c-file-offsets:((innamespace . 0)(inline-open . 0)(case-label . +))
indent-tabs-mode:nil
fill-column:99
End:
*/
// vim: filetype=cpp:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:fileencoding=utf-8:textwidth=99 :
|
