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
|
#pragma once
#include "../Base.h"
#include "../DeleteLater.h"
#include "../events/KeyEventArgs.h"
#include "../events/MouseWheelEventArgs.h"
#include "../events/UiEvents.h"
#include "../render/MeasureRequirement.h"
#include "../render/RenderObject.h"
#include "../style/StyleRuleSet.h"
#include <cru/base/SelfResolvable.h>
namespace cru::ui::controls {
/**
* \remarks If you want to write a new control. You should override following
* methods:
* - GetControlType()
* - GetRenderObject()
* - ForEachChild(const std::function<void(Control*)>& predicate)
* - RemoveChild(Control* child)
* The last two methods are totally for convenient control tree management.
*/
class CRU_UI_API Control : public Object,
public DeleteLaterImpl,
public SelfResolvable<Control> {
friend class RootControl;
CRU_DEFINE_CLASS_LOG_TAG("Control")
protected:
Control();
public:
~Control() override;
public:
virtual std::string GetControlType() const = 0;
std::string GetDebugId() const;
//*************** region: tree ***************
public:
Window* GetWindow();
Control* GetParent() const { return parent_; }
void SetParent(Control* parent);
bool HasAncestor(Control* control);
virtual void ForEachChild(const std::function<void(Control*)>& predicate) = 0;
/**
* \remarks This method should be permissive, which means if the specified
* child control is not a real child of this then nothing will be done.
*/
virtual void RemoveChild(Control* child) = 0;
void RemoveFromParent();
controls::Control* HitTest(const Point& point);
public:
virtual render::RenderObject* GetRenderObject() const = 0;
virtual render::MeasureSize GetPreferredSize() const {
return GetRenderObject()->GetPreferredSize();
}
virtual void SetPreferredSize(const render::MeasureSize& size) {
GetRenderObject()->SetPreferredSize(size);
}
virtual Thickness GetMargin() const { return GetRenderObject()->GetMargin(); }
virtual void SetMargin(const Thickness& margin) {
GetRenderObject()->SetMargin(margin);
}
virtual Thickness GetPadding() const {
return GetRenderObject()->GetPadding();
}
virtual void SetPadding(const Thickness& padding) {
GetRenderObject()->SetPadding(padding);
}
//*************** region: focus ***************
public:
bool HasFocus();
void SetFocus();
//*************** region: mouse ***************
public:
bool IsMouseOver() const { return is_mouse_over_; }
bool CaptureMouse();
bool ReleaseMouse();
bool IsMouseCaptured();
//*************** region: cursor ***************
// Cursor is inherited from parent recursively if not set.
public:
// null for not set
std::shared_ptr<platform::gui::ICursor> GetCursor();
// will not return nullptr
std::shared_ptr<platform::gui::ICursor> GetInheritedCursor();
// null to unset
void SetCursor(std::shared_ptr<platform::gui::ICursor> cursor);
public:
std::shared_ptr<style::StyleRuleSet> GetStyleRuleSet();
//*************** region: events ***************
public:
// Raised when mouse enter the control. Even when the control itself captures
// the mouse, this event is raised as regular. But if mouse is captured by
// another control, the control will not receive any mouse enter event. You
// can use `IsMouseCaptured` to get more info.
CRU_DEFINE_ROUTED_EVENT(MouseEnter, events::MouseEventArgs)
// Raised when mouse is leave the control. Even when the control itself
// captures the mouse, this event is raised as regular. But if mouse is
// captured by another control, the control will not receive any mouse leave
// event. You can use `IsMouseCaptured` to get more info.
CRU_DEFINE_ROUTED_EVENT(MouseLeave, events::MouseEventArgs)
CRU_DEFINE_ROUTED_EVENT(MouseMove, events::MouseEventArgs)
CRU_DEFINE_ROUTED_EVENT(MouseDown, events::MouseButtonEventArgs)
CRU_DEFINE_ROUTED_EVENT(MouseUp, events::MouseButtonEventArgs)
CRU_DEFINE_ROUTED_EVENT(MouseWheel, events::MouseWheelEventArgs)
CRU_DEFINE_ROUTED_EVENT(KeyDown, events::KeyEventArgs)
CRU_DEFINE_ROUTED_EVENT(KeyUp, events::KeyEventArgs)
CRU_DEFINE_ROUTED_EVENT(GainFocus, events::FocusChangeEventArgs)
CRU_DEFINE_ROUTED_EVENT(LoseFocus, events::FocusChangeEventArgs)
//*************** region: tree ***************
protected:
virtual void OnParentChanged(Control* old_parent, Control* new_parent) {}
private:
Control* parent_ = nullptr;
bool is_mouse_over_ = false;
std::shared_ptr<platform::gui::ICursor> cursor_ = nullptr;
std::shared_ptr<style::StyleRuleSet> style_rule_set_;
std::unique_ptr<style::StyleRuleSetBind> style_rule_set_bind_;
};
} // namespace cru::ui::controls
|
