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

Base Class of all view objects. More...

+ Inheritance diagram for CView:

Classes

struct  Impl
 

Public Types

enum  MouseListenerCall { MouseDown, MouseMoved, MouseUp, MouseCancel }
 

Public Member Functions

 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
 
Mouse Methods
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 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 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...
 
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...
 
Drag & Drop Methods
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...
 
Keyboard Methods
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...
 
View Size Methods
CCoord getHeight () const
 get the height of the view More...
 
CCoord getWidth () const
 get the width of the view More...
 
virtual void setViewSize (const CRect &rect, bool invalid=true)
 set views size 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 bool sizeToFit ()
 resize view to optimal size More...
 
Focus Methods
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...
 
Attribute Methods
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...
 
Background Methods
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...
 
Transparency Methods
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...
 
Attaching Methods
virtual bool removed (CView *parent)
 view is removed from parent view More...
 
virtual bool attached (CView *parent)
 view is attached to a parent view More...
 
bool isAttached () const
 is view attached to a parentView More...
 
Parent Methods
CViewgetParentView () const
 get parent view More...
 
CFramegetFrame () const
 get frame More...
 
virtual VSTGUIEditorInterfacegetEditor () const
 get editor More...
 
Animation Methods
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 ()
 
View Listener Methods
void registerViewListener (IViewListener *listener)
 
void unregisterViewListener (IViewListener *listener)
 
void registerViewMouseListener (IViewMouseListener *listener)
 
void unregisterViewMouseListener (IViewMouseListener *listener)
 
Coordinate translation Methods
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...
 
- 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...
 

Protected Types

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

 ~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)
 

Draw and Update Methods

static bool kDirtyCallAlwaysOnMainThread = false
 if this is true, setting a view dirty will call invalid() instead of checking it in idle. More...
 
virtual void draw (CDrawContext *pContext)
 called if the view should draw itself More...
 
virtual void drawRect (CDrawContext *pContext, const CRect &updateRect)
 called if the view should draw itself More...
 
virtual bool checkUpdate (const CRect &updateRect) const
 
virtual bool isDirty () const
 check if view is dirty More...
 
virtual void setDirty (bool val=true)
 set the view to dirty so that it is redrawn in the next idle. More...
 
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...
 

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.

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

Detailed Description

Base Class of all view objects.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
protected
Enumerator
kMouseEnabled 
kTransparencyEnabled 
kWantsFocus 
kIsAttached 
kVisible 
kDirty 
kWantsIdle 
kIsSubview 
kHasAlpha 
kHasBackground 
kHasDisabledBackground 
kHasMouseableArea 
kLastCViewFlag 

◆ MouseListenerCall

enum MouseListenerCall
strong
Enumerator
MouseDown 
MouseMoved 
MouseUp 
MouseCancel 

Constructor & Destructor Documentation

◆ CView() [1/2]

CView ( const CRect size)
explicit

◆ CView() [2/2]

CView ( const CView view)

◆ ~CView()

~CView ( )
overrideprotecteddefaultnoexcept

Member Function Documentation

◆ addAnimation() [1/2]

void addAnimation ( IdStringPtr  name,
Animation::IAnimationTarget target,
Animation::ITimingFunction timingFunction,
CBaseObject notificationObject 
)

◆ addAnimation() [2/2]

void addAnimation ( IdStringPtr  name,
Animation::IAnimationTarget target,
Animation::ITimingFunction timingFunction,
const Animation::DoneFunction doneFunc = nullptr 
)

◆ asViewContainer() [1/2]

virtual CViewContainer* asViewContainer ( )
inlinevirtual

Reimplemented in CViewContainer.

◆ asViewContainer() [2/2]

virtual const CViewContainer* asViewContainer ( ) const
inlinevirtual

Reimplemented in CViewContainer.

◆ attached()

bool attached ( CView parent)
virtual

view is attached to a parent view

Parameters
parentparent view
Returns
true if view successfully attached to parent

Reimplemented in CFrame, CViewContainer, CSegmentButton, CDataBrowser, CSplitView, CFontChooser, UIViewSwitchContainer, CListControl, COpenGLView, CShadowViewContainer, CLayeredViewContainer, and CAutoLayoutContainerView.

◆ beforeDelete()

void beforeDelete ( )
overridevirtual

Reimplemented from ReferenceCounted< T >.

Reimplemented in CViewContainer.

◆ callMouseListener()

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

◆ callMouseListenerEnteredExited()

void callMouseListenerEnteredExited ( bool  mouseEntered)

◆ checkUpdate()

virtual bool checkUpdate ( const CRect updateRect) const
inlinevirtual

◆ doDrag() [1/2]

bool doDrag ( const DragDescription dragDescription,
const SharedPointer< IDragCallback > &  callback = {} 
)

start a drag operation

A drag can only be started from within onMouseDown or onMouseMove.

This method may return immediately before the drop occurs, if you want to be notified about the result you have to provide a callback object.

Parameters
dragDescriptiondrag description
callbackcallback
Returns
true if the drag was started, otherwise false

◆ doDrag() [2/2]

DragResult doDrag ( IDataPackage source,
const CPoint offset = CPoint (0, 0),
CBitmap dragBitmap = nullptr 
)

a drag can only be started from within onMouseDown

Deprecated:
start a drag operation.

See CDropSource to create the source data package

Parameters
sourcesource drop
offsetbitmap offset
dragBitmapbitmap to drag
Returns
see DragResult

◆ draw()

◆ drawRect()

virtual void drawRect ( CDrawContext pContext,
const CRect updateRect 
)
inlinevirtual

called if the view should draw itself

Reimplemented in CFrame, CViewContainer, CSegmentButton, CMultiLineTextLabel, CListControl, CShadowViewContainer, and CLayeredViewContainer.

◆ frameToLocal()

CPoint & frameToLocal ( CPoint point) const
virtual

conversion from frame coordinates to local view coordinates

Parameters
pointlocation
Returns
converted point

Reimplemented in CFrame, and CViewContainer.

◆ getAlphaValue()

float getAlphaValue ( ) const

get alpha value

◆ getAttribute() [1/2]

bool getAttribute ( const CViewAttributeID  aId,
const uint32_t  inSize,
void *  outData,
uint32_t &  outSize 
) const

get an attribute

Parameters
aIdthe ID of the Attribute
inSizethe size of the outData pointer
outDataa pointer where to copy the attribute data
outSizethe size in bytes which was copied into outData
Returns
true if attribute exists and outData was big enough. outSize and outData is valid then.

◆ getAttribute() [2/2]

bool getAttribute ( const CViewAttributeID  id,
T &  data 
) const
inline

get an attribute

◆ getAttributeSize()

bool getAttributeSize ( const CViewAttributeID  aId,
uint32_t &  outSize 
) const

get the size of an attribute

Parameters
aIdthe ID of the Attribute
outSizeon return the size of the attribute
Returns
true if attribute exists. outSize is valid then.

◆ getAutosizeFlags()

int32_t getAutosizeFlags ( ) const

get autosize flags

◆ getBackground()

CBitmap * getBackground ( ) const

get the background image of this view

◆ getDisabledBackground()

CBitmap * getDisabledBackground ( ) const

get background image used when the mouse is not enabled

◆ getDrawBackground()

CBitmap * getDrawBackground ( ) const

get the bitmap which is drawn depending on the enabled state.

◆ getDropTarget()

SharedPointer< IDropTarget > getDropTarget ( )
virtual

get the drag target for drag and drop handling

Reimplemented in CViewContainer.

◆ getEditor()

VSTGUIEditorInterface * getEditor ( ) const
virtual

get editor

Reimplemented in CFrame.

◆ getFrame()

CFrame * getFrame ( ) const

get frame

◆ getGlobalTransform()

CGraphicsTransform getGlobalTransform ( bool  ignoreFrame = false) const

get the active global transform for this view

◆ getHeight()

CCoord getHeight ( ) const
inline

get the height of the view

◆ getHitTestPath()

CGraphicsPath * getHitTestPath ( ) const
protected

◆ getMouseableArea() [1/2]

CRect & getMouseableArea ( CRect rect) const

get the area in which the view reacts to the mouse

◆ getMouseableArea() [2/2]

CRect getMouseableArea ( ) const

get the area in which the view reacts to the mouse

◆ getMouseEnabled()

bool getMouseEnabled ( ) const
inline

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

◆ getParentView()

CView * getParentView ( ) const

get parent view

◆ getTransparency()

bool getTransparency ( ) const
inline

get views transparent state

◆ getViewSize()

const CRect & getViewSize ( ) const

read only access to view size

◆ getVisibleViewSize()

CRect getVisibleViewSize ( ) const
virtual

returns the visible size of the view

Returns
visible size of view

◆ getWidth()

CCoord getWidth ( ) const
inline

get the width of the view

◆ hasViewFlag()

bool hasViewFlag ( int32_t  bit) const
protected

◆ hitTest()

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

check if where hits this view

Parameters
wherelocation
buttonsbutton and modifier state
Returns
true if point hits this view

Reimplemented in CViewContainer, and CSplashScreen.

◆ invalid()

virtual void invalid ( )
inlinevirtual

mark whole view as invalid

Reimplemented in CFrame, CViewContainer, and CLayeredViewContainer.

◆ invalidRect()

void invalidRect ( const CRect rect)
virtual

mark rect as invalid

Parameters
rectrect to invalidate

Reimplemented in CFrame, CViewContainer, COpenGLView, and CLayeredViewContainer.

◆ isAttached()

bool isAttached ( ) const
inline

is view attached to a parentView

◆ isDirty()

virtual bool isDirty ( ) const
inlinevirtual

check if view is dirty

Reimplemented in CViewContainer, and CControl.

◆ isSubview()

bool isSubview ( ) const
inline

◆ isVisible()

bool isVisible ( ) const
inline

get visibility state

◆ localToFrame()

CPoint & localToFrame ( CPoint point) const
virtual

conversion from local view coordinates to frame coordinates

Parameters
pointlocation
Returns
converted point

Reimplemented in CFrame, and CViewContainer.

◆ looseFocus()

void looseFocus ( )
virtual

called if view should loose focus

Reimplemented in COptionMenu, CViewContainer, and CTextEdit.

◆ newCopy()

CBaseObject* newCopy ( ) const
inlineoverride

◆ notify()

CMessageResult notify ( CBaseObject sender,
IdStringPtr  message 
)
overridevirtual
Parameters
sendermessage sender
messagemessage text
Returns
message handled or not. See CMessageResult

Reimplemented from CBaseObject.

Reimplemented in CViewContainer.

◆ onIdle()

virtual void onIdle ( )
inlinevirtual

called on idle when view wants idle

Reimplemented in CVuMeter.

◆ onKeyDown()

int32_t onKeyDown ( VstKeyCode keyCode)
virtual

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

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

Reimplemented in COptionMenu, CTextButton, CFrame, CKickButton, CRockerSwitch, CSegmentButton, CDataBrowser, CCheckBox, CHorizontalSwitch, CVerticalSwitch, CTextEdit, CFontChooser, CSliderBase, CListControl, COnOffButton, CKnobBase, CXYPad, and CMovieButton.

◆ onKeyUp()

int32_t onKeyUp ( VstKeyCode keyCode)
virtual

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

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

Reimplemented in CTextButton, CFrame, CKickButton, and CRockerSwitch.

◆ onMouseCancel()

CMouseEventResult onMouseCancel ( )
virtual

called when mouse tracking should be canceled

Reimplemented in CTextButton, CKickButton, CRockerSwitch, CViewContainer, CCheckBox, CSliderBase, CScrollbar, CKnobBase, COnOffButton, CSwitchBase, CXYPad, and CMovieButton.

◆ onMouseDown()

CMouseEventResult onMouseDown ( CPoint where,
const CButtonState buttons 
)
virtual

called when a mouse down event occurs

Parameters
wheremouse location of mouse down
buttonsbutton and modifier state
Returns
event result. see CMouseEventResult

Reimplemented in COptionMenu, CTextButton, CFrame, CKickButton, CRockerSwitch, CViewContainer, CSegmentButton, CDataBrowser, CCheckBox, CAnimationSplashScreen, CTextEdit, CSliderBase, CScrollbar, CListControl, CKnobBase, CSplashScreen, COnOffButton, CSwitchBase, CXYPad, CSearchTextEdit, CMovieButton, and CAutoAnimation.

◆ onMouseEntered()

virtual CMouseEventResult onMouseEntered ( CPoint where,
const CButtonState buttons 
)
inlinevirtual

called when the mouse enters this view

Reimplemented in CScrollbar.

◆ onMouseExited()

virtual CMouseEventResult onMouseExited ( CPoint where,
const CButtonState buttons 
)
inlinevirtual

called when the mouse leaves this view

Reimplemented in CFrame, CScrollbar, and CListControl.

◆ onMouseMoved()

CMouseEventResult onMouseMoved ( CPoint where,
const CButtonState buttons 
)
virtual

called when a mouse move event occurs

Parameters
wheremouse location of mouse move
buttonsbutton and modifier state
Returns
event result. see CMouseEventResult

Reimplemented in CTextButton, CFrame, CKickButton, CRockerSwitch, CViewContainer, CCheckBox, CSliderBase, CScrollbar, CListControl, CKnobBase, COnOffButton, CSwitchBase, CXYPad, and CMovieButton.

◆ onMouseUp()

CMouseEventResult onMouseUp ( CPoint where,
const CButtonState buttons 
)
virtual

called when a mouse up event occurs

Parameters
wheremouse location of mouse up
buttonsbutton and modifier state
Returns
event result. see CMouseEventResult

Reimplemented in CTextButton, CFrame, CKickButton, CRockerSwitch, CViewContainer, CCheckBox, CSliderBase, CScrollbar, CListControl, CKnobBase, COnOffButton, CSwitchBase, CXYPad, and CMovieButton.

◆ onWheel() [1/2]

virtual bool onWheel ( const CPoint where,
const float &  distance,
const CButtonState buttons 
)
inlinefinalvirtual
Deprecated:
never called anymore please override the method below for wheel handling

◆ onWheel() [2/2]

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

called if a mouse wheel event is happening over this view

Parameters
wherelocation
axismouse wheel axis
distancewheel distance
buttonsbutton and modifier state
Returns
true if handled

Reimplemented in CFrame, CViewContainer, CRockerSwitch, CScrollView, CTextLabel, CSliderBase, CScrollbar, CKnobBase, and CXYPad.

◆ onWindowActivate()

virtual void onWindowActivate ( bool  state)
inlinevirtual

called when the active state of the window changes

◆ parentSizeChanged()

virtual void parentSizeChanged ( )
inlinevirtual

notification that one of the views parent has changed its size

Reimplemented in CViewContainer, CTextEdit, COpenGLView, and CLayeredViewContainer.

◆ registerViewListener()

void registerViewListener ( IViewListener listener)

◆ registerViewMouseListener()

void registerViewMouseListener ( IViewMouseListener listener)

◆ removeAllAnimations()

void removeAllAnimations ( )

◆ removeAnimation()

void removeAnimation ( IdStringPtr  name)

◆ removeAttribute()

bool removeAttribute ( const CViewAttributeID  id)

remove an attribute

◆ removed()

bool removed ( CView parent)
virtual

view is removed from parent view

Parameters
parentparent view
Returns
true if view successfully removed from parent

Reimplemented in CTextButton, CViewContainer, CParamDisplay, CDataBrowser, CSplitView, UIViewSwitchContainer, COpenGLView, CShadowViewContainer, and CLayeredViewContainer.

◆ setAlphaValue()

void setAlphaValue ( float  alpha)
virtual

set alpha value which will be applied when drawing this view

Reimplemented in CLayeredViewContainer.

◆ setAlphaValueNoInvalidate()

void setAlphaValueNoInvalidate ( float  value)
protected

◆ setAttribute() [1/2]

bool setAttribute ( const CViewAttributeID  aId,
const uint32_t  inSize,
const void *  inData 
)

set an attribute

copies data into the attribute.

If it does not exist, creates a new attribute.

Parameters
aIdthe ID of the Attribute
inSizethe size of the outData pointer
inDataa pointer to the data
Returns
true if attribute was set

◆ setAttribute() [2/2]

bool setAttribute ( const CViewAttributeID  id,
const T &  data 
)
inline

set an attribute

◆ setAutosizeFlags()

void setAutosizeFlags ( int32_t  flags)
virtual

set autosize flags

Reimplemented in CDataBrowser, CScrollView, and CTabView.

◆ setBackground()

void setBackground ( CBitmap background)
virtual

set the background image of this view

Parameters
backgroundnew background bitmap

Reimplemented in CAnimKnob, and CCheckBox.

◆ setDirty()

void setDirty ( bool  val = true)
virtual

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

Thread Safe !

Reimplemented in CControl, and CVuMeter.

◆ setDisabledBackground()

void setDisabledBackground ( CBitmap background)
virtual

set background image used when the mouse is not enabled

Parameters
backgroundnew disabled background bitmap

◆ setDropTarget()

void setDropTarget ( const SharedPointer< IDropTarget > &  dt)

set a custom drop target

◆ setHitTestPath()

void setHitTestPath ( CGraphicsPath path)
Parameters
paththe 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.

◆ setMouseableArea()

void setMouseableArea ( const CRect rect)

set the area in which the view reacts to the mouse

◆ setMouseEnabled()

void setMouseEnabled ( bool  bEnable = true)
virtual

turn on/off mouse usage for this view

◆ setParentFrame()

void setParentFrame ( CFrame frame)
protected

◆ setParentView()

void setParentView ( CView parent)
protected

◆ setSubviewState()

void setSubviewState ( bool  state)

◆ setTooltipText()

void setTooltipText ( UTF8StringPtr  text)

◆ setTransparency()

void setTransparency ( bool  val)
virtual

set views transparent state

Reimplemented in CScrollView.

◆ setViewFlag()

void setViewFlag ( int32_t  bit,
bool  state 
)
protected

◆ setViewSize()

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

◆ setVisible()

void setVisible ( bool  state)
virtual

set visibility state

Reimplemented in COpenGLView.

◆ setWantsFocus()

void setWantsFocus ( bool  state)
virtual

set focus support on/off

Reimplemented in CDataBrowser.

◆ setWantsIdle()

void setWantsIdle ( bool  state)

enable/disable onIdle() callback

◆ sizeToFit()

◆ takeFocus()

void takeFocus ( )
virtual

called if view should take focus

Reimplemented in COptionMenu, CViewContainer, and CTextEdit.

◆ translateToGlobal() [1/2]

T& translateToGlobal ( T &  t,
bool  ignoreFrame = false 
) const
inline

translates a local coordinate to a global one using parent transforms

◆ translateToGlobal() [2/2]

T translateToGlobal ( const T &  t,
bool  ignoreFrame = false 
) const
inline

translates a local coordinate to a global one using parent transforms

◆ translateToLocal() [1/2]

T& translateToLocal ( T &  t,
bool  ignoreFrame = false 
) const
inline

translates a global coordinate to a local one using parent transforms

◆ translateToLocal() [2/2]

T translateToLocal ( const T &  t,
bool  ignoreFrame = false 
) const
inline

translates a local coordinate to a global one using parent transforms

◆ unregisterViewListener()

void unregisterViewListener ( IViewListener listener)

◆ unregisterViewMouseListener()

void unregisterViewMouseListener ( IViewMouseListener listener)

◆ wantsFocus()

virtual bool wantsFocus ( ) const
inlinevirtual

check if view supports focus

Reimplemented in CDataBrowser, and CTextEdit.

◆ wantsIdle()

bool wantsIdle ( ) const
inline

returns if the view wants idle callback or not

◆ wantsWindowActiveStateChangeNotification()

virtual bool wantsWindowActiveStateChangeNotification ( ) const
inlinevirtual

whether this view wants to be informed if the window's active state changes

Member Data Documentation

◆ idleRate

uint32_t idleRate
static

global idle rate in Hz, defaults to 30 Hz

◆ kDirtyCallAlwaysOnMainThread

bool kDirtyCallAlwaysOnMainThread = false
static

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

Default value is false.


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