A check box that can have two or three states. More...
#include <CheckBox.h>
Inheritance diagram for PLGui::CheckBox:
Public Member Functions | |
| PLGUI_API | CheckBox (Widget *pParent=nullptr) |
| Constructor. | |
| virtual PLGUI_API | ~CheckBox () |
| Destructor. | |
Protected Member Functions | |
| virtual void | OnDraw (Graphics &cGraphics) override |
| Called to draw the widget. | |
| virtual PLMath::Vector2i | OnPreferredSize (const PLMath::Vector2i &vRefSize) const override |
| Called when the widget is to calculate it's preferred size. | |
Detailed Description
A check box that can have two or three states.
Constructor & Destructor Documentation
| PLGUI_API PLGui::CheckBox::CheckBox | ( | Widget * | pParent = nullptr | ) |
Constructor.
- Parameters:
-
[in] pParent Pointer to the parent widget
| virtual PLGUI_API PLGui::CheckBox::~CheckBox | ( | ) | [virtual] |
Destructor.
Member Function Documentation
| virtual void PLGui::CheckBox::OnDraw | ( | Graphics & | cGraphics | ) | [override, protected, virtual] |
Called to draw the widget.
- Parameters:
-
[in] cGraphics Graphics object used for painting
Reimplemented from PLGui::WidgetFunctions.
| virtual PLMath::Vector2i PLGui::CheckBox::OnPreferredSize | ( | const PLMath::Vector2i & | vRefSize | ) | const [override, protected, virtual] |
Called when the widget is to calculate it's preferred size.
- Parameters:
-
[in] vRefSize Precalculated reference size, can be (-1, -1) if no reference size is available
- Returns:
- Preferred size
- Remarks:
- If the widget returns -1 in a component (X/Y), it means that there is no preferred size in that direction. A layout will in that case use 'as much space as possible', while the FitSize() functions will use the current size.
Reimplemented from PLGui::Widget.
The documentation for this class was generated from the following file:
