FabGL
ESP32 Display Controller and Graphics Library
uiPaintBox Class Reference

A paintbox control allows applications to perform custom drawings providing uiPaintBox.onPaint delegate. A paintbox can have horizontal and vertical scrollbars. More...

#include <fabui.h>

Inheritance diagram for uiPaintBox:

Public Member Functions

 uiPaintBox (uiWindow *parent, const Point &pos, const Size &size, bool visible=true, uint32_t styleClassID=0)
 Creates an instance of the object. More...
 
uiAnchorsanchors ()
 Allows to switch on or off anchors. More...
 
uiAppapp ()
 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...
 
uiWindowfirstChild ()
 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...
 
int HScrollBarPos ()
 Determines position of the horizontal scrollbar thumb. More...
 
int HScrollBarRange ()
 Determines horizontal scrollbar range. More...
 
int HScrollBarVisible ()
 Determines horizontal scrollbar visible portion (aka thumb size) of the scrollable content. More...
 
bool isActiveWindow ()
 Determines wheter this window is the active window. More...
 
bool isMouseOver ()
 Determines whether the mouse is over this window. More...
 
uiWindowlastChild ()
 Gets last child. More...
 
uiWindownext ()
 Gets next sibling. More...
 
uiObjectTypeobjectType ()
 Determines the object type. More...
 
uiPaintBoxStylepaintBoxStyle ()
 Sets or gets paintbox style. More...
 
uiWindowparent ()
 Determines the parent window. More...
 
uiWindowparentFrame ()
 Determines the parent frame. More...
 
Point pos ()
 Determines the window position relative to parent window. More...
 
uiWindowprev ()
 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...
 
uiScrollableControlStylescrollableControlStyle ()
 Sets or gets control style. 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...
 
virtual void setScrollBar (uiOrientation orientation, int position, int visible, int range, bool repaintScrollbar=true)
 Sets scrollbar position, visible portion and range. More...
 
void setStyleClassID (uint16_t value)
 Sets style class for this UI element. 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...
 
Rect transformRect (Rect const &rect, uiWindow *baseWindow)
 Transforms rectangle origins from current window to another one. More...
 
int VScrollBarPos ()
 Determines position of the vertical scrollbar thumb. More...
 
int VScrollBarRange ()
 Determines vertical scrollbar range. More...
 
int VScrollBarVisible ()
 Determines vertical scrollbar visible portion (aka thumb size) of the scrollable content. More...
 
uiWindowPropswindowProps ()
 Sets or gets window properties. More...
 
uiWindowStylewindowStyle ()
 Sets or gets window style. More...
 

Public Attributes

Delegate onChangeHScrollBar
 Horizontal scrollbar change event delegate. More...
 
Delegate onChangeVScrollBar
 Vertical scrollbar change event delegate. More...
 
Delegate< Rect const & > onPaint
 Paint event delegate. More...
 

Detailed Description

A paintbox control allows applications to perform custom drawings providing uiPaintBox.onPaint delegate. A paintbox can have horizontal and vertical scrollbars.

Definition at line 1866 of file fabui.h.


The documentation for this class was generated from the following files: