a text edit control More...

#include <ctextedit.h>

Inheritance diagram for CTextEdit:

Public Types
enum	Style { kDoubleClickStyle = 1 << StyleDoubleClick }

using	PlatformTextEditPtr = SharedPointer< IPlatformTextEdit >

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	CheckDefaultValueEventFuncT = bool()(CControl , MouseDownEvent &)

using	CheckDefaultValueFuncT = bool()(CControl , CButtonState)

Public Types inherited from CView
enum class	MouseListenerCall { MouseDown , MouseMoved , MouseUp , MouseCancel }

Public Member Functions
	CTextEdit (const CRect &size, IControlListener listener, int32_t tag, UTF8StringPtr txt=nullptr, CBitmap background=nullptr, const int32_t style=0)
	CTextEdit constructor. More...

	CTextEdit (const CTextEdit &textEdit)

bool	isDoubleClickStyle () const

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)

virtual const UTF8String &	getText () const
	read only access to text More...

virtual void	setTextTruncateMode (TextTruncateMode mode)
	set text truncate mode More...

TextTruncateMode	getTextTruncateMode () const
	get text truncate mode More...

const UTF8String &	getTruncatedText () 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...

void	draw (CDrawContext *pContext) override
	called if the view should draw itself More...

bool	sizeToFit () override
	resize view to optimal size More...

void	setViewSize (const CRect &rect, bool invalid=true) override
	set views size More...

void	drawStyleChanged () override

void	valueChanged () override
	notifies listener and dependent objects More...

CBaseObject *	newCopy () const override

Public Member Functions inherited from CParamDisplay
	CParamDisplay (const CRect &size, CBitmap *background=nullptr, int32_t style=0)

	CParamDisplay (const CParamDisplay &paramDisplay)

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

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 CPoint &	getBackOffset () const

void	copyBackOffset ()

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...

Public Member Functions inherited from CControl
	CControl (const CRect &size, IControlListener listener=nullptr, int32_t tag=0, CBitmap pBackground=nullptr)

	CControl (const CControl &c)

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 void	setTag (int32_t val)

virtual int32_t	getTag () const

virtual void	beginEdit ()

virtual void	endEdit ()

bool	isEditing () const

virtual IControlListener *	getListener () 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

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...

Public Member Functions inherited from CView
	CView (const CRect &size)

	CView (const CView &view)

virtual void	dispatchEvent (Event &event)
	dispatch an event More...

virtual void	onMouseDownEvent (MouseDownEvent &event)
	called when a mouse down event occurs More...

virtual void	onMouseMoveEvent (MouseMoveEvent &event)
	called when a mouse move event occurs More...

virtual void	onMouseUpEvent (MouseUpEvent &event)
	called when a mouse up event occurs More...

virtual void	onMouseCancelEvent (MouseCancelEvent &event)
	called when mouse tracking should be canceled More...

virtual void	onMouseEnterEvent (MouseEnterEvent &event)
	called when the mouse enters this view More...

virtual void	onMouseExitEvent (MouseExitEvent &event)
	called when the mouse leaves this view More...

virtual void	onMouseWheelEvent (MouseWheelEvent &event)
	called when a mouse wheel event occurs More...

virtual void	onZoomGestureEvent (ZoomGestureEvent &event)
	called when a zoom gesture event occurs More...

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...

virtual void	setMouseableArea (const CRect &rect)
	set 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...

virtual CMouseEventResult	onMouseUp (CPoint &where, const CButtonState &buttons)
	do not use any longer. More...

virtual CMouseEventResult	onMouseMoved (CPoint &where, const CButtonState &buttons)
	do not use any longer. More...

virtual CMouseEventResult	onMouseCancel ()
	do not use any longer. More...

virtual CMouseEventResult	onMouseEntered (CPoint &where, const CButtonState &buttons)
	do not use any longer. More...

virtual CMouseEventResult	onMouseExited (CPoint &where, const CButtonState &buttons)
	do not use any longer. More...

virtual bool	onWheel (const CPoint &where, const float &distance, const CButtonState &buttons) final

CRect &	getMouseableArea (CRect &rect) const
	get the area in which the view reacts to the mouse More...

void	setHitTestPath (CGraphicsPath *path)

virtual bool	hitTest (const CPoint &where, const Event &event=noEvent())
	check if where hits this view More...

virtual bool	hitTest (const CPoint &where, const CButtonState &buttons)

bool	doDrag (const DragDescription &dragDescription, const SharedPointer< IDragCallback > &callback={})
	start a drag operation More...

virtual SharedPointer< IDropTarget >	getDropTarget ()
	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 CRect &	getViewSize () const
	read only access to view size More...

virtual CRect	getVisibleViewSize () const
	returns the visible size of the view More...

virtual CPoint &	frameToLocal (CPoint &point) const
	conversion from frame coordinates to local view coordinates More...

virtual CPoint &	localToFrame (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	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...

CBitmap *	getBackground () 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...

CBitmap *	getDisabledBackground () const
	get background image used when the mouse is not enabled More...

CBitmap *	getDrawBackground () 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...

void	setSubviewState (bool state)

bool	isSubview () const

CView *	getParentView () const
	get parent view More...

CFrame *	getFrame () const
	get frame More...

virtual VSTGUIEditorInterface *	getEditor () 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, bool callDoneOnCancel=false)

void	removeAnimation (IdStringPtr name)

void	removeAllAnimations ()

void	registerViewListener (IViewListener *listener)

void	unregisterViewListener (IViewListener *listener)

void	registerViewEventListener (IViewEventListener *listener)

void	unregisterViewEventListener (IViewEventListener *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 >
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 >
T	translateToLocal (const T &t, bool ignoreFrame=false) const
	translates a local coordinate to a global one using parent transforms More...

virtual CViewContainer *	asViewContainer ()

virtual const CViewContainer *	asViewContainer () const

CMouseEventResult	callMouseListener (MouseListenerCall type, CPoint pos, CButtonState buttons)

void	callMouseListenerEnteredExited (bool mouseEntered)

CMessageResult	notify (CBaseObject *sender, IdStringPtr message) override

void	beforeDelete () override

CBaseObject *	newCopy () const override

virtual void	drawRect (CDrawContext *pContext, const CRect &updateRect)
	called if the view should draw itself 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...

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)

Public Member Functions inherited from CBaseObject
	CBaseObject ()=default

	~CBaseObject () noexcept override=default

	CBaseObject (const CBaseObject &)

CBaseObject &	operator= (const CBaseObject &)

Public Member Functions inherited from ReferenceCounted< T >
	ReferenceCounted ()=default

virtual	~ReferenceCounted () noexcept=default

	ReferenceCounted (const ReferenceCounted &)

ReferenceCounted &	operator= (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

CTextEdit Methods
using	StringToValueUserData = CTextEdit

using	StringToValueFunction = std::function< bool(UTF8StringPtr txt, float &result, CTextEdit *textEdit)>

bool	bWasReturnPressed {false}

PlatformTextEditPtr	platformControl

StringToValueFunction	stringToValueFunction

bool	immediateTextChange {false}

bool	secureStyle {false}

SharedPointer< CFontDesc >	platformFont

UTF8String	placeholderString

DispatchList< ITextEditListener * >	textEditListeners

void	setStringToValueFunction (const StringToValueFunction &stringToValueFunc)

void	setStringToValueFunction (StringToValueFunction &&stringToValueFunc)

virtual void	setImmediateTextChange (bool state)
	enable/disable immediate text change behaviour More...

bool	getImmediateTextChange () const
	get immediate text change behaviour More...

void	setSecureStyle (bool state)
	enable/disable secure style More...

bool	getSecureStyle () const
	get secure style More...

virtual void	setPlaceholderString (const UTF8String &str)

const UTF8String &	getPlaceholderString () const

void	registerTextEditListener (ITextEditListener *listener)

void	unregisterTextEditListener (ITextEditListener *listener)

void	setText (const UTF8String &txt) override
	set text More...

void	valueChanged () override
	notifies listener and dependent objects More...

void	setValue (float val) override

void	setTextRotation (double angle) override

void	draw (CDrawContext *pContext) override
	called if the view should draw itself More...

CMouseEventResult	onMouseDown (CPoint &where, const CButtonState &buttons) override
	do not use any longer. More...

void	onKeyboardEvent (KeyboardEvent &event) override
	called when a keyboard event is dispatched to this view More...

void	takeFocus () override
	called if view should take focus More...

void	looseFocus () override
	called if view should loose focus More...

bool	wantsFocus () const override
	check if view supports focus More...

void	setViewSize (const CRect &newSize, bool invalid=true) override
	set views size More...

void	parentSizeChanged () override
	notification that one of the views parent has changed its size More...

PlatformTextEditPtr	getPlatformTextEdit () const

CBaseObject *	newCopy () const override

	~CTextEdit () noexcept override

void	createPlatformTextEdit ()

void	updateText (IPlatformTextEdit *pte)

CColor	platformGetBackColor () const override

CColor	platformGetFontColor () const override

CFontRef	platformGetFont () const override

CHoriTxtAlign	platformGetHoriTxtAlign () const override

const UTF8String &	platformGetText () const override

const UTF8String &	platformGetPlaceholderText () const override

CRect	platformGetSize () const override

CRect	platformGetVisibleSize () const override

CPoint	platformGetTextInset () const override

void	platformLooseFocus (bool returnPressed) override

void	platformOnKeyboardEvent (KeyboardEvent &event) override

void	platformTextDidChange () override

bool	platformIsSecureTextEdit () override

Additional Inherited Members
Static Public Attributes inherited from CControl
static CheckDefaultValueEventFuncT	CheckDefaultValueEventFunc
	Function to check if a mouse down event should reset the value to its default value for a control. More...

static int32_t	kZoomModifier = kShift
	zoom modifier key, per default is the shift key More...

static int32_t	kDefaultValueModifier = kControl

static CheckDefaultValueFuncT	CheckDefaultValueFunc

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 = 30
	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

Protected Member Functions inherited from CParamDisplay
	~CParamDisplay () noexcept override

virtual void	drawBack (CDrawContext pContext, CBitmap newBack=nullptr)

virtual void	drawPlatformText (CDrawContext *pContext, const UTF8String &string)

virtual void	drawPlatformText (CDrawContext *pContext, const UTF8String &string, const CRect &size)

Protected Member Functions inherited from CControl
	~CControl () noexcept override

Protected Member Functions inherited from CView
	~CView () noexcept override

CGraphicsPath *	getHitTestPath () 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< TextLabelListenerList >	listeners

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
IControlListener *	listener

int32_t	tag

float	value

Detailed Description

a text edit control

Define a rectangle view where a text-value can be displayed and edited with a given font and color. The user can specify its convert function (from char to char). The text-value is centered in the given rect. A bitmap can be used as background.

Member Typedef Documentation

◆ PlatformTextEditPtr

using PlatformTextEditPtr = SharedPointer<IPlatformTextEdit>

◆ StringToValueFunction

using StringToValueFunction = std::function<bool(UTF8StringPtr txt, float& result, CTextEdit* textEdit)>

◆ StringToValueUserData

using StringToValueUserData = CTextEdit

Member Enumeration Documentation

◆ Style

enum Style

Enumerator
kDoubleClickStyle

Constructor & Destructor Documentation

◆ CTextEdit() [1/2]

CTextEdit	(	const CRect &	size,
		IControlListener *	listener,
		int32_t	tag,
		UTF8StringPtr	txt = `nullptr`,
		CBitmap *	background = `nullptr`,
		const int32_t	style = `0`
	)

CTextEdit constructor.

Parameters

size	the size of this view
listener	the listener
tag	the control tag
txt	the initial text as c string (UTF-8 encoded)
background	the background bitmap
style	the display style (see CParamDisplay for styles)

◆ CTextEdit() [2/2]

CTextEdit ( const CTextEdit & textEdit )

◆ ~CTextEdit()

~CTextEdit ( )

overrideprotectednoexcept

Member Function Documentation

◆ createPlatformTextEdit()

void createPlatformTextEdit ( )

protected

◆ draw()

void draw ( CDrawContext * pContext )

overridevirtual

called if the view should draw itself

Parameters

pContext draw context in which to draw

Reimplemented from CParamDisplay.

◆ getImmediateTextChange()

bool getImmediateTextChange ( ) const

inline

get immediate text change behaviour

◆ getPlaceholderString()

const UTF8String & getPlaceholderString ( ) const

inline

◆ getPlatformTextEdit()

PlatformTextEditPtr getPlatformTextEdit ( ) const

inline

◆ getSecureStyle()

bool getSecureStyle ( ) const

get secure style

◆ isDoubleClickStyle()

bool isDoubleClickStyle ( ) const

inline

◆ looseFocus()

void looseFocus ( )

overridevirtual

called if view should loose focus

Reimplemented from CView.

◆ newCopy()

CBaseObject * newCopy ( ) const

inlineoverridevirtual

Reimplemented from CParamDisplay.

◆ onKeyboardEvent()

void onKeyboardEvent ( KeyboardEvent & event )

overridevirtual

called when a keyboard event is dispatched to this view

This happens normally only if the view is the focus view.

Reimplemented from CView.

◆ onMouseDown()

CMouseEventResult onMouseDown	(	CPoint &	where,
		const CButtonState &	buttons
	)

overridevirtual

do not use any longer.

if possible refactor your classes to use the newer mouse event methods above.

Parameters

where	mouse location of mouse down
buttons	button and modifier state

Returns: event result. see CMouseEventResult

Reimplemented from CView.

◆ parentSizeChanged()

void parentSizeChanged ( )

overridevirtual

notification that one of the views parent has changed its size

Reimplemented from CView.

◆ platformGetBackColor()

CColor platformGetBackColor ( ) const

inlineoverrideprotected

◆ platformGetFont()

CFontRef platformGetFont ( ) const

overrideprotected

◆ platformGetFontColor()

CColor platformGetFontColor ( ) const

inlineoverrideprotected

◆ platformGetHoriTxtAlign()

CHoriTxtAlign platformGetHoriTxtAlign ( ) const

inlineoverrideprotected

◆ platformGetPlaceholderText()

const UTF8String & platformGetPlaceholderText ( ) const

inlineoverrideprotected

◆ platformGetSize()

CRect platformGetSize ( ) const

overrideprotected

◆ platformGetText()

const UTF8String & platformGetText ( ) const

inlineoverrideprotected

◆ platformGetTextInset()

CPoint platformGetTextInset ( ) const

inlineoverrideprotected

◆ platformGetVisibleSize()

CRect platformGetVisibleSize ( ) const

overrideprotected

◆ platformIsSecureTextEdit()

bool platformIsSecureTextEdit ( )

overrideprotected

◆ platformLooseFocus()

void platformLooseFocus ( bool returnPressed )

overrideprotected

◆ platformOnKeyboardEvent()

void platformOnKeyboardEvent ( KeyboardEvent & event )

overrideprotected

◆ platformTextDidChange()

void platformTextDidChange ( )

overrideprotected

◆ registerTextEditListener()

void registerTextEditListener ( ITextEditListener * listener )

◆ setImmediateTextChange()

void setImmediateTextChange ( bool state )

virtual

enable/disable immediate text change behaviour

◆ setPlaceholderString()

void setPlaceholderString ( const UTF8String & str )

virtual

◆ setSecureStyle()

void setSecureStyle ( bool state )

enable/disable secure style

◆ setStringToValueFunction() [1/2]

void setStringToValueFunction ( const StringToValueFunction & stringToValueFunc )

◆ setStringToValueFunction() [2/2]

void setStringToValueFunction ( StringToValueFunction && stringToValueFunc )

◆ setText()

void setText ( const UTF8String & txt )

overridevirtual

set text

Reimplemented from CTextLabel.

◆ setTextRotation()

void setTextRotation ( double angle )

inlineoverridevirtual

Reimplemented from CParamDisplay.

◆ setValue()

void setValue ( float val )

overridevirtual

Reimplemented from CControl.

◆ setViewSize()

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

overridevirtual

set views size

Parameters

newSize	rect of new size of view
doInvalid	if true set view dirty

Reimplemented from CView.

◆ takeFocus()

void takeFocus ( )

overridevirtual

called if view should take focus

Reimplemented from CView.

◆ unregisterTextEditListener()

void unregisterTextEditListener ( ITextEditListener * listener )

◆ updateText()

void updateText ( IPlatformTextEdit * pte )

protected

◆ valueChanged()

void valueChanged ( )

overridevirtual

notifies listener and dependent objects

Reimplemented from CControl.

◆ wantsFocus()

bool wantsFocus ( ) const

overridevirtual

check if view supports focus

Reimplemented from CView.

Member Data Documentation

◆ bWasReturnPressed

bool bWasReturnPressed {false}

◆ immediateTextChange

bool immediateTextChange {false}

protected

◆ placeholderString

UTF8String placeholderString

protected

◆ platformControl

PlatformTextEditPtr platformControl

protected

◆ platformFont

SharedPointer<CFontDesc> platformFont

mutableprotected

◆ secureStyle

bool secureStyle {false}

protected

◆ stringToValueFunction

StringToValueFunction stringToValueFunction

protected

◆ textEditListeners

DispatchList<ITextEditListener*> textEditListeners

protected

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

ctextedit.h
ctextedit.cpp

Public Types

Public Member Functions

CTextEdit Methods

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ PlatformTextEditPtr

◆ StringToValueFunction

◆ StringToValueUserData

Member Enumeration Documentation

◆ Style

Constructor & Destructor Documentation

◆ CTextEdit() [1/2]

◆ CTextEdit() [2/2]

◆ ~CTextEdit()

Member Function Documentation

◆ createPlatformTextEdit()

◆ draw()

◆ getImmediateTextChange()

◆ getPlaceholderString()

◆ getPlatformTextEdit()

◆ getSecureStyle()

◆ isDoubleClickStyle()

◆ looseFocus()

◆ newCopy()

◆ onKeyboardEvent()

◆ onMouseDown()

◆ parentSizeChanged()

◆ platformGetBackColor()

◆ platformGetFont()

◆ platformGetFontColor()

◆ platformGetHoriTxtAlign()

◆ platformGetPlaceholderText()

◆ platformGetSize()

◆ platformGetText()

◆ platformGetTextInset()

◆ platformGetVisibleSize()

◆ platformIsSecureTextEdit()

◆ platformLooseFocus()

◆ platformOnKeyboardEvent()

◆ platformTextDidChange()

◆ registerTextEditListener()

◆ setImmediateTextChange()

◆ setPlaceholderString()

◆ setSecureStyle()

◆ setStringToValueFunction() [1/2]

◆ setStringToValueFunction() [2/2]

◆ setText()

◆ setTextRotation()

◆ setValue()

◆ setViewSize()

◆ takeFocus()

◆ unregisterTextEditListener()

◆ updateText()

◆ valueChanged()

◆ wantsFocus()

Member Data Documentation

◆ bWasReturnPressed

◆ immediateTextChange

◆ placeholderString

◆ platformControl

◆ platformFont

◆ secureStyle

◆ stringToValueFunction

◆ textEditListeners