Repository navigation
Expand file tree
/
Copy pathWidget.hpp
More file actions
483 lines (403 loc) · 14.1 KB
/
Copy pathWidget.hpp
File metadata and controls
483 lines (403 loc) · 14.1 KB
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
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
/*
* DISTRHO Plugin Framework (DPF)
* Copyright (C) 2012-2022 Filipe Coelho <falktx@falktx.com>
*
* Permission to use, copy, modify, and/or distribute this software for any purpose with
* or without fee is hereby granted, provided that the above copyright notice and this
* permission notice appear in all copies.
*
* THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD
* TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN
* NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
* DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER
* IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
* CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
*/
#ifndef DGL_WIDGET_HPP_INCLUDED
#define DGL_WIDGET_HPP_INCLUDED
#include "Geometry.hpp"
#include <list>
START_NAMESPACE_DGL
// --------------------------------------------------------------------------------------------------------------------
// Forward class names
class Application;
class SubWidget;
class TopLevelWidget;
class Window;
// --------------------------------------------------------------------------------------------------------------------
/**
Base DGL Widget class.
This is the base Widget class, from which all widgets are built.
All widgets have a parent widget where they'll be drawn, this can be the top-level widget or a group widget.
This parent is never changed during a widget's lifetime.
Widgets receive events in relative coordinates. (0, 0) means its top-left position.
The top-level widget will draw subwidgets in the order they are constructed.
Early subwidgets are drawn first, at the bottom, then newer ones on top.
Events are sent in the inverse order so that the top-most widgets get
a chance to catch the event and stop its propagation.
All widget event callbacks do nothing by default and onDisplay MUST be reimplemented by subclasses.
@note It is not possible to subclass this Widget class directly, you must use SubWidget or TopLevelWidget instead.
*/
class Widget
{
public:
/**
Base event data.
These are the fields present on all Widget events.
*/
struct BaseEvent {
/** Currently active keyboard modifiers. @see Modifier */
uint mod;
/** Event flags. @see EventFlag */
uint flags;
/** Event timestamp in milliseconds (if any). */
uint time;
/** Constructor for default/null values */
BaseEvent() noexcept : mod(0x0), flags(0x0), time(0) {}
/** Destuctor */
virtual ~BaseEvent() noexcept {}
};
/**
Keyboard event.
This event represents low-level key presses and releases.
This can be used for "direct" keyboard handing like key bindings, but must not be interpreted as text input.
Keys are represented portably as Unicode code points, using the "natural" code point for the key.
The @a key field is the code for the pressed key, without any modifiers applied.
For example, a press or release of the 'A' key will have `key` 97 ('a')
regardless of whether shift or control are being held.
Alternatively, the raw @a keycode can be used to work directly with physical keys,
but note that this value is not portable and differs between platforms and hardware.
@see onKeyboard
*/
struct KeyboardEvent : BaseEvent {
/** True if the key was pressed, false if released. */
bool press;
/** Unicode point of the key pressed. */
uint key;
/** Raw keycode. */
uint keycode;
/** Constructor for default/null values */
KeyboardEvent() noexcept
: BaseEvent(),
press(false),
key(0),
keycode(0) {}
};
/**
Special keyboard event.
DEPRECATED This used to be part of DPF due to pugl, but now deprecated and simply non-functional.
All events go through KeyboardEvent or CharacterInputEvent, use those instead.
*/
struct DISTRHO_DEPRECATED_BY("KeyboardEvent") SpecialEvent : BaseEvent {
bool press;
Key key;
/** Constructor for default/null values */
SpecialEvent() noexcept
: BaseEvent(),
press(false),
key(Key(0)) {}
};
/**
Character input event.
This event represents text input, usually as the result of a key press.
The text is given both as a Unicode character code and a UTF-8 string.
Note that this event is generated by the platform's input system,
so there is not necessarily a direct correspondence between text events and physical key presses.
For example, with some input methods a sequence of several key presses will generate a single character.
@see onCharacterInput
*/
struct CharacterInputEvent : BaseEvent {
/** Raw key code. */
uint keycode;
/** Unicode character code. */
uint character;
/** UTF-8 string. */
char string[8];
/** Constructor for default/null values */
CharacterInputEvent() noexcept
: BaseEvent(),
keycode(0),
character(0),
#ifdef DISTRHO_PROPER_CPP11_SUPPORT
string{'\0','\0','\0','\0','\0','\0','\0','\0'} {}
#else
string() { std::memset(string, 0, sizeof(string)); }
#endif
};
/**
Mouse press or release event.
@see onMouse
*/
struct MouseEvent : BaseEvent {
/** The button number starting from 1. @see MouseButton */
uint button;
/** True if the button was pressed, false if released. */
bool press;
/** The widget-relative coordinates of the pointer. */
Point<double> pos;
/** The absolute coordinates of the pointer. */
Point<double> absolutePos;
/** Constructor for default/null values */
MouseEvent() noexcept
: BaseEvent(),
button(0),
press(false),
pos(0.0, 0.0),
absolutePos(0.0, 0.0) {}
};
/**
Mouse motion event.
@see onMotion
*/
struct MotionEvent : BaseEvent {
/** The widget-relative coordinates of the pointer. */
Point<double> pos;
/** The absolute coordinates of the pointer. */
Point<double> absolutePos;
/** Constructor for default/null values */
MotionEvent() noexcept
: BaseEvent(),
pos(0.0, 0.0),
absolutePos(0.0, 0.0) {}
};
/**
Mouse scroll event.
The scroll distance is expressed in "lines",
an arbitrary unit that corresponds to a single tick of a detented mouse wheel.
For example, `delta.y` = 1.0 scrolls 1 line up.
Some systems and devices support finer resolution and/or higher values for fast scrolls,
so programs should handle any value gracefully.
@see onScroll
*/
struct ScrollEvent : BaseEvent {
/** The widget-relative coordinates of the pointer. */
Point<double> pos;
/** The absolute coordinates of the pointer. */
Point<double> absolutePos;
/** The scroll distance. */
Point<double> delta;
/** The direction of the scroll or "smooth". */
ScrollDirection direction;
/** Constructor for default/null values */
ScrollEvent() noexcept
: BaseEvent(),
pos(0.0, 0.0),
absolutePos(0.0, 0.0),
delta(0.0, 0.0),
direction(kScrollSmooth) {}
};
/**
Resize event.
@see onResize
*/
struct ResizeEvent {
/** The new widget size. */
Size<uint> size;
/** The previous size, can be null. */
Size<uint> oldSize;
/** Constructor for default/null values */
ResizeEvent() noexcept
: size(0, 0),
oldSize(0, 0) {}
};
/**
Widget position changed event.
@see onPositionChanged
*/
struct PositionChangedEvent {
/** The new absolute position of the widget. */
Point<int> pos;
/** The previous absolute position of the widget. */
Point<int> oldPos;
/** Constructor for default/null values */
PositionChangedEvent() noexcept
: pos(0, 0),
oldPos(0, 0) {}
};
private:
/**
Private constructor, reserved for TopLevelWidget class.
*/
explicit Widget(TopLevelWidget* topLevelWidget);
/**
Private constructor, reserved for SubWidget class.
*/
explicit Widget(Widget* widgetToGroupTo);
public:
/**
Destructor.
*/
virtual ~Widget();
/**
Check if this widget is visible within its parent window.
Invisible widgets do not receive events except resize.
*/
bool isVisible() const noexcept;
/**
Set widget visible (or not) according to @a visible.
*/
void setVisible(bool visible);
/**
Show widget.
This is the same as calling setVisible(true).
*/
void show();
/**
Hide widget.
This is the same as calling setVisible(false).
*/
void hide();
/**
Get width.
*/
uint getWidth() const noexcept;
/**
Get height.
*/
uint getHeight() const noexcept;
/**
Get size.
*/
const Size<uint> getSize() const noexcept;
/**
Set width.
*/
void setWidth(uint width) noexcept;
/**
Set height.
*/
void setHeight(uint height) noexcept;
/**
Set size using @a width and @a height values.
*/
void setSize(uint width, uint height) noexcept;
/**
Set size.
*/
void setSize(const Size<uint>& size) noexcept;
/**
Get the Id associated with this widget.
Returns 0 by default.
@see setId
*/
uint getId() const noexcept;
/**
Get the name associated with this widget.
This is complately optional, mostly useful for debugging purposes.
Returns an empty string by default.
@see setName
*/
const char* getName() const noexcept;
/**
Set an Id to be associated with this widget.
@see getId
*/
void setId(uint id) noexcept;
/**
Set a name to be associated with this widget.
This is complately optional, only useful for debugging purposes.
@note name must not be null
@see getName
*/
void setName(const char* name) noexcept;
/**
Get the application associated with this widget's window.
This is the same as calling `getTopLevelWidget()->getApp()`.
*/
Application& getApp() const noexcept;
/**
Get the window associated with this widget.
This is the same as calling `getTopLevelWidget()->getWindow()`.
*/
Window& getWindow() const noexcept;
/**
Get the graphics context associated with this widget's window.
GraphicsContext is an empty struct and needs to be casted into a different type in order to be usable,
for example GraphicsContext.
@see CairoSubWidget, CairoTopLevelWidget
*/
const GraphicsContext& getGraphicsContext() const noexcept;
/**
Get top-level widget, as passed directly in the constructor
or going up the chain of group widgets until it finds the top-level one.
*/
TopLevelWidget* getTopLevelWidget() const noexcept;
/**
Get list of children (a subwidgets) that belong to this widget.
*/
std::list<SubWidget*> getChildren() const noexcept;
/**
Request repaint of this widget's area to the window this widget belongs to.
On the raw Widget class this function does nothing.
*/
virtual void repaint() noexcept;
DISTRHO_DEPRECATED_BY("getApp()")
Application& getParentApp() const noexcept { return getApp(); }
DISTRHO_DEPRECATED_BY("getWindow()")
Window& getParentWindow() const noexcept { return getWindow(); }
protected:
/**
A function called to draw the widget contents.
*/
virtual void onDisplay() = 0;
/**
A function called when a key is pressed or released.
@return True to stop event propagation, false otherwise.
*/
virtual bool onKeyboard(const KeyboardEvent&);
/**
A function called when an UTF-8 character is received.
@return True to stop event propagation, false otherwise.
*/
virtual bool onCharacterInput(const CharacterInputEvent&);
/**
A function called when a mouse button is pressed or released.
@return True to stop event propagation, false otherwise.
*/
virtual bool onMouse(const MouseEvent&);
/**
A function called when the pointer moves.
@return True to stop event propagation, false otherwise.
*/
virtual bool onMotion(const MotionEvent&);
/**
A function called on scrolling (e.g. mouse wheel or track pad).
@return True to stop event propagation, false otherwise.
*/
virtual bool onScroll(const ScrollEvent&);
/**
A function called when the widget is resized.
*/
virtual void onResize(const ResizeEvent&);
/**
A function called when a special key is pressed or relea
50B7
sed.
DEPRECATED use onKeyboard or onCharacterInput
*/
#if defined(_MSC_VER)
#pragma warning(push)
#pragma warning(disable:4996)
#elif defined(__clang__)
#pragma clang diagnostic push
#pragma clang diagnostic ignored "-Wdeprecated-declarations"
#elif defined(__GNUC__) && (__GNUC__ * 100 + __GNUC_MINOR__) >= 460
#pragma GCC diagnostic push
#pragma GCC diagnostic ignored "-Wdeprecated-declarations"
#endif
virtual bool onSpecial(const SpecialEvent&) { return false; }
#if defined(_MSC_VER)
#pragma warning(pop)
#elif defined(__clang__)
#pragma clang diagnostic pop
#elif defined(__GNUC__) && (__GNUC__ * 100 + __GNUC_MINOR__) >= 460
#pragma GCC diagnostic pop
#endif
private:
struct PrivateData;
PrivateData* const pData;
friend class SubWidget;
friend class TopLevelWidget;
DISTRHO_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR(Widget)
};
// --------------------------------------------------------------------------------------------------------------------
END_NAMESPACE_DGL
#endif // DGL_WIDGET_HPP_INCLUDED