FabGL
ESP32 VGA Controller and Graphics Library
|
A frame is a window with a title bar, maximize/minimize/close buttons and that is resizeable or moveable. More...
#include <fabui.h>
Public Member Functions | |
uiFrame (uiWindow *parent, char const *title, const Point &pos, const Size &size, 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... | |
Point | clientPos () |
Determines position of the client area. More... | |
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... | |
uiFrameProps & | frameProps () |
Sets or gets frame properties. More... | |
uiFrameStyle & | frameStyle () |
Sets or gets frame style. 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 | setFocusIndex (int value) |
Sets the focus index (aka tab-index) More... | |
void | setTitle (char const *value) |
Sets window title. More... | |
Size | size () |
Determines the window size. More... | |
uiWindowState | state () |
Determines the window state. More... | |
char const * | title () |
Determines the window title. 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 | onClick |
Mouse click event delegate. More... | |
Delegate | onDblClick |
Mouse double click event delegate4. More... | |
Delegate | onHide |
Hide window event delegate. More... | |
Delegate | onResize |
Resize window event delegate. More... | |
Delegate | onShow |
Show window event delegate. More... | |
Delegate< uiTimerHandle > | onTimer |
Timer event delegate. More... | |
A frame is a window with a title bar, maximize/minimize/close buttons and that is resizeable or moveable.
fabgl::uiFrame::uiFrame | ( | uiWindow * | parent, |
char const * | title, | ||
const Point & | pos, | ||
const Size & | size, | ||
bool | visible = true |
||
) |
Creates an instance of the object.
parent | Parent window |
title | Title of the frame. An empty string hides the title bar |
pos | Top-left coordinates of the frame relative to the parent |
size | The frame size |
visible | If true the frame 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.
|
inherited |
Determines position of the client area.
Determines the client area bounding box.
origin | Decides the origin of returned rectangle |
Reimplemented from fabgl::uiWindow.
|
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 |
Sets or gets frame properties.
|
inline |
Sets or gets frame style.
|
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.
|
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::uiFrame::setTitle | ( | char const * | value | ) |
Sets window title.
Window needs to be repainted in order to display changed title.
value | The window title. nullptr hides the title bar. |
|
inlineinherited |
|
inlineinherited |
Determines the window state.
To set window state (hidden, visible, maximized, minimized) use uiApp.showWindow(), uiApp.maximizeWindow(), uiApp.minimizeWindow().
|
inline |
Determines the window title.
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.
|
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().
Delegate fabgl::uiFrame::onHide |
Hide window event delegate.
This delegate is called when the window is about to be hidden.
Delegate fabgl::uiFrame::onResize |
Resize window event delegate.
This delegate is called after its size has changed.
Delegate fabgl::uiFrame::onShow |
Show window event delegate.
This delegate is called when the window is about to be shown.
Delegate<uiTimerHandle> fabgl::uiFrame::onTimer |
Timer event delegate.
This delegate is called when the timer expires. To create a timer use uiApp.setTimer().