a scrollable container view with scrollbars More...
Public Types | |
enum | CScrollViewStyle { kHorizontalScrollbar = 1 << kHorizontalScrollbarFlag, kVerticalScrollbar = 1 << kVerticalScrollbarFlag, kDontDrawFrame = 1 << kDontDrawFrameFlag, kAutoDragScrolling = 1 << kAutoDragScollingFlag, kOverlayScrollbars = 1 << kOverlayScrollbarsFlag, kFollowFocusView = 1 << kFollowFocusViewFlag, kAutoHideScrollbars = 1 << kAutoHideScrollbarsFlag } |
typedef std::list < SharedPointer< CView > >::const_iterator | ChildViewConstIterator |
typedef std::list < SharedPointer< CView > >::const_reverse_iterator | ChildViewConstReverseIterator |
Public Member Functions | |
CScrollView (const CRect &size, const CRect &containerSize, int32_t style, CCoord scrollbarWidth=16, CBitmap *pBackground=0) | |
CScrollView (const CScrollView &scrollView) | |
bool | addView (CView *pView) |
add a child view | |
bool | addView (CView *pView, const CRect &mouseableArea, bool mouseEnabled=true) |
add a child view | |
bool | addView (CView *pView, CView *pBefore) |
add a child view before another view | |
bool | removeView (CView *pView, bool withForget=true) |
remove a child view | |
bool | removeAll (bool withForget=true) |
remove all child views | |
int32_t | getNbViews () const |
get the number of child views | |
CView * | getView (int32_t index) const |
get the child view at index | |
void | drawBackgroundRect (CDrawContext *pContext, const CRect &_updateRect) |
draw the background | |
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 | |
void | valueChanged (CControl *pControl) |
void | setTransparency (bool val) |
set views transparent state | |
void | setBackgroundColor (const CColor &color) |
set the background color (will only be drawn if this container is not set to transparent and does not have a background bitmap) | |
void | setViewSize (const CRect &rect, bool invalid=true) |
set views size | |
void | setAutosizeFlags (int32_t flags) |
set autosize flags | |
CMessageResult | notify (CBaseObject *sender, IdStringPtr message) |
void | modifyDrawContext (CCoord save[4], CDrawContext *pContext) |
void | restoreDrawContext (CDrawContext *pContext, CCoord save[4]) |
virtual bool | advanceNextFocusView (CView *oldFocus, bool reverse=false) |
virtual bool | invalidateDirtyViews () |
virtual CRect | getVisibleSize (const CRect &rect) const |
virtual void | draw (CDrawContext *pContext) |
called if the view should draw itself | |
virtual void | drawRect (CDrawContext *pContext, const CRect &updateRect) |
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 bool | hitTest (const CPoint &where, const CButtonState &buttons=-1) |
check if where hits this view | |
virtual void | onTouchEvent (ITouchEvent &event) |
virtual bool | wantsMultiTouchEvents () const |
virtual void | findSingleTouchEventTarget (ITouchEvent::Touch &event) |
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 void | looseFocus () |
called if view should loose focus | |
virtual void | takeFocus () |
called if view should take focus | |
virtual bool | isDirty () const |
check if view is dirty | |
virtual void | invalid () |
mark whole view as invalid | |
virtual void | invalidRect (const CRect &rect) |
mark rect as invalid | |
virtual void | parentSizeChanged () |
notification that one of the views parent has changed its size | |
virtual bool | sizeToFit () |
resize view to optimal size | |
virtual bool | removed (CView *parent) |
virtual bool | attached (CView *parent) |
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 | |
template<class ViewClass , class ContainerClass > | |
uint32_t | getChildViewsOfType (ContainerClass &result, bool deep=false) const |
virtual int32_t | controlModifierClicked (VSTGUI::CControl *pControl, VSTGUI::CButtonState button) |
return 1 if you want the control to not handle it, otherwise 0 | |
virtual void | controlBeginEdit (VSTGUI::CControl *pControl) |
virtual void | controlEndEdit (VSTGUI::CControl *pControl) |
virtual void | controlTagWillChange (VSTGUI::CControl *pControl) |
virtual void | controlTagDidChange (VSTGUI::CControl *pControl) |
CScrollView Methods | |
int32_t | getStyle () const |
void | setStyle (int32_t newStyle) |
int32_t | getActiveScrollbars () const |
CCoord | getScrollbarWidth () const |
void | setScrollbarWidth (CCoord width) |
virtual void | setContainerSize (const CRect &cs, bool keepVisibleArea=false) |
set the virtual size of this container | |
const CRect & | getContainerSize () const |
const CPoint & | getScrollOffset () const |
get scroll offset | |
void | resetScrollOffset () |
CScrollbar * | getVerticalScrollbar () const |
get the vertical scrollbar | |
CScrollbar * | getHorizontalScrollbar () const |
get the horizontal scrollbar | |
virtual void | makeRectVisible (const CRect &rect) |
set scrollview to show rect | |
Sub View Methods | |
virtual bool | isChild (CView *pView) const |
check if pView is a child view of this container | |
virtual bool | isChild (CView *pView, bool deep) const |
check if pView is a child view of this container | |
virtual bool | hasChildren () const |
check if container has child views | |
virtual CView * | getViewAt (const CPoint &where, bool deep=false, bool mustbeMouseEnabled=false) const |
get the view at point where | |
virtual CViewContainer * | getContainerAt (const CPoint &where, bool deep=true) const |
get the container at point where | |
virtual bool | getViewsAt (const CPoint &where, std::list< SharedPointer< CView > > &views, bool deep=true) const |
get all views at point where, top->down | |
virtual bool | changeViewZOrder (CView *view, int32_t newIndex) |
change view z order position | |
virtual void | setAutosizingEnabled (bool state) |
enable or disable autosizing subviews. Per default this is enabled. | |
bool | getAutosizingEnabled () const |
Background Methods | |
virtual CColor | getBackgroundColor () const |
get the background color | |
virtual void | setBackgroundOffset (const CPoint &p) |
set the offset of the background bitmap | |
virtual const CPoint & | getBackgroundOffset () const |
get the offset of the background bitmap | |
virtual void | setBackgroundColorDrawStyle (CDrawStyle style) |
CDrawStyle | getBackgroundColorDrawStyle () const |
Message Methods | |
virtual CMessageResult | notify (CBaseObject *sender, IdStringPtr message) |
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 | |
Mouse Methods | |
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 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 | |
Keyboard Methods | |
virtual int32_t | onKeyDown (VstKeyCode &keyCode) |
called if a key down event occurs and this view has focus | |
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 int32_t | getAutosizeFlags () const |
get autosize flags | |
Focus Methods | |
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 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 | |
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 () |
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 | |
Protected Types | |
enum | { kHorizontalScrollbarFlag, kVerticalScrollbarFlag, kDontDrawFrameFlag, kAutoDragScollingFlag, kOverlayScrollbarsFlag, kFollowFocusViewFlag, kAutoHideScrollbarsFlag, kLastScrollViewStyleFlag } |
enum | { kHSBTag, kVSBTag } |
enum | { kAutosizeSubviews = 1 << (CView::kLastCViewFlag + 1) } |
enum | { kMouseEnabled = 1 << 0, kTransparencyEnabled = 1 << 1, kWantsFocus = 1 << 2, kIsAttached = 1 << 3, kVisible = 1 << 4, kDirty = 1 << 5, kWantsIdle = 1 << 6, kLastCViewFlag = 6 } |
Protected Member Functions | |
~CScrollView () | |
virtual void | recalculateSubViews () |
virtual bool | checkUpdateRect (CView *view, const CRect &rect) |
virtual bool | hitTestSubViews (const CPoint &where, const CButtonState buttons=-1) |
CGraphicsPath * | getHitTestPath () const |
Protected Attributes | |
CScrollContainer * | sc |
CScrollbar * | vsb |
CScrollbar * | hsb |
CRect | containerSize |
CCoord | scrollbarWidth |
int32_t | style |
int32_t | activeScrollbarStyle |
CDrawStyle | backgroundColorDrawStyle |
CColor | backgroundColor |
CPoint | backgroundOffset |
CRect | lastDrawnFocus |
CView * | currentDragView |
CView * | mouseDownView |
CRect | size |
CRect | mouseableArea |
CFrame * | pParentFrame |
CView * | pParentView |
int32_t | viewFlags |
int32_t | autosizeFlags |
float | alphaValue |
Drag & Drop Methods | |
| |
enum | DragResult { kDragRefused = 0, kDragMoved, kDragCopied, kDragError = -1 } |
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 | |
Draw and Update Methods | |
| |
virtual bool | checkUpdate (const CRect &updateRect) const |
virtual void | setDirty (bool val=true) |
set the view to dirty so that it is redrawn in the next idle. Thread Safe ! | |
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. | |
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 scrollable container view with scrollbars
typedef std::list<SharedPointer<CView> >::const_iterator ChildViewConstIterator [inherited] |
typedef std::list<SharedPointer<CView> >::const_reverse_iterator ChildViewConstReverseIterator [inherited] |
anonymous enum [protected] |
anonymous enum [protected, inherited] |
enum CScrollViewStyle |
Scroll View Style Flags
enum DragResult [inherited] |
CScrollView | ( | const CRect & | size, | |
const CRect & | containerSize, | |||
int32_t | style, | |||
CCoord | scrollbarWidth = 16 , |
|||
CBitmap * | pBackground = 0 | |||
) |
CScrollView | ( | const CScrollView & | scrollView | ) |
~CScrollView | ( | ) | [protected] |
void addAnimation | ( | IdStringPtr | name, | |
Animation::IAnimationTarget * | target, | |||
Animation::ITimingFunction * | timingFunction, | |||
CBaseObject * | notificationObject = 0 | |||
) | [inherited] |
add a child view before another view
Reimplemented from CViewContainer.
add a child view
Reimplemented from CViewContainer.
bool addView | ( | CView * | pView | ) | [virtual] |
add a child view
Reimplemented from CViewContainer.
virtual bool advanceNextFocusView | ( | CView * | oldFocus, | |
bool | reverse = false | |||
) | [virtual, inherited] |
Reimplemented in CFrame.
bool attached | ( | CView * | parent | ) | [virtual, inherited] |
view is attached to a parent view
parent | parent view |
virtual bool attached | ( | CView * | parent | ) | [virtual, inherited] |
Reimplemented in CDataBrowser, CFrame, CLayeredViewContainer, CFontChooser, CAutoLayoutContainerView, CSplitView, and UIViewSwitchContainer.
virtual bool changeViewZOrder | ( | CView * | view, | |
int32_t | newIndex | |||
) | [virtual, inherited] |
change view z order position
Reimplemented in CAutoLayoutContainerView, and CShadowViewContainer.
virtual bool checkUpdate | ( | const CRect & | updateRect | ) | const [inline, virtual, inherited] |
virtual void controlBeginEdit | ( | VSTGUI::CControl * | pControl | ) | [inline, virtual, inherited] |
Reimplemented in CColorChooser, DelegationController, VST3Editor, GroupController, and PadController.
virtual void controlEndEdit | ( | VSTGUI::CControl * | pControl | ) | [inline, virtual, inherited] |
Reimplemented in CColorChooser, DelegationController, VST3Editor, GroupController, and PadController.
virtual int32_t controlModifierClicked | ( | VSTGUI::CControl * | pControl, | |
VSTGUI::CButtonState | button | |||
) | [inline, virtual, inherited] |
return 1 if you want the control to not handle it, otherwise 0
Reimplemented in DelegationController.
virtual void controlTagDidChange | ( | VSTGUI::CControl * | pControl | ) | [inline, virtual, inherited] |
Reimplemented in DelegationController, and VST3Editor.
virtual void controlTagWillChange | ( | VSTGUI::CControl * | pControl | ) | [inline, virtual, inherited] |
Reimplemented in DelegationController, and VST3Editor.
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.
virtual void draw | ( | CDrawContext * | pContext | ) | [virtual, inherited] |
void drawBackgroundRect | ( | CDrawContext * | pContext, | |
const CRect & | _updateRect | |||
) | [virtual] |
draw the background
Reimplemented from CViewContainer.
virtual void drawRect | ( | CDrawContext * | pContext, | |
const CRect & | updateRect | |||
) | [virtual, inherited] |
called if the view should draw itself
Reimplemented from CView.
Reimplemented in CFrame, CLayeredViewContainer, and CShadowViewContainer.
virtual void findSingleTouchEventTarget | ( | ITouchEvent::Touch & | event | ) | [virtual, inherited] |
virtual void forget | ( | ) | [inline, virtual, inherited] |
decrease refcount and delete object if refcount == 0
conversion from frame coordinates to local view coordinates
point | location |
Reimplemented from CView.
int32_t getActiveScrollbars | ( | ) | const [inline] |
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
bool getAutosizingEnabled | ( | ) | const [inline, inherited] |
CBitmap* getBackground | ( | ) | const [inline, inherited] |
get the background image of this view
virtual CColor getBackgroundColor | ( | ) | const [inline, virtual, inherited] |
get the background color
CDrawStyle getBackgroundColorDrawStyle | ( | ) | const [inline, inherited] |
virtual const CPoint& getBackgroundOffset | ( | ) | const [inline, virtual, inherited] |
get the offset of the background bitmap
uint32_t getChildViewsOfType | ( | ContainerClass & | result, | |
bool | deep = false | |||
) | const [inline, inherited] |
get child views of type ViewClass. ContainerClass must be a stdc++ container
virtual CViewContainer* getContainerAt | ( | const CPoint & | where, | |
bool | deep = true | |||
) | const [virtual, inherited] |
get the container at point where
Reimplemented in CFrame.
const CRect& getContainerSize | ( | ) | const [inline] |
CBitmap* getDisabledBackground | ( | ) | const [inline, inherited] |
get background image used when the mouse is not enabled
CBitmap* getDrawBackground | ( | ) | const [inline, inherited] |
VSTGUIEditorInterface * getEditor | ( | ) | const [virtual, inherited] |
get editor
Reimplemented in CFrame.
CFrame* getFrame | ( | ) | const [inline, inherited] |
get frame
CCoord getHeight | ( | ) | const [inline, inherited] |
get the height of the view
CGraphicsPath* getHitTestPath | ( | ) | const [inline, protected, inherited] |
CScrollbar* getHorizontalScrollbar | ( | ) | const [inline] |
get the horizontal scrollbar
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
int32_t getNbViews | ( | ) | const [virtual] |
get the number of child views
Reimplemented from CViewContainer.
CView* getParentView | ( | ) | const [inline, inherited] |
get parent view
CCoord getScrollbarWidth | ( | ) | const [inline] |
const CPoint& getScrollOffset | ( | ) | const |
get scroll offset
int32_t getStyle | ( | ) | const [inline] |
virtual bool getTransparency | ( | ) | const [inline, virtual, inherited] |
get views transparent state
CScrollbar* getVerticalScrollbar | ( | ) | const [inline] |
get the vertical scrollbar
CView* getView | ( | int32_t | index | ) | const [virtual] |
get the child view at index
Reimplemented from CViewContainer.
virtual CView* getViewAt | ( | const CPoint & | where, | |
bool | deep = false , |
|||
bool | mustbeMouseEnabled = false | |||
) | const [virtual, inherited] |
get the view at point where
Reimplemented in CFrame.
virtual bool getViewsAt | ( | const CPoint & | where, | |
std::list< SharedPointer< CView > > & | views, | |||
bool | deep = true | |||
) | const [virtual, inherited] |
get all views at point where, top->down
const CRect& getViewSize | ( | ) | const [inline, inherited] |
read only access to view size
CRect getVisibleViewSize | ( | ) | const [virtual, inherited] |
returns the visible size of the view
CCoord getWidth | ( | ) | const [inline, inherited] |
get the width of the view
virtual bool hasChildren | ( | ) | const [virtual, inherited] |
check if container has child views
virtual 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 from CView.
virtual bool hitTestSubViews | ( | const CPoint & | where, | |
const CButtonState | buttons = -1 | |||
) | [protected, virtual, inherited] |
virtual void invalid | ( | ) | [virtual, inherited] |
virtual bool invalidateDirtyViews | ( | ) | [virtual, inherited] |
virtual void invalidRect | ( | const CRect & | rect | ) | [virtual, inherited] |
mark rect as invalid
rect | rect to invalidate |
Reimplemented from CView.
Reimplemented in CFrame, and CLayeredViewContainer.
bool isAttached | ( | ) | const [inline, inherited] |
is view attached to a parentView
virtual bool isChild | ( | CView * | pView, | |
bool | deep | |||
) | const [virtual, inherited] |
check if pView is a child view of this container
virtual bool isChild | ( | CView * | pView | ) | const [virtual, inherited] |
check if pView is a child view of this container
virtual bool isDirty | ( | ) | const [virtual, inherited] |
check if view is dirty
Reimplemented from CView.
bool isVisible | ( | ) | const [inline, inherited] |
get visibility state
conversion from local view coordinates to frame coordinates
point | location |
Reimplemented from CView.
virtual void looseFocus | ( | ) | [virtual, inherited] |
called if view should loose focus
Reimplemented from CView.
virtual void makeRectVisible | ( | const CRect & | rect | ) | [virtual] |
set scrollview to show rect
void modifyDrawContext | ( | CCoord | save[4], | |
CDrawContext * | pContext | |||
) | [inherited] |
virtual CMessageResult notify | ( | CBaseObject * | sender, | |
IdStringPtr | message | |||
) | [inline, virtual, inherited] |
CMessageResult notify | ( | CBaseObject * | sender, | |
IdStringPtr | message | |||
) | [virtual] |
sender | message sender | |
message | message text |
Reimplemented from CViewContainer.
Reimplemented in CDataBrowser.
virtual void onDragEnter | ( | IDataPackage * | drag, | |
const CPoint & | where | |||
) | [virtual, inherited] |
called if a drag is entering this view
Reimplemented from CView.
virtual void onDragLeave | ( | IDataPackage * | drag, | |
const CPoint & | where | |||
) | [virtual, inherited] |
called if a drag is leaving this view
Reimplemented from CView.
virtual void onDragMove | ( | IDataPackage * | drag, | |
const CPoint & | where | |||
) | [virtual, inherited] |
called if a drag is moved inside this view
Reimplemented from CView.
virtual bool onDrop | ( | IDataPackage * | drag, | |
const CPoint & | where | |||
) | [virtual, inherited] |
called if a drag is dropped onto this view
Reimplemented from CView.
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 in CDataBrowser, CFrame, COnOffButton, CCheckBox, CKickButton, CTextButton, CFontChooser, CKnob, CMovieButton, COptionMenu, CSlider, CVerticalSwitch, CHorizontalSwitch, CRockerSwitch, and CTextEdit.
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.
virtual CMouseEventResult onMouseCancel | ( | ) | [virtual, inherited] |
called when mouse tracking should be canceled
Reimplemented from CView.
virtual 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.
Reimplemented in CDataBrowser, and CFrame.
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.
virtual 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.
Reimplemented in CFrame.
virtual 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.
Reimplemented in CFrame.
virtual void onTouchEvent | ( | ITouchEvent & | event | ) | [virtual, inherited] |
Reimplemented from CView.
virtual bool onWheel | ( | const CPoint & | where, | |
const float & | distance, | |||
const CButtonState & | buttons | |||
) | [virtual, inherited] |
bool onWheel | ( | const CPoint & | where, | |
const CMouseWheelAxis & | axis, | |||
const float & | distance, | |||
const CButtonState & | buttons | |||
) | [virtual] |
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 from CViewContainer.
virtual void parentSizeChanged | ( | ) | [virtual, inherited] |
notification that one of the views parent has changed its size
Reimplemented from CView.
Reimplemented in CLayeredViewContainer.
virtual void recalculateSubViews | ( | ) | [protected, virtual] |
Reimplemented in CDataBrowser.
virtual void remember | ( | ) | [inline, virtual, inherited] |
increase refcount
bool removeAll | ( | bool | withForget = true |
) | [virtual] |
remove all child views
Reimplemented from CViewContainer.
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 |
virtual bool removed | ( | CView * | parent | ) | [virtual, inherited] |
Reimplemented in CDataBrowser, CLayeredViewContainer, CSplitView, and UIViewSwitchContainer.
bool removeView | ( | CView * | pView, | |
bool | withForget = true | |||
) | [virtual] |
remove a child view
Reimplemented from CViewContainer.
void resetScrollOffset | ( | ) |
void restoreDrawContext | ( | CDrawContext * | pContext, | |
CCoord | save[4] | |||
) | [inherited] |
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 |
void setAutosizeFlags | ( | int32_t | flags | ) | [virtual] |
set autosize flags
Reimplemented from CView.
virtual void setAutosizingEnabled | ( | bool | state | ) | [virtual, inherited] |
enable or disable autosizing subviews. Per default this is enabled.
void setBackground | ( | CBitmap * | background | ) | [virtual, inherited] |
void setBackgroundColor | ( | const CColor & | color | ) | [virtual] |
set the background color (will only be drawn if this container is not set to transparent and does not have a background bitmap)
Reimplemented from CViewContainer.
virtual void setBackgroundColorDrawStyle | ( | CDrawStyle | style | ) | [virtual, inherited] |
virtual void setBackgroundOffset | ( | const CPoint & | p | ) | [inline, virtual, inherited] |
set the offset of the background bitmap
virtual void setContainerSize | ( | const CRect & | cs, | |
bool | keepVisibleArea = false | |||
) | [virtual] |
set the virtual size of this container
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 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 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
void setScrollbarWidth | ( | CCoord | width | ) |
void setStyle | ( | int32_t | newStyle | ) |
void setTransparency | ( | bool | val | ) | [virtual] |
set views transparent state
Reimplemented from CView.
void setViewSize | ( | const CRect & | newSize, | |
bool | invalid = true | |||
) | [virtual] |
set views size
newSize | rect of new size of view | |
invalid | if true set view dirty |
Reimplemented from CViewContainer.
Reimplemented in CDataBrowser.
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 bool sizeToFit | ( | ) | [virtual, inherited] |
resize view to optimal size
Reimplemented from CView.
Reimplemented in CRowColumnView, and CSplitView.
virtual void takeFocus | ( | ) | [virtual, inherited] |
called if view should take focus
Reimplemented from CView.
void valueChanged | ( | CControl * | pControl | ) | [virtual] |
Implements CControlListener.
Reimplemented in CDataBrowser.
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 from CView.
int32_t activeScrollbarStyle [protected] |
float alphaValue [protected, inherited] |
int32_t autosizeFlags [protected, inherited] |
CColor backgroundColor [protected, inherited] |
CDrawStyle backgroundColorDrawStyle [protected, inherited] |
CPoint backgroundOffset [protected, inherited] |
CRect containerSize [protected] |
CView* currentDragView [protected, inherited] |
CScrollbar* hsb [protected] |
int32_t idleRate [static, inherited] |
global idle rate in Hz, defaults to 30 Hz
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.
CRect lastDrawnFocus [protected, inherited] |
CRect mouseableArea [protected, inherited] |
CView* mouseDownView [protected, inherited] |
CFrame* pParentFrame [protected, inherited] |
CView* pParentView [protected, inherited] |
CScrollContainer* sc [protected] |
CCoord scrollbarWidth [protected] |
int32_t style [protected] |
int32_t viewFlags [protected, inherited] |
CScrollbar* vsb [protected] |