Skylicht Engine
Toggle main menu visibility
Loading...
Searching...
No Matches
UserInterface
CUICheckbox.h
1
/*
2
!@
3
MIT License
4
5
Copyright (c) 2024 Skylicht Technology CO., LTD
6
7
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files
8
(the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify,
9
merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so,
10
subject to the following conditions:
11
12
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
13
14
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
15
INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
16
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
17
WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
18
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
19
20
This file is part of the "Skylicht Engine".
21
https://github.com/skylicht-lab/skylicht-engine
22
!#
23
*/
24
25
#pragma once
26
27
#include "CUIBase.h"
28
29
namespace
Skylicht
30
{
31
namespace
UI
32
{
54
class
CUICheckbox
:
public
CUIBase
55
{
56
protected
:
57
CGUIElement
* m_background;
58
CGUIElement
* m_checked;
59
60
bool
m_toggleStatus;
61
62
CTween
* m_tween;
63
64
public
:
65
73
std::function<void(
CUICheckbox
*,
bool
)>
OnChanged
;
74
75
public
:
84
CUICheckbox
(
CUIContainer
* container,
CGUIElement
* element);
85
93
CUICheckbox
(
CUIContainer
* container,
CGUIElement
* element,
CGUIElement
* bg,
CGUIElement
* checked);
94
95
virtual
~CUICheckbox
();
96
104
virtual
void
onPressed
();
105
112
void
setToggle
(
bool
b,
bool
invokeEvent =
true
,
bool
doAnimation =
false
);
113
118
inline
bool
isToggle
()
119
{
120
return
m_toggleStatus;
121
}
122
127
inline
CGUIElement
*
getBackground
()
128
{
129
return
m_background;
130
}
131
136
inline
CGUIElement
*
getChecked
()
137
{
138
return
m_checked;
139
}
140
141
protected
:
142
149
void
stopTween
();
150
156
void
playTween
();
157
};
158
}
159
}
Skylicht::CGUIElement
This is the base object class from which other GUIs inherit. It's an empty GUI and can contain child ...
Definition
CGUIElement.h:51
Skylicht::CTween
Definition
CTween.h:11
Skylicht::UI::CUIBase::CUIBase
CUIBase(CUIContainer *container, CGUIElement *element)
Constructor.
Skylicht::UI::CUICheckbox::playTween
void playTween()
Start the tween animation for the checked/unchecked transition.
Skylicht::UI::CUICheckbox::isToggle
bool isToggle()
Query current checked state.
Definition
CUICheckbox.h:118
Skylicht::UI::CUICheckbox::getChecked
CGUIElement * getChecked()
Get the checked element.
Definition
CUICheckbox.h:136
Skylicht::UI::CUICheckbox::stopTween
void stopTween()
Stop and clear any active tween animation.
Skylicht::UI::CUICheckbox::setToggle
void setToggle(bool b, bool invokeEvent=true, bool doAnimation=false)
Set the checked state programmatically.
Skylicht::UI::CUICheckbox::onPressed
virtual void onPressed()
Called when the control is pressed.
Skylicht::UI::CUICheckbox::getBackground
CGUIElement * getBackground()
Get the background element.
Definition
CUICheckbox.h:127
Skylicht::UI::CUICheckbox::OnChanged
std::function< void(CUICheckbox *, bool)> OnChanged
Callback invoked when the checkbox state changes.
Definition
CUICheckbox.h:73
Skylicht::UI::CUICheckbox::CUICheckbox
CUICheckbox(CUIContainer *container, CGUIElement *element, CGUIElement *bg, CGUIElement *checked)
Create a checkbox with explicit background and checked elements.
Skylicht::UI::CUICheckbox::CUICheckbox
CUICheckbox(CUIContainer *container, CGUIElement *element)
Create a checkbox bound to a container and element.
Skylicht::UI::CUIContainer
Top-level UI container and event router.
Definition
CUIContainer.h:59
Skylicht::UI
Classes used to build the User Interface (UI).
Definition
CAlphaMotion.h:32
Skylicht
Everything in the Skylicht Engine. You can start by looking at the topics.
Definition
AudioDebugLog.h:29
Generated by
1.17.0