uiFrame Class Reference
A frame is a window with a title bar, maximize/minimize/close buttons and that is resizeable or moveable. More...
#include <fabui.h>
Inheritance diagram for uiFrame:
Public Member Functions | |
| uiFrame (uiWindow *parent, char const *title, const Point &pos, const Size &size, bool visible=true, uint32_t styleClassID=0) | |
| 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... | |
| uiFrameState | frameState () |
| Determines the frame state. 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 | isActiveWindow () |
| Determines wheter this window is the active window. More... | |
| bool | isMouseOver () |
| Determines whether the mouse is over this window. More... | |
| uiWindow * | lastChild () |
| Gets last child. More... | |
| uiWindow * | next () |
| Gets next sibling. More... | |
| uiObjectType & | objectType () |
| Determines the object type. More... | |
| uiWindow * | parent () |
| Determines the parent window. More... | |
| uiWindow * | parentFrame () |
| Determines the parent frame. 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 () |
| Repaints this window. More... | |
| void | repaint (Rect const &rect) |
| Repaints a rectangle of this window. More... | |
| void | setFocusIndex (int value) |
| Sets the focus index (aka tab-index) More... | |
| void | setParentProcessKbdEvents (bool value) |
| Enables a child window to send keyboard events to its parent. More... | |
| void | setStyleClassID (uint16_t value) |
| Sets style class for this UI element. More... | |
| void | setTitle (char const *value) |
| Sets window title. More... | |
| void | setTitleFmt (const char *format,...) |
| Sets window title as formatted text. More... | |
| Size | size () |
| Determines the window size. More... | |
| uiWindowState | state () |
| Determines the window state. More... | |
| uint16_t | styleClassID () |
| Determines current style class for this UI element. 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 | onHide |
| Hide window event delegate. More... | |
| Delegate< uiKeyEventInfo const & > | onKeyDown |
| Key-down event delegate. More... | |
| Delegate< uiKeyEventInfo const & > | onKeyUp |
| Key-up event delegate. More... | |
| Delegate | onPaint |
| Paint event delegate. More... | |
| Delegate | onResize |
| Resize window event delegate. More... | |
| Delegate | onShow |
| Show window event delegate. More... | |
| Delegate< uiTimerHandle > | onTimer |
| Timer event delegate. More... | |
Detailed Description
A frame is a window with a title bar, maximize/minimize/close buttons and that is resizeable or moveable.
A frame is the unique container that can handle focus travel (TAB and SHIFT-TAB) among child controls.
The documentation for this class was generated from the following files:
