special display with custom numbers (0...9) More...
#include <vstcontrols.h>
Public Member Functions | |
virtual | ~CSpecialDigit () |
virtual void | draw (CDrawContext *) |
called if the view should draw itself | |
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 | |
void | setDirty (const bool val=true) |
set the view to dirty so that it is redrawn in the next idle. Thread Safe ! | |
virtual void | setBackground (CBitmap *background) |
set the background image of this view | |
virtual CBitmap * | getBackground () const |
get the background image of this view | |
virtual void | setTransparency (bool val) |
set views transparent state | |
virtual bool | getTransparency () const |
get views transparent state | |
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 | |
virtual bool | isTypeOf (const char *s) const |
virtual CView * | newCopy () const |
CMessageResult | notify (CBaseObject *sender, const char *message) |
VSTGUI_DEPRECATED (virtual void mouse(CDrawContext *pContext, CPoint &where, long buttons=-1);) VSTGUI_DEPRECATED(virtual void getMouseLocation(CDrawContext *context | |
VSTGUI_DEPRECATED (virtual void setParentView(CView *pParentView){this->pParentView=pParentView;}) VSTGUI_DEPRECATED(virtual void setFrame(CFrame *pParent) | |
< | |
Public Attributes | |
VSTGUI_DEPRECATED(bool isDoubleClick();) protected long | tag |
float | oldValue |
float | defaultValue |
float | value |
float | vmin |
float | vmax |
float | wheelInc |
long | lastTicks |
long | delta |
CPoint | backOffset |
CPoint & | point |
VSTGUI_DEPRECATED(virtual void getFrameTopLeftPos(CPoint &topLeft) const ;) protected CRect | mouseableArea |
< | |
CFrame * | pParentFrame |
CView * | pParentView |
bool | bDirty |
bool | bMouseEnabled |
bool | bTransparencyEnabled |
bool | bWantsFocus |
bool | bIsAttached |
bool | bVisible |
long | autosizeFlags |
CBitmap * | pBackground |
CAttributeListEntry * | pAttributeList |
Protected Attributes | |
long | iNumbers |
long | xpos [7] |
long | ypos [7] |
long | width |
long | height |
Constructor | |
| |
CSpecialDigit (const CRect &size, CControlListener *listener, long tag, long dwPos, long iNumbers, long *xpos, long *ypos, long width, long height, CBitmap *background) | |
CSpecialDigit (const CSpecialDigit &digit) | |
CSpecialDigit Methods | |
| |
virtual float | getNormValue (void) const |
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 CControlListener * | getListener () const |
virtual void | setListener (CControlListener *l) |
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 | |
Mouse Methods | |
| |
virtual CMouseEventResult | onMouseDown (CPoint &where, const long &buttons) |
called when a mouse down event occurs | |
virtual CMouseEventResult | onMouseUp (CPoint &where, const long &buttons) |
called when a mouse up event occurs | |
virtual CMouseEventResult | onMouseMoved (CPoint &where, const long &buttons) |
called when a mouse move event occurs | |
virtual CMouseEventResult | onMouseEntered (CPoint &where, const long &buttons) |
called when the mouse enters this view | |
virtual CMouseEventResult | onMouseExited (CPoint &where, const long &buttons) |
called when the mouse leaves this view | |
virtual bool | hitTest (const CPoint &where, const long buttons=-1) |
check if where hits this view | |
virtual bool | onWheel (const CPoint &where, const float &distance, const long &buttons) |
called if a mouse wheel event is happening over this view | |
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 | |
virtual void | setMouseEnabled (const 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 CRect & | getMouseableArea (CRect &rect) const |
get the area in which the view reacts to the mouse | |
virtual const CRect & | getMouseableArea () const |
read only access to the mouseable area | |
Drag & Drop Methods | |
| |
virtual bool | onDrop (CDragContainer *drag, const CPoint &where) |
called if a drag is dropped onto this view | |
virtual void | onDragEnter (CDragContainer *drag, const CPoint &where) |
called if a drag is entering this view | |
virtual void | onDragLeave (CDragContainer *drag, const CPoint &where) |
called if a drag is leaving this view | |
virtual void | onDragMove (CDragContainer *drag, const CPoint &where) |
called if a drag is moved inside this view | |
Keyboard Methods | |
| |
virtual long | onKeyDown (VstKeyCode &keyCode) |
called if a key down event occurs and this view has focus | |
virtual long | 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 | |
virtual void | setViewSize (CRect &rect, bool invalid=true) |
set views size | |
virtual CRect & | getViewSize (CRect &rect) const |
returns the current view size | |
virtual const CRect & | getViewSize () const |
read only access to view size | |
virtual CRect | getVisibleSize () const |
returns the visible size of the view | |
virtual void | parentSizeChanged () |
notification that one of the views parent has changed its size | |
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 (long flags) |
set autosize flags | |
virtual long | getAutosizeFlags () const |
get autosize flags | |
Focus Methods | |
| |
virtual void | looseFocus () |
called if view should loose focus | |
virtual void | takeFocus () |
called if view should take focus | |
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, long &outSize) const |
get the size of an attribute | |
bool | getAttribute (const CViewAttributeID id, const long inSize, void *outData, long &outSize) const |
get an attribute | |
bool | setAttribute (const CViewAttributeID id, const long inSize, const void *inData) |
set an attribute | |
bool | removeAttribute (const CViewAttributeID id) |
remove an attribute | |
Parent Methods | |
| |
CView * | getParentView () const |
get parent view | |
CFrame * | getFrame () const |
get frame | |
virtual VSTGUIEditorInterface * | getEditor () const |
get editor | |
Reference Counting Methods | |
| |
virtual void | forget () |
decrease refcount and delete object if refcount == 0 | |
virtual void | remember () |
increase refcount | |
long | getNbReference () const |
get refcount |
special display with custom numbers (0...9)
Can be used to display a counter with maximum 7 digits. All digit have the same size and are stacked in height in the bitmap.
CSpecialDigit | ( | const CRect & | size, | |
CControlListener * | listener, | |||
long | tag, | |||
long | dwPos, | |||
long | iNumbers, | |||
long * | xpos, | |||
long * | ypos, | |||
long | width, | |||
long | height, | |||
CBitmap * | background | |||
) |
CSpecialDigit constructor.
size | the size of this view | |
listener | the listener | |
tag | the control tag | |
dwPos | actual value | |
iNumbers | amount of numbers (max 7) | |
xpos | array of all X positions, can be NULL | |
ypos | array of all Y positions, can be NULL | |
width | width of one number in the bitmap | |
height | height of one number in the bitmap | |
background | bitmap |
CSpecialDigit | ( | const CSpecialDigit & | digit | ) |
~CSpecialDigit | ( | ) | [virtual] |
void draw | ( | CDrawContext * | pContext | ) | [virtual] |
called if the view should draw itself
pContext | draw context in which to draw |
Implements CControl.
float getNormValue | ( | void | ) | const [virtual] |
virtual void doIdleStuff | ( | ) | [inline, virtual, inherited] |
virtual void setValue | ( | float | val | ) | [inline, virtual, inherited] |
Reimplemented in COptionMenu.
virtual float getValue | ( | ) | const [inline, virtual, inherited] |
virtual void setMin | ( | float | val | ) | [inline, virtual, inherited] |
virtual float getMin | ( | ) | const [inline, virtual, inherited] |
virtual void setMax | ( | float | val | ) | [inline, virtual, inherited] |
virtual float getMax | ( | ) | const [inline, virtual, inherited] |
virtual void setOldValue | ( | float | val | ) | [inline, virtual, inherited] |
virtual float getOldValue | ( | void | ) | const [inline, virtual, inherited] |
virtual void setDefaultValue | ( | float | val | ) | [inline, virtual, inherited] |
virtual float getDefaultValue | ( | void | ) | const [inline, virtual, inherited] |
void bounceValue | ( | ) | [virtual, inherited] |
bool checkDefaultValue | ( | long | button | ) | [virtual, inherited] |
virtual void setTag | ( | long | val | ) | [inline, virtual, inherited] |
virtual long getTag | ( | ) | const [inline, virtual, inherited] |
void beginEdit | ( | ) | [virtual, inherited] |
void endEdit | ( | ) | [virtual, inherited] |
virtual CControlListener* getListener | ( | ) | const [inline, virtual, inherited] |
virtual void setListener | ( | CControlListener * | l | ) | [inline, virtual, inherited] |
void setBackOffset | ( | CPoint & | offset | ) | [virtual, inherited] |
void copyBackOffset | ( | ) | [virtual, inherited] |
virtual void setWheelInc | ( | float | val | ) | [inline, virtual, inherited] |
virtual float getWheelInc | ( | ) | const [inline, virtual, inherited] |
bool isDirty | ( | ) | const [virtual, inherited] |
void setDirty | ( | const bool | val = true |
) | [virtual, inherited] |
virtual void drawRect | ( | CDrawContext * | pContext, | |
const CRect & | updateRect | |||
) | [inline, virtual, inherited] |
called if the view should draw itself
Reimplemented in CViewContainer, and CFrame.
virtual bool checkUpdate | ( | const CRect & | updateRect | ) | const [inline, virtual, inherited] |
void invalidRect | ( | const CRect | rect | ) | [virtual, inherited] |
mark rect as invalid
rect | rect to invalidate |
Reimplemented in CViewContainer, and CFrame.
virtual void invalid | ( | ) | [inline, virtual, inherited] |
mark whole view as invalid
Reimplemented in CViewContainer, and CFrame.
void setVisible | ( | bool | state | ) | [virtual, inherited] |
set visibility state
bool isVisible | ( | ) | const [inline, inherited] |
get visibility state
CMouseEventResult onMouseDown | ( | CPoint & | where, | |
const long & | buttons | |||
) | [virtual, inherited] |
called when a mouse down event occurs
where | mouse location of mouse down | |
buttons | button and modifier state |
Reimplemented in CScrollbar, COnOffButton, CTextEdit, COptionMenu, CKnob, CVerticalSwitch, CHorizontalSwitch, CRockerSwitch, CMovieButton, CAutoAnimation, CSlider, CKickButton, CSplashScreen, CViewContainer, and CFrame.
CMouseEventResult onMouseUp | ( | CPoint & | where, | |
const long & | buttons | |||
) | [virtual, inherited] |
called when a mouse up event occurs
where | mouse location of mouse up | |
buttons | button and modifier state |
Reimplemented in CScrollbar, CKnob, CVerticalSwitch, CHorizontalSwitch, CRockerSwitch, CMovieButton, CSlider, CKickButton, CViewContainer, and CFrame.
CMouseEventResult onMouseMoved | ( | CPoint & | where, | |
const long & | buttons | |||
) | [virtual, inherited] |
called when a mouse move event occurs
where | mouse location of mouse move | |
buttons | button and modifier state |
Reimplemented in CScrollbar, CKnob, CVerticalSwitch, CHorizontalSwitch, CRockerSwitch, CMovieButton, CSlider, CKickButton, CViewContainer, and CFrame.
virtual CMouseEventResult onMouseEntered | ( | CPoint & | where, | |
const long & | buttons | |||
) | [inline, virtual, inherited] |
called when the mouse enters this view
virtual CMouseEventResult onMouseExited | ( | CPoint & | where, | |
const long & | buttons | |||
) | [inline, virtual, inherited] |
called when the mouse leaves this view
Reimplemented in CFrame.
virtual bool hitTest | ( | const CPoint & | where, | |
const long | buttons = -1 | |||
) | [inline, virtual, inherited] |
check if where hits this view
Reimplemented in CSplashScreen, and CViewContainer.
bool onWheel | ( | const CPoint & | where, | |
const float & | distance, | |||
const long & | buttons | |||
) | [virtual, inherited] |
called if a mouse wheel event is happening over this view
where | location | |
distance | wheel distance | |
buttons | button and modifier state |
Reimplemented in CKnob, CRockerSwitch, CSlider, CViewContainer, and CFrame.
bool onWheel | ( | const CPoint & | where, | |
const CMouseWheelAxis & | axis, | |||
const float & | distance, | |||
const long & | buttons | |||
) | [virtual, inherited] |
called if a mouse wheel event is happening over this view
where | location | |
axis | mouse wheel axis | |
distance | wheel distance | |
buttons | button and modifier state |
Reimplemented in CScrollView, CScrollbar, CViewContainer, and CFrame.
virtual void setMouseEnabled | ( | const bool | bEnable = true |
) | [inline, virtual, inherited] |
turn on/off mouse usage for this view
virtual bool getMouseEnabled | ( | ) | const [inline, virtual, inherited] |
get the state of wheather this view uses the mouse or not
virtual void setMouseableArea | ( | const CRect & | rect | ) | [inline, virtual, inherited] |
set the area in which the view reacts to the mouse
get the area in which the view reacts to the mouse
virtual const CRect& getMouseableArea | ( | ) | const [inline, virtual, inherited] |
read only access to the mouseable area
virtual bool onDrop | ( | CDragContainer * | drag, | |
const CPoint & | where | |||
) | [inline, virtual, inherited] |
called if a drag is dropped onto this view
Reimplemented in CViewContainer.
virtual void onDragEnter | ( | CDragContainer * | drag, | |
const CPoint & | where | |||
) | [inline, virtual, inherited] |
called if a drag is entering this view
Reimplemented in CViewContainer.
virtual void onDragLeave | ( | CDragContainer * | drag, | |
const CPoint & | where | |||
) | [inline, virtual, inherited] |
called if a drag is leaving this view
Reimplemented in CViewContainer.
virtual void onDragMove | ( | CDragContainer * | drag, | |
const CPoint & | where | |||
) | [inline, virtual, inherited] |
called if a drag is moved inside this view
Reimplemented in CViewContainer.
long onKeyDown | ( | VstKeyCode & | keyCode | ) | [virtual, inherited] |
called if a key down event occurs and this view has focus
keyCode | key code of pressed key |
Reimplemented in CKnob, CSlider, CViewContainer, and CFrame.
long onKeyUp | ( | VstKeyCode & | keyCode | ) | [virtual, inherited] |
called if a key up event occurs and this view has focus
keyCode | key code of pressed key |
Reimplemented in CViewContainer, and CFrame.
CCoord getHeight | ( | ) | const [inline, inherited] |
get the height of the view
CCoord getWidth | ( | ) | const [inline, inherited] |
get the width of the view
void setViewSize | ( | CRect & | newSize, | |
bool | invalid = true | |||
) | [virtual, inherited] |
set views size
newSize | rect of new size of view | |
invalid | if true set view dirty |
Reimplemented in CScrollView, CScrollbar, CTabView, CTextEdit, CSlider, CViewContainer, and CFrame.
returns the current view size
virtual const CRect& getViewSize | ( | ) | const [inline, virtual, inherited] |
read only access to view size
CRect getVisibleSize | ( | ) | const [virtual, inherited] |
returns the visible size of the view
virtual void parentSizeChanged | ( | ) | [inline, virtual, inherited] |
notification that one of the views parent has changed its size
Reimplemented in CTextEdit, and CViewContainer.
conversion from frame coordinates to local view coordinates
point | location |
Reimplemented in CViewContainer.
conversion from local view coordinates to frame coordinates
point | location |
Reimplemented in CViewContainer.
virtual void setAutosizeFlags | ( | long | flags | ) | [inline, virtual, inherited] |
set autosize flags
virtual long getAutosizeFlags | ( | ) | const [inline, virtual, inherited] |
get autosize flags
void looseFocus | ( | ) | [virtual, inherited] |
called if view should loose focus
Reimplemented in CTextEdit, COptionMenu, and CViewContainer.
void takeFocus | ( | ) | [virtual, inherited] |
called if view should take focus
Reimplemented in CTextEdit, COptionMenu, and CViewContainer.
virtual bool wantsFocus | ( | ) | const [inline, virtual, inherited] |
check if view supports focus
virtual void setWantsFocus | ( | bool | state | ) | [inline, virtual, inherited] |
set focus support on/off
bool getAttributeSize | ( | const CViewAttributeID | id, | |
long & | outSize | |||
) | const [inherited] |
get the size of an attribute
id | the ID of the Attribute | |
outSize | on return the size of the attribute |
bool getAttribute | ( | const CViewAttributeID | id, | |
const long | inSize, | |||
void * | outData, | |||
long & | outSize | |||
) | const [inherited] |
get an attribute
id | 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 |
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.
id | the ID of the Attribute | |
inSize | the size of the outData pointer | |
inData | a pointer to the data |
bool removeAttribute | ( | const CViewAttributeID | id | ) | [inherited] |
remove an attribute
void setBackground | ( | CBitmap * | background | ) | [virtual, inherited] |
set the background image of this view
background | new background bitmap |
virtual CBitmap* getBackground | ( | ) | const [inline, virtual, inherited] |
get the background image of this view
virtual void setTransparency | ( | bool | val | ) | [inline, virtual, inherited] |
set views transparent state
Reimplemented in CScrollView.
virtual bool getTransparency | ( | ) | const [inline, virtual, inherited] |
get views transparent state
bool removed | ( | CView * | parent | ) | [virtual, inherited] |
view is removed from parent view
parent | parent view |
Reimplemented in CVuMeter, and CViewContainer.
bool attached | ( | CView * | parent | ) | [virtual, inherited] |
view is attached to a parent view
parent | parent view |
Reimplemented in CDataBrowser, CVuMeter, and CViewContainer.
bool isAttached | ( | ) | const [inline, inherited] |
is view attached to a parentView
CView* getParentView | ( | ) | const [inline, inherited] |
get parent view
CFrame* getFrame | ( | ) | const [inline, inherited] |
get frame
VSTGUIEditorInterface * getEditor | ( | ) | const [virtual, inherited] |
get editor
Reimplemented in CFrame.
virtual bool isTypeOf | ( | const char * | s | ) | const [inline, virtual, inherited] |
virtual CView* newCopy | ( | ) | const [inline, virtual, inherited] |
CMessageResult notify | ( | CBaseObject * | sender, | |
const char * | message | |||
) | [virtual, inherited] |
sender | message sender | |
message | message text |
Reimplemented from CBaseObject.
Reimplemented in CDataBrowser, CScrollbar, and CViewContainer.
VSTGUI_DEPRECATED | ( | virtual void mouse(CDrawContext *pContext, CPoint &where, long buttons=-1); | ) | [inherited] |
VSTGUI_DEPRECATED | ( | ) | [inline, inherited] |
<
virtual void forget | ( | ) | [inline, virtual, inherited] |
decrease refcount and delete object if refcount == 0
Reimplemented in CDrawContext.
virtual void remember | ( | ) | [inline, virtual, inherited] |
increase refcount
long getNbReference | ( | ) | const [inline, inherited] |
get refcount
long iNumbers [protected] |
long xpos[7] [protected] |
long ypos[7] [protected] |
long width [protected] |
long height [protected] |
VSTGUI_DEPRECATED (bool isDoubleClick ();) protected long tag [inherited] |
float oldValue [inherited] |
float defaultValue [inherited] |
float value [inherited] |
float vmin [inherited] |
float vmax [inherited] |
float wheelInc [inherited] |
long lastTicks [inherited] |
long delta [inherited] |
CPoint backOffset [inherited] |
VSTGUI_DEPRECATED (virtual void getFrameTopLeftPos (CPoint& topLeft) const;) protected CRect mouseableArea [inherited] |
CFrame* pParentFrame [inherited] |
CView* pParentView [inherited] |
bool bDirty [inherited] |
bool bMouseEnabled [inherited] |
bool bTransparencyEnabled [inherited] |
bool bWantsFocus [inherited] |
bool bIsAttached [inherited] |
bool bVisible [inherited] |
long autosizeFlags [inherited] |
CBitmap* pBackground [inherited] |
CAttributeListEntry* pAttributeList [inherited] |