iPlug 2: IText Struct Reference
IText is used to manage font and text/text entry style for a piece of text on the UI, independent of draw class/platform. More...
#include <IGraphicsStructs.h>
Public Member Functions | |
| IText (float size=DEFAULT_TEXT_SIZE, const IColor &color=DEFAULT_TEXT_FGCOLOR, const char *fontID=nullptr, EAlign align=EAlign::Center, EVAlign valign=EVAlign::Middle, float angle=0, const IColor &TEBGColor=DEFAULT_TEXTENTRY_BGCOLOR, const IColor &TEFGColor=DEFAULT_TEXTENTRY_FGCOLOR) | |
| Create a new IText with size, color, fontID ... More... | |
| IText (float size, EVAlign valign, const IColor &color=DEFAULT_TEXT_FGCOLOR) | |
| Create a new IText with size, vertical align, color. More... | |
| IText (float size, EAlign align, const IColor &color=DEFAULT_TEXT_FGCOLOR) | |
| Create a new IText with size, horizontal align, color. More... | |
| IText (float size, const char *fontID) | |
| Create a new IText with size and fontID. More... | |
| IText | WithFGColor (const IColor &fgColor) const |
| IText | WithTEColors (const IColor &teBgColor, const IColor &teFgColor) const |
| IText | WithAlign (EAlign align) const |
| IText | WithVAlign (EVAlign valign) const |
| IText | WithSize (float size) const |
| IText | WithAngle (float v) const |
| IText | WithFont (const char *fontID) const |
Public Attributes | |
| char | mFont [FONT_LEN] |
| float | mSize |
| IColor | mFGColor |
| IColor | mTextEntryBGColor |
| IColor | mTextEntryFGColor |
| float | mAngle = 0.f |
| EAlign | mAlign = EAlign::Near |
| EVAlign | mVAlign = EVAlign::Middle |
IText is used to manage font and text/text entry style for a piece of text on the UI, independent of draw class/platform.
Definition at line 661 of file IGraphicsStructs.h.
◆ IText() [1/4]
|
inline |
Create a new IText with size, color, fontID ...
- Parameters
-
size The size of the text color The color of the text font CString for the font name or nullptr for DEFAULT_FONT align Horizontal alignment valign Vertical alignment angle Angle of the text in in degrees clockwise where 0 is normal, horizontal TEBGColor Background color for text entry TEFGColor Foreground color for text entry
Definition at line 672 of file IGraphicsStructs.h.
|
inline |
Create a new IText with size, vertical align, color.
- Parameters
-
size The size of the text valign Vertical alignment color The color of the text
Definition at line 695 of file IGraphicsStructs.h.
◆ IText() [3/4]
|
inline |
Create a new IText with size, horizontal align, color.
- Parameters
-
size The size of the text align Horizontal alignment color The color of the text
Definition at line 707 of file IGraphicsStructs.h.
◆ IText() [4/4]
|
inline |
Create a new IText with size and fontID.
- Parameters
-
size The size of the text fontID CString used to identify the font
Definition at line 718 of file IGraphicsStructs.h.
◆ WithAlign()
|
inline |
◆ WithAngle()
|
inline |
◆ WithFGColor()
◆ WithFont()
|
inline |
◆ WithSize()
|
inline |
◆ WithTEColors()
◆ WithVAlign()
|
inline |
◆ mAlign
EAlign IText::mAlign = EAlign::Near
◆ mAngle
float IText::mAngle = 0.f
◆ mFGColor
◆ mFont
char IText::mFont[FONT_LEN]
◆ mSize
◆ mTextEntryBGColor
IColor IText::mTextEntryBGColor
◆ mTextEntryFGColor
IColor IText::mTextEntryFGColor
◆ mVAlign
EVAlign IText::mVAlign = EVAlign::Middle
The documentation for this struct was generated from the following file: