a horizontal slider control More...
Public Types | |
enum | Mode { kTouchMode, kRelativeTouchMode, kFreeClickMode } |
Public Member Functions | |
CHorizontalSlider (const CRect &size, CControlListener *listener, int32_t tag, int32_t iMinPos, int32_t iMaxPos, CBitmap *handle, CBitmap *background, const CPoint &offset=CPoint(0, 0), const int32_t style=kRight) | |
CHorizontalSlider (const CRect &rect, CControlListener *listener, int32_t tag, const CPoint &offsetHandle, int32_t rangeHandle, CBitmap *handle, CBitmap *background, const CPoint &offset=CPoint(0, 0), const int32_t style=kRight) | |
CHorizontalSlider (const CHorizontalSlider &slider) | |
virtual void | draw (CDrawContext *) |
called if the view should draw itself | |
virtual CMouseEventResult | onMouseDown (CPoint &where, const CButtonState &buttons) |
called when a mouse down event occurs | |
virtual CMouseEventResult | onMouseUp (CPoint &where, const CButtonState &buttons) |
called when a mouse up event occurs | |
virtual CMouseEventResult | onMouseMoved (CPoint &where, const CButtonState &buttons) |
called when a mouse move event occurs | |
virtual CMouseEventResult | onMouseCancel () |
called when mouse tracking should be canceled | |
virtual bool | onWheel (const CPoint &where, const float &distance, const CButtonState &buttons) |
called if a mouse wheel event is happening over this view | |
virtual int32_t | onKeyDown (VstKeyCode &keyCode) |
called if a key down event occurs and this view has focus | |
virtual bool | sizeToFit () |
resize view to optimal size | |
bool | isDirty () const |
check if view is dirty | |
void | setDirty (bool val=true) |
set the view to dirty so that it is redrawn in the next idle. Thread Safe ! | |
bool | drawFocusOnTop () |
bool | getFocusPath (CGraphicsPath &outPath) |
CMessageResult | notify (CBaseObject *sender, IdStringPtr message) |
virtual void | addDependency (CBaseObject *obj) |
virtual void | removeDependency (CBaseObject *obj) |
virtual void | changed (IdStringPtr message) |
virtual void | deferChanges (bool state) |
CSlider Methods | |
virtual void | setDrawTransparentHandle (bool val) |
virtual bool | getDrawTransparentHandle () const |
virtual void | setMode (Mode newMode) |
virtual Mode | getMode () const |
virtual void | setOffsetHandle (const CPoint &val) |
virtual CPoint | getOffsetHandle () const |
virtual void | setOffset (const CPoint &val) |
virtual CPoint | getOffset () const |
virtual void | setStyle (int32_t style) |
virtual int32_t | getStyle () const |
virtual void | setHandle (CBitmap *pHandle) |
virtual CBitmap * | getHandle () const |
virtual void | setZoomFactor (float val) |
virtual float | getZoomFactor () const |
VSTGUI_DEPRECATED (virtual void setFreeClick(bool val){setMode(val?kFreeClickMode:kTouchMode);}) VSTGUI_DEPRECATED(virtual bool getFreeClick() const | |
Mouse Methods | |
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 | |
virtual CMouseEventResult | onMouseEntered (CPoint &where, const CButtonState &buttons) |
called when the mouse enters this view | |
virtual CMouseEventResult | onMouseExited (CPoint &where, const CButtonState &buttons) |
called when the mouse leaves this view | |
void | setHitTestPath (CGraphicsPath *path) |
virtual bool | hitTest (const CPoint &where, const CButtonState &buttons=-1) |
check if where hits this view | |
virtual void | setMouseEnabled (bool bEnable=true) |
turn on/off mouse usage for this view | |
virtual bool | getMouseEnabled () const |
get the state of wheather this view uses the mouse or not | |
virtual void | setMouseableArea (const CRect &rect) |
set the area in which the view reacts to the mouse | |
virtual 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 | |
Value Methods | |
virtual void | setValue (float val) |
virtual float | getValue () const |
virtual void | setValueNormalized (float val) |
virtual float | getValueNormalized () const |
virtual void | setMin (float val) |
virtual float | getMin () const |
virtual void | setMax (float val) |
virtual float | getMax () const |
float | getRange () const |
virtual void | setOldValue (float val) |
virtual float | getOldValue (void) const |
virtual void | setDefaultValue (float val) |
virtual float | getDefaultValue (void) const |
virtual void | bounceValue () |
virtual bool | checkDefaultValue (CButtonState button) |
virtual void | valueChanged () |
notifies listener and dependent objects | |
Editing Methods | |
virtual void | setTag (int32_t val) |
virtual int32_t | getTag () const |
virtual void | beginEdit () |
virtual void | endEdit () |
bool | isEditing () const |
virtual CControlListener * | getListener () const |
get main listener | |
virtual void | setListener (CControlListener *l) |
set main listener | |
Misc | |
virtual void | setBackOffset (const CPoint &offset) |
virtual const CPoint & | getBackOffset () const |
virtual void | copyBackOffset () |
virtual void | setWheelInc (float val) |
virtual float | getWheelInc () const |
Touch Event Handling Methods | |
virtual void | onTouchEvent (ITouchEvent &event) |
virtual bool | wantsMultiTouchEvents () const |
Keyboard Methods | |
virtual int32_t | onKeyUp (VstKeyCode &keyCode) |
called if a key up event occurs and this view has focus | |
View Size Methods | |
CCoord | getHeight () const |
get the height of the view | |
CCoord | getWidth () const |
get the width of the view | |
CRect & | getViewSize (CRect &rect) const |
returns the current view size | |
const CRect & | getViewSize () const |
read only access to view size | |
virtual CRect | getVisibleViewSize () 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 (int32_t flags) |
set autosize flags | |
virtual int32_t | 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, int32_t &outSize) const |
get the size of an attribute | |
bool | getAttribute (const CViewAttributeID id, const int32_t inSize, void *outData, int32_t &outSize) const |
get an attribute | |
bool | setAttribute (const CViewAttributeID id, const int32_t inSize, const void *inData) |
set an attribute | |
bool | removeAttribute (const CViewAttributeID id) |
remove an attribute | |
Background Methods | |
virtual void | setBackground (CBitmap *background) |
set the background image of this view | |
CBitmap * | getBackground () const |
get the background image of this view | |
virtual void | setDisabledBackground (CBitmap *background) |
set background image used when the mouse is not enabled | |
CBitmap * | getDisabledBackground () const |
get background image used when the mouse is not enabled | |
CBitmap * | getDrawBackground () const |
Transparency Methods | |
virtual void | setTransparency (bool val) |
set views transparent state | |
virtual bool | getTransparency () const |
get views transparent state | |
virtual void | setAlphaValue (float alpha) |
set alpha value which will be applied when drawing this view | |
float | getAlphaValue () const |
get alpha value | |
Attaching Methods | |
virtual bool | removed (CView *parent) |
view is removed from parent view | |
virtual bool | attached (CView *parent) |
view is attached to a parent view | |
bool | isAttached () const |
is view attached to a parentView | |
Parent Methods | |
CView * | getParentView () const |
get parent view | |
CFrame * | getFrame () const |
get frame | |
virtual VSTGUIEditorInterface * | getEditor () const |
get editor | |
Animation Methods | |
void | addAnimation (IdStringPtr name, Animation::IAnimationTarget *target, Animation::ITimingFunction *timingFunction, CBaseObject *notificationObject=0) |
void | removeAnimation (IdStringPtr name) |
void | removeAllAnimations () |
Message Methods | |
virtual CMessageResult | notify (CBaseObject *sender, IdStringPtr message) |
Reference Counting Methods | |
virtual void | forget () |
decrease refcount and delete object if refcount == 0 | |
virtual void | remember () |
increase refcount | |
virtual int32_t | getNbReference () const |
get refcount | |
Static Public Attributes | |
static bool | kAlwaysUseZoomFactor = false |
static int32_t | kZoomModifier = kShift |
zoom modifier key, per default is the shift key | |
static int32_t | kDefaultValueModifier = kControl |
default value modifier key, per default is the control key | |
static IdStringPtr | kMessageTagWillChange = "kMessageTagWillChange" |
static IdStringPtr | kMessageTagDidChange = "kMessageTagDidChange" |
static IdStringPtr | kMessageValueChanged = "kMessageValueChanged" |
static IdStringPtr | kMessageBeginEdit = "kMessageBeginEdit" |
static IdStringPtr | kMessageEndEdit = "kMessageEndEdit" |
Protected Types | |
enum | { kMouseEnabled = 1 << 0, kTransparencyEnabled = 1 << 1, kWantsFocus = 1 << 2, kIsAttached = 1 << 3, kVisible = 1 << 4, kDirty = 1 << 5, kWantsIdle = 1 << 6, kLastCViewFlag = 6 } |
typedef std::set< IdStringPtr > | DeferedChangesSet |
typedef std::list< CBaseObject * > | DependentList |
Protected Member Functions | |
void | setViewSize (const CRect &rect, bool invalid) |
set views size | |
float | calculateDelta (const CPoint &where, CRect *handleRect=0) const |
CGraphicsPath * | getHitTestPath () const |
Static Protected Member Functions | |
static int32_t | mapVstKeyModifier (int32_t vstModifier) |
static void | rememberObject (CBaseObject *obj) |
static void | forgetObject (CBaseObject *obj) |
Protected Attributes | |
CPoint | offset |
CPoint | offsetHandle |
CBitmap * | pHandle |
int32_t | style |
Mode | mode |
CCoord | widthOfSlider |
CCoord | heightOfSlider |
CCoord | rangeHandle |
CCoord | minTmp |
CCoord | maxTmp |
CCoord | minPos |
CCoord | widthControl |
CCoord | heightControl |
float | zoomFactor |
bool | bDrawTransparentEnabled |
int32_t | drawStyle |
CColor | frameColor |
CColor | backColor |
CColor | valueColor |
CControlListener * | listener |
int32_t | tag |
float | oldValue |
float | defaultValue |
float | value |
float | vmin |
float | vmax |
float | wheelInc |
int32_t | editing |
CPoint | backOffset |
CRect | size |
CRect | mouseableArea |
CFrame * | pParentFrame |
CView * | pParentView |
int32_t | viewFlags |
int32_t | autosizeFlags |
float | alphaValue |
int32_t | deferChangeCount |
DeferedChangesSet | deferedChanges |
DependentList | dependents |
Draw Style Methods | |
| |
virtual void | setDrawStyle (int32_t style) |
virtual void | setFrameColor (CColor color) |
virtual void | setBackColor (CColor color) |
virtual void | setValueColor (CColor color) |
int32_t | getDrawStyle () const |
CColor | getFrameColor () const |
CColor | getBackColor () const |
CColor | getValueColor () const |
enum | DrawStyle { kDrawFrame = 1 << 0, kDrawBack = 1 << 1, kDrawValue = 1 << 2, kDrawValueFromCenter = 1 << 3, kDrawInverted = 1 << 4 } |
Draw and Update Methods | |
| |
virtual void | drawRect (CDrawContext *pContext, const CRect &updateRect) |
called if the view should draw itself | |
virtual bool | checkUpdate (const CRect &updateRect) const |
virtual void | invalidRect (const CRect &rect) |
mark rect as invalid | |
virtual void | invalid () |
mark whole view as invalid | |
virtual void | setVisible (bool state) |
set visibility state | |
bool | isVisible () const |
get visibility state | |
static bool | kDirtyCallAlwaysOnMainThread = false |
if this is true, setting a view dirty will call invalid() instead of checking it in idle. Default value is false. | |
Drag & Drop Methods | |
| |
virtual DragResult | doDrag (IDataPackage *source, const CPoint &offset=CPoint(0, 0), CBitmap *dragBitmap=0) |
start a drag operation. See CDropSource to create the source data package | |
virtual bool | onDrop (IDataPackage *drag, const CPoint &where) |
called if a drag is dropped onto this view | |
virtual void | onDragEnter (IDataPackage *drag, const CPoint &where) |
called if a drag is entering this view | |
virtual void | onDragLeave (IDataPackage *drag, const CPoint &where) |
called if a drag is leaving this view | |
virtual void | onDragMove (IDataPackage *drag, const CPoint &where) |
called if a drag is moved inside this view | |
enum | DragResult { kDragRefused = 0, kDragMoved, kDragCopied, kDragError = -1 } |
Idle Methods | |
Should be used when a view needs to do a task periodically. The onIdle() method will be called only if the view is attached. | |
virtual void | onIdle () |
called on idle when view wants idle | |
void | setWantsIdle (bool state) |
enable/disable onIdle() callback | |
bool | wantsIdle () const |
returns if the view wants idle callback or not | |
static int32_t | idleRate |
global idle rate in Hz, defaults to 30 Hz |
a horizontal slider control
This is the horizontal slider. See CSlider.
typedef std::set<IdStringPtr> DeferedChangesSet [protected, inherited] |
typedef std::list<CBaseObject*> DependentList [protected, inherited] |
anonymous enum [protected, inherited] |
enum DragResult [inherited] |
enum DrawStyle [inherited] |
enum Mode [inherited] |
CHorizontalSlider | ( | const CRect & | rect, | |
CControlListener * | listener, | |||
int32_t | tag, | |||
int32_t | iMinPos, | |||
int32_t | iMaxPos, | |||
CBitmap * | handle, | |||
CBitmap * | background, | |||
const CPoint & | offset = CPoint (0, 0) , |
|||
const int32_t | style = kRight | |||
) |
CHorizontalSlider constructor.
rect | the size of this view | |
listener | the listener | |
tag | the control tag | |
iMinPos | min position in pixel | |
iMaxPos | max position in pixel | |
handle | bitmap of the slider | |
background | bitmap of the background | |
offset | offset of the background | |
style | style (kLeft, kRight) |
CHorizontalSlider | ( | const CRect & | rect, | |
CControlListener * | listener, | |||
int32_t | tag, | |||
const CPoint & | offsetHandle, | |||
int32_t | rangeHandle, | |||
CBitmap * | handle, | |||
CBitmap * | background, | |||
const CPoint & | offset = CPoint (0, 0) , |
|||
const int32_t | style = kRight | |||
) |
CHorizontalSlider constructor.
rect | the size of this view | |
listener | the listener | |
tag | the control tag | |
offsetHandle | handle offset | |
rangeHandle | size of handle range | |
handle | bitmap of the slider | |
background | bitmap of the background | |
offset | offset of the background | |
style | style (kLeft, kRight) |
CHorizontalSlider | ( | const CHorizontalSlider & | slider | ) |
void addAnimation | ( | IdStringPtr | name, | |
Animation::IAnimationTarget * | target, | |||
Animation::ITimingFunction * | timingFunction, | |||
CBaseObject * | notificationObject = 0 | |||
) | [inherited] |
void addDependency | ( | CBaseObject * | obj | ) | [inline, virtual, inherited] |
add a dependent object
bool attached | ( | CView * | parent | ) | [virtual, inherited] |
view is attached to a parent view
parent | parent view |
void beginEdit | ( | ) | [virtual, inherited] |
void bounceValue | ( | ) | [virtual, inherited] |
void changed | ( | IdStringPtr | message | ) | [inline, virtual, inherited] |
notify dependent objects of change with message.
bool checkDefaultValue | ( | CButtonState | button | ) | [virtual, inherited] |
virtual bool checkUpdate | ( | const CRect & | updateRect | ) | const [inline, virtual, inherited] |
void copyBackOffset | ( | ) | [virtual, inherited] |
void deferChanges | ( | bool | state | ) | [inline, virtual, inherited] |
defer changes until later. can be nested. If you use this, you must make sure that all message pointers are valid the whole time.
CView::DragResult doDrag | ( | IDataPackage * | source, | |
const CPoint & | offset = CPoint (0, 0) , |
|||
CBitmap * | dragBitmap = 0 | |||
) | [virtual, inherited] |
start a drag operation. See CDropSource to create the source data package
a drag can only be started from within onMouseDown
source | source drop | |
offset | bitmap offset | |
dragBitmap | bitmap to drag |
Reimplemented in CFrame.
void draw | ( | CDrawContext * | pContext | ) | [virtual, inherited] |
called if the view should draw itself
pContext | draw context in which to draw |
Implements CControl.
bool drawFocusOnTop | ( | ) | [virtual, inherited] |
draw focus before view will be drawn or afterwards
Implements IFocusDrawing.
Reimplemented in CKnob.
virtual void drawRect | ( | CDrawContext * | pContext, | |
const CRect & | updateRect | |||
) | [inline, virtual, inherited] |
called if the view should draw itself
Reimplemented in CFrame, CLayeredViewContainer, CShadowViewContainer, and CViewContainer.
void endEdit | ( | ) | [virtual, inherited] |
virtual void forget | ( | ) | [inline, virtual, inherited] |
decrease refcount and delete object if refcount == 0
static void forgetObject | ( | CBaseObject * | obj | ) | [inline, static, protected, inherited] |
conversion from frame coordinates to local view coordinates
point | location |
Reimplemented in CViewContainer.
float getAlphaValue | ( | ) | const [inline, inherited] |
get alpha value
bool getAttribute | ( | const CViewAttributeID | aId, | |
const int32_t | inSize, | |||
void * | outData, | |||
int32_t & | outSize | |||
) | const [inherited] |
get an attribute
aId | the ID of the Attribute | |
inSize | the size of the outData pointer | |
outData | a pointer where to copy the attribute data | |
outSize | the size in bytes which was copied into outData |
bool getAttributeSize | ( | const CViewAttributeID | aId, | |
int32_t & | outSize | |||
) | const [inherited] |
get the size of an attribute
aId | the ID of the Attribute | |
outSize | on return the size of the attribute |
virtual int32_t getAutosizeFlags | ( | ) | const [inline, virtual, inherited] |
get autosize flags
CColor getBackColor | ( | ) | const [inline, inherited] |
CBitmap* getBackground | ( | ) | const [inline, inherited] |
get the background image of this view
virtual const CPoint& getBackOffset | ( | ) | const [inline, virtual, inherited] |
virtual float getDefaultValue | ( | void | ) | const [inline, virtual, inherited] |
CBitmap* getDisabledBackground | ( | ) | const [inline, inherited] |
get background image used when the mouse is not enabled
CBitmap* getDrawBackground | ( | ) | const [inline, inherited] |
int32_t getDrawStyle | ( | ) | const [inline, inherited] |
virtual bool getDrawTransparentHandle | ( | ) | const [inline, virtual, inherited] |
VSTGUIEditorInterface * getEditor | ( | ) | const [virtual, inherited] |
get editor
Reimplemented in CFrame.
bool getFocusPath | ( | CGraphicsPath & | outPath | ) | [virtual, inherited] |
the graphics path will be drawn filled with the evenodd method and the color set in CFrame::setFocusColor()
Implements IFocusDrawing.
Reimplemented in CCheckBox, CTextButton, CKnob, and CParamDisplay.
CFrame* getFrame | ( | ) | const [inline, inherited] |
get frame
CColor getFrameColor | ( | ) | const [inline, inherited] |
virtual CBitmap* getHandle | ( | ) | const [inline, virtual, inherited] |
CCoord getHeight | ( | ) | const [inline, inherited] |
get the height of the view
CGraphicsPath* getHitTestPath | ( | ) | const [inline, protected, inherited] |
virtual CControlListener* getListener | ( | ) | const [inline, virtual, inherited] |
get main listener
virtual float getMax | ( | ) | const [inline, virtual, inherited] |
Reimplemented in COptionMenu.
virtual float getMin | ( | ) | const [inline, virtual, inherited] |
Reimplemented in COptionMenu.
virtual Mode getMode | ( | ) | 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
virtual int32_t getNbReference | ( | ) | const [inline, virtual, inherited] |
get refcount
virtual CPoint getOffset | ( | ) | const [inline, virtual, inherited] |
virtual CPoint getOffsetHandle | ( | ) | const [inline, virtual, inherited] |
virtual float getOldValue | ( | void | ) | const [inline, virtual, inherited] |
CView* getParentView | ( | ) | const [inline, inherited] |
get parent view
float getRange | ( | ) | const [inline, inherited] |
virtual int32_t getStyle | ( | ) | const [inline, virtual, inherited] |
virtual int32_t getTag | ( | ) | const [inline, virtual, inherited] |
virtual bool getTransparency | ( | ) | const [inline, virtual, inherited] |
get views transparent state
virtual float getValue | ( | ) | const [inline, virtual, inherited] |
CColor getValueColor | ( | ) | const [inline, inherited] |
float getValueNormalized | ( | ) | const [virtual, inherited] |
const CRect& getViewSize | ( | ) | const [inline, inherited] |
read only access to view size
CRect getVisibleViewSize | ( | ) | 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 float getZoomFactor | ( | ) | const [inline, virtual, inherited] |
bool hitTest | ( | const CPoint & | where, | |
const CButtonState & | buttons = -1 | |||
) | [virtual, inherited] |
check if where hits this view
where | location | |
buttons | button and modifier state |
Reimplemented in CSplashScreen, and CViewContainer.
virtual void invalid | ( | ) | [inline, virtual, inherited] |
mark whole view as invalid
Reimplemented in CFrame, and CViewContainer.
void invalidRect | ( | const CRect & | rect | ) | [virtual, inherited] |
mark rect as invalid
rect | rect to invalidate |
Reimplemented in CFrame, CLayeredViewContainer, COpenGLView, and CViewContainer.
bool isAttached | ( | ) | const [inline, inherited] |
is view attached to a parentView
bool isDirty | ( | ) | const [virtual, inherited] |
check if view is dirty
Reimplemented from CView.
bool isEditing | ( | ) | const [inline, inherited] |
bool isVisible | ( | ) | const [inline, inherited] |
get visibility state
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 COptionMenu, CTextEdit, and CViewContainer.
int32_t mapVstKeyModifier | ( | int32_t | vstModifier | ) | [static, protected, inherited] |
virtual CMessageResult notify | ( | CBaseObject * | sender, | |
IdStringPtr | message | |||
) | [inline, virtual, inherited] |
CMessageResult notify | ( | CBaseObject * | sender, | |
IdStringPtr | message | |||
) | [inherited] |
sender | message sender | |
message | message text |
Reimplemented in CDataBrowser, CAnimationSplashScreen, CRockerSwitch, CRowColumnView, CScrollView, CScrollbar, CShadowViewContainer, and CViewContainer.
virtual void onDragEnter | ( | IDataPackage * | drag, | |
const CPoint & | where | |||
) | [inline, virtual, inherited] |
called if a drag is entering this view
Reimplemented in CViewContainer.
virtual void onDragLeave | ( | IDataPackage * | drag, | |
const CPoint & | where | |||
) | [inline, virtual, inherited] |
called if a drag is leaving this view
Reimplemented in CViewContainer.
virtual void onDragMove | ( | IDataPackage * | drag, | |
const CPoint & | where | |||
) | [inline, virtual, inherited] |
called if a drag is moved inside this view
Reimplemented in CViewContainer.
virtual bool onDrop | ( | IDataPackage * | drag, | |
const CPoint & | where | |||
) | [inline, virtual, inherited] |
called if a drag is dropped onto this view
Reimplemented in CViewContainer.
virtual void onIdle | ( | ) | [inline, virtual, inherited] |
called on idle when view wants idle
Reimplemented in CVuMeter.
int32_t onKeyDown | ( | VstKeyCode & | keyCode | ) | [virtual, inherited] |
called if a key down event occurs and this view has focus
keyCode | key code of pressed key |
Reimplemented from CView.
int32_t 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 CFrame, CKickButton, CTextButton, and CRockerSwitch.
CMouseEventResult onMouseCancel | ( | ) | [virtual, inherited] |
called when mouse tracking should be canceled
Reimplemented from CView.
CMouseEventResult onMouseDown | ( | CPoint & | where, | |
const CButtonState & | buttons | |||
) | [virtual, inherited] |
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 CButtonState & | buttons | |||
) | [inline, virtual, inherited] |
called when the mouse enters this view
Reimplemented in CScrollbar.
virtual CMouseEventResult onMouseExited | ( | CPoint & | where, | |
const CButtonState & | buttons | |||
) | [inline, virtual, inherited] |
called when the mouse leaves this view
Reimplemented in CFrame, and CScrollbar.
CMouseEventResult onMouseMoved | ( | CPoint & | where, | |
const CButtonState & | buttons | |||
) | [virtual, inherited] |
called when a mouse move event occurs
where | mouse location of mouse move | |
buttons | button and modifier state |
Reimplemented from CView.
CMouseEventResult onMouseUp | ( | CPoint & | where, | |
const CButtonState & | buttons | |||
) | [virtual, inherited] |
called when a mouse up event occurs
where | mouse location of mouse up | |
buttons | button and modifier state |
Reimplemented from CView.
virtual void onTouchEvent | ( | ITouchEvent & | event | ) | [inline, virtual, inherited] |
Reimplemented in CViewContainer.
bool onWheel | ( | const CPoint & | where, | |
const CMouseWheelAxis & | axis, | |||
const float & | distance, | |||
const CButtonState & | buttons | |||
) | [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 CFrame, CTextLabel, CScrollView, CScrollbar, and CViewContainer.
bool onWheel | ( | const CPoint & | where, | |
const float & | distance, | |||
const CButtonState & | 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 from CView.
virtual void parentSizeChanged | ( | ) | [inline, virtual, inherited] |
notification that one of the views parent has changed its size
Reimplemented in CLayeredViewContainer, CTextEdit, COpenGLView, and CViewContainer.
virtual void remember | ( | ) | [inline, virtual, inherited] |
increase refcount
static void rememberObject | ( | CBaseObject * | obj | ) | [inline, static, protected, inherited] |
void removeAllAnimations | ( | ) | [inherited] |
void removeAnimation | ( | IdStringPtr | name | ) | [inherited] |
bool removeAttribute | ( | const CViewAttributeID | id | ) | [inherited] |
remove an attribute
bool removed | ( | CView * | parent | ) | [virtual, inherited] |
view is removed from parent view
parent | parent view |
void removeDependency | ( | CBaseObject * | obj | ) | [inline, virtual, inherited] |
remove a dependent object.
void setAlphaValue | ( | float | alpha | ) | [virtual, inherited] |
set alpha value which will be applied when drawing this view
bool setAttribute | ( | const CViewAttributeID | aId, | |
const int32_t | inSize, | |||
const void * | inData | |||
) | [inherited] |
set an attribute
copies data into the attribute. If it does not exist, creates a new attribute.
aId | the ID of the Attribute | |
inSize | the size of the outData pointer | |
inData | a pointer to the data |
virtual void setAutosizeFlags | ( | int32_t | flags | ) | [inline, virtual, inherited] |
set autosize flags
Reimplemented in CScrollView, and CTabView.
void setBackColor | ( | CColor | color | ) | [virtual, inherited] |
void setBackground | ( | CBitmap * | background | ) | [virtual, inherited] |
void setBackOffset | ( | const CPoint & | offset | ) | [virtual, inherited] |
virtual void setDefaultValue | ( | float | val | ) | [inline, virtual, inherited] |
void setDirty | ( | bool | val = true |
) | [virtual, inherited] |
void setDisabledBackground | ( | CBitmap * | background | ) | [virtual, inherited] |
set background image used when the mouse is not enabled
background | new disabled background bitmap |
void setDrawStyle | ( | int32_t | style | ) | [virtual, inherited] |
virtual void setDrawTransparentHandle | ( | bool | val | ) | [inline, virtual, inherited] |
void setFrameColor | ( | CColor | color | ) | [virtual, inherited] |
void setHandle | ( | CBitmap * | pHandle | ) | [virtual, inherited] |
void setHitTestPath | ( | CGraphicsPath * | path | ) | [inherited] |
path | the path to use for hit testing. The path will be translated by this views origin, so that the path must not be set again, if the view is moved. Otherwise when the size of the view changes, the path must also be set again. |
virtual void setListener | ( | CControlListener * | l | ) | [inline, virtual, inherited] |
set main listener
virtual void setMax | ( | float | val | ) | [inline, virtual, inherited] |
Reimplemented in CKnob, COptionMenu, and CXYPad.
virtual void setMin | ( | float | val | ) | [inline, virtual, inherited] |
Reimplemented in CKnob, COptionMenu, and CXYPad.
virtual void setMode | ( | Mode | newMode | ) | [inline, virtual, inherited] |
virtual void setMouseableArea | ( | const CRect & | rect | ) | [inline, virtual, inherited] |
set the area in which the view reacts to the mouse
void setMouseEnabled | ( | bool | bEnable = true |
) | [virtual, inherited] |
turn on/off mouse usage for this view
virtual void setOffset | ( | const CPoint & | val | ) | [inline, virtual, inherited] |
void setOffsetHandle | ( | const CPoint & | val | ) | [virtual, inherited] |
virtual void setOldValue | ( | float | val | ) | [inline, virtual, inherited] |
void setStyle | ( | int32_t | style | ) | [virtual, inherited] |
void setTag | ( | int32_t | val | ) | [virtual, inherited] |
void setTransparency | ( | bool | val | ) | [virtual, inherited] |
set views transparent state
Reimplemented in CScrollView.
void setValue | ( | float | val | ) | [virtual, inherited] |
Reimplemented in COptionMenu, and CTextEdit.
void setValueColor | ( | CColor | color | ) | [virtual, inherited] |
void setValueNormalized | ( | float | val | ) | [virtual, inherited] |
void setViewSize | ( | const CRect & | newSize, | |
bool | invalid | |||
) | [protected, virtual, inherited] |
set views size
newSize | rect of new size of view | |
invalid | if true set view dirty |
Reimplemented from CView.
void setVisible | ( | bool | state | ) | [virtual, inherited] |
set visibility state
Reimplemented in COpenGLView.
void setWantsFocus | ( | bool | state | ) | [virtual, inherited] |
set focus support on/off
Reimplemented in CDataBrowser.
void setWantsIdle | ( | bool | state | ) | [inherited] |
enable/disable onIdle() callback
virtual void setWheelInc | ( | float | val | ) | [inline, virtual, inherited] |
virtual void setZoomFactor | ( | float | val | ) | [inline, virtual, inherited] |
bool sizeToFit | ( | ) | [virtual, inherited] |
resize view to optimal size
Reimplemented from CView.
void takeFocus | ( | ) | [virtual, inherited] |
called if view should take focus
Reimplemented in COptionMenu, CTextEdit, and CViewContainer.
void valueChanged | ( | ) | [virtual, inherited] |
notifies listener and dependent objects
VSTGUI_DEPRECATED | ( | ) | const [inline, inherited] |
virtual bool wantsFocus | ( | ) | const [inline, virtual, inherited] |
check if view supports focus
bool wantsIdle | ( | ) | const [inline, inherited] |
returns if the view wants idle callback or not
virtual bool wantsMultiTouchEvents | ( | ) | const [inline, virtual, inherited] |
Reimplemented in CViewContainer.
float alphaValue [protected, inherited] |
int32_t autosizeFlags [protected, inherited] |
CPoint backOffset [protected, inherited] |
bool bDrawTransparentEnabled [protected, inherited] |
float defaultValue [protected, inherited] |
int32_t deferChangeCount [protected, inherited] |
DeferedChangesSet deferedChanges [protected, inherited] |
DependentList dependents [protected, inherited] |
int32_t drawStyle [protected, inherited] |
int32_t editing [protected, inherited] |
CColor frameColor [protected, inherited] |
CCoord heightControl [protected, inherited] |
CCoord heightOfSlider [protected, inherited] |
int32_t idleRate [static, inherited] |
global idle rate in Hz, defaults to 30 Hz
bool kAlwaysUseZoomFactor = false [static, inherited] |
int32_t kDefaultValueModifier = kControl [static, inherited] |
default value modifier key, per default is the control key
bool kDirtyCallAlwaysOnMainThread = false [static, inherited] |
if this is true, setting a view dirty will call invalid() instead of checking it in idle. Default value is false.
IdStringPtr kMessageBeginEdit = "kMessageBeginEdit" [static, inherited] |
IdStringPtr kMessageEndEdit = "kMessageEndEdit" [static, inherited] |
IdStringPtr kMessageTagDidChange = "kMessageTagDidChange" [static, inherited] |
IdStringPtr kMessageTagWillChange = "kMessageTagWillChange" [static, inherited] |
IdStringPtr kMessageValueChanged = "kMessageValueChanged" [static, inherited] |
int32_t kZoomModifier = kShift [static, inherited] |
zoom modifier key, per default is the shift key
CControlListener* listener [protected, inherited] |
CRect mouseableArea [protected, inherited] |
CPoint offsetHandle [protected, inherited] |
float oldValue [protected, inherited] |
CFrame* pParentFrame [protected, inherited] |
CView* pParentView [protected, inherited] |
CCoord rangeHandle [protected, inherited] |
int32_t style [protected, inherited] |
int32_t tag [protected, inherited] |
float value [protected, inherited] |
CColor valueColor [protected, inherited] |
int32_t viewFlags [protected, inherited] |
float vmax [protected, inherited] |
float vmin [protected, inherited] |
float wheelInc [protected, inherited] |
CCoord widthControl [protected, inherited] |
CCoord widthOfSlider [protected, inherited] |
float zoomFactor [protected, inherited] |