simple auto-animation of bitmaps More...
#include <vstcontrols.h>
Public Member Functions | |
virtual | ~CAutoAnimation () |
virtual void | draw (CDrawContext *) |
called if the view should draw itself | |
virtual CMouseEventResult | onMouseDown (CPoint &where, const long &buttons) |
called when a mouse down event occurs | |
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) |
virtual DEPRECATED_ATTRIBUTE void | mouse (CDrawContext *pContext, CPoint &where, long buttons=-1) |
virtual DEPRECATED_ATTRIBUTE void | getMouseLocation (CDrawContext *context, CPoint &point) |
virtual DEPRECATED_ATTRIBUTE void | setParentView (CView *pParentView) |
virtual DEPRECATED_ATTRIBUTE void | setFrame (CFrame *pParent) |
virtual DEPRECATED_ATTRIBUTE void | getFrameTopLeftPos (CPoint &topLeft) const |
virtual void | setHeightOfOneImage (const CCoord &height) |
virtual CCoord | getHeightOfOneImage () const |
virtual void | autoComputeHeightOfOneImage () |
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 |
Protected Attributes | |
CPoint | offset |
long | subPixmaps |
CCoord | totalHeightOfBitmap |
bool | bWindowOpened |
CRect | size |
CRect | mouseableArea |
CFrame * | pParentFrame |
CView * | pParentView |
bool | bDirty |
bool | bMouseEnabled |
bool | bTransparencyEnabled |
bool | bWantsFocus |
bool | bIsAttached |
bool | bVisible |
long | autosizeFlags |
CBitmap * | pBackground |
CAttributeListEntry * | pAttributeList |
CCoord | heightOfOneImage |
Constructor | |
| |
CAutoAnimation (const CRect &size, CControlListener *listener, long tag, CBitmap *background, const CPoint &offset=CPoint(0, 0)) | |
CAutoAnimation (const CRect &size, CControlListener *listener, long tag, long subPixmaps, CCoord heightOfOneImage, CBitmap *background, const CPoint &offset=CPoint(0, 0)) | |
CAutoAnimation (const CAutoAnimation &autoAnimation) | |
CAutoAnimation Methods | |
| |
virtual void | openWindow (void) |
enabled drawing | |
virtual void | closeWindow (void) |
disable drawing | |
virtual void | nextPixmap (void) |
the next sub bitmap should be displayed | |
virtual void | previousPixmap (void) |
the previous sub bitmap should be displayed | |
bool | isWindowOpened () 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 | 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 | |
Message Methods | |
| |
virtual CMessageResult | notify (CBaseObject *sender, const char *message) |
Reference Counting Methods | |
| |
virtual void | forget () |
decrease refcount and delete object if refcount == 0 | |
virtual void | remember () |
increase refcount | |
long | getNbReference () const |
get refcount |
simple auto-animation of bitmaps
An auto-animation control contains a given number of subbitmap which can be displayed in loop. Two functions allows to get the previous or the next subbitmap (these functions increase or decrease the current value of this control).
CAutoAnimation | ( | const CRect & | size, | |
CControlListener * | listener, | |||
long | tag, | |||
CBitmap * | background, | |||
const CPoint & | offset = CPoint (0, 0) | |||
) |
CAutoAnimation constructor.
size | the size of this view | |
listener | the listener | |
tag | the control tag | |
background | the bitmap | |
offset | unused |
CAutoAnimation | ( | const CRect & | size, | |
CControlListener * | listener, | |||
long | tag, | |||
long | subPixmaps, | |||
CCoord | heightOfOneImage, | |||
CBitmap * | background, | |||
const CPoint & | offset = CPoint (0, 0) | |||
) |
CAutoAnimation constructor.
size | the size of this view | |
listener | the listener | |
tag | the control tag | |
subPixmaps | number of sub bitmaps in background | |
heightOfOneImage | height of one sub bitmap | |
background | the bitmap | |
offset | unused |
CAutoAnimation | ( | const CAutoAnimation & | autoAnimation | ) |
~CAutoAnimation | ( | ) | [virtual] |
bool attached | ( | CView * | parent | ) | [virtual, inherited] |
view is attached to a parent view
parent | parent view |
void autoComputeHeightOfOneImage | ( | ) | [virtual, inherited] |
void beginEdit | ( | ) | [virtual, inherited] |
void bounceValue | ( | ) | [virtual, inherited] |
bool checkDefaultValue | ( | long | button | ) | [virtual, inherited] |
virtual bool checkUpdate | ( | const CRect & | updateRect | ) | const [inline, virtual, inherited] |
void closeWindow | ( | void | ) | [virtual] |
disable drawing
void copyBackOffset | ( | ) | [virtual, inherited] |
virtual void doIdleStuff | ( | ) | [inline, virtual, inherited] |
void draw | ( | CDrawContext * | pContext | ) | [virtual] |
called if the view should draw itself
pContext | draw context in which to draw |
Implements CControl.
virtual void drawRect | ( | CDrawContext * | pContext, | |
const CRect & | updateRect | |||
) | [inline, virtual, inherited] |
called if the view should draw itself
Reimplemented in CViewContainer, and CFrame.
void endEdit | ( | ) | [virtual, inherited] |
virtual void forget | ( | ) | [inline, virtual, inherited] |
decrease refcount and delete object if refcount == 0
Reimplemented in CDrawContext.
conversion from frame coordinates to local view coordinates
point | location |
Reimplemented in CViewContainer.
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 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 |
virtual long getAutosizeFlags | ( | ) | const [inline, virtual, inherited] |
get autosize flags
virtual CBitmap* getBackground | ( | ) | const [inline, virtual, inherited] |
get the background image of this view
virtual float getDefaultValue | ( | void | ) | const [inline, virtual, inherited] |
VSTGUIEditorInterface * getEditor | ( | ) | const [virtual, inherited] |
get editor
Reimplemented in CFrame.
CFrame* getFrame | ( | ) | const [inline, inherited] |
get frame
void getFrameTopLeftPos | ( | CPoint & | topLeft | ) | const [virtual, inherited] |
CCoord getHeight | ( | ) | const [inline, inherited] |
get the height of the view
virtual CCoord getHeightOfOneImage | ( | ) | const [inline, virtual, inherited] |
virtual CControlListener* getListener | ( | ) | const [inline, virtual, inherited] |
virtual float getMax | ( | ) | const [inline, virtual, inherited] |
virtual float getMin | ( | ) | const [inline, virtual, inherited] |
virtual const CRect& getMouseableArea | ( | ) | const [inline, virtual, inherited] |
read only access to the mouseable area
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
void getMouseLocation | ( | CDrawContext * | context, | |
CPoint & | point | |||
) | [virtual, inherited] |
long getNbReference | ( | ) | const [inline, inherited] |
get refcount
virtual float getOldValue | ( | void | ) | const [inline, virtual, inherited] |
CView* getParentView | ( | ) | const [inline, inherited] |
get parent view
virtual long getTag | ( | ) | const [inline, virtual, inherited] |
virtual bool getTransparency | ( | ) | const [inline, virtual, inherited] |
get views transparent state
virtual float getValue | ( | ) | const [inline, virtual, inherited] |
virtual const CRect& getViewSize | ( | ) | const [inline, virtual, inherited] |
read only access to view size
returns the current view size
CRect getVisibleSize | ( | ) | const [virtual, inherited] |
returns the visible size of the view
virtual float getWheelInc | ( | ) | const [inline, virtual, inherited] |
CCoord getWidth | ( | ) | const [inline, inherited] |
get the width of the view
virtual bool hitTest | ( | const CPoint & | where, | |
const long | buttons = -1 | |||
) | [inline, virtual, inherited] |
check if where hits this view
Reimplemented in CSplashScreen, and CViewContainer.
virtual void invalid | ( | ) | [inline, virtual, inherited] |
mark whole view as invalid
Reimplemented in CViewContainer, and CFrame.
void invalidRect | ( | const CRect | rect | ) | [virtual, inherited] |
mark rect as invalid
rect | rect to invalidate |
Reimplemented in CViewContainer, and CFrame.
bool isAttached | ( | ) | const [inline, inherited] |
is view attached to a parentView
bool isDirty | ( | ) | const [virtual, inherited] |
virtual bool isTypeOf | ( | const char * | s | ) | const [inline, virtual, inherited] |
Reimplemented in CViewContainer, and CFrame.
bool isVisible | ( | ) | const [inline, inherited] |
get visibility state
bool isWindowOpened | ( | ) | const [inline] |
conversion from local view coordinates to frame coordinates
point | location |
Reimplemented in CViewContainer.
void looseFocus | ( | ) | [virtual, inherited] |
called if view should loose focus
Reimplemented in CTextEdit, COptionMenu, and CViewContainer.
void mouse | ( | CDrawContext * | pContext, | |
CPoint & | where, | |||
long | buttons = -1 | |||
) | [virtual, inherited] |
Reimplemented in CViewContainer, and CFrame.
virtual CView* newCopy | ( | ) | const [inline, virtual, inherited] |
Reimplemented in CViewContainer, and CFrame.
void nextPixmap | ( | void | ) | [virtual] |
the next sub bitmap should be displayed
virtual CMessageResult notify | ( | CBaseObject * | sender, | |
const char * | message | |||
) | [inline, virtual, inherited] |
CMessageResult notify | ( | CBaseObject * | sender, | |
const char * | message | |||
) | [inherited] |
sender | message sender | |
message | message text |
Reimplemented in CDataBrowser, CScrollbar, and 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.
virtual bool onDrop | ( | CDragContainer * | drag, | |
const CPoint & | where | |||
) | [inline, virtual, inherited] |
called if a drag is dropped onto 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.
CMouseEventResult onMouseDown | ( | CPoint & | where, | |
const long & | buttons | |||
) | [virtual] |
called when a mouse down event occurs
where | mouse location of mouse down | |
buttons | button and modifier state |
Reimplemented from CView.
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.
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.
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.
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.
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.
void openWindow | ( | void | ) | [virtual] |
enabled drawing
virtual void parentSizeChanged | ( | ) | [inline, virtual, inherited] |
notification that one of the views parent has changed its size
Reimplemented in CTextEdit, and CViewContainer.
void previousPixmap | ( | void | ) | [virtual] |
the previous sub bitmap should be displayed
virtual void remember | ( | ) | [inline, virtual, inherited] |
increase refcount
bool removeAttribute | ( | const CViewAttributeID | id | ) | [inherited] |
remove an attribute
bool removed | ( | CView * | parent | ) | [virtual, inherited] |
view is removed from parent view
parent | parent view |
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 |
virtual void setAutosizeFlags | ( | long | flags | ) | [inline, virtual, inherited] |
set autosize flags
void setBackground | ( | CBitmap * | background | ) | [virtual, inherited] |
set the background image of this view
background | new background bitmap |
void setBackOffset | ( | CPoint & | offset | ) | [virtual, inherited] |
virtual void setDefaultValue | ( | float | val | ) | [inline, virtual, inherited] |
void setDirty | ( | const bool | val = true |
) | [virtual, inherited] |
virtual DEPRECATED_ATTRIBUTE void setFrame | ( | CFrame * | pParent | ) | [inline, virtual, inherited] |
virtual void setHeightOfOneImage | ( | const CCoord & | height | ) | [inline, virtual, inherited] |
Reimplemented in CAnimKnob.
virtual void setListener | ( | CControlListener * | l | ) | [inline, virtual, inherited] |
virtual void setMax | ( | float | val | ) | [inline, virtual, inherited] |
virtual void setMin | ( | float | val | ) | [inline, virtual, inherited] |
virtual void setMouseableArea | ( | const CRect & | rect | ) | [inline, virtual, inherited] |
set the area in which the view reacts to the mouse
virtual void setMouseEnabled | ( | const bool | bEnable = true |
) | [inline, virtual, inherited] |
turn on/off mouse usage for this view
virtual void setOldValue | ( | float | val | ) | [inline, virtual, inherited] |
virtual DEPRECATED_ATTRIBUTE void setParentView | ( | CView * | pParentView | ) | [inline, virtual, inherited] |
virtual void setTag | ( | long | val | ) | [inline, virtual, inherited] |
virtual void setTransparency | ( | bool | val | ) | [inline, virtual, inherited] |
set views transparent state
Reimplemented in CScrollView.
virtual void setValue | ( | float | val | ) | [inline, virtual, inherited] |
Reimplemented in COptionMenu.
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.
void setVisible | ( | bool | state | ) | [virtual, inherited] |
set visibility state
virtual void setWantsFocus | ( | bool | state | ) | [inline, virtual, inherited] |
set focus support on/off
virtual void setWheelInc | ( | float | val | ) | [inline, virtual, inherited] |
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
long autosizeFlags [protected, inherited] |
CPoint backOffset [inherited] |
bool bDirty [protected, inherited] |
bool bIsAttached [protected, inherited] |
bool bMouseEnabled [protected, inherited] |
bool bTransparencyEnabled [protected, inherited] |
bool bVisible [protected, inherited] |
bool bWantsFocus [protected, inherited] |
bool bWindowOpened [protected] |
float defaultValue [inherited] |
long delta [inherited] |
CCoord heightOfOneImage [protected, inherited] |
long lastTicks [inherited] |
CRect mouseableArea [protected, inherited] |
float oldValue [inherited] |
CAttributeListEntry* pAttributeList [protected, inherited] |
CBitmap* pBackground [protected, inherited] |
CFrame* pParentFrame [protected, inherited] |
CView* pParentView [protected, inherited] |
long subPixmaps [protected] |
VSTGUI_DEPRECATED (bool isDoubleClick ();) protected long tag [inherited] |
CCoord totalHeightOfBitmap [protected] |
float value [inherited] |
float vmax [inherited] |
float vmin [inherited] |
float wheelInc [inherited] |