VSTGUI 4.10 Graphical User Interface Framework not only for VST plugins

Loading...
Searching...
No Matches
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
CSearchTextEdit Class Reference
New classes » Version 4.5

Search text edit field. More...

`#include <csearchtextedit.h>`

Inheritance diagram for CSearchTextEdit:

## Public Member Functions
| CSearchTextEdit (const CRect &size, IControlListener *listener, int32_t tag, UTF8StringPtr txt=nullptr, CBitmap *background=nullptr, const int32_t style=0)
void | setClearMarkInset (CPoint inset)
CPoint | getClearMarkInset () const
void | draw (CDrawContext *pContext) override
| called if the view should draw itself
CMouseEventResult | onMouseDown (CPoint &where, const CButtonState &buttons) override
| do not use any longer.
Public Member Functions inherited from CTextEdit
| CTextEdit (const CRect &size, IControlListener *listener, int32_t tag, UTF8StringPtr txt=nullptr, CBitmap *background=nullptr, const int32_t style=0)
| CTextEdit constructor.
| CTextEdit (const CTextEdit &textEdit)
bool | isDoubleClickStyle () const
void | setStringToValueFunction (const StringToValueFunction &stringToValueFunc)
void | setStringToValueFunction (StringToValueFunction &&stringToValueFunc)
virtual void | setImmediateTextChange (bool state)
| enable/disable immediate text change behaviour
bool | getImmediateTextChange () const
| get immediate text change behaviour
void | setSecureStyle (bool state)
| enable/disable secure style
bool | getSecureStyle () const
| get secure style
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
void | valueChanged () override
| notifies listener and dependent objects
void | setValue (float val) override
void | setTextRotation (double angle) override
void | draw (CDrawContext *pContext) override
| called if the view should draw itself
CMouseEventResult | onMouseDown (CPoint &where, const CButtonState &buttons) override
| do not use any longer.
void | onKeyboardEvent (KeyboardEvent &event) override
| called when a keyboard event is dispatched to this view
void | takeFocus () override
| called if view should take focus
void | looseFocus () override
| called if view should loose focus
bool | wantsFocus () const override
| check if view supports focus
void | setViewSize (const CRect &newSize, bool invalid=true) override
| set views size
void | parentSizeChanged () override
| notification that one of the views parent has changed its size
PlatformTextEditPtr | getPlatformTextEdit () const
CBaseObject * | newCopy () const override
Public Member Functions inherited from CTextLabel
| CTextLabel (const CRect &size, UTF8StringPtr txt=nullptr, CBitmap *background=nullptr, const int32_t style=0)
| CTextLabel constructor.
| CTextLabel (const CTextLabel &textLabel)
virtual const UTF8String & | getText () const
| read only access to text
virtual void | setTextTruncateMode (TextTruncateMode mode)
| set text truncate mode
TextTruncateMode | getTextTruncateMode () const
| get text truncate mode
const UTF8String & | getTruncatedText () const
| get the truncated text
void | registerTextLabelListener (ITextLabelListener *listener)
| register a text label listener
void | unregisterTextLabelListener (ITextLabelListener *listener)
| unregister a text label listener
void | draw (CDrawContext *pContext) override
| called if the view should draw itself
bool | sizeToFit () override
| resize view to optimal size
void | setViewSize (const CRect &rect, bool invalid=true) override
| set views size
void | drawStyleChanged () override
void | valueChanged () override
| notifies listener and dependent objects
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()
bool | removed (CView *parent) override
| view is removed from parent view
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
virtual void | setListener (IControlListener *l)
| set main listener
void | registerControlListener (IControlListener *listener)
| register a sub listener
void | unregisterControlListener (IControlListener *listener)
| unregister a sub listener
virtual void | setWheelInc (float val)
virtual float | getWheelInc () const
bool | isDirty () const override
| check if view is dirty
void | setDirty (bool val=true) override
| set the view to dirty so that it is redrawn in the next idle.
bool | drawFocusOnTop () override
| draw focus before view will be drawn or afterwards
Public Member Functions inherited from CView
| CView (const CRect &size)
| CView (const CView &view)
virtual void | dispatchEvent (Event &event)
| dispatch an event
virtual void | onMouseDownEvent (MouseDownEvent &event)
| called when a mouse down event occurs
virtual void | onMouseMoveEvent (MouseMoveEvent &event)
| called when a mouse move event occurs
virtual void | onMouseUpEvent (MouseUpEvent &event)
| called when a mouse up event occurs
virtual void | onMouseCancelEvent (MouseCancelEvent &event)
| called when mouse tracking should be canceled
virtual void | onMouseEnterEvent (MouseEnterEvent &event)
| called when the mouse enters this view
virtual void | onMouseExitEvent (MouseExitEvent &event)
| called when the mouse leaves this view
virtual void | onMouseWheelEvent (MouseWheelEvent &event)
| called when a mouse wheel event occurs
virtual void | onZoomGestureEvent (ZoomGestureEvent &event)
| called when a zoom gesture event occurs
virtual void | setMouseEnabled (bool bEnable=true)
| turn on/off mouse usage for this view
bool | getMouseEnabled () const
| get the state of wheather this view uses the mouse or not
virtual void | setMouseableArea (const CRect &rect)
| set the area in which the view reacts to the mouse
CRect | getMouseableArea () const
| get the area in which the view reacts to the mouse
virtual CMouseEventResult | onMouseUp (CPoint &where, const CButtonState &buttons)
| do not use any longer.
virtual CMouseEventResult | onMouseMoved (CPoint &where, const CButtonState &buttons)
| do not use any longer.
virtual CMouseEventResult | onMouseCancel ()
| do not use any longer.
virtual CMouseEventResult | onMouseEntered (CPoint &where, const CButtonState &buttons)
| do not use any longer.
virtual CMouseEventResult | onMouseExited (CPoint &where, const CButtonState &buttons)
| do not use any longer.
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
void | setHitTestPath (CGraphicsPath *path)
virtual bool | hitTest (const CPoint &where, const Event &event=noEvent())
| check if where hits this view
virtual bool | hitTest (const CPoint &where, const CButtonState &buttons)
bool | doDrag (const DragDescription &dragDescription, const SharedPointer< IDragCallback > &callback={})
| start a drag operation
virtual SharedPointer< IDropTarget > | getDropTarget ()
| get the drag target for drag and drop handling
void | setDropTarget (const SharedPointer< IDropTarget > &dt)
| set a custom drop target
DragResult | doDrag (IDataPackage *source, const CPoint &offset=CPoint(0, 0), CBitmap *dragBitmap=nullptr)
| a drag can only be started from within onMouseDown
virtual int32_t | onKeyDown (VstKeyCode &keyCode)
| called if a key down event occurs and this view has focus
virtual int32_t | onKeyUp (VstKeyCode &keyCode)
| called if a key up event occurs and this view has focus
CCoord | getHeight () const
| get the height of the view
CCoord | getWidth () const
| get the width of the view
const CRect & | getViewSize () const
| read only access to view size
virtual CRect | getVisibleViewSize () const
| returns the visible size of the view
virtual CPoint & | frameToLocal (CPoint &point) const
| conversion from frame coordinates to local view coordinates
virtual CPoint & | localToFrame (CPoint &point) const
| conversion from local view coordinates to frame coordinates
virtual void | setAutosizeFlags (int32_t flags)
| set autosize flags
int32_t | getAutosizeFlags () const
| get autosize flags
virtual void | setWantsFocus (bool state)
| set focus support on/off
bool | getAttributeSize (const CViewAttributeID id, uint32_t &outSize) const
| get the size of an attribute
bool | getAttribute (const CViewAttributeID id, const uint32_t inSize, void *outData, uint32_t &outSize) const
| get an attribute
bool | setAttribute (const CViewAttributeID id, const uint32_t inSize, const void *inData)
| set an attribute
bool | removeAttribute (const CViewAttributeID id)
| remove an attribute
template<typename T>
bool | setAttribute (const CViewAttributeID id, const T &data)
| set an attribute
template<typename T>
bool | getAttribute (const CViewAttributeID id, T &data) const
| get an attribute
virtual void | setBackground (CBitmap *background)
| set the background image of this view
CBitmap * | getBackground () const
| get the background image of this view
virtual void | setDisabledBackground (CBitmap *background)
| set background image used when the mouse is not enabled
CBitmap * | getDisabledBackground () const
| get background image used when the mouse is not enabled
CBitmap * | getDrawBackground () const
| get the bitmap which is drawn depending on the enabled state.
virtual void | setTransparency (bool val)
| set views transparent state
bool | getTransparency () const
| get views transparent state
virtual void | setAlphaValue (float alpha)
| set alpha value which will be applied when drawing this view
float | getAlphaValue () const
| get alpha value
virtual bool | attached (CView *parent)
| view is attached to a parent view
bool | isAttached () const
| is view attached to a parentView
void | setSubviewState (bool state)
bool | isSubview () const
CView * | getParentView () const
| get parent view
CFrame * | getFrame () const
| get frame
virtual VSTGUIEditorInterface * | getEditor () const
| get editor
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
template<typename T>
T & | translateToGlobal (T &t, bool ignoreFrame=false) const
| translates a local coordinate to a global one using parent transforms
template<typename T>
T | translateToGlobal (const T &t, bool ignoreFrame=false) const
| translates a local coordinate to a global one using parent transforms
template<typename T>
T & | translateToLocal (T &t, bool ignoreFrame=false) const
| translates a global coordinate to a local one using parent transforms
template<typename T>
T | translateToLocal (const T &t, bool ignoreFrame=false) const
| translates a local coordinate to a global one using parent transforms
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
virtual bool | checkUpdate (const CRect &updateRect) const
virtual void | invalidRect (const CRect &rect)
| mark rect as invalid
virtual void | invalid ()
| mark whole view as invalid
virtual void | setVisible (bool state)
| set visibility state
bool | isVisible () const
| get visibility state
virtual void | onIdle ()
| called on idle when view wants idle
void | setWantsIdle (bool state)
| enable/disable onIdle() callback
bool | wantsIdle () const
| returns if the view wants idle callback or not
virtual bool | wantsWindowActiveStateChangeNotification () const
| whether this view wants to be informed if the window's active state changes
virtual void | onWindowActivate (bool state)
| called when the active state of the window changes
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< int32_t >
| ReferenceCounted ()=default
virtual | ~ReferenceCounted () noexcept=default
| ReferenceCounted (const ReferenceCounted &)
ReferenceCounted & | operator= (const ReferenceCounted &)
| ReferenceCounted ()=default
| ReferenceCounted (const ReferenceCounted &)
virtual | ~ReferenceCounted () noexcept=default
ReferenceCounted & | operator= (const ReferenceCounted &)
void | forget () override
| decrease refcount and delete object if refcount == 0
void | remember () override
| increase refcount
virtual int32_t | getNbReference () const
| get refcount
void | forget () override
| decrease refcount and delete object if refcount == 0
void | remember () override
| increase refcount
virtual int32_t | getNbReference () const
| get refcount
Public Member Functions inherited from IFocusDrawing
virtual | ~IFocusDrawing () noexcept=default

## Protected Member Functions
void | drawClearMark (CDrawContext *context) const
CRect | getClearMarkRect () const
CRect | getTextRect () const
CRect | platformGetSize () const override
CRect | platformGetVisibleSize () const override
void | platformTextDidChange () 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
| ~CTextLabel () noexcept override=default
void | freeText ()
void | calculateTruncatedText ()
bool | onWheel (const CPoint &where, const CMouseWheelAxis &axis, const float &distance, const CButtonState &buttons) override
| ~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)
| ~CControl () noexcept override
| ~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)

## Protected Attributes
CPoint | clearMarkInset {2., 2.}
PlatformTextEditPtr | platformControl
StringToValueFunction | stringToValueFunction
bool | immediateTextChange {false}
bool | secureStyle {false}
SharedPointer< CFontDesc > | platformFont
UTF8String | placeholderString
DispatchList< ITextEditListener * > | textEditListeners
TextTruncateMode | textTruncateMode
UTF8String | text
UTF8String | truncatedText
std::unique_ptr< TextLabelListenerList > | listeners
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
IControlListener * | listener
int32_t | tag
float | value

## Additional Inherited Members
Public Types inherited from CTextEdit
enum | Style { kDoubleClickStyle = 1 << StyleDoubleClick }
using | PlatformTextEditPtr = SharedPointer<IPlatformTextEdit>
using | StringToValueUserData = CTextEdit
using | StringToValueFunction = std::function<bool(UTF8StringPtr txt, float& result, CTextEdit* textEdit)>
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)>
using | CheckDefaultValueEventFuncT = bool (*) (CControl*, MouseDownEvent&)
using | CheckDefaultValueFuncT = bool (*) (CControl*, CButtonState)
enum class | MouseListenerCall { MouseDown , MouseMoved , MouseUp , MouseCancel }
bool | bWasReturnPressed {false}
static CheckDefaultValueEventFuncT | CheckDefaultValueEventFunc
| Function to check if a mouse down event should reset the value to its default value for a control.
static int32_t | kZoomModifier = kShift
| zoom modifier key, per default is the shift key
static int32_t | kDefaultValueModifier = kControl
static CheckDefaultValueFuncT | CheckDefaultValueFunc
static bool | kDirtyCallAlwaysOnMainThread = false
| if this is true, setting a view dirty will call invalid() instead of checking it in idle.
static uint32_t | idleRate = 30
| global idle rate in Hz, defaults to 30 Hz
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 }
static int32_t | mapVstKeyModifier (int32_t vstModifier)

## Detailed Description

Search text edit field.

## Constructor & Destructor Documentation

## ◆ CSearchTextEdit()

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

## Member Function Documentation

## ◆ draw()

void draw | ( | CDrawContext * | pContext | ) |
| override virtual

called if the view should draw itself

Parameters

  pContext | draw context in which to draw

Reimplemented from CParamDisplay.

## ◆ drawClearMark()

void drawClearMark | ( | CDrawContext * | context | ) | const
| protected

## ◆ getClearMarkInset()

CPoint getClearMarkInset | ( |  | ) | const

## ◆ getClearMarkRect()

CRect getClearMarkRect | ( |  | ) | const
| protected

## ◆ getTextRect()

CRect getTextRect | ( |  | ) | const
| protected

## ◆ onMouseDown()

CMouseEventResult onMouseDown | ( | CPoint & | where,
|  | const CButtonState & | buttons )
| override virtual

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.

## ◆ platformGetSize()

CRect platformGetSize | ( |  | ) | const
| override protected

## ◆ platformGetVisibleSize()

CRect platformGetVisibleSize | ( |  | ) | const
| override protected

## ◆ platformTextDidChange()

void platformTextDidChange | ( |  | ) |
| override protected

## ◆ setClearMarkInset()

void setClearMarkInset | ( | CPoint | inset | ) |

## Member Data Documentation

## ◆ clearMarkInset

CPoint clearMarkInset {2., 2.}
| protected

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

- csearchtextedit.h
- csearchtextedit.cpp