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
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
|
//
// Shortcut Button code for the Fast Light Tool Kit (FLTK).
//
// Copyright 1998-2023 by Bill Spitzak and others.
//
// This library is free software. Distribution and use rights are outlined in
// the file "COPYING" which should have been included with this file. If this
// file is missing or damaged, see the license at:
//
// https://www.fltk.org/COPYING.php
//
// Please see the following page on how to report bugs and issues:
//
// https://www.fltk.org/bugs.php
//
#include <FL/Fl_Shortcut_Button.H>
#include <FL/Fl.H>
#include <FL/fl_draw.H>
#include <FL/fl_utf8.h>
#include "flstring.h"
#include <ctype.h>
/** \class Fl_Shortcut_Button
A button that allows the user to type a key combination to create shortcuts.
After clicked once, the button catches the following keyboard events and
records the pressed keys and all modifiers. It draws a text representation of
the shortcut.
The backspace key deletes the current shortcut. A second click on the button
or moving focus makes the last shortcut permanent.
The Shortcut button calls the user callback after every change if
FL_WHEN_CHANGED is set, and when the button is no longer recording
shortcuts if FL_WHEN_RELEASE is set.
*/
/** Construct a shortcut button.
\param X, Y, W, H position and size of the button
\param l label text when no shortcut is set
*/
Fl_Shortcut_Button::Fl_Shortcut_Button(int X,int Y,int W,int H, const char* l)
: Fl_Button(X,Y,W,H,l),
hot_(false),
pre_hot_(false),
default_set_(false),
handle_default_button_(false),
pre_esc_(0),
shortcut_value(0),
default_shortcut_(0)
{
box(FL_DOWN_BOX);
selection_color(FL_SELECTION_COLOR);
type(FL_TOGGLE_BUTTON);
}
/**
Set the displayed shortcut.
\param[in] shortcut encoded as key and modifier
*/
void Fl_Shortcut_Button::value(Fl_Shortcut shortcut) {
shortcut_value = shortcut;
clear_changed();
redraw();
}
/**
Return the user selected shortcut.
\return shortcut encoded as key and modifier
*/
Fl_Shortcut Fl_Shortcut_Button::value() {
return shortcut_value;
}
/**
Set the default shortcut.
If set, and additional 'reverse' button apears that the user can click to
reset the shortcut to some default value (including 0).
\param[in] shortcut encoded as key and modifier
*/
void Fl_Shortcut_Button::default_value(Fl_Shortcut shortcut) {
default_shortcut_ = shortcut;
default_set_ = true;
redraw();
}
/**
Return the default shortcut.
\return shortcut encoded as key and modifier
*/
Fl_Shortcut Fl_Shortcut_Button::default_value() {
return default_shortcut_;
}
/**
No longer show the button to reverse to a default shortcut.
*/
void Fl_Shortcut_Button::default_clear() {
default_set_ = false;
redraw();
}
/**
Draw the textual representation of the shortcut button.
When the button can receive shortcut key events, it's "hot". A hot button
is drawn in selection color. A cold button is drawn as a regular text box
containing a human readable version of the shortcut key.
*/
void Fl_Shortcut_Button::draw() {
Fl_Color col = hot_ ? selection_color() : color();
Fl_Boxtype b = box();
if (hot_) {
if (down_box())
b = down_box();
else if ((b > FL_FLAT_BOX) && (b < FL_BORDER_BOX))
b = Fl_Boxtype(((int)b) ^ 1);
}
draw_box(b, col);
draw_backdrop();
int X = x() + Fl::box_dx(box());
int Y = y() + Fl::box_dy(box());
int W = w() - Fl::box_dw(box());
int H = h() - Fl::box_dh(box());
Fl_Color textcol = fl_contrast(labelcolor(), col);
if (!active_r())
textcol = fl_inactive(textcol);
fl_color(textcol);
fl_font(labelfont(), labelsize());
const char *text = label();
if (shortcut_value)
text = fl_shortcut_label(shortcut_value);
if (default_set_) {
fl_draw(text, X, Y, W-H, H, align() | FL_ALIGN_INSIDE);
fl_draw_symbol("@-29undo", X+W-H, Y, H, H, textcol);
} else {
fl_draw(text, X, Y, W, H, align() | FL_ALIGN_INSIDE);
}
if (Fl::focus() == this) draw_focus();
}
/**
Call the callback if the user is interested.
*/
void Fl_Shortcut_Button::do_end_hot_callback() {
if (when() & FL_WHEN_RELEASE) {
do_callback(FL_REASON_RELEASED);
}
}
/**
Handle keystrokes to catch the user's shortcut.
*/
int Fl_Shortcut_Button::handle(int e) {
bool inside_default_button = false;
if (default_set_ && ( (e == FL_PUSH) || (e == FL_DRAG) || (e == FL_RELEASE) ) ) {
int X = x() + Fl::box_dx(box());
int Y = y() + Fl::box_dy(box());
int W = w() - Fl::box_dw(box());
int H = h() - Fl::box_dh(box());
if (Fl::event_inside(this) && (Fl::event_x() > X+W-H))
inside_default_button = true;
}
if ((e == FL_PUSH) && default_set_ && inside_default_button) {
if (Fl::visible_focus() && handle(FL_FOCUS)) Fl::focus(this);
handle_default_button_ = true;
return 1;
}
if (handle_default_button_) {
if (e == FL_DRAG)
return 1;
if (e == FL_RELEASE) {
if (inside_default_button && (shortcut_value != default_shortcut_)) {
shortcut_value = default_shortcut_;
set_changed();
redraw();
if (when() & FL_WHEN_CHANGED) do_callback(FL_REASON_CHANGED);
clear_changed();
}
handle_default_button_ = false;
return 1;
}
}
switch (e) {
case FL_PUSH:
if (Fl::visible_focus() && handle(FL_FOCUS)) Fl::focus(this);
pre_hot_ = hot_;
/* FALLTHROUGH */
case FL_DRAG:
case FL_RELEASE:
if (Fl::event_inside(this)) {
hot_ = !pre_hot_;
} else {
hot_ = pre_hot_;
}
if ((e == FL_RELEASE) && pre_hot_ && !hot_)
do_end_hot_callback();
redraw();
handle_default_button_ = false;
return 1;
case FL_UNFOCUS:
if (hot_) do_end_hot_callback();
hot_ = false;
handle_default_button_ = false;
/* FALLTHROUGH */
case FL_FOCUS:
redraw();
return 1;
case FL_KEYBOARD:
if (hot_) {
// Note: we can't really handle non-Latin shortcuts in the Fl_Shortcut
// type, so we don't handle them here either
int v = fl_utf8decode(Fl::event_text(), 0, 0);
if ( (v > 32 && v < 0x7f) || (v > 0xa0 && v <= 0xff) ) {
if (isupper(v)) {
v = tolower(v);
v |= FL_SHIFT;
}
v = v | (Fl::event_state()&(FL_META|FL_ALT|FL_CTRL));
} else {
v = (Fl::event_state() & (FL_META|FL_ALT|FL_CTRL|FL_SHIFT)) | Fl::event_key();
if (v == FL_Escape) {
if (shortcut_value == FL_Escape) {
v = pre_esc_;
do_end_hot_callback();
hot_ = false;
} else {
pre_esc_ = shortcut_value;
}
}
if ((v == FL_BackSpace) && shortcut_value) {
v = 0;
}
}
if (v != (int)shortcut_value) {
shortcut_value = v;
set_changed();
redraw();
if (when() & FL_WHEN_CHANGED) do_callback(FL_REASON_CHANGED);
clear_changed();
}
return 1;
} else {
if ((Fl::event_key() == FL_Enter) || (strcmp(Fl::event_text(), " ") == 0)) {
hot_ = true;
redraw();
return 1;
}
}
break;
}
return Fl_Button::handle(e);
}
|
