Container widget that displays a border around it's content. More...
#include <Border.h>
Inheritance diagram for PLGui::Border:
Public Member Functions | |
| virtual PLGUI_API void | OnDraw (Graphics &cGraphics) override |
| Called to draw the widget. | |
| virtual PLGUI_API PLMath::Vector2i | OnPreferredSize (const PLMath::Vector2i &vRefSize) const override |
| Called when the widget is to calculate it's preferred size. | |
| virtual PLGUI_API void | OnAdjustContent () override |
| Called when the widget content has to be adjusted. | |
Public Attributes | |
| ELineStyle | m_nLineStyle |
| int | m_nBorderSize |
| PLGraphics::Color4 | m_cBorderColor |
Detailed Description
Container widget that displays a border around it's content.
Member Function Documentation
| virtual PLGUI_API void PLGui::Border::OnDraw | ( | Graphics & | cGraphics | ) | [override, virtual] |
Called to draw the widget.
- Parameters:
-
[in] cGraphics Graphics object used for painting
Reimplemented from PLGui::WidgetFunctions.
| virtual PLGUI_API PLMath::Vector2i PLGui::Border::OnPreferredSize | ( | const PLMath::Vector2i & | vRefSize | ) | const [override, 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.
| virtual PLGUI_API void PLGui::Border::OnAdjustContent | ( | ) | [override, virtual] |
Called when the widget content has to be adjusted.
Reimplemented from PLGui::ContainerWidget.
Member Data Documentation
Line style
Border size
The documentation for this class was generated from the following file:
