Widget that displays a static text. More...
#include <Label.h>
Inheritance diagram for PLGui::Label:
Public Member Functions | |
| PLGUI_API | Label (Widget *pParent=nullptr) |
| Constructor. | |
| virtual PLGUI_API | ~Label () |
| Destructor. | |
| PLGUI_API const Font & | GetFont () const |
| Get font. | |
| PLGUI_API void | SetFont (const Font &cFont) |
| Set font. | |
| PLGUI_API PLGraphics::Color4 | GetColor () const |
| Get color. | |
| PLGUI_API void | SetColor (const PLGraphics::Color4 &cColor) |
| Set color. | |
| PLGUI_API EAlign | GetAlign () const |
| Get horizontal alignment. | |
| PLGUI_API void | SetAlign (EAlign nAlign) |
| Set horizontal alignment. | |
| PLGUI_API EVAlign | GetVAlign () const |
| Get vertical alignment. | |
| PLGUI_API void | SetVAlign (EVAlign nAlign) |
| Set vertical alignment. | |
| PLGUI_API ETextWrap | GetWrap () const |
| Get text wrapping. | |
| PLGUI_API void | SetWrap (ETextWrap nWrap) |
| Set text wrapping. | |
| PLGUI_API PLCore::uint32 | GetStyle () const |
| Get text style. | |
| PLGUI_API void | SetStyle (PLCore::uint32 nStyle) |
| Set text style. | |
| PLGUI_API PLCore::String | GetText () const |
| Get text. | |
| PLGUI_API void | SetText (const PLCore::String &sText) |
| Set text. | |
Detailed Description
Widget that displays a static text.
Constructor & Destructor Documentation
| PLGUI_API PLGui::Label::Label | ( | Widget * | pParent = nullptr | ) |
Constructor.
- Parameters:
-
[in] pParent Pointer to parent widget
| virtual PLGUI_API PLGui::Label::~Label | ( | ) | [virtual] |
Destructor.
Member Function Documentation
| PLGUI_API const Font& PLGui::Label::GetFont | ( | ) | const |
Get font.
- Returns:
- Font
| PLGUI_API void PLGui::Label::SetFont | ( | const Font & | cFont | ) |
Set font.
- Parameters:
-
[in] cFont Font
| PLGUI_API PLGraphics::Color4 PLGui::Label::GetColor | ( | ) | const |
Get color.
- Returns:
- Color
| PLGUI_API void PLGui::Label::SetColor | ( | const PLGraphics::Color4 & | cColor | ) |
Set color.
- Parameters:
-
[in] cColor Color
| PLGUI_API EAlign PLGui::Label::GetAlign | ( | ) | const |
Get horizontal alignment.
- Returns:
- Alignment
| PLGUI_API void PLGui::Label::SetAlign | ( | EAlign | nAlign | ) |
Set horizontal alignment.
- Parameters:
-
[in] nAlign Alignment
| PLGUI_API EVAlign PLGui::Label::GetVAlign | ( | ) | const |
Get vertical alignment.
- Returns:
- Alignment
| PLGUI_API void PLGui::Label::SetVAlign | ( | EVAlign | nAlign | ) |
Set vertical alignment.
- Parameters:
-
[in] nAlign Alignment
| PLGUI_API ETextWrap PLGui::Label::GetWrap | ( | ) | const |
Get text wrapping.
- Returns:
- Wrapping mode
| PLGUI_API void PLGui::Label::SetWrap | ( | ETextWrap | nWrap | ) |
Set text wrapping.
- Parameters:
-
[in] nWrap Wrapping mode
| PLGUI_API PLCore::uint32 PLGui::Label::GetStyle | ( | ) | const |
Get text style.
- Returns:
- Text style
| PLGUI_API void PLGui::Label::SetStyle | ( | PLCore::uint32 | nStyle | ) |
Set text style.
- Parameters:
-
[in] nStyle Text style
| PLGUI_API PLCore::String PLGui::Label::GetText | ( | ) | const |
Get text.
- Returns:
- Text
| PLGUI_API void PLGui::Label::SetText | ( | const PLCore::String & | sText | ) |
Set text.
- Parameters:
-
[in] sText Text
The documentation for this class was generated from the following file:
