FabGL
ESP32 VGA Controller and Graphics Library
|
Represents a checkbox or a radiobutton. More...
#include <fabui.h>
Public Member Functions | |
uiCheckBox (uiWindow *parent, const Point &pos, const Size &size, uiCheckBoxKind kind=uiCheckBoxKind::CheckBox, bool visible=true) | |
Creates an instance of the object. More... | |
uiAnchors & | anchors () |
Allows to switch on or off anchors. More... | |
uiApp * | app () |
Determines the app that owns this object. More... | |
void | bringAfter (uiWindow *insertionPoint) |
Brings this window after another one. More... | |
void | bringOnTop () |
Brings this window on top. More... | |
uiCheckBoxStyle & | checkBoxStyle () |
Sets or gets checkbox style. More... | |
bool | checked () |
Determines whether the checkbox or radiobutton is checked. More... | |
Point | clientPos () |
Determines position of the client area. More... | |
virtual Rect | clientRect (uiOrigin origin) |
Determines the client area bounding box. More... | |
Size | clientSize () |
Determines the client area size. More... | |
void | exitModal (int modalResult) |
Exits from a modal window. More... | |
uiWindow * | firstChild () |
Gets first child. More... | |
int | focusIndex () |
Determines the focus index (aka tab-index) More... | |
int | groupIndex () |
Determines radiobutton group index. More... | |
bool | hasChildren () |
Determines whether this window has children. More... | |
bool | hasFocus () |
Determines whether this window or control has focus. More... | |
bool | isMouseOver () |
Determines whether the mouse is over this window. More... | |
uiWindow * | lastChild () |
Gets last child. More... | |
Point | mouseDownPos () |
Determines mouse position when left button was down. More... | |
uiWindow * | next () |
Gets next sibling. More... | |
uiObjectType & | objectType () |
Determines the object type. More... | |
uiWindow * | parent () |
Determines the parent window. More... | |
Point | pos () |
Determines the window position relative to parent window. More... | |
uiWindow * | prev () |
Gets previous sibling. More... | |
Rect | rect (uiOrigin origin) |
Determines the window bounding box. More... | |
void | repaint (Rect const &rect) |
Repaints a rectangle of this window. More... | |
void | repaint () |
Repaints this window. More... | |
void | setChecked (bool value) |
Sets current checkbox or radiobutton checked status. More... | |
void | setFocusIndex (int value) |
Sets the focus index (aka tab-index) More... | |
void | setGroupIndex (int value) |
Sets radiobutton group index. More... | |
Size | size () |
Determines the window size. More... | |
uiWindowState | state () |
Determines the window state. More... | |
Rect | transformRect (Rect const &rect, uiWindow *baseWindow) |
Transforms rectangle origins from current window to another one. More... | |
uiWindowProps & | windowProps () |
Sets or gets window properties. More... | |
uiWindowStyle & | windowStyle () |
Sets or gets window style. More... | |
Public Attributes | |
Delegate | onChange |
Change event delegate. More... | |
Delegate | onClick |
Mouse click event delegate. More... | |
Delegate | onDblClick |
Mouse double click event delegate4. More... | |
Represents a checkbox or a radiobutton.
A checkbox permits the user to make a binary choice. A radio button allows the user to choose only one of a predefined set of mutually exclusive options.
fabgl::uiCheckBox::uiCheckBox | ( | uiWindow * | parent, |
const Point & | pos, | ||
const Size & | size, | ||
uiCheckBoxKind | kind = uiCheckBoxKind::CheckBox , |
||
bool | visible = true |
||
) |
Creates an instance of the object.
parent | The parent window. A checkbox must always have a parent window |
pos | Top-left coordinates of the checkbox relative to the parent |
size | The checkbox size |
kind | Defines the checkbox behaviour: checkbox or radiobutton |
visible | If true the checkbox is immediately visible |
|
inlineinherited |
Allows to switch on or off anchors.
|
inlineinherited |
Determines the app that owns this object.
|
inherited |
Brings this window after another one.
insertionPoint | This window will be placed after insertionPoint window. If insertionPoint is nullptr this window will be placed at the first position (location of less visibility.). |
|
inherited |
Brings this window on top.
|
inline |
Sets or gets checkbox style.
|
inline |
Determines whether the checkbox or radiobutton is checked.
|
inherited |
Determines position of the client area.
Determines the client area bounding box.
origin | Decides the origin of returned rectangle |
Reimplemented in fabgl::uiScrollableControl, and fabgl::uiFrame.
|
inherited |
Determines the client area size.
|
inherited |
Exits from a modal window.
To open a modal window use uiApp.showModalWindow().
modalResult | An integer value to return to uiApp.showModalWindow(). |
|
inlineinherited |
Gets first child.
|
inlineinherited |
Determines the focus index (aka tab-index)
To set focus index use uiWindow.setFocusIndex().
|
inline |
Determines radiobutton group index.
|
inlineinherited |
Determines whether this window has children.
|
inherited |
Determines whether this window or control has focus.
To set currently focused window use uiApp.setFocusedWindow().
|
inlineinherited |
Determines whether the mouse is over this window.
This methods returns True also when the mouse is captured.
|
inlineinherited |
Gets last child.
|
inlineinherited |
Determines mouse position when left button was down.
|
inlineinherited |
|
inlineinherited |
Determines the object type.
|
inlineinherited |
Determines the parent window.
|
inlineinherited |
Determines the window position relative to parent window.
To change window position use uiApp.moveWindow().
|
inlineinherited |
Gets previous sibling.
Previous sibling is less visible than calling object.
Determines the window bounding box.
To set window position use uiApp.moveWindow(), to set window size use uiApp.resizeWindow() or uiApp.reshapeWindow().
origin | Decides the origin of returned rectangle |
|
inherited |
Repaints a rectangle of this window.
rect | Rectangle to repaint |
|
inherited |
Repaints this window.
void fabgl::uiCheckBox::setChecked | ( | bool | value | ) |
Sets current checkbox or radiobutton checked status.
When in radiobutton mode, setting True all other items with the same uiCheckBox.groupIndex() are deselected.
value | Checkbox or radiobutton checked status |
|
inlineinherited |
Sets the focus index (aka tab-index)
value | The focus index. -1 = control isn't included into the focusable controls. 0 = first focusable control. |
|
inline |
Sets radiobutton group index.
value | Radiobutton group index (-1 = no group) |
|
inlineinherited |
|
inlineinherited |
Determines the window state.
To set window state (hidden, visible, maximized, minimized) use uiApp.showWindow(), uiApp.maximizeWindow(), uiApp.minimizeWindow().
Transforms rectangle origins from current window to another one.
rect | Rectangle to transform |
baseWindow | Window where the output rectangle will be relative to |
|
inlineinherited |
Sets or gets window properties.
|
inlineinherited |
Sets or gets window style.
Delegate fabgl::uiCheckBox::onChange |
Change event delegate.
This delegate is called whenever checkbox or radiobutton is checked or unchecked.
|
inherited |
Mouse click event delegate.
This delegate is called when the mouse button is pressed and released on the same position.
|
inherited |
Mouse double click event delegate4.
This delegate is called when the mouse button is double pressed and released on the same position. To change double click time use uiAppProps.doubleClickTime of uiApp.appProps().