VSTGUI  4.10
Graphical User Interface Framework not only for VST plugins
CMultiLineTextLabel Class Reference

Multi line text label. More...

+ Inheritance diagram for CMultiLineTextLabel:

Public Types

enum  LineLayout { clip, truncate, wrap }
 
- Public Types inherited from CTextLabel
enum  TextTruncateMode { kTruncateNone = 0, kTruncateHead, kTruncateTail }
 
- Public Types inherited from CParamDisplay
enum  Style {
  kShadowText = 1 << StyleShadowText, k3DIn = 1 << Style3DIn, k3DOut = 1 << Style3DOut, kNoTextStyle = 1 << StyleNoText,
  kNoDrawStyle = 1 << StyleNoDraw, kRoundRectStyle = 1 << StyleRoundRect, kNoFrame = 1 << StyleNoFrame
}
 
using ValueToStringUserData = CParamDisplay
 
using ValueToStringFunction = std::function< bool(float value, char utf8String[256], CParamDisplay *display)>
 
using ValueToStringFunction2 = std::function< bool(float value, std::string &result, CParamDisplay *display)>
 
- Public Types inherited from CControl
using CheckDefaultValueFuncT = bool(*)(CControl *, CButtonState)
 
- Public Types inherited from CView
enum  MouseListenerCall { MouseDown, MouseMoved, MouseUp, MouseCancel }
 

Public Member Functions

 CMultiLineTextLabel (const CRect &size)
 
 CMultiLineTextLabel (const CMultiLineTextLabel &)=default
 
void setLineLayout (LineLayout layout)
 
LineLayout getLineLayout () const
 
void setAutoHeight (bool state)
 automatically resize the view according to the contents (only the height) More...
 
bool getAutoHeight () const
 returns true if this view resizes itself according to the contents More...
 
void setVerticalCentered (bool state)
 draw the lines vertical centered More...
 
bool getVerticalCentered () const
 returns true if the view draws the lines vertically centered More...
 
CCoord getMaxLineWidth ()
 return the maximum line width of all lines More...
 
void drawRect (CDrawContext *pContext, const CRect &updateRect) override
 called if the view should draw itself More...
 
bool sizeToFit () override
 resize view to optimal size More...
 
void setText (const UTF8String &txt) override
 set text More...
 
void setViewSize (const CRect &rect, bool invalid=true) override
 set views size More...
 
void setTextTruncateMode (TextTruncateMode mode) override
 set text truncate mode More...
 
void setValue (float val) override
 
- Public Member Functions inherited from CTextLabel
 CTextLabel (const CRect &size, UTF8StringPtr txt=nullptr, CBitmap *background=nullptr, const int32_t style=0)
 CTextLabel constructor. More...
 
 CTextLabel (const CTextLabel &textLabel)
 
void draw (CDrawContext *pContext) override
 called if the view should draw itself More...
 
void valueChanged () override
 notifies listener and dependent objects More...
 
CBaseObjectnewCopy () const override
 
virtual const UTF8StringgetText () const
 read only access to text More...
 
TextTruncateMode getTextTruncateMode () const
 get text truncate mode More...
 
const UTF8StringgetTruncatedText () const
 get the truncated text More...
 
void registerTextLabelListener (ITextLabelListener *listener)
 register a text label listener More...
 
void unregisterTextLabelListener (ITextLabelListener *listener)
 unregister a text label listener More...
 
- Public Member Functions inherited from CParamDisplay
 CParamDisplay (const CRect &size, CBitmap *background=nullptr, int32_t style=0)
 
 CParamDisplay (const CParamDisplay &paramDisplay)
 
bool getFocusPath (CGraphicsPath &outPath) override
 the graphics path will be drawn filled with the evenodd method and the color set in CFrame::setFocusColor() More...
 
bool removed (CView *parent) override
 view is removed from parent view More...
 
virtual void setFont (CFontRef fontID)
 
const CFontRef getFont () const
 
virtual void setFontColor (CColor color)
 
CColor getFontColor () const
 
virtual void setBackColor (CColor color)
 
CColor getBackColor () const
 
virtual void setFrameColor (CColor color)
 
CColor getFrameColor () const
 
virtual void setShadowColor (CColor color)
 
CColor getShadowColor () const
 
virtual void setShadowTextOffset (const CPoint &offset)
 
CPoint getShadowTextOffset () const
 
virtual void setAntialias (bool state)
 
bool getAntialias () const
 
virtual void setHoriAlign (CHoriTxtAlign hAlign)
 
CHoriTxtAlign getHoriAlign () const
 
virtual void setTextInset (const CPoint &p)
 
CPoint getTextInset () const
 
virtual void setTextRotation (double angle)
 
double getTextRotation () const
 
virtual void setRoundRectRadius (const CCoord &radius)
 
CCoord getRoundRectRadius () const
 
virtual void setFrameWidth (const CCoord &width)
 
CCoord getFrameWidth () const
 
void setValueToStringFunction (const ValueToStringFunction &valueToStringFunc)
 
void setValueToStringFunction (ValueToStringFunction &&valueToStringFunc)
 
void setValueToStringFunction2 (const ValueToStringFunction2 &valueToStringFunc)
 
void setValueToStringFunction2 (ValueToStringFunction2 &&valueToStringFunc)
 
virtual void setStyle (int32_t val)
 
int32_t getStyle () const
 
virtual void setPrecision (uint8_t precision)
 
uint8_t getPrecision () const
 
virtual void setBackOffset (const CPoint &offset)
 
const CPointgetBackOffset () const
 
void copyBackOffset ()
 
- Public Member Functions inherited from CControl
 CControl (const CRect &size, IControlListener *listener=nullptr, int32_t tag=0, CBitmap *pBackground=nullptr)
 
 CControl (const CControl &c)
 
bool isDirty () const override
 check if view is dirty More...
 
void setDirty (bool val=true) override
 set the view to dirty so that it is redrawn in the next idle. More...
 
bool drawFocusOnTop () override
 draw focus before view will be drawn or afterwards More...
 
virtual float getValue () const
 
virtual void setValueNormalized (float val)
 
virtual float getValueNormalized () const
 
virtual void setMin (float val)
 
virtual float getMin () const
 
virtual void setMax (float val)
 
virtual float getMax () const
 
float getRange () const
 
virtual void setOldValue (float val)
 
virtual float getOldValue () const
 
virtual void setDefaultValue (float val)
 
virtual float getDefaultValue () const
 
virtual void bounceValue ()
 
virtual bool checkDefaultValue (CButtonState button)
 
virtual void setTag (int32_t val)
 
virtual int32_t getTag () const
 
virtual void beginEdit ()
 
virtual void endEdit ()
 
bool isEditing () const
 
virtual IControlListenergetListener () const
 get main listener More...
 
virtual void setListener (IControlListener *l)
 set main listener More...
 
void registerControlListener (IControlListener *listener)
 register a sub listener More...
 
void unregisterControlListener (IControlListener *listener)
 unregister a sub listener More...
 
virtual void setWheelInc (float val)
 
virtual float getWheelInc () const
 
- Public Member Functions inherited from CView
 CView (const CRect &size)
 
 CView (const CView &view)
 
void setSubviewState (bool state)
 
bool isSubview () const
 
virtual bool wantsWindowActiveStateChangeNotification () const
 whether this view wants to be informed if the window's active state changes More...
 
virtual void onWindowActivate (bool state)
 called when the active state of the window changes More...
 
void setTooltipText (UTF8StringPtr text)
 
virtual CViewContainerasViewContainer ()
 
virtual const CViewContainerasViewContainer () const
 
CMouseEventResult callMouseListener (MouseListenerCall type, CPoint pos, CButtonState buttons)
 
void callMouseListenerEnteredExited (bool mouseEntered)
 
CMessageResult notify (CBaseObject *sender, IdStringPtr message) override
 
void beforeDelete () override
 
CBaseObjectnewCopy () const override
 
virtual CMouseEventResult onMouseDown (CPoint &where, const CButtonState &buttons)
 called when a mouse down event occurs More...
 
virtual CMouseEventResult onMouseUp (CPoint &where, const CButtonState &buttons)
 called when a mouse up event occurs More...
 
virtual CMouseEventResult onMouseMoved (CPoint &where, const CButtonState &buttons)
 called when a mouse move event occurs More...
 
virtual CMouseEventResult onMouseCancel ()
 called when mouse tracking should be canceled More...
 
virtual CMouseEventResult onMouseEntered (CPoint &where, const CButtonState &buttons)
 called when the mouse enters this view More...
 
virtual CMouseEventResult onMouseExited (CPoint &where, const CButtonState &buttons)
 called when the mouse leaves this view More...
 
void setHitTestPath (CGraphicsPath *path)
 
virtual bool hitTest (const CPoint &where, const CButtonState &buttons=-1)
 check if where hits this view More...
 
virtual bool onWheel (const CPoint &where, const float &distance, const CButtonState &buttons) final
 
virtual void setMouseEnabled (bool bEnable=true)
 turn on/off mouse usage for this view More...
 
bool getMouseEnabled () const
 get the state of wheather this view uses the mouse or not More...
 
void setMouseableArea (const CRect &rect)
 set the area in which the view reacts to the mouse More...
 
CRectgetMouseableArea (CRect &rect) const
 get the area in which the view reacts to the mouse More...
 
CRect getMouseableArea () const
 get the area in which the view reacts to the mouse More...
 
bool doDrag (const DragDescription &dragDescription, const SharedPointer< IDragCallback > &callback={})
 start a drag operation More...
 
virtual SharedPointer< IDropTargetgetDropTarget ()
 get the drag target for drag and drop handling More...
 
void setDropTarget (const SharedPointer< IDropTarget > &dt)
 set a custom drop target More...
 
DragResult doDrag (IDataPackage *source, const CPoint &offset=CPoint(0, 0), CBitmap *dragBitmap=nullptr)
 a drag can only be started from within onMouseDown More...
 
virtual int32_t onKeyDown (VstKeyCode &keyCode)
 called if a key down event occurs and this view has focus More...
 
virtual int32_t onKeyUp (VstKeyCode &keyCode)
 called if a key up event occurs and this view has focus More...
 
CCoord getHeight () const
 get the height of the view More...
 
CCoord getWidth () const
 get the width of the view More...
 
const CRectgetViewSize () const
 read only access to view size More...
 
virtual CRect getVisibleViewSize () const
 returns the visible size of the view More...
 
virtual void parentSizeChanged ()
 notification that one of the views parent has changed its size More...
 
virtual CPointframeToLocal (CPoint &point) const
 conversion from frame coordinates to local view coordinates More...
 
virtual CPointlocalToFrame (CPoint &point) const
 conversion from local view coordinates to frame coordinates More...
 
virtual void setAutosizeFlags (int32_t flags)
 set autosize flags More...
 
int32_t getAutosizeFlags () const
 get autosize flags More...
 
virtual void looseFocus ()
 called if view should loose focus More...
 
virtual void takeFocus ()
 called if view should take focus More...
 
virtual bool wantsFocus () const
 check if view supports focus More...
 
virtual void setWantsFocus (bool state)
 set focus support on/off More...
 
bool getAttributeSize (const CViewAttributeID id, uint32_t &outSize) const
 get the size of an attribute More...
 
bool getAttribute (const CViewAttributeID id, const uint32_t inSize, void *outData, uint32_t &outSize) const
 get an attribute More...
 
bool setAttribute (const CViewAttributeID id, const uint32_t inSize, const void *inData)
 set an attribute More...
 
bool removeAttribute (const CViewAttributeID id)
 remove an attribute More...
 
template<typename T >
bool setAttribute (const CViewAttributeID id, const T &data)
 set an attribute More...
 
template<typename T >
bool getAttribute (const CViewAttributeID id, T &data) const
 get an attribute More...
 
virtual void setBackground (CBitmap *background)
 set the background image of this view More...
 
CBitmapgetBackground () const
 get the background image of this view More...
 
virtual void setDisabledBackground (CBitmap *background)
 set background image used when the mouse is not enabled More...
 
CBitmapgetDisabledBackground () const
 get background image used when the mouse is not enabled More...
 
CBitmapgetDrawBackground () const
 get the bitmap which is drawn depending on the enabled state. More...
 
virtual void setTransparency (bool val)
 set views transparent state More...
 
bool getTransparency () const
 get views transparent state More...
 
virtual void setAlphaValue (float alpha)
 set alpha value which will be applied when drawing this view More...
 
float getAlphaValue () const
 get alpha value More...
 
virtual bool attached (CView *parent)
 view is attached to a parent view More...
 
bool isAttached () const
 is view attached to a parentView More...
 
CViewgetParentView () const
 get parent view More...
 
CFramegetFrame () const
 get frame More...
 
virtual VSTGUIEditorInterfacegetEditor () const
 get editor More...
 
void addAnimation (IdStringPtr name, Animation::IAnimationTarget *target, Animation::ITimingFunction *timingFunction, CBaseObject *notificationObject)
 
void addAnimation (IdStringPtr name, Animation::IAnimationTarget *target, Animation::ITimingFunction *timingFunction, const Animation::DoneFunction &doneFunc=nullptr)
 
void removeAnimation (IdStringPtr name)
 
void removeAllAnimations ()
 
void registerViewListener (IViewListener *listener)
 
void unregisterViewListener (IViewListener *listener)
 
void registerViewMouseListener (IViewMouseListener *listener)
 
void unregisterViewMouseListener (IViewMouseListener *listener)
 
CGraphicsTransform getGlobalTransform (bool ignoreFrame=false) const
 get the active global transform for this view More...
 
template<typename T >
T & translateToGlobal (T &t, bool ignoreFrame=false) const
 translates a local coordinate to a global one using parent transforms More...
 
template<typename T >
translateToGlobal (const T &t, bool ignoreFrame=false) const
 translates a local coordinate to a global one using parent transforms More...
 
template<typename T >
T & translateToLocal (T &t, bool ignoreFrame=false) const
 translates a global coordinate to a local one using parent transforms More...
 
template<typename T >
translateToLocal (const T &t, bool ignoreFrame=false) const
 translates a local coordinate to a global one using parent transforms More...
 
virtual bool checkUpdate (const CRect &updateRect) const
 
virtual void invalidRect (const CRect &rect)
 mark rect as invalid More...
 
virtual void invalid ()
 mark whole view as invalid More...
 
virtual void setVisible (bool state)
 set visibility state More...
 
bool isVisible () const
 get visibility state More...
 
virtual void onIdle ()
 called on idle when view wants idle More...
 
void setWantsIdle (bool state)
 enable/disable onIdle() callback More...
 
bool wantsIdle () const
 returns if the view wants idle callback or not More...
 
- Public Member Functions inherited from CBaseObject
 CBaseObject ()=default
 
 ~CBaseObject () noexcept override=default
 
 CBaseObject (const CBaseObject &o)
 
CBaseObjectoperator= (const CBaseObject &obj)
 
- Public Member Functions inherited from ReferenceCounted< T >
 ReferenceCounted ()=default
 
virtual ~ReferenceCounted () noexcept=default
 
 ReferenceCounted (const ReferenceCounted &)
 
ReferenceCountedoperator= (const ReferenceCounted &)
 
void forget () override
 decrease refcount and delete object if refcount == 0 More...
 
void remember () override
 increase refcount More...
 
virtual int32_t getNbReference () const
 get refcount More...
 
- Public Member Functions inherited from IFocusDrawing
virtual ~IFocusDrawing () noexcept=default
 

Additional Inherited Members

- Static Public Attributes inherited from CControl
static int32_t kZoomModifier = kShift
 zoom modifier key, per default is the shift key More...
 
static int32_t kDefaultValueModifier = kControl
 default value modifier key, per default is the control key More...
 
static CheckDefaultValueFuncT CheckDefaultValueFunc
 Function to check if the button state is the state to set the control value to its default value. More...
 
- Static Public Attributes inherited from CView
static bool kDirtyCallAlwaysOnMainThread = false
 if this is true, setting a view dirty will call invalid() instead of checking it in idle. More...
 
static uint32_t idleRate
 global idle rate in Hz, defaults to 30 Hz More...
 
- Protected Types inherited from CTextLabel
using TextLabelListenerList = DispatchList< ITextLabelListener * >
 
- Protected Types inherited from CParamDisplay
enum  StyleEnum {
  StyleShadowText = 0, Style3DIn, Style3DOut, StyleNoText,
  StyleNoDraw, StyleRoundRect, StyleNoFrame, StyleAntialias,
  LastStyle
}
 
enum  StylePrivate { kAntialias = 1 << StyleAntialias }
 
- Protected Types inherited from CView
enum  {
  kMouseEnabled = 1 << 0, kTransparencyEnabled = 1 << 1, kWantsFocus = 1 << 2, kIsAttached = 1 << 3,
  kVisible = 1 << 4, kDirty = 1 << 5, kWantsIdle = 1 << 6, kIsSubview = 1 << 7,
  kHasAlpha = 1 << 8, kHasBackground = 1 << 9, kHasDisabledBackground = 1 << 10, kHasMouseableArea = 1 << 11,
  kLastCViewFlag = 11
}
 
- Protected Member Functions inherited from CTextLabel
 ~CTextLabel () noexcept override=default
 
void freeText ()
 
void calculateTruncatedText ()
 
bool onWheel (const CPoint &where, const CMouseWheelAxis &axis, const float &distance, const CButtonState &buttons) override
 called if a mouse wheel event is happening over this view More...
 
- Protected Member Functions inherited from CParamDisplay
 ~CParamDisplay () noexcept override
 
virtual void drawBack (CDrawContext *pContext, CBitmap *newBack=nullptr)
 
virtual void drawPlatformText (CDrawContext *pContext, IPlatformString *string)
 
virtual void drawPlatformText (CDrawContext *pContext, IPlatformString *string, const CRect &size)
 
- Protected Member Functions inherited from CControl
 ~CControl () noexcept override
 
- Protected Member Functions inherited from CView
 ~CView () noexcept override
 
CGraphicsPathgetHitTestPath () const
 
bool hasViewFlag (int32_t bit) const
 
void setViewFlag (int32_t bit, bool state)
 
void setAlphaValueNoInvalidate (float value)
 
void setParentFrame (CFrame *frame)
 
void setParentView (CView *parent)
 
- Static Protected Member Functions inherited from CControl
static int32_t mapVstKeyModifier (int32_t vstModifier)
 
- Protected Attributes inherited from CTextLabel
TextTruncateMode textTruncateMode
 
UTF8String text
 
UTF8String truncatedText
 
std::unique_ptr< TextLabelListenerListlisteners
 
- Protected Attributes inherited from CParamDisplay
ValueToStringFunction2 valueToStringFunction
 
CHoriTxtAlign horiTxtAlign
 
int32_t style
 
uint8_t valuePrecision
 
CFontRef fontID
 
CColor fontColor
 
CColor backColor
 
CColor frameColor
 
CColor shadowColor
 
CPoint textInset
 
CPoint shadowTextOffset {1., 1.}
 
CPoint backOffset
 
CCoord roundRectRadius
 
CCoord frameWidth
 
double textRotation
 
- Protected Attributes inherited from CControl
IControlListenerlistener
 
int32_t tag
 
float value
 

Detailed Description

Multi line text label.

Member Enumeration Documentation

◆ LineLayout

enum LineLayout
strong
Enumerator
clip 

clip lines overflowing the view size width

truncate 

truncate lines overflowing the view size width

wrap 

wrap overflowing words to next line

Constructor & Destructor Documentation

◆ CMultiLineTextLabel() [1/2]

CMultiLineTextLabel ( const CRect size)

◆ CMultiLineTextLabel() [2/2]

Member Function Documentation

◆ drawRect()

void drawRect ( CDrawContext pContext,
const CRect updateRect 
)
overridevirtual

called if the view should draw itself

Reimplemented from CView.

◆ getAutoHeight()

bool getAutoHeight ( ) const
inline

returns true if this view resizes itself according to the contents

◆ getLineLayout()

LineLayout getLineLayout ( ) const
inline

◆ getMaxLineWidth()

CCoord getMaxLineWidth ( )

return the maximum line width of all lines

◆ getVerticalCentered()

bool getVerticalCentered ( ) const
inline

returns true if the view draws the lines vertically centered

◆ setAutoHeight()

void setAutoHeight ( bool  state)

automatically resize the view according to the contents (only the height)

Parameters
stateon or off

◆ setLineLayout()

void setLineLayout ( LineLayout  layout)

◆ setText()

void setText ( const UTF8String txt)
overridevirtual

set text

Reimplemented from CTextLabel.

◆ setTextTruncateMode()

void setTextTruncateMode ( TextTruncateMode  mode)
overridevirtual

set text truncate mode

Reimplemented from CTextLabel.

◆ setValue()

void setValue ( float  val)
overridevirtual

Reimplemented from CControl.

◆ setVerticalCentered()

void setVerticalCentered ( bool  state)

draw the lines vertical centered

Parameters
stateon or off

◆ setViewSize()

void setViewSize ( const CRect newSize,
bool  doInvalid = true 
)
overridevirtual

set views size

Parameters
newSizerect of new size of view
doInvalidif true set view dirty

Reimplemented from CTextLabel.

◆ sizeToFit()

bool sizeToFit ( )
overridevirtual

resize view to optimal size

Reimplemented from CTextLabel.


The documentation for this class was generated from the following files: