CTextEdit Class Reference
[Controls]

a text edit control More...

Inheritance diagram for CTextEdit:
Inheritance graph
[legend]
Collaboration diagram for CTextEdit:
Collaboration graph
[legend]

List of all members.

Public Member Functions

 CTextEdit (const CRect &size, CControlListener *listener, int32_t tag, UTF8StringPtr txt=0, CBitmap *background=0, const int32_t style=0)
 CTextEdit (const CTextEdit &textEdit)
virtual void setText (UTF8StringPtr txt)
 set text
virtual void setValue (float val)
virtual void draw (CDrawContext *pContext)
 called if the view should draw itself
virtual CMouseEventResult onMouseDown (CPoint &where, const CButtonState &buttons)
 called when a mouse down event occurs
virtual int32_t onKeyDown (VstKeyCode &keyCode)
 called if a key down event occurs and this view has focus
virtual void takeFocus ()
 called if view should take focus
virtual void looseFocus ()
 called if view should loose focus
virtual void setViewSize (const CRect &newSize, bool invalid=true)
 set views size
virtual void parentSizeChanged ()
 notification that one of the views parent has changed its size
IPlatformTextEdit * getPlatformTextEdit () const
virtual bool sizeToFit ()
 resize view to optimal size
virtual void drawStyleChanged ()
bool getFocusPath (CGraphicsPath &outPath)
bool isDirty () const
 check if view is dirty
void setDirty (bool val=true)
 set the view to dirty so that it is redrawn in the next idle. Thread Safe !
bool drawFocusOnTop ()
CMessageResult notify (CBaseObject *sender, IdStringPtr message)
virtual void addDependency (CBaseObject *obj)
virtual void removeDependency (CBaseObject *obj)
virtual void changed (IdStringPtr message)
virtual void deferChanges (bool state)
CTextEdit Methods



virtual void setStringToValueProc (CTextEditStringToValueProc proc, void *userData=0)
virtual void setImmediateTextChange (bool state)
 enable/disable immediate text change behaviour.
bool getImmediateTextChange () const
 get immediate text change behaviour
CParamDisplay Methods



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 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 setRoundRectRadius (const CCoord &radius)
CCoord getRoundRectRadius () const
virtual void setFrameWidth (const CCoord &width)
CCoord getFrameWidth () const
virtual void setValueToStringProc (CParamDisplayValueToStringProc proc, void *userData=0)
virtual void setStyle (int32_t val)
int32_t getStyle () const
virtual void setPrecision (uint8_t precision)
uint8_t getPrecision () const
Value Methods



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 (void) const
virtual void setDefaultValue (float val)
virtual float getDefaultValue (void) const
virtual void bounceValue ()
virtual bool checkDefaultValue (CButtonState button)
virtual void valueChanged ()
 notifies listener and dependent objects
Editing Methods



virtual void setTag (int32_t val)
virtual int32_t getTag () const
virtual void beginEdit ()
virtual void endEdit ()
bool isEditing () const
virtual CControlListenergetListener () const
 get main listener
virtual void setListener (CControlListener *l)
 set main listener
Misc



virtual void setBackOffset (const CPoint &offset)
virtual const CPointgetBackOffset () const
virtual void copyBackOffset ()
virtual void setWheelInc (float val)
virtual float getWheelInc () const
Mouse Methods



virtual CMouseEventResult onMouseUp (CPoint &where, const CButtonState &buttons)
 called when a mouse up event occurs
virtual CMouseEventResult onMouseMoved (CPoint &where, const CButtonState &buttons)
 called when a mouse move event occurs
virtual CMouseEventResult onMouseCancel ()
 called when mouse tracking should be canceled
virtual CMouseEventResult onMouseEntered (CPoint &where, const CButtonState &buttons)
 called when the mouse enters this view
virtual CMouseEventResult onMouseExited (CPoint &where, const CButtonState &buttons)
 called when the mouse leaves this view
void setHitTestPath (CGraphicsPath *path)
virtual bool hitTest (const CPoint &where, const CButtonState &buttons=-1)
 check if where hits this view
virtual void setMouseEnabled (bool bEnable=true)
 turn on/off mouse usage for this view
virtual 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
virtual CRectgetMouseableArea (CRect &rect) const
 get the area in which the view reacts to the mouse
virtual const CRectgetMouseableArea () const
 read only access to the mouseable area
Touch Event Handling Methods



virtual void onTouchEvent (ITouchEvent &event)
virtual bool wantsMultiTouchEvents () const
Keyboard Methods



virtual int32_t onKeyUp (VstKeyCode &keyCode)
 called if a key up event occurs and this view has focus
View Size Methods



CCoord getHeight () const
 get the height of the view
CCoord getWidth () const
 get the width of the view
CRectgetViewSize (CRect &rect) const
 returns the current view size
const CRectgetViewSize () const
 read only access to view size
virtual CRect getVisibleViewSize () const
 returns the visible size of the view
virtual CPointframeToLocal (CPoint &point) const
 conversion from frame coordinates to local view coordinates
virtual CPointlocalToFrame (CPoint &point) const
 conversion from local view coordinates to frame coordinates
virtual void setAutosizeFlags (int32_t flags)
 set autosize flags
virtual int32_t getAutosizeFlags () const
 get autosize flags
Focus Methods



virtual bool wantsFocus () const
 check if view supports focus
virtual void setWantsFocus (bool state)
 set focus support on/off
Attribute Methods



bool getAttributeSize (const CViewAttributeID id, int32_t &outSize) const
 get the size of an attribute
bool getAttribute (const CViewAttributeID id, const int32_t inSize, void *outData, int32_t &outSize) const
 get an attribute
bool setAttribute (const CViewAttributeID id, const int32_t inSize, const void *inData)
 set an attribute
bool removeAttribute (const CViewAttributeID id)
 remove an attribute
Background Methods



virtual void setBackground (CBitmap *background)
 set the background image of this view
CBitmapgetBackground () const
 get the background image of this view
virtual void setDisabledBackground (CBitmap *background)
 set background image used when the mouse is not enabled
CBitmapgetDisabledBackground () const
 get background image used when the mouse is not enabled
CBitmapgetDrawBackground () const
Transparency Methods



virtual void setTransparency (bool val)
 set views transparent state
virtual 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
Attaching Methods



virtual bool removed (CView *parent)
 view is removed from parent view
virtual bool attached (CView *parent)
 view is attached to a parent view
bool isAttached () const
 is view attached to a parentView
Parent Methods



CViewgetParentView () const
 get parent view
CFramegetFrame () const
 get frame
virtual VSTGUIEditorInterfacegetEditor () const
 get editor
Animation Methods



void addAnimation (IdStringPtr name, Animation::IAnimationTarget *target, Animation::ITimingFunction *timingFunction, CBaseObject *notificationObject=0)
void removeAnimation (IdStringPtr name)
void removeAllAnimations ()
Message Methods



virtual CMessageResult notify (CBaseObject *sender, IdStringPtr message)
Reference Counting Methods



virtual void forget ()
 decrease refcount and delete object if refcount == 0
virtual void remember ()
 increase refcount
virtual int32_t getNbReference () const
 get refcount

Public Attributes

bool bWasReturnPressed

Static Public Attributes

static IdStringPtr kMsgTruncatedTextChanged = "CTextLabel::kMsgTruncatedTextChanged"
 message which is send to dependent objects when the truncated text changes
static int32_t kZoomModifier = kShift
 zoom modifier key, per default is the shift key
static int32_t kDefaultValueModifier = kControl
 default value modifier key, per default is the control key
static IdStringPtr kMessageTagWillChange = "kMessageTagWillChange"
static IdStringPtr kMessageTagDidChange = "kMessageTagDidChange"
static IdStringPtr kMessageValueChanged = "kMessageValueChanged"
static IdStringPtr kMessageBeginEdit = "kMessageBeginEdit"
static IdStringPtr kMessageEndEdit = "kMessageEndEdit"

Protected Types

enum  {
  kMouseEnabled = 1 << 0, kTransparencyEnabled = 1 << 1, kWantsFocus = 1 << 2, kIsAttached = 1 << 3,
  kVisible = 1 << 4, kDirty = 1 << 5, kWantsIdle = 1 << 6, kLastCViewFlag = 6
}
typedef std::set< IdStringPtrDeferedChangesSet
typedef std::list< CBaseObject * > DependentList

Protected Member Functions

 ~CTextEdit ()
void updateText (IPlatformTextEdit *pte)
CColor platformGetBackColor () const
CColor platformGetFontColor () const
CFontRef platformGetFont () const
CHoriTxtAlign platformGetHoriTxtAlign () const
UTF8StringPtr platformGetText () const
CRect platformGetSize () const
CRect platformGetVisibleSize () const
CPoint platformGetTextInset () const
void platformLooseFocus (bool returnPressed)
bool platformOnKeyDown (const VstKeyCode &key)
void platformTextDidChange ()
void freeText ()
void calculateTruncatedText ()
bool onWheel (const CPoint &where, const float &distance, const CButtonState &buttons)
 called if a mouse wheel event is happening over this view
bool onWheel (const CPoint &where, const CMouseWheelAxis &axis, const float &distance, const CButtonState &buttons)
 called if a mouse wheel event is happening over this view
virtual void drawBack (CDrawContext *pContext, CBitmap *newBack=0)
virtual void drawText (CDrawContext *pContext, UTF8StringPtr string)
virtual void drawText (CDrawContext *pContext, UTF8StringPtr string, const CRect &size)
CGraphicsPathgetHitTestPath () const

Static Protected Member Functions

static int32_t mapVstKeyModifier (int32_t vstModifier)
static void rememberObject (CBaseObject *obj)
static void forgetObject (CBaseObject *obj)

Protected Attributes

IPlatformTextEdit * platformControl
CTextEditStringToValueProc textToValue
void * textToValueUserData
bool immediateTextChange
TextTruncateMode textTruncateMode
UTF8StringBuffer text
std::string truncatedText
CParamDisplayValueToStringProc valueToString
void * valueToStringUserData
CHoriTxtAlign horiTxtAlign
int32_t style
uint8_t valuePrecision
CFontRef fontID
CColor fontColor
CColor backColor
CColor frameColor
CColor shadowColor
CPoint textInset
CCoord roundRectRadius
CCoord frameWidth
bool bAntialias
CControlListenerlistener
int32_t tag
float oldValue
float defaultValue
float value
float vmin
float vmax
float wheelInc
int32_t editing
CPoint backOffset
CRect size
CRect mouseableArea
CFramepParentFrame
CViewpParentView
int32_t viewFlags
int32_t autosizeFlags
float alphaValue
int32_t deferChangeCount
DeferedChangesSet deferedChanges
DependentList dependents

CTextLabel Methods



virtual UTF8StringPtr getText () const
 read only access to text
virtual void setTextTruncateMode (TextTruncateMode mode)
 set text truncate mode
TextTruncateMode getTextTruncateMode () const
 get text truncate mode
UTF8StringPtr getTruncatedText () const
 get the truncated text
enum  TextTruncateMode { kTruncateNone = 0, kTruncateHead, kTruncateTail }

Draw and Update Methods



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
static bool kDirtyCallAlwaysOnMainThread = false
 if this is true, setting a view dirty will call invalid() instead of checking it in idle. Default value is false.

Drag & Drop Methods



virtual DragResult doDrag (IDataPackage *source, const CPoint &offset=CPoint(0, 0), CBitmap *dragBitmap=0)
 start a drag operation. See CDropSource to create the source data package
virtual bool onDrop (IDataPackage *drag, const CPoint &where)
 called if a drag is dropped onto this view
virtual void onDragEnter (IDataPackage *drag, const CPoint &where)
 called if a drag is entering this view
virtual void onDragLeave (IDataPackage *drag, const CPoint &where)
 called if a drag is leaving this view
virtual void onDragMove (IDataPackage *drag, const CPoint &where)
 called if a drag is moved inside this view
enum  DragResult { kDragRefused = 0, kDragMoved, kDragCopied, kDragError = -1 }

Idle Methods

Should be used when a view needs to do a task periodically. The onIdle() method will be called only if the view is attached.



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
static int32_t idleRate
 global idle rate in Hz, defaults to 30 Hz

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

typedef std::set<IdStringPtr> DeferedChangesSet [protected, inherited]
typedef std::list<CBaseObject*> DependentList [protected, inherited]

Member Enumeration Documentation

anonymous enum [protected, inherited]
Enumerator:
kMouseEnabled 
kTransparencyEnabled 
kWantsFocus 
kIsAttached 
kVisible 
kDirty 
kWantsIdle 
kLastCViewFlag 
enum DragResult [inherited]
Enumerator:
kDragRefused 
kDragMoved 
kDragCopied 
kDragError 
enum TextTruncateMode [inherited]
Enumerator:
kTruncateNone 

no characters will be removed

kTruncateHead 

characters will be removed from the beginning of the text

kTruncateTail 

characters will be removed from the end of the text


Constructor & Destructor Documentation

CTextEdit ( const CRect size,
CControlListener listener,
int32_t  tag,
UTF8StringPtr  txt = 0,
CBitmap background = 0,
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 ( const CTextEdit textEdit  ) 
~CTextEdit (  )  [protected]

Member Function Documentation

void addAnimation ( IdStringPtr  name,
Animation::IAnimationTarget target,
Animation::ITimingFunction timingFunction,
CBaseObject notificationObject = 0 
) [inherited]
void addDependency ( CBaseObject obj  )  [inline, virtual, inherited]

add a dependent object

bool attached ( CView parent  )  [virtual, inherited]

view is attached to a parent view

Parameters:
parent parent view
Returns:
true if view successfully attached to parent
void beginEdit (  )  [virtual, inherited]
void bounceValue (  )  [virtual, inherited]
void calculateTruncatedText (  )  [protected, inherited]
void changed ( IdStringPtr  message  )  [inline, virtual, inherited]

notify dependent objects of change with message.

bool checkDefaultValue ( CButtonState  button  )  [virtual, inherited]
virtual bool checkUpdate ( const CRect updateRect  )  const [inline, virtual, inherited]
void copyBackOffset (  )  [virtual, inherited]
void deferChanges ( bool  state  )  [inline, virtual, inherited]

defer changes until later. can be nested. If you use this, you must make sure that all message pointers are valid the whole time.

CView::DragResult doDrag ( IDataPackage source,
const CPoint offset = CPoint (0, 0),
CBitmap dragBitmap = 0 
) [virtual, inherited]

start a drag operation. See CDropSource to create the source data package

a drag can only be started from within onMouseDown

Parameters:
source source drop
offset bitmap offset
dragBitmap bitmap to drag
Returns:
0 on failure, negative if source was moved and positive if source was copied

Reimplemented in CFrame.

void draw ( CDrawContext pContext  )  [virtual]

called if the view should draw itself

Parameters:
pContext draw context in which to draw

Reimplemented from CTextLabel.

void drawBack ( CDrawContext pContext,
CBitmap newBack = 0 
) [protected, virtual, inherited]
bool drawFocusOnTop (  )  [virtual, inherited]

draw focus before view will be drawn or afterwards

Implements IFocusDrawing.

Reimplemented in CKnob.

virtual void drawRect ( CDrawContext pContext,
const CRect updateRect 
) [inline, virtual, inherited]

called if the view should draw itself

Reimplemented in CFrame, CLayeredViewContainer, CShadowViewContainer, and CViewContainer.

void drawStyleChanged (  )  [virtual, inherited]

Reimplemented from CParamDisplay.

void drawText ( CDrawContext pContext,
UTF8StringPtr  string,
const CRect size 
) [protected, virtual, inherited]
void drawText ( CDrawContext pContext,
UTF8StringPtr  string 
) [protected, virtual, inherited]
void endEdit (  )  [virtual, inherited]
virtual void forget (  )  [inline, virtual, inherited]

decrease refcount and delete object if refcount == 0

static void forgetObject ( CBaseObject obj  )  [inline, static, protected, inherited]
CPoint & frameToLocal ( CPoint point  )  const [virtual, inherited]

conversion from frame coordinates to local view coordinates

Parameters:
point location
Returns:
converted point

Reimplemented in CViewContainer.

void freeText (  )  [protected, inherited]
float getAlphaValue (  )  const [inline, inherited]

get alpha value

bool getAntialias (  )  const [inline, inherited]
bool getAttribute ( const CViewAttributeID  aId,
const int32_t  inSize,
void *  outData,
int32_t &  outSize 
) const [inherited]

get an attribute

Parameters:
aId the ID of the Attribute
inSize the size of the outData pointer
outData a pointer where to copy the attribute data
outSize the size in bytes which was copied into outData
Returns:
true if attribute exists and outData was big enough. outSize and outData is valid then.
bool getAttributeSize ( const CViewAttributeID  aId,
int32_t &  outSize 
) const [inherited]

get the size of an attribute

Parameters:
aId the ID of the Attribute
outSize on return the size of the attribute
Returns:
true if attribute exists. outSize is valid then.
virtual int32_t getAutosizeFlags (  )  const [inline, virtual, inherited]

get autosize flags

CColor getBackColor (  )  const [inline, inherited]
CBitmap* getBackground (  )  const [inline, inherited]

get the background image of this view

virtual const CPoint& getBackOffset (  )  const [inline, virtual, inherited]
virtual float getDefaultValue ( void   )  const [inline, virtual, inherited]
CBitmap* getDisabledBackground (  )  const [inline, inherited]

get background image used when the mouse is not enabled

CBitmap* getDrawBackground (  )  const [inline, inherited]
VSTGUIEditorInterface * getEditor (  )  const [virtual, inherited]

get editor

Reimplemented in CFrame.

bool getFocusPath ( CGraphicsPath outPath  )  [virtual, inherited]

the graphics path will be drawn filled with the evenodd method and the color set in CFrame::setFocusColor()

Reimplemented from CControl.

const CFontRef getFont (  )  const [inline, inherited]
CColor getFontColor (  )  const [inline, inherited]
CFrame* getFrame (  )  const [inline, inherited]

get frame

CColor getFrameColor (  )  const [inline, inherited]
CCoord getFrameWidth (  )  const [inline, inherited]
CCoord getHeight (  )  const [inline, inherited]

get the height of the view

CGraphicsPath* getHitTestPath (  )  const [inline, protected, inherited]
CHoriTxtAlign getHoriAlign (  )  const [inline, inherited]
bool getImmediateTextChange (  )  const [inline]

get immediate text change behaviour

virtual CControlListener* getListener (  )  const [inline, virtual, inherited]

get main listener

virtual float getMax (  )  const [inline, virtual, inherited]

Reimplemented in COptionMenu.

virtual float getMin (  )  const [inline, virtual, inherited]

Reimplemented in COptionMenu.

virtual const CRect& getMouseableArea (  )  const [inline, virtual, inherited]

read only access to the mouseable area

virtual CRect& getMouseableArea ( CRect rect  )  const [inline, virtual, inherited]

get the area in which the view reacts to the mouse

virtual bool getMouseEnabled (  )  const [inline, virtual, inherited]

get the state of wheather this view uses the mouse or not

virtual int32_t getNbReference (  )  const [inline, virtual, inherited]

get refcount

virtual float getOldValue ( void   )  const [inline, virtual, inherited]
CView* getParentView (  )  const [inline, inherited]

get parent view

IPlatformTextEdit* getPlatformTextEdit (  )  const [inline]
uint8_t getPrecision (  )  const [inline, inherited]
float getRange (  )  const [inline, inherited]
CCoord getRoundRectRadius (  )  const [inline, inherited]
CColor getShadowColor (  )  const [inline, inherited]
int32_t getStyle (  )  const [inline, inherited]
virtual int32_t getTag (  )  const [inline, virtual, inherited]
UTF8StringPtr getText (  )  const [virtual, inherited]

read only access to text

CPoint getTextInset (  )  const [inline, inherited]
TextTruncateMode getTextTruncateMode (  )  const [inline, inherited]

get text truncate mode

virtual bool getTransparency (  )  const [inline, virtual, inherited]

get views transparent state

UTF8StringPtr getTruncatedText (  )  const [inline, inherited]

get the truncated text

virtual float getValue (  )  const [inline, virtual, inherited]
float getValueNormalized (  )  const [virtual, inherited]
const CRect& getViewSize (  )  const [inline, inherited]

read only access to view size

CRect& getViewSize ( CRect rect  )  const [inline, inherited]

returns the current view size

CRect getVisibleViewSize (  )  const [virtual, inherited]

returns the visible size of the view

Returns:
visible size of view
virtual float getWheelInc (  )  const [inline, virtual, inherited]
CCoord getWidth (  )  const [inline, inherited]

get the width of the view

bool hitTest ( const CPoint where,
const CButtonState buttons = -1 
) [virtual, inherited]

check if where hits this view

Parameters:
where location
buttons button and modifier state
Returns:
true if point hits this view

Reimplemented in CSplashScreen, and CViewContainer.

virtual void invalid (  )  [inline, virtual, inherited]

mark whole view as invalid

Reimplemented in CFrame, and CViewContainer.

void invalidRect ( const CRect rect  )  [virtual, inherited]

mark rect as invalid

Parameters:
rect rect to invalidate

Reimplemented in CFrame, CLayeredViewContainer, COpenGLView, and CViewContainer.

bool isAttached (  )  const [inline, inherited]

is view attached to a parentView

bool isDirty (  )  const [virtual, inherited]

check if view is dirty

Reimplemented from CView.

bool isEditing (  )  const [inline, inherited]
bool isVisible (  )  const [inline, inherited]

get visibility state

CPoint & localToFrame ( CPoint point  )  const [virtual, inherited]

conversion from local view coordinates to frame coordinates

Parameters:
point location
Returns:
converted point

Reimplemented in CViewContainer.

void looseFocus (  )  [virtual]

called if view should loose focus

Reimplemented from CView.

int32_t mapVstKeyModifier ( int32_t  vstModifier  )  [static, protected, inherited]
virtual CMessageResult notify ( CBaseObject sender,
IdStringPtr  message 
) [inline, virtual, inherited]
CMessageResult notify ( CBaseObject sender,
IdStringPtr  message 
) [inherited]
Parameters:
sender message sender
message message text
Returns:
message handled or not. See CMessageResult

Reimplemented in CDataBrowser, CAnimationSplashScreen, CRockerSwitch, CRowColumnView, CScrollView, CScrollbar, CShadowViewContainer, and CViewContainer.

virtual void onDragEnter ( IDataPackage drag,
const CPoint where 
) [inline, virtual, inherited]

called if a drag is entering this view

Reimplemented in CViewContainer.

virtual void onDragLeave ( IDataPackage drag,
const CPoint where 
) [inline, virtual, inherited]

called if a drag is leaving this view

Reimplemented in CViewContainer.

virtual void onDragMove ( IDataPackage drag,
const CPoint where 
) [inline, virtual, inherited]

called if a drag is moved inside this view

Reimplemented in CViewContainer.

virtual bool onDrop ( IDataPackage drag,
const CPoint where 
) [inline, virtual, inherited]

called if a drag is dropped onto this view

Reimplemented in CViewContainer.

virtual void onIdle (  )  [inline, virtual, inherited]

called on idle when view wants idle

Reimplemented in CVuMeter.

int32_t onKeyDown ( VstKeyCode keyCode  )  [virtual]

called if a key down event occurs and this view has focus

Parameters:
keyCode key code of pressed key
Returns:
-1 if not handled and 1 if handled

Reimplemented from CView.

int32_t onKeyUp ( VstKeyCode keyCode  )  [virtual, inherited]

called if a key up event occurs and this view has focus

Parameters:
keyCode key code of pressed key
Returns:
-1 if not handled and 1 if handled

Reimplemented in CFrame, CKickButton, CTextButton, and CRockerSwitch.

CMouseEventResult onMouseCancel (  )  [virtual, inherited]

called when mouse tracking should be canceled

Reimplemented in COnOffButton, CCheckBox, CKickButton, CTextButton, CSlider, and CViewContainer.

CMouseEventResult onMouseDown ( CPoint where,
const CButtonState buttons 
) [virtual]

called when a mouse down event occurs

Parameters:
where mouse location of mouse down
buttons button and modifier state
Returns:
event result. see CMouseEventResult

Reimplemented from CView.

virtual CMouseEventResult onMouseEntered ( CPoint where,
const CButtonState buttons 
) [inline, virtual, inherited]

called when the mouse enters this view

Reimplemented in CScrollbar.

virtual CMouseEventResult onMouseExited ( CPoint where,
const CButtonState buttons 
) [inline, virtual, inherited]

called when the mouse leaves this view

Reimplemented in CFrame, and CScrollbar.

CMouseEventResult onMouseMoved ( CPoint where,
const CButtonState buttons 
) [virtual, inherited]

called when a mouse move event occurs

Parameters:
where mouse location of mouse move
buttons button and modifier state
Returns:
event result. see CMouseEventResult

Reimplemented in CFrame, COnOffButton, CCheckBox, CKickButton, CTextButton, CKnob, CMovieButton, CSlider, CVerticalSwitch, CHorizontalSwitch, CRockerSwitch, CXYPad, CScrollbar, and CViewContainer.

CMouseEventResult onMouseUp ( CPoint where,
const CButtonState buttons 
) [virtual, inherited]

called when a mouse up event occurs

Parameters:
where mouse location of mouse up
buttons button and modifier state
Returns:
event result. see CMouseEventResult

Reimplemented in CFrame, COnOffButton, CCheckBox, CKickButton, CTextButton, CKnob, CMovieButton, CSlider, CVerticalSwitch, CHorizontalSwitch, CRockerSwitch, CXYPad, CScrollbar, and CViewContainer.

virtual void onTouchEvent ( ITouchEvent event  )  [inline, virtual, inherited]

Reimplemented in CViewContainer.

bool onWheel ( const CPoint where,
const CMouseWheelAxis axis,
const float &  distance,
const CButtonState buttons 
) [inline, protected, virtual, inherited]

called if a mouse wheel event is happening over this view

Parameters:
where location
axis mouse wheel axis
distance wheel distance
buttons button and modifier state
Returns:
true if handled

Reimplemented from CView.

bool onWheel ( const CPoint where,
const float &  distance,
const CButtonState buttons 
) [inline, protected, virtual, inherited]

called if a mouse wheel event is happening over this view

Parameters:
where location
distance wheel distance
buttons button and modifier state
Returns:
true if handled

Reimplemented from CView.

void parentSizeChanged (  )  [virtual]

notification that one of the views parent has changed its size

Reimplemented from CView.

CColor platformGetBackColor (  )  const [inline, protected]
CFontRef platformGetFont (  )  const [inline, protected]
CColor platformGetFontColor (  )  const [inline, protected]
CHoriTxtAlign platformGetHoriTxtAlign (  )  const [inline, protected]
CRect platformGetSize (  )  const [protected]
UTF8StringPtr platformGetText (  )  const [inline, protected]
CPoint platformGetTextInset (  )  const [inline, protected]
CRect platformGetVisibleSize (  )  const [protected]
void platformLooseFocus ( bool  returnPressed  )  [protected]
bool platformOnKeyDown ( const VstKeyCode key  )  [protected]
void platformTextDidChange (  )  [protected]
virtual void remember (  )  [inline, virtual, inherited]

increase refcount

static void rememberObject ( CBaseObject obj  )  [inline, static, protected, inherited]
void removeAllAnimations (  )  [inherited]
void removeAnimation ( IdStringPtr  name  )  [inherited]
bool removeAttribute ( const CViewAttributeID  id  )  [inherited]

remove an attribute

bool removed ( CView parent  )  [virtual, inherited]

view is removed from parent view

Parameters:
parent parent view
Returns:
true if view successfully removed from parent
void removeDependency ( CBaseObject obj  )  [inline, virtual, inherited]

remove a dependent object.

void setAlphaValue ( float  alpha  )  [virtual, inherited]

set alpha value which will be applied when drawing this view

virtual void setAntialias ( bool  state  )  [inline, virtual, inherited]
bool setAttribute ( const CViewAttributeID  aId,
const int32_t  inSize,
const void *  inData 
) [inherited]

set an attribute

copies data into the attribute. If it does not exist, creates a new attribute.

Parameters:
aId the ID of the Attribute
inSize the size of the outData pointer
inData a pointer to the data
Returns:
true if attribute was set
virtual void setAutosizeFlags ( int32_t  flags  )  [inline, virtual, inherited]

set autosize flags

Reimplemented in CScrollView, and CTabView.

void setBackColor ( CColor  color  )  [virtual, inherited]
void setBackground ( CBitmap background  )  [virtual, inherited]

set the background image of this view

Parameters:
background new background bitmap

Reimplemented in CCheckBox, and CAnimKnob.

void setBackOffset ( const CPoint offset  )  [virtual, inherited]
virtual void setDefaultValue ( float  val  )  [inline, virtual, inherited]
void setDirty ( bool  val = true  )  [virtual, inherited]

set the view to dirty so that it is redrawn in the next idle. Thread Safe !

Reimplemented from CView.

Reimplemented in CVuMeter.

void setDisabledBackground ( CBitmap background  )  [virtual, inherited]

set background image used when the mouse is not enabled

Parameters:
background new disabled background bitmap
void setFont ( CFontRef  fontID  )  [virtual, inherited]
void setFontColor ( CColor  color  )  [virtual, inherited]
void setFrameColor ( CColor  color  )  [virtual, inherited]
void setFrameWidth ( const CCoord width  )  [virtual, inherited]
void setHitTestPath ( CGraphicsPath path  )  [inherited]
Parameters:
path the path to use for hit testing. The path will be translated by this views origin, so that the path must not be set again, if the view is moved. Otherwise when the size of the view changes, the path must also be set again.
void setHoriAlign ( CHoriTxtAlign  hAlign  )  [virtual, inherited]
void setImmediateTextChange ( bool  state  )  [virtual]

enable/disable immediate text change behaviour.

virtual void setListener ( CControlListener l  )  [inline, virtual, inherited]

set main listener

virtual void setMax ( float  val  )  [inline, virtual, inherited]

Reimplemented in CKnob, COptionMenu, and CXYPad.

virtual void setMin ( float  val  )  [inline, virtual, inherited]

Reimplemented in CKnob, COptionMenu, and CXYPad.

virtual void setMouseableArea ( const CRect rect  )  [inline, virtual, inherited]

set the area in which the view reacts to the mouse

void setMouseEnabled ( bool  bEnable = true  )  [virtual, inherited]

turn on/off mouse usage for this view

virtual void setOldValue ( float  val  )  [inline, virtual, inherited]
void setPrecision ( uint8_t  precision  )  [virtual, inherited]
void setRoundRectRadius ( const CCoord radius  )  [virtual, inherited]
void setShadowColor ( CColor  color  )  [virtual, inherited]
void setStringToValueProc ( CTextEditStringToValueProc  proc,
void *  userData = 0 
) [virtual]
void setStyle ( int32_t  val  )  [virtual, inherited]
void setTag ( int32_t  val  )  [virtual, inherited]
void setText ( UTF8StringPtr  txt  )  [virtual]

set text

Reimplemented from CTextLabel.

void setTextInset ( const CPoint p  )  [virtual, inherited]
void setTextTruncateMode ( TextTruncateMode  mode  )  [virtual, inherited]

set text truncate mode

void setTransparency ( bool  val  )  [virtual, inherited]

set views transparent state

Reimplemented in CScrollView.

void setValue ( float  val  )  [virtual]

Reimplemented from CControl.

void setValueNormalized ( float  val  )  [virtual, inherited]
void setValueToStringProc ( CParamDisplayValueToStringProc  proc,
void *  userData = 0 
) [virtual, inherited]
void setViewSize ( const CRect newSize,
bool  invalid = true 
) [virtual]

set views size

Parameters:
newSize rect of new size of view
invalid if true set view dirty

Reimplemented from CTextLabel.

void setVisible ( bool  state  )  [virtual, inherited]

set visibility state

Reimplemented in COpenGLView.

void setWantsFocus ( bool  state  )  [virtual, inherited]

set focus support on/off

Reimplemented in CDataBrowser.

void setWantsIdle ( bool  state  )  [inherited]

enable/disable onIdle() callback

virtual void setWheelInc ( float  val  )  [inline, virtual, inherited]
bool sizeToFit (  )  [virtual, inherited]

resize view to optimal size

Reimplemented from CView.

void takeFocus (  )  [virtual]

called if view should take focus

Reimplemented from CView.

void updateText ( IPlatformTextEdit *  pte  )  [protected]
void valueChanged (  )  [virtual, inherited]

notifies listener and dependent objects

virtual bool wantsFocus (  )  const [inline, virtual, inherited]

check if view supports focus

bool wantsIdle (  )  const [inline, inherited]

returns if the view wants idle callback or not

virtual bool wantsMultiTouchEvents (  )  const [inline, virtual, inherited]

Reimplemented in CViewContainer.


Member Data Documentation

float alphaValue [protected, inherited]
int32_t autosizeFlags [protected, inherited]
CColor backColor [protected, inherited]
CPoint backOffset [protected, inherited]
bool bAntialias [protected, inherited]
float defaultValue [protected, inherited]
int32_t deferChangeCount [protected, inherited]
DeferedChangesSet deferedChanges [protected, inherited]
DependentList dependents [protected, inherited]
int32_t editing [protected, inherited]
CColor fontColor [protected, inherited]
CFontRef fontID [protected, inherited]
CColor frameColor [protected, inherited]
CCoord frameWidth [protected, inherited]
CHoriTxtAlign horiTxtAlign [protected, inherited]
int32_t idleRate [static, inherited]

global idle rate in Hz, defaults to 30 Hz

bool immediateTextChange [protected]
int32_t kDefaultValueModifier = kControl [static, inherited]

default value modifier key, per default is the control key

bool kDirtyCallAlwaysOnMainThread = false [static, inherited]

if this is true, setting a view dirty will call invalid() instead of checking it in idle. Default value is false.

IdStringPtr kMessageBeginEdit = "kMessageBeginEdit" [static, inherited]
IdStringPtr kMessageEndEdit = "kMessageEndEdit" [static, inherited]
IdStringPtr kMessageTagDidChange = "kMessageTagDidChange" [static, inherited]
IdStringPtr kMessageTagWillChange = "kMessageTagWillChange" [static, inherited]
IdStringPtr kMessageValueChanged = "kMessageValueChanged" [static, inherited]
IdStringPtr kMsgTruncatedTextChanged = "CTextLabel::kMsgTruncatedTextChanged" [static, inherited]

message which is send to dependent objects when the truncated text changes

int32_t kZoomModifier = kShift [static, inherited]

zoom modifier key, per default is the shift key

CControlListener* listener [protected, inherited]
CRect mouseableArea [protected, inherited]
float oldValue [protected, inherited]
IPlatformTextEdit* platformControl [protected]
CFrame* pParentFrame [protected, inherited]
CView* pParentView [protected, inherited]
CCoord roundRectRadius [protected, inherited]
CColor shadowColor [protected, inherited]
CRect size [protected, inherited]
int32_t style [protected, inherited]
int32_t tag [protected, inherited]
UTF8StringBuffer text [protected, inherited]
CPoint textInset [protected, inherited]
void* textToValueUserData [protected]
TextTruncateMode textTruncateMode [protected, inherited]
std::string truncatedText [protected, inherited]
float value [protected, inherited]
uint8_t valuePrecision [protected, inherited]
void* valueToStringUserData [protected, inherited]
int32_t viewFlags [protected, inherited]
float vmax [protected, inherited]
float vmin [protected, inherited]
float wheelInc [protected, inherited]

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

Generated on Fri Nov 22 11:09:50 2013 for VSTGUI by  doxygen 1.6.1