ASPiK SDK
VSTGUI::KeyboardViewRangeSelector Class Reference
Inheritance diagram for VSTGUI::KeyboardViewRangeSelector:
VSTGUI::KeyboardViewBase VSTGUI::CView VSTGUI::CBaseObject VSTGUI::ReferenceCounted< T > VSTGUI::IReference

Classes

struct  Range
 

Public Member Functions

void drawRect (CDrawContext *context, const CRect &dirtyRect) override
 called if the view should draw itself
 
void setKeyRange (NoteIndex startNote, NumNotes numKeys) override
 
void setSelectionRange (const Range &range)
 
void setSelectionMinMax (NumNotes minRange, NumNotes maxRange)
 
const RangegetSelectionRange () const
 
NumNotes getSelectionMin () const
 
NumNotes getSelectionMax () const
 
NumNotes getNumWhiteKeysSelected () const
 
void registerKeyRangeChangedListener (IKeyboardViewKeyRangeChangedListener *listener)
 
void unregisterKeyRangeChangedListener (IKeyboardViewKeyRangeChangedListener *listener)
 
- Public Member Functions inherited from VSTGUI::KeyboardViewBase
void setKeyPressed (NoteIndex note, bool state)
 
NoteIndex getKeyRangeStart () const
 
NumNotes getNumKeys () const
 
NumNotes getNumWhiteKeys () const
 
void setWhiteKeyWidth (CCoord width)
 
void setBlackKeyWidth (CCoord width)
 
void setBlackKeyHeight (CCoord height)
 
void setLineWidth (CCoord width)
 
CCoord getWhiteKeyWidth () const
 
CCoord getBlackKeyWidth () const
 
CCoord getBlackKeyHeight () const
 
CCoord getLineWidth () const
 
void setFrameColor (CColor color)
 
void setFontColor (CColor color)
 
void setWhiteKeyColor (CColor color)
 
void setWhiteKeyPressedColor (CColor color)
 
void setBlackKeyColor (CColor color)
 
void setBlackKeyPressedColor (CColor color)
 
CColor getFrameColor () const
 
CColor getFontColor () const
 
CColor getWhiteKeyColor () const
 
CColor getWhiteKeyPressedColor () const
 
CColor getBlackKeyColor () const
 
CColor getBlackKeyPressedColor () const
 
void setNoteNameFont (CFontDesc *font)
 
CFontDescgetNoteNameFont () const
 
void setDrawNoteText (bool state)
 
bool getDrawNoteText () const
 
void setBitmap (BitmapID bID, CBitmap *bitmap)
 
CBitmapgetBitmap (BitmapID bID) const
 
void setWhiteKeyBitmapInset (const CRect &inset)
 
void setBlackKeyBitmapInset (const CRect &inset)
 
const CRectgetNoteRect (NoteIndex note) const
 
bool isWhiteKey (NoteIndex note) const
 
void setViewSize (const CRect &rect, bool invalid=true) override
 set views size More...
 
bool sizeToFit () override
 resize view to optimal size
 
- Public Member Functions inherited from VSTGUI::CView
 CView (const CRect &size)
 
 CView (const CView &view)
 
void setSubviewState (bool state)
 
bool isSubview () const
 
virtual bool wantsWindowActiveStateChangeNotification () const
 
virtual void onWindowActivate (bool state)
 
CGraphicsTransform getGlobalTransform () const
 
template<typename T >
T & translateToGlobal (T &t) const
 translates a local coordinate to a global one using parent transforms
 
template<typename T >
translateToGlobal (const T &t) const
 translates a local coordinate to a global one using parent transforms
 
template<typename T >
T & translateToLocal (T &t) const
 translates a global coordinate to a local one using parent transforms
 
template<typename T >
translateToLocal (const T &t) const
 translates a local coordinate to a global one using parent transforms
 
virtual CViewContainerasViewContainer ()
 
virtual const CViewContainerasViewContainer () const
 
CMessageResult notify (CBaseObject *sender, IdStringPtr message) override
 
void beforeDelete () override
 
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 More...
 
virtual bool onWheel (const CPoint &where, const float &distance, const CButtonState &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 CButtonState &buttons)
 called if a mouse wheel event is happening over this view More...
 
virtual void setMouseEnabled (bool bEnable=true)
 turn on/off mouse usage for this view
 
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
 
CRectgetMouseableArea (CRect &rect) const
 get the area in which the view reacts to the mouse
 
const CRectgetMouseableArea () const
 read only access to the mouseable area
 
virtual DragResult doDrag (IDataPackage *source, const CPoint &offset=CPoint(0, 0), CBitmap *dragBitmap=nullptr)
 start a drag operation. See CDropSource to create the source data package More...
 
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
 
virtual int32_t onKeyDown (VstKeyCode &keyCode)
 called if a key down event occurs and this view has focus More...
 
virtual int32_t onKeyUp (VstKeyCode &keyCode)
 called if a key up event occurs and this view has focus More...
 
CCoord getHeight () const
 get the height of the view
 
CCoord getWidth () const
 get the width of the view
 
const CRectgetViewSize () const
 read only access to view size
 
virtual CRect getVisibleViewSize () const
 returns the visible size of the view More...
 
virtual void parentSizeChanged ()
 notification that one of the views parent has changed its size
 
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 (int32_t flags)
 set autosize flags
 
int32_t getAutosizeFlags () const
 get autosize flags
 
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
 
bool getAttributeSize (const CViewAttributeID id, uint32_t &outSize) const
 get the size of an attribute More...
 
bool getAttribute (const CViewAttributeID id, const uint32_t inSize, void *outData, uint32_t &outSize) const
 get an attribute More...
 
bool setAttribute (const CViewAttributeID id, const uint32_t inSize, const void *inData)
 set an attribute More...
 
bool removeAttribute (const CViewAttributeID id)
 remove an attribute
 
virtual void setBackground (CBitmap *background)
 set the background image of this view More...
 
CBitmapgetBackground () const
 get the background image of this view
 
virtual void setDisabledBackground (CBitmap *background)
 set background image used when the mouse is not enabled More...
 
CBitmapgetDisabledBackground () const
 get background image used when the mouse is not enabled
 
CBitmapgetDrawBackground () const
 
virtual void setTransparency (bool val)
 set views transparent state
 
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
 
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
 
CViewgetParentView () const
 get parent view
 
CFramegetFrame () const
 get frame
 
virtual VSTGUIEditorInterfacegetEditor () const
 get editor
 
void addAnimation (IdStringPtr name, Animation::IAnimationTarget *target, Animation::ITimingFunction *timingFunction, CBaseObject *notificationObject=nullptr)
 
void addAnimation (IdStringPtr name, Animation::IAnimationTarget *target, Animation::ITimingFunction *timingFunction, const Animation::DoneFunction &doneFunc)
 
void removeAnimation (IdStringPtr name)
 
void removeAllAnimations ()
 
void registerViewListener (IViewListener *listener)
 
void unregisterViewListener (IViewListener *listener)
 
virtual void draw (CDrawContext *pContext)
 called if the view should draw itself More...
 
virtual bool checkUpdate (const CRect &updateRect) const
 
virtual bool isDirty () const
 check if view is dirty
 
virtual void setDirty (bool val=true)
 set the view to dirty so that it is redrawn in the next idle. Thread Safe !
 
virtual void invalidRect (const CRect &rect)
 mark rect as invalid More...
 
virtual void invalid ()
 mark whole view as invalid
 
virtual void setVisible (bool state)
 set visibility state
 
bool isVisible () const
 get visibility state
 
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
 
- Public Member Functions inherited from VSTGUI::CBaseObject
 CBaseObject (const CBaseObject &o)
 
CBaseObjectoperator= (const CBaseObject &obj)
 
- Public Member Functions inherited from VSTGUI::ReferenceCounted< T >
 ReferenceCounted (const ReferenceCounted &)
 
ReferenceCountedoperator= (const ReferenceCounted &)
 
void forget () override
 decrease refcount and delete object if refcount == 0
 
void remember () override
 increase refcount
 
virtual int32_t getNbReference () const
 get refcount
 

Additional Inherited Members

- Public Types inherited from VSTGUI::KeyboardViewBase
enum  BitmapID {
  WhiteKeyPressed = 0, WhiteKeyUnpressed, BlackKeyPressed, BlackKeyUnpressed,
  WhiteKeyShadowLeft, WhiteKeyShadowRight, NumBitmaps
}
 
using NoteIndex = int16_t
 
using NumNotes = uint8_t
 
- Static Public Attributes inherited from VSTGUI::KeyboardViewBase
static constexpr NumNotes MaxNotes = 128
 
- Static Public Attributes inherited from VSTGUI::CView
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.
 
static uint32_t idleRate
 global idle rate in Hz, defaults to 30 Hz
 
- Protected Types inherited from VSTGUI::KeyboardViewBase
using NoteRectCache = std::array< CRect, MaxNotes >
 
- Protected Types inherited from VSTGUI::CView
enum  {
  kMouseEnabled = 1 << 0, kTransparencyEnabled = 1 << 1, kWantsFocus = 1 << 2, kIsAttached = 1 << 3,
  kVisible = 1 << 4, kDirty = 1 << 5, kWantsIdle = 1 << 6, kIsSubview = 1 << 7,
  kLastCViewFlag = 7
}
 
- Protected Member Functions inherited from VSTGUI::KeyboardViewBase
void invalidNote (NoteIndex note)
 
NoteIndex pointToNote (const CPoint &p, bool ignoreY) const
 
const NoteRectCache & getNoteRectCache () const
 
- Protected Member Functions inherited from VSTGUI::CView
CGraphicsPathgetHitTestPath () const
 
bool hasViewFlag (int32_t bit) const
 
void setViewFlag (int32_t bit, bool state)
 
void setAlphaValueNoInvalidate (float value)
 
void setParentFrame (CFrame *frame)
 
void setParentView (CView *parent)
 

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