Single-line, single-color label with tight extents. More...
#include <text_label.h>
Public Member Functions | |
| void | drawTo (const Surface &s) const override |
| Draw this object's content, respecting the fill mode. | |
| Box | anchorExtents () const override |
| Return the bounds used for alignment. | |
| template<typename String > | |
| TextLabel (const String &label, const Font &font, Color color, FillMode fill_mode=FillMode::kVisible) | |
| Construct from a string-like value (moves into internal storage). | |
| TextLabel (std::string label, const Font &font, Color color, FillMode fill_mode=FillMode::kVisible) | |
| Construct from an owned string. | |
 Public Member Functions inherited from roo_display::TextLabel | |
| template<typename String > | |
| TextLabel (const String &label, const Font &font, Color color, FillMode fill_mode=FillMode::kVisible) | |
| Construct from a string-like value (moves into internal storage). | |
| TextLabel (std::string label, const Font &font, Color color, FillMode fill_mode=FillMode::kVisible) | |
| Construct from an owned string. | |
| void | drawTo (const Surface &s) const override |
| Draw this object's content, respecting the fill mode. | |
| Box | extents () const override |
| Return the bounding box encompassing all pixels that need to be drawn. | |
| Box | anchorExtents () const override |
| Return the bounds used for alignment. | |
| const Font & | font () const |
| Return the font used by the label. | |
| const GlyphMetrics & | metrics () const |
| Return cached string metrics. | |
| const std::string & | label () const |
| Return the label text. | |
| const Color | color () const |
| Return the label color. | |
| const FillMode | fill_mode () const |
| Return the fill mode. | |
| void | setColor (Color color) |
| Set the label color. | |
| void | setFillMode (FillMode fill_mode) |
| Set the fill mode. | |
| Public Member Functions inherited from roo_display::Drawable | |
| virtual | ~Drawable () |
Additional Inherited Members | |
| Static Public Member Functions inherited from roo_display::Drawable | |
| static const Drawable * | Empty () |
| A singleton representing a no-op drawable with no bounding box. | |
Detailed Description
Single-line, single-color label with tight extents.
Extents are the smallest rectangle that fits all rendered pixels. The origin is at the text baseline and horizontally affected by the bearing.
Definition at line 92 of file text_label.h.
Member Function Documentation
◆ anchorExtents()
|
inlineoverridevirtual |
Return the bounds used for alignment.
Defaults to extents(). Some drawables (notably text labels) may want different alignment bounds.
This method is called during a transaction and must not block or perform I/O.
Reimplemented from roo_display::Drawable.
Definition at line 105 of file text_label.h.
References roo_display::TextLabel::metrics(), and roo_display::GlyphMetrics::screen_extents().
◆ drawTo()
Draw this object's content, respecting the fill mode.
If s.fill_mode() == FillMode::kExtents, the method must fill the entire (clipped) extents() rectangle (using s.bgcolor() for transparent parts).
The default implementation fills the clipped extents() rectangle with bgcolor and then calls drawInteriorTo(). That can cause flicker, so override this method if a better implementation is possible.
The implementation must respect surface parameters, particularly clip_box(), and must not draw outside it. The surface clip box is pre-clipped to fit within this drawable's extents().
Reimplemented from roo_display::Drawable.
Definition at line 96 of file text_label.h.
References roo_display::TextLabel::color(), roo_display::Font::drawHorizontalString(), roo_display::TextLabel::fill_mode(), roo_display::TextLabel::font(), roo_display::kExtents, and roo_display::TextLabel::label().
◆ TextLabel() [1/2]
|
inline |
Construct from a string-like value (moves into internal storage).
Definition at line 36 of file text_label.h.
◆ TextLabel() [2/2]
|
inline |
Construct from an owned string.
Definition at line 41 of file text_label.h.
The documentation for this class was generated from the following file:
- temp_repos/roo_display/src/roo_display/ui/text_label.h
