FabGL
ESP32 VGA Controller and Graphics Library
|
Represents a button control. A button can have text and optionally a bitmap. More...
#include <fabui.h>
Public Member Functions | |
uiButton (uiWindow *parent, char const *text, const Point &pos, const Size &size, uiButtonKind kind=uiButtonKind::Button, 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... | |
uiButtonStyle & | buttonStyle () |
Sets or gets button style. 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... | |
bool | down () |
Determines whether the switch button is down or up. 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... | |
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 | setDown (bool value) |
Sets button state of a switch button. More... | |
void | setFocusIndex (int value) |
Sets the focus index (aka tab-index) More... | |
void | setText (char const *value) |
Sets button text. More... | |
Size | size () |
Determines the window size. More... | |
uiWindowState | state () |
Determines the window state. More... | |
char const * | text () |
Determines button text. 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 |
Button changed event delegate. More... | |
Delegate | onClick |
Mouse click event delegate. More... | |
Delegate | onDblClick |
Mouse double click event delegate4. More... | |
Represents a button control. A button can have text and optionally a bitmap.
fabgl::uiButton::uiButton | ( | uiWindow * | parent, |
char const * | text, | ||
const Point & | pos, | ||
const Size & | size, | ||
uiButtonKind | kind = uiButtonKind::Button , |
||
bool | visible = true |
||
) |
Creates an instance of the object.
parent | The parent window. A button must always have a parent window |
text | The text of the button |
pos | Top-left coordinates of the button relative to the parent |
size | The button size |
kind | The button kind (button or switch) |
visible | If true the button 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 button style.
|
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.
|
inline |
Determines whether the switch button is down or up.
Only a switch button can be down.
|
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().
|
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::uiButton::setDown | ( | bool | value | ) |
Sets button state of a switch button.
Only a switch button can be down.
value | Button state (true = down, false = up) |
|
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. |
void fabgl::uiButton::setText | ( | char const * | value | ) |
Sets button text.
Button needs to be repainted in order to display changed text.
value | Button text |
|
inlineinherited |
|
inlineinherited |
Determines the window state.
To set window state (hidden, visible, maximized, minimized) use uiApp.showWindow(), uiApp.maximizeWindow(), uiApp.minimizeWindow().
|
inline |
Determines button text.
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::uiButton::onChange |
Button changed event delegate.
This delegate is called whenever a switch button change its state
|
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().