a horizontal switch control
More...
#include <vstcontrols.h>
|
| | CHorizontalSwitch (const CRect &size, CControlListener *listener, long tag, CBitmap *background, const CPoint &offset=CPoint(0, 0)) |
| |
| | CHorizontalSwitch (const CRect &size, CControlListener *listener, long tag, long subPixmaps, CCoord heightOfOneImage, long iMaxPositions, CBitmap *background, const CPoint &offset=CPoint(0, 0)) |
| |
| | CHorizontalSwitch (const CHorizontalSwitch &hswitch) |
| |
a horizontal switch control
Same as the CVerticalSwitch but horizontal.
CHorizontalSwitch constructor.
- Parameters
-
| size | the size of this view |
| listener | the listener |
| tag | the control tag |
| background | the bitmap of the switch |
| offset | unused |
CHorizontalSwitch constructor.
- Parameters
-
| 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 |
| iMaxPositions | TODO |
| background | the switch bitmap |
| offset | unused |
| bool attached |
( |
CView * |
parent | ) |
|
|
virtualinherited |
| void autoComputeHeightOfOneImage |
( |
| ) |
|
|
virtualinherited |
| bool checkDefaultValue |
( |
long |
button | ) |
|
|
virtualinherited |
| virtual bool checkUpdate |
( |
const CRect & |
updateRect | ) |
const |
|
inlinevirtualinherited |
| virtual void doIdleStuff |
( |
| ) |
|
|
inlinevirtualinherited |
called if the view should draw itself
- Parameters
-
| pContext | draw context in which to draw |
Implements CControl.
decrease refcount and delete object if refcount == 0
Reimplemented in CDrawContext.
conversion from frame coordinates to local view coordinates
- Parameters
-
- Returns
- converted point
Reimplemented in CViewContainer.
| bool getAttribute |
( |
const CViewAttributeID |
id, |
|
|
const long |
inSize, |
|
|
void * |
outData, |
|
|
long & |
outSize |
|
) |
| const |
|
inherited |
get an attribute
- Parameters
-
| 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 |
- Returns
- true if attribute exists and outData was big enough. outSize and outData is valid then.
get the size of an attribute
- Parameters
-
| id | the ID of the Attribute |
| outSize | on return the size of the attribute |
- Returns
- true if attribute exists. outSize is valid then.
| virtual long getAutosizeFlags |
( |
| ) |
const |
|
inlinevirtualinherited |
| virtual CBitmap* getBackground |
( |
| ) |
const |
|
inlinevirtualinherited |
get the background image of this view
| virtual float getDefaultValue |
( |
void |
| ) |
const |
|
inlinevirtualinherited |
get editor
Reimplemented in CFrame.
| void getFrameTopLeftPos |
( |
CPoint & |
topLeft | ) |
const |
|
virtualinherited |
get the height of the view
| virtual CCoord getHeightOfOneImage |
( |
| ) |
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
| long getNbReference |
( |
| ) |
const |
|
inlineinherited |
| virtual float getOldValue |
( |
void |
| ) |
const |
|
inlinevirtualinherited |
| CView* getParentView |
( |
| ) |
const |
|
inlineinherited |
| virtual long getTag |
( |
| ) |
const |
|
inlinevirtualinherited |
| virtual bool getTransparency |
( |
| ) |
const |
|
inlinevirtualinherited |
get views transparent state
| virtual float getValue |
( |
| ) |
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 |
get the width of the view
| virtual bool hitTest |
( |
const CPoint & |
where, |
|
|
const long |
buttons = -1 |
|
) |
| |
|
inlinevirtualinherited |
| void invalidRect |
( |
const CRect |
rect | ) |
|
|
virtualinherited |
| bool isAttached |
( |
| ) |
const |
|
inlineinherited |
is view attached to a parentView
check if view is dirty
Reimplemented from CView.
Reimplemented in CAnimKnob.
| virtual bool isTypeOf |
( |
const char * |
s | ) |
const |
|
inlinevirtual |
conversion from local view coordinates to frame coordinates
- Parameters
-
- Returns
- converted point
Reimplemented in CViewContainer.
| virtual CView* newCopy |
( |
| ) |
const |
|
inlinevirtual |
called if a drag is entering this view
Reimplemented in CViewContainer.
called if a drag is leaving this view
Reimplemented in CViewContainer.
called if a drag is moved inside this view
Reimplemented in CViewContainer.
called if a drag is dropped onto this view
Reimplemented in CViewContainer.
called if a key down event occurs and this view has focus
- Parameters
-
| keyCode | key code of pressed key |
- Returns
- -1 if not handled and 1 if handled
Reimplemented in CFrame, CViewContainer, CSlider, and CKnob.
called if a key up event occurs and this view has focus
- Parameters
-
| keyCode | key code of pressed key |
- Returns
- -1 if not handled and 1 if handled
Reimplemented in CFrame, and CViewContainer.
called when a mouse down event occurs
- Parameters
-
| where | mouse location of mouse down |
| buttons | button and modifier state |
- Returns
- event result. see CMouseEventResult
Reimplemented from CView.
called when the mouse enters this view
called when the mouse leaves this view
Reimplemented in CFrame.
called when a mouse move event occurs
- Parameters
-
| where | mouse location of mouse move |
| buttons | button and modifier state |
- Returns
- event result. see CMouseEventResult
Reimplemented from CView.
called when a mouse up event occurs
- Parameters
-
| where | mouse location of mouse up |
| buttons | button and modifier state |
- Returns
- event result. see CMouseEventResult
Reimplemented from CView.
| bool onWheel |
( |
const CPoint & |
where, |
|
|
const float & |
distance, |
|
|
const long & |
buttons |
|
) |
| |
|
virtualinherited |
called if a mouse wheel event is happening over this view
- Parameters
-
| where | location |
| distance | wheel distance |
| buttons | button 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
-
| where | location |
| axis | mouse wheel axis |
| distance | wheel distance |
| buttons | button and modifier state |
- Returns
- true if handled
Reimplemented in CFrame, CViewContainer, CScrollbar, and CScrollView.
| virtual void parentSizeChanged |
( |
| ) |
|
|
inlinevirtualinherited |
| virtual void remember |
( |
| ) |
|
|
inlinevirtualinherited |
| bool removed |
( |
CView * |
parent | ) |
|
|
virtualinherited |
view is removed from parent view
- Parameters
-
- 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
-
| id | the ID of the Attribute |
| inSize | the size of the outData pointer |
| inData | a pointer to the data |
- Returns
- true if attribute was set
| virtual void setAutosizeFlags |
( |
long |
flags | ) |
|
|
inlinevirtualinherited |
| void setBackground |
( |
CBitmap * |
background | ) |
|
|
virtualinherited |
set the background image of this view
- Parameters
-
| background | new 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 setHeightOfOneImage |
( |
const CCoord & |
height | ) |
|
|
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 setTag |
( |
long |
val | ) |
|
|
inlinevirtualinherited |
| virtual void setTransparency |
( |
bool |
val | ) |
|
|
inlinevirtualinherited |
set views transparent state
Reimplemented in CScrollView.
| virtual void setValue |
( |
float |
val | ) |
|
|
inlinevirtualinherited |
| void setViewSize |
( |
CRect & |
newSize, |
|
|
bool |
invalid = true |
|
) |
| |
|
virtualinherited |
| void setVisible |
( |
bool |
state | ) |
|
|
virtualinherited |
| virtual void setWantsFocus |
( |
bool |
state | ) |
|
|
inlinevirtualinherited |
| virtual void setWheelInc |
( |
float |
val | ) |
|
|
inlinevirtualinherited |
| virtual bool wantsFocus |
( |
| ) |
const |
|
inlinevirtualinherited |
check if view supports focus
| bool bTransparencyEnabled |
|
protectedinherited |
| CAttributeListEntry* pAttributeList |
|
protectedinherited |
The documentation for this class was generated from the following files: