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
192
193
194
195
196
|
// SPDX-License-Identifier: GPL-2.0-or-later
/*
* Authors:
* Bryce Harrington <bryce@bryceharrington.org>
* Derek P. Moore <derekm@hackunix.org>
* buliabyak@gmail.com
*
* Copyright (C) 2004-2005 Authors
*
* Released under GNU GPL v2+, read the file 'COPYING' for more information.
*/
#ifndef INKSCAPE_UI_WIDGET_SCALAR_UNIT_H
#define INKSCAPE_UI_WIDGET_SCALAR_UNIT_H
#include "scalar.h"
#include "unit-menu.h"
namespace Inkscape {
namespace UI {
namespace Widget {
/**
* A labelled text box, with spin buttons and optional icon or suffix, for
* entering the values of various unit types.
*
* A ScalarUnit is a control for entering, viewing, or manipulating
* numbers with units. This differs from ordinary numbers like 2 or
* 3.14 because the number portion of a scalar *only* has meaning
* when considered with its unit type. For instance, 12 m and 12 in
* have very different actual values, but 1 m and 100 cm have the same
* value. The ScalarUnit allows us to abstract the presentation of
* the scalar to the user from the internal representations used by
* the program.
*/
class ScalarUnit : public Scalar
{
public:
/**
* Construct a ScalarUnit.
*
* @param label Label.
* @param unit_type Unit type (defaults to UNIT_TYPE_LINEAR).
* @param suffix Suffix, placed after the widget (defaults to "").
* @param icon Icon filename, placed before the label (defaults to "").
* @param unit_menu UnitMenu drop down; if not specified, one will be created
* and displayed after the widget (defaults to NULL).
* @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).
*/
ScalarUnit(Glib::ustring const &label, Glib::ustring const &tooltip,
UnitType unit_type = UNIT_TYPE_LINEAR,
Glib::ustring const &suffix = "",
Glib::ustring const &icon = "",
UnitMenu *unit_menu = nullptr,
bool mnemonic = true);
/**
* Construct a ScalarUnit.
*
* @param label Label.
* @param tooltip Tooltip text.
* @param take_unitmenu Use the unitmenu from this parameter.
* @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).
*/
ScalarUnit(Glib::ustring const &label, Glib::ustring const &tooltip,
ScalarUnit &take_unitmenu,
Glib::ustring const &suffix = "",
Glib::ustring const &icon = "",
bool mnemonic = true);
/**
* Initializes the scalar based on the settings in _unit_menu.
* Requires that _unit_menu has already been initialized.
*/
void initScalar(double min_value, double max_value);
/**
* Gets the object for the currently selected unit.
*/
Unit const * getUnit() const;
/**
* Gets the UnitType ID for the unit.
*/
UnitType getUnitType() const;
/**
* Returns the value in the given unit system.
*/
double getValue(Glib::ustring const &units) const;
/**
* Sets the unit for the ScalarUnit widget.
*/
bool setUnit(Glib::ustring const &units);
/**
* Adds the unit type to the ScalarUnit widget.
*/
void setUnitType(UnitType unit_type);
/**
* Resets the unit type for the ScalarUnit widget.
*/
void resetUnitType(UnitType unit_type);
/**
* allow align text in entry.
*/
void setAlignment(double xalign);
/**
* Sets the number and unit system.
*/
void setValue(double number, Glib::ustring const &units);
/**
* Convert and sets the number only and keeps the current unit.
*/
void setValueKeepUnit(double number, Glib::ustring const &units);
/**
* Sets the number only.
*/
void setValue(double number);
/**
* Grab focus, and select the text that is in the entry field.
*/
void grabFocusAndSelectEntry();
void setHundredPercent(double number);
void setAbsoluteIsIncrement(bool value);
void setPercentageIsIncrement(bool value);
/**
* Convert value from % to absolute, using _hundred_percent and *_is_increment flags.
*/
double PercentageToAbsolute(double value);
/**
* Convert value from absolute to %, using _hundred_percent and *_is_increment flags.
*/
double AbsoluteToPercentage(double value);
/**
* Assuming the current unit is absolute, get the corresponding % value.
*/
double getAsPercentage();
/**
* Assuming the current unit is absolute, set the value corresponding to a given %.
*/
void setFromPercentage(double value);
/**
* Signal handler for updating the value and suffix label when unit is changed.
*/
void on_unit_changed();
protected:
UnitMenu *_unit_menu;
double _hundred_percent; // the length that corresponds to 100%, in px, for %-to/from-absolute conversions
bool _absolute_is_increment; // if true, 120% with _hundred_percent=100px gets converted to/from 20px; otherwise, to/from 120px
bool _percentage_is_increment; // if true, 120px with _hundred_percent=100px gets converted to/from 20%; otherwise, to/from 120%
// if both are true, 20px is converted to/from 20% if _hundred_percent=100px
Glib::ustring lastUnits; // previously selected unit, for conversions
};
} // namespace Widget
} // namespace UI
} // namespace Inkscape
#endif // INKSCAPE_UI_WIDGET_SCALAR_UNIT_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 :
|
