VSTGUI  3.6
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
Public Types | Public Member Functions | Protected Attributes | List of all members
COnOffButton Class Reference

a button control with 2 states More...

#include <vstcontrols.h>

+ Inheritance diagram for COnOffButton:

Public Types

enum  COnOffButtonStyle { kPreListenerUpdate, kPostListenerUpdate }
 

Public Member Functions

virtual ~COnOffButton ()
 
virtual void draw (CDrawContext *)
 called if the view should draw itself More...
 
virtual void mouse (CDrawContext *pContext, CPoint &where, long button=-1)
 
virtual CMouseEventResult onMouseDown (CPoint &where, const long &buttons)
 called when a mouse down event occurs More...
 
virtual bool isTypeOf (const char *s) const
 
virtual CViewnewCopy () const
 
virtual void doIdleStuff ()
 
virtual void setBackOffset (CPoint &offset)
 
virtual void copyBackOffset ()
 
virtual void setWheelInc (float val)
 
virtual float getWheelInc () const
 
bool isDirty () const
 check if view is dirty More...
 
void setDirty (const bool val=true)
 set the view to dirty so that it is redrawn in the next idle. Thread Safe ! More...
 
bool isDoubleClick ()
 
virtual void setBackground (CBitmap *background)
 set the background image of this view More...
 
virtual CBitmapgetBackground () const
 get the background image of this view More...
 
virtual void setTransparency (bool val)
 set views transparent state More...
 
virtual bool getTransparency () const
 get views transparent state More...
 
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...
 
CMessageResult notify (CBaseObject *sender, const char *message)
 
virtual void getMouseLocation (CDrawContext *context, CPoint &point)
 
virtual void setParentView (CView *pParentView)
 
virtual void setFrame (CFrame *pParent)
 
virtual void getFrameTopLeftPos (CPoint &topLeft) const
 

Protected Attributes

long style
 
CControlListenerlistener
 
long tag
 
float oldValue
 
float defaultValue
 
float value
 
float vmin
 
float vmax
 
float wheelInc
 
long lastTicks
 
long delta
 
CPoint backOffset
 
CRect size
 
CRect mouseableArea
 
CFramepParentFrame
 
CViewpParentView
 
bool bDirty
 
bool bMouseEnabled
 
bool bTransparencyEnabled
 
bool bWantsFocus
 
bool bIsAttached
 
bool bVisible
 
long autosizeFlags
 
CBitmappBackground
 
CAttributeListEntry * pAttributeList
 

Value Methods

virtual void setValue (float val)
 
virtual float getValue () const
 
virtual void setMin (float val)
 
virtual float getMin () const
 
virtual void setMax (float val)
 
virtual float getMax () 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 (long button)
 

Editing Methods

virtual void setTag (long val)
 
virtual long getTag () const
 
virtual void beginEdit ()
 
virtual void endEdit ()
 
virtual CControlListenergetListener () const
 
virtual void setListener (CControlListener *l)
 

Constructor

 COnOffButton (const CRect &size, CControlListener *listener, long tag, CBitmap *background, long style=kPreListenerUpdate)
 
 COnOffButton (const COnOffButton &onOffButton)
 

COnOffButton Methods

virtual long getStyle () const
 
virtual void setStyle (long newStyle)
 

Reference Counting Methods

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

Draw and Update Methods

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

Mouse Methods

virtual CMouseEventResult onMouseUp (CPoint &where, const long &buttons)
 called when a mouse up event occurs More...
 
virtual CMouseEventResult onMouseMoved (CPoint &where, const long &buttons)
 called when a mouse move event occurs More...
 
virtual CMouseEventResult onMouseEntered (CPoint &where, const long &buttons)
 called when the mouse enters this view More...
 
virtual CMouseEventResult onMouseExited (CPoint &where, const long &buttons)
 called when the mouse leaves this view More...
 
virtual bool hitTest (const CPoint &where, const long buttons=-1)
 check if where hits this view More...
 
virtual bool onWheel (const CPoint &where, const float &distance, const long &buttons)
 called if a mouse wheel event is happening over this view More...
 
virtual bool onWheel (const CPoint &where, const CMouseWheelAxis &axis, const float &distance, const long &buttons)
 called if a mouse wheel event is happening over this view More...
 
virtual void setMouseEnabled (const bool bEnable=true)
 turn on/off mouse usage for this view More...
 
virtual 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...
 
virtual CRectgetMouseableArea (CRect &rect) const
 get the area in which the view reacts to the mouse More...
 
virtual const CRectgetMouseableArea () const
 read only access to the mouseable area More...
 

Drag & Drop Methods

virtual bool onDrop (CDragContainer *drag, const CPoint &where)
 called if a drag is dropped onto this view More...
 
virtual void onDragEnter (CDragContainer *drag, const CPoint &where)
 called if a drag is entering this view More...
 
virtual void onDragLeave (CDragContainer *drag, const CPoint &where)
 called if a drag is leaving this view More...
 
virtual void onDragMove (CDragContainer *drag, const CPoint &where)
 called if a drag is moved inside this view More...
 

Keyboard Methods

virtual long onKeyDown (VstKeyCode &keyCode)
 called if a key down event occurs and this view has focus More...
 
virtual long 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 (CRect &rect, bool invalid=true)
 set views size More...
 
virtual CRectgetViewSize (CRect &rect) const
 returns the current view size More...
 
virtual const CRectgetViewSize () const
 read only access to view size More...
 
virtual CRect getVisibleSize () 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 (long flags)
 set autosize flags More...
 
virtual long getAutosizeFlags () const
 get autosize flags 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, long &outSize) const
 get the size of an attribute More...
 
bool getAttribute (const CViewAttributeID id, const long inSize, void *outData, long &outSize) const
 get an attribute More...
 
bool setAttribute (const CViewAttributeID id, const long inSize, const void *inData)
 set an attribute More...
 
bool removeAttribute (const CViewAttributeID id)
 remove an attribute More...
 

Parent Methods

CViewgetParentView () const
 get parent view More...
 
CFramegetFrame () const
 get frame More...
 
virtual VSTGUIEditorInterfacegetEditor () const
 get editor More...
 

Detailed Description

a button control with 2 states

Define a button with 2 positions. The bitmap includes the 2 subbitmaps (i.e the rectangle used for the display of this button is half-height of the bitmap). When its value changes, the listener is called.

Member Enumeration Documentation

Enumerator
kPreListenerUpdate 

listener will be called after doIdleStuff was called

kPostListenerUpdate 

listener will be called before doIdleStuff is called

Constructor & Destructor Documentation

COnOffButton ( const CRect size,
CControlListener listener,
long  tag,
CBitmap background,
long  style = kPreListenerUpdate 
)

COnOffButton constructor.

Parameters
sizethe size of this view
listenerthe listener
tagthe control tag
backgroundbitmap of the on/off button
stylestyle (kPostListenerUpdate or kPreListenerUpdate)
COnOffButton ( const COnOffButton onOffButton)
~COnOffButton ( )
virtual

Member Function Documentation

bool attached ( CView parent)
virtualinherited

view is attached to a parent view

Parameters
parentparent view
Returns
true if view successfully attached to parent

Reimplemented in CViewContainer, CVuMeter, and CDataBrowser.

void beginEdit ( )
virtualinherited
void bounceValue ( )
virtualinherited
bool checkDefaultValue ( long  button)
virtualinherited
virtual bool checkUpdate ( const CRect updateRect) const
inlinevirtualinherited
void copyBackOffset ( )
virtualinherited
virtual void doIdleStuff ( )
inlinevirtualinherited
void draw ( CDrawContext pContext)
virtual

called if the view should draw itself

Parameters
pContextdraw context in which to draw

Implements CControl.

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

called if the view should draw itself

Reimplemented in CFrame, and CViewContainer.

void endEdit ( )
virtualinherited
virtual void forget ( )
inlinevirtualinherited

decrease refcount and delete object if refcount == 0

Reimplemented in CDrawContext.

CPoint & frameToLocal ( CPoint point) const
virtualinherited

conversion from frame coordinates to local view coordinates

Parameters
pointlocation
Returns
converted point

Reimplemented in CViewContainer.

bool getAttribute ( const CViewAttributeID  id,
const long  inSize,
void *  outData,
long &  outSize 
) const
inherited

get an attribute

Parameters
idthe 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.
bool getAttributeSize ( const CViewAttributeID  id,
long &  outSize 
) const
inherited

get the size of an attribute

Parameters
idthe ID of the Attribute
outSizeon return the size of the attribute
Returns
true if attribute exists. outSize is valid then.
virtual long getAutosizeFlags ( ) const
inlinevirtualinherited

get autosize flags

virtual CBitmap* getBackground ( ) const
inlinevirtualinherited

get the background image of this view

virtual float getDefaultValue ( void  ) const
inlinevirtualinherited
VSTGUIEditorInterface * getEditor ( ) const
virtualinherited

get editor

Reimplemented in CFrame.

CFrame* getFrame ( ) const
inlineinherited

get frame

void getFrameTopLeftPos ( CPoint topLeft) const
virtualinherited
CCoord getHeight ( ) const
inlineinherited

get the height of the view

virtual CControlListener* getListener ( ) const
inlinevirtualinherited
virtual float getMax ( ) const
inlinevirtualinherited
virtual float getMin ( ) const
inlinevirtualinherited
virtual CRect& getMouseableArea ( CRect rect) const
inlinevirtualinherited

get the area in which the view reacts to the mouse

virtual const CRect& getMouseableArea ( ) const
inlinevirtualinherited

read only access to the mouseable area

virtual bool getMouseEnabled ( ) const
inlinevirtualinherited

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

void getMouseLocation ( CDrawContext context,
CPoint point 
)
virtualinherited
long getNbReference ( ) const
inlineinherited

get refcount

virtual float getOldValue ( void  ) const
inlinevirtualinherited
CView* getParentView ( ) const
inlineinherited

get parent view

virtual long getStyle ( ) const
inlinevirtual
virtual long getTag ( ) const
inlinevirtualinherited
virtual bool getTransparency ( ) const
inlinevirtualinherited

get views transparent state

virtual float getValue ( ) const
inlinevirtualinherited
virtual CRect& getViewSize ( CRect rect) const
inlinevirtualinherited

returns the current view size

virtual const CRect& getViewSize ( ) const
inlinevirtualinherited

read only access to view size

CRect getVisibleSize ( ) const
virtualinherited

returns the visible size of the view

Returns
visible size of view
virtual float getWheelInc ( ) const
inlinevirtualinherited
CCoord getWidth ( ) const
inlineinherited

get the width of the view

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

check if where hits this view

Reimplemented in CViewContainer, and CSplashScreen.

virtual void invalid ( )
inlinevirtualinherited

mark whole view as invalid

Reimplemented in CFrame, and CViewContainer.

void invalidRect ( const CRect  rect)
virtualinherited

mark rect as invalid

Parameters
rectrect to invalidate

Reimplemented in CFrame, and CViewContainer.

bool isAttached ( ) const
inlineinherited

is view attached to a parentView

bool isDirty ( ) const
virtualinherited

check if view is dirty

Reimplemented from CView.

Reimplemented in CAnimKnob.

bool isDoubleClick ( )
inherited
Deprecated:
use kDoubleClick in onMouseDown
virtual bool isTypeOf ( const char *  s) const
inlinevirtual

Reimplemented from CControl.

bool isVisible ( ) const
inlineinherited

get visibility state

CPoint & localToFrame ( CPoint point) const
virtualinherited

conversion from local view coordinates to frame coordinates

Parameters
pointlocation
Returns
converted point

Reimplemented in CViewContainer.

void looseFocus ( )
virtualinherited

called if view should loose focus

Reimplemented in CViewContainer, COptionMenu, and CTextEdit.

void mouse ( CDrawContext pContext,
CPoint where,
long  buttons = -1 
)
virtual
Deprecated:
use the new mouse methods instead

Reimplemented from CView.

virtual CView* newCopy ( ) const
inlinevirtual

Implements CControl.

CMessageResult notify ( CBaseObject sender,
const char *  message 
)
virtualinherited
Parameters
sendermessage sender
messagemessage text
Returns
message handled or not. See CMessageResult

Reimplemented from CBaseObject.

Reimplemented in CViewContainer.

virtual void onDragEnter ( CDragContainer drag,
const CPoint where 
)
inlinevirtualinherited

called if a drag is entering this view

Reimplemented in CViewContainer.

virtual void onDragLeave ( CDragContainer drag,
const CPoint where 
)
inlinevirtualinherited

called if a drag is leaving this view

Reimplemented in CViewContainer.

virtual void onDragMove ( CDragContainer drag,
const CPoint where 
)
inlinevirtualinherited

called if a drag is moved inside this view

Reimplemented in CViewContainer.

virtual bool onDrop ( CDragContainer drag,
const CPoint where 
)
inlinevirtualinherited

called if a drag is dropped onto this view

Reimplemented in CViewContainer.

long onKeyDown ( VstKeyCode keyCode)
virtualinherited

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 CFrame, CViewContainer, CSlider, and CKnob.

long onKeyUp ( VstKeyCode keyCode)
virtualinherited

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 CFrame, and CViewContainer.

CMouseEventResult onMouseDown ( CPoint where,
const long &  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 from CView.

virtual CMouseEventResult onMouseEntered ( CPoint where,
const long &  buttons 
)
inlinevirtualinherited

called when the mouse enters this view

virtual CMouseEventResult onMouseExited ( CPoint where,
const long &  buttons 
)
inlinevirtualinherited

called when the mouse leaves this view

Reimplemented in CFrame.

CMouseEventResult onMouseMoved ( CPoint where,
const long &  buttons 
)
virtualinherited

called when a mouse move event occurs

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

Reimplemented in CFrame, CViewContainer, CKickButton, CSlider, CMovieButton, CRockerSwitch, CHorizontalSwitch, CVerticalSwitch, CKnob, and CScrollbar.

CMouseEventResult onMouseUp ( CPoint where,
const long &  buttons 
)
virtualinherited

called when a mouse up event occurs

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

Reimplemented in CFrame, CViewContainer, CKickButton, CSlider, CMovieButton, CRockerSwitch, CHorizontalSwitch, CVerticalSwitch, CKnob, and CScrollbar.

bool onWheel ( const CPoint where,
const float &  distance,
const long &  buttons 
)
virtualinherited

called if a mouse wheel event is happening over this view

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

Reimplemented in CFrame, CViewContainer, CSlider, CRockerSwitch, and CKnob.

bool onWheel ( const CPoint where,
const CMouseWheelAxis axis,
const float &  distance,
const long &  buttons 
)
virtualinherited

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, CScrollbar, and CScrollView.

virtual void parentSizeChanged ( )
inlinevirtualinherited

notification that one of the views parent has changed its size

Reimplemented in CViewContainer, and CTextEdit.

virtual void remember ( )
inlinevirtualinherited

increase refcount

bool removeAttribute ( const CViewAttributeID  id)
inherited

remove an attribute

bool removed ( CView parent)
virtualinherited

view is removed from parent view

Parameters
parentparent view
Returns
true if view successfully removed from parent

Reimplemented in CViewContainer, and CVuMeter.

bool setAttribute ( const CViewAttributeID  id,
const long  inSize,
const void *  inData 
)
inherited

set an attribute

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

Parameters
idthe ID of the Attribute
inSizethe size of the outData pointer
inDataa pointer to the data
Returns
true if attribute was set
virtual void setAutosizeFlags ( long  flags)
inlinevirtualinherited

set autosize flags

void setBackground ( CBitmap background)
virtualinherited

set the background image of this view

Parameters
backgroundnew background bitmap
void setBackOffset ( CPoint offset)
virtualinherited
virtual void setDefaultValue ( float  val)
inlinevirtualinherited
void setDirty ( const bool  val = true)
virtualinherited

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

Reimplemented from CView.

Reimplemented in CVuMeter.

virtual void setFrame ( CFrame pParent)
inlinevirtualinherited
virtual void setListener ( CControlListener l)
inlinevirtualinherited
virtual void setMax ( float  val)
inlinevirtualinherited
virtual void setMin ( float  val)
inlinevirtualinherited
virtual void setMouseableArea ( const CRect rect)
inlinevirtualinherited

set the area in which the view reacts to the mouse

virtual void setMouseEnabled ( const bool  bEnable = true)
inlinevirtualinherited

turn on/off mouse usage for this view

virtual void setOldValue ( float  val)
inlinevirtualinherited
virtual void setParentView ( CView pParentView)
inlinevirtualinherited
virtual void setStyle ( long  newStyle)
inlinevirtual
virtual void setTag ( long  val)
inlinevirtualinherited
virtual void setTransparency ( bool  val)
inlinevirtualinherited

set views transparent state

Reimplemented in CScrollView.

virtual void setValue ( float  val)
inlinevirtualinherited

Reimplemented in COptionMenu.

void setViewSize ( CRect newSize,
bool  invalid = true 
)
virtualinherited

set views size

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

Reimplemented in CFrame, CViewContainer, CSlider, CTextEdit, CScrollbar, CScrollView, and CTabView.

void setVisible ( bool  state)
virtualinherited

set visibility state

virtual void setWantsFocus ( bool  state)
inlinevirtualinherited

set focus support on/off

virtual void setWheelInc ( float  val)
inlinevirtualinherited
void takeFocus ( )
virtualinherited

called if view should take focus

Reimplemented in CViewContainer, COptionMenu, and CTextEdit.

virtual bool wantsFocus ( ) const
inlinevirtualinherited

check if view supports focus

Member Data Documentation

long autosizeFlags
protectedinherited
CPoint backOffset
protectedinherited
bool bDirty
protectedinherited
bool bIsAttached
protectedinherited
bool bMouseEnabled
protectedinherited
bool bTransparencyEnabled
protectedinherited
bool bVisible
protectedinherited
bool bWantsFocus
protectedinherited
float defaultValue
protectedinherited
long delta
protectedinherited
long lastTicks
protectedinherited
CControlListener* listener
protectedinherited
CRect mouseableArea
protectedinherited
float oldValue
protectedinherited
CAttributeListEntry* pAttributeList
protectedinherited
CBitmap* pBackground
protectedinherited
CFrame* pParentFrame
protectedinherited
CView* pParentView
protectedinherited
CRect size
protectedinherited
long style
protected
long tag
protectedinherited
float value
protectedinherited
float vmax
protectedinherited
float vmin
protectedinherited
float wheelInc
protectedinherited

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