carma::ui::rtd::RtLabel Class Reference
A static label. More...
#include <carma/ui/rtd/common/RtDisplay.h>
Inheritance diagram for carma::ui::rtd::RtLabel:
Public Member Functions | |
| FontType | getFontType () const |
| Get the font type code. More... | |
| ::std::string | getLabel () const |
| Retrieve the label text. More... | |
| int | getRelFontSize () const |
| Get the relative font size. More... | |
| RtLabel () | |
| Default constructor. More... | |
| RtLabel (const std::string &label) | |
| Constructor. More... | |
| RtLabel (const std::string &label, char layoutCode) | |
| Constructor. More... | |
| RtLabel (const std::string &label, int relFontSize) | |
| Constructor. More... | |
| virtual void | serialize (bool initialize, int fontSize,::rtdproto::RtObject *rtobj) |
| Creates static description of container to stdout. More... | |
| void | setFontType (const FontType type) |
| Set the font type code, a single character code. More... | |
| void | setLabel (const std::string &label) |
| Set the label text. More... | |
| void | setRelFontSize (int relFontSize) |
| Set the relative font size. More... | |
| virtual void | update () |
| Update dynamic contents of this label - a null routine. More... | |
 Public Member Functions inherited from carma::ui::rtd::RtObject | |
| void | appendToolTipText (const std::string &text) |
| Append more text to the existing tool tip text. More... | |
| Layout | getLayout () const |
| Get the layout for this object. More... | |
| std::string | getToolTipText () |
| void | setFontSize (int fontSize) |
| Set the absolute font size for this object. More... | |
| void | setLayout (Layout layout) |
| Set the layout for this object. More... | |
| void | setToolTipText (const std::string &text) |
| Set the tool tip text for this RtObject. More... | |
| virtual | ~RtObject () |
| Destructor. More... | |
Additional Inherited Members | |
| Protected Member Functions inherited from carma::ui::rtd::RtObject | |
| int | getFontSize (int parentFontSize) const |
| Get the absolute font size for this object. More... | |
| int | getFontSize () const |
| Get the absolute font size for this object. More... | |
| RtObject () | |
| Constructor. More... | |
Detailed Description
A static label.
The default is a BOLD font, 2 points bigger than the default size.
Definition at line 1476 of file RtDisplay.h.
Constructor & Destructor Documentation
| carma::ui::rtd::RtLabel::RtLabel | ( | ) |
Default constructor.
|
explicit |
| carma::ui::rtd::RtLabel::RtLabel | ( | const std::string & | label, |
| char | layoutCode | ||
| ) |
| carma::ui::rtd::RtLabel::RtLabel | ( | const std::string & | label, |
| int | relFontSize | ||
| ) |
Constructor.
Create a new label with a layout code for RtArea layout
- Parameters
-
label the text for the label relFontSize the relative font size (wrt the default), in points
Member Function Documentation
| FontType carma::ui::rtd::RtLabel::getFontType | ( | ) | const |
Get the font type code.
| ::std::string carma::ui::rtd::RtLabel::getLabel | ( | ) | const |
Retrieve the label text.
| int carma::ui::rtd::RtLabel::getRelFontSize | ( | ) | const |
Get the relative font size.
|
virtual |
Creates static description of container to stdout.
Implements carma::ui::rtd::RtObject.
| void carma::ui::rtd::RtLabel::setFontType | ( | const FontType | type | ) |
Set the font type code, a single character code.
- Parameters
-
fontType the font type code:
P=plain, B=bold, I=italics
| void carma::ui::rtd::RtLabel::setLabel | ( | const std::string & | label | ) |
Set the label text.
| void carma::ui::rtd::RtLabel::setRelFontSize | ( | int | relFontSize | ) |
Set the relative font size.
|
virtual |
Update dynamic contents of this label - a null routine.
Implements carma::ui::rtd::RtObject.
The documentation for this class was generated from the following file:
- carma/ui/rtd/common/RtDisplay.h
