ASPiK SDK
VSTGUI::CViewContainer Class Reference

Container Class of CView objects. More...

#include <cviewcontainer.h>

Inheritance diagram for VSTGUI::CViewContainer:
VSTGUI::CView VSTGUI::CBaseObject VSTGUI::ReferenceCounted< T > VSTGUI::IReference VSTGUI::CAutoLayoutContainerView VSTGUI::CColorChooser VSTGUI::CFontChooser VSTGUI::CFrame VSTGUI::CLayeredViewContainer VSTGUI::CScrollView VSTGUI::CShadowViewContainer VSTGUI::CSplitView VSTGUI::CTabView VSTGUI::FadeViewContainer VSTGUI::ScaleView VSTGUI::UIViewSwitchContainer

Classes

struct  Impl
 
class  Iterator
 

Public Types

using ViewList = std::list< SharedPointer< CView > >
 
using ChildViewConstIterator = ViewList::const_iterator
 
using ChildViewConstReverseIterator = ViewList::const_reverse_iterator
 

Public Member Functions

 CViewContainer (const CRect &size)
 
 CViewContainer (const CViewContainer &viewContainer)
 
virtual bool advanceNextFocusView (CView *oldFocus, bool reverse=false)
 
virtual bool invalidateDirtyViews ()
 
virtual CRect getVisibleSize (const CRect &rect) const
 
void setTransform (const CGraphicsTransform &t)
 
const CGraphicsTransformgetTransform () const
 
void registerViewContainerListener (IViewContainerListener *listener)
 
void unregisterViewContainerListener (IViewContainerListener *listener)
 
void draw (CDrawContext *pContext) override
 
void drawRect (CDrawContext *pContext, const CRect &updateRect) override
 
CMouseEventResult onMouseDown (CPoint &where, const CButtonState &buttons) override
 called when a mouse down event occurs More...
 
CMouseEventResult onMouseUp (CPoint &where, const CButtonState &buttons) override
 called when a mouse up event occurs More...
 
CMouseEventResult onMouseMoved (CPoint &where, const CButtonState &buttons) override
 called when a mouse move event occurs More...
 
CMouseEventResult onMouseCancel () override
 called when mouse tracking should be canceled
 
bool onWheel (const CPoint &where, const float &distance, const CButtonState &buttons) override
 called if a mouse wheel event is happening over this view More...
 
bool onWheel (const CPoint &where, const CMouseWheelAxis &axis, const float &distance, const CButtonState &buttons) override
 called if a mouse wheel event is happening over this view More...
 
bool hitTest (const CPoint &where, const CButtonState &buttons=-1) override
 
CMessageResult notify (CBaseObject *sender, IdStringPtr message) override
 
bool onDrop (IDataPackage *drag, const CPoint &where) override
 called if a drag is dropped onto this view
 
void onDragEnter (IDataPackage *drag, const CPoint &where) override
 called if a drag is entering this view
 
void onDragLeave (IDataPackage *drag, const CPoint &where) override
 called if a drag is leaving this view
 
void onDragMove (IDataPackage *drag, const CPoint &where) override
 called if a drag is moved inside this view
 
void looseFocus () override
 called if view should loose focus
 
void takeFocus () override
 called if view should take focus
 
bool isDirty () const override
 check if view is dirty
 
void invalid () override
 mark whole view as invalid
 
void invalidRect (const CRect &rect) override
 mark rect as invalid More...
 
void setViewSize (const CRect &rect, bool invalid=true) override
 
void parentSizeChanged () override
 notification that one of the views parent has changed its size
 
bool sizeToFit () override
 resize view to optimal size
 
bool removed (CView *parent) override
 view is removed from parent view More...
 
bool attached (CView *parent) override
 view is attached to a parent view More...
 
CPointframeToLocal (CPoint &point) const override
 conversion from frame coordinates to local view coordinates More...
 
CPointlocalToFrame (CPoint &point) const override
 conversion from local view coordinates to frame coordinates More...
 
CViewContainerasViewContainer () final
 
const CViewContainerasViewContainer () const final
 
Sub View Methods
virtual bool addView (CView *pView)
 add a child view More...
 
virtual bool addView (CView *pView, const CRect &mouseableArea, bool mouseEnabled=true)
 add a child view More...
 
virtual bool addView (CView *pView, CView *pBefore)
 add a child view before another view More...
 
virtual bool removeView (CView *pView, bool withForget=true)
 remove a child view More...
 
virtual bool removeAll (bool withForget=true)
 remove all child views More...
 
virtual bool isChild (CView *pView) const
 check if pView is a child view of this container More...
 
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 uint32_t getNbViews () const
 get the number of child views More...
 
virtual CViewgetView (uint32_t index) const
 get the child view at index More...
 
virtual CViewgetViewAt (const CPoint &where, const GetViewOptions &options=GetViewOptions()) const
 get the view at point where More...
 
virtual CViewContainergetContainerAt (const CPoint &where, const GetViewOptions &options=GetViewOptions().deep()) const
 get the container at point where More...
 
virtual bool getViewsAt (const CPoint &where, ViewList &views, const GetViewOptions &options=GetViewOptions().deep()) const
 get all views at point where, top->down More...
 
virtual bool changeViewZOrder (CView *view, uint32_t newIndex)
 change view z order position More...
 
virtual bool hitTestSubViews (const CPoint &where, const CButtonState &buttons=-1)
 
virtual void setAutosizingEnabled (bool state)
 enable or disable autosizing subviews. Per default this is enabled.
 
bool getAutosizingEnabled () const
 
template<class ViewClass , class ContainerClass >
uint32_t getChildViewsOfType (ContainerClass &result, bool deep=false) const
 
Background Methods
virtual 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) More...
 
virtual CColor getBackgroundColor () const
 get the background color
 
virtual void setBackgroundOffset (const CPoint &p)
 set the offset of the background bitmap
 
virtual const CPointgetBackgroundOffset () const
 get the offset of the background bitmap
 
virtual void drawBackgroundRect (CDrawContext *pContext, const CRect &_updateRect)
 draw the background More...
 
virtual void setBackgroundColorDrawStyle (CDrawStyle style)
 
CDrawStyle getBackgroundColorDrawStyle () const
 
- 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 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
 
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 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 setAutosizeFlags (int32_t flags)
 set autosize flags
 
int32_t getAutosizeFlags () const
 get autosize flags
 
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
 
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 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
 
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
 

Protected Types

enum  { kAutosizeSubviews = 1 << (CView::kLastCViewFlag + 1) }
 
- 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

void beforeDelete () override
 
virtual bool checkUpdateRect (CView *view, const CRect &rect)
 
void setMouseDownView (CView *view)
 
CViewgetMouseDownView () const
 
const ViewList & getChildren () 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)
 

Additional Inherited Members

- 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
 

Detailed Description

Container Class of CView objects.

Constructor & Destructor Documentation

◆ CViewContainer()

VSTGUI::CViewContainer::CViewContainer ( const CRect rect)
explicit

CViewContainer constructor.

Parameters
rectthe size of the container

Member Function Documentation

◆ addView() [1/3]

bool VSTGUI::CViewContainer::addView ( CView pView)
virtual

add a child view

Parameters
pViewthe view object to add to this container
Returns
true on success. false if view was already attached

Reimplemented in VSTGUI::CScrollView, VSTGUI::CSplitView, and VSTGUI::CAutoLayoutContainerView.

◆ addView() [2/3]

bool VSTGUI::CViewContainer::addView ( CView pView,
const CRect mouseableArea,
bool  mouseEnabled = true 
)
virtual

add a child view

Parameters
pViewthe view object to add to this container
mouseableAreathe view area in where the view will get mouse events
mouseEnabledbool to set if view will get mouse events
Returns
true on success. false if view was already attached

Reimplemented in VSTGUI::CScrollView, VSTGUI::CSplitView, and VSTGUI::CAutoLayoutContainerView.

◆ addView() [3/3]

bool VSTGUI::CViewContainer::addView ( CView pView,
CView pBefore 
)
virtual

add a child view before another view

Parameters
pViewthe view object to add to this container
pBeforethe view object
Returns
true on success. false if view was already attached

Reimplemented in VSTGUI::CScrollView, VSTGUI::CSplitView, and VSTGUI::CAutoLayoutContainerView.

◆ advanceNextFocusView()

bool VSTGUI::CViewContainer::advanceNextFocusView ( CView oldFocus,
bool  reverse = false 
)
virtual
Parameters
oldFocusold focus view
reversesearch order
Returns
true on success

Reimplemented in VSTGUI::CFrame.

◆ attached()

bool VSTGUI::CViewContainer::attached ( CView parent)
overridevirtual

view is attached to a parent view

Parameters
parentparent view
Returns
true if view successfully attached to parent

Reimplemented from VSTGUI::CView.

Reimplemented in VSTGUI::UIViewSwitchContainer.

◆ changeViewZOrder()

bool VSTGUI::CViewContainer::changeViewZOrder ( CView view,
uint32_t  newIndex 
)
virtual

change view z order position

Parameters
viewview which z order position should be changed
newIndexindex of new z position
Returns
true if z order of view changed

Reimplemented in VSTGUI::CAutoLayoutContainerView.

◆ checkUpdateRect()

bool VSTGUI::CViewContainer::checkUpdateRect ( CView view,
const CRect rect 
)
protectedvirtual

check if view needs to be updated for rect

Parameters
viewview to check
rectupdate rect
Returns
true if view needs update

◆ draw()

void VSTGUI::CViewContainer::draw ( CDrawContext pContext)
overridevirtual
Parameters
pContextthe context which to use to draw this container and its subviews

Reimplemented from VSTGUI::CView.

◆ drawBackgroundRect()

void VSTGUI::CViewContainer::drawBackgroundRect ( CDrawContext pContext,
const CRect _updateRect 
)
virtual

draw the background

Parameters
pContextthe context which to use to draw the background
_updateRectthe area which to draw

Reimplemented in VSTGUI::CScrollView, VSTGUI::CTabView, and VSTGUI::CShadowViewContainer.

◆ drawRect()

void VSTGUI::CViewContainer::drawRect ( CDrawContext pContext,
const CRect updateRect 
)
overridevirtual
Parameters
pContextthe context which to use to draw
updateRectthe area which to draw

Reimplemented from VSTGUI::CView.

◆ frameToLocal()

CPoint & VSTGUI::CViewContainer::frameToLocal ( CPoint point) const
overridevirtual

conversion from frame coordinates to local view coordinates

Parameters
pointlocation
Returns
converted point

Reimplemented from VSTGUI::CView.

◆ getChildViewsOfType()

template<class ViewClass , class ContainerClass >
uint32_t VSTGUI::CViewContainer::getChildViewsOfType ( ContainerClass &  result,
bool  deep = false 
) const
inline

get child views of type ViewClass. ContainerClass must be a stdc++ container

◆ getContainerAt()

CViewContainer * VSTGUI::CViewContainer::getContainerAt ( const CPoint p,
const GetViewOptions options = GetViewOptions ().deep () 
) const
virtual

get the container at point where

Parameters
plocation
optionssearch search options
Returns
view container at position p or null

Reimplemented in VSTGUI::CFrame.

◆ getNbViews()

uint32_t VSTGUI::CViewContainer::getNbViews ( ) const
virtual

get the number of child views

Returns
number of subviews

Reimplemented in VSTGUI::CScrollView.

◆ getView()

CView * VSTGUI::CViewContainer::getView ( uint32_t  index) const
virtual

get the child view at index

Parameters
indexthe index of the view to return
Returns
view at index. NULL if view at index does not exist.

Reimplemented in VSTGUI::CScrollView.

◆ getViewAt()

CView * VSTGUI::CViewContainer::getViewAt ( const CPoint p,
const GetViewOptions options = GetViewOptions () 
) const
virtual

get the view at point where

Parameters
plocation
optionssearch options
Returns
view at position p or null

Reimplemented in VSTGUI::CFrame.

◆ getViewsAt()

bool VSTGUI::CViewContainer::getViewsAt ( const CPoint p,
ViewList &  views,
const GetViewOptions options = GetViewOptions ().deep () 
) const
virtual

get all views at point where, top->down

Parameters
plocation
viewsresult list
optionssearch options
Returns
success

◆ getVisibleSize()

CRect VSTGUI::CViewContainer::getVisibleSize ( const CRect rect) const
virtual
Parameters
rectsize to get visible size of
Returns
visible size of rect

◆ hitTest()

bool VSTGUI::CViewContainer::hitTest ( const CPoint where,
const CButtonState buttons = -1 
)
overridevirtual
Parameters
wherepoint
buttonsmouse button and modifier state
Returns
true if container accepts the hit

Reimplemented from VSTGUI::CView.

◆ hitTestSubViews()

bool VSTGUI::CViewContainer::hitTestSubViews ( const CPoint where,
const CButtonState buttons = -1 
)
virtual
Parameters
wherepoint
buttonsmouse button and modifier state
Returns
true if any sub view accepts the hit

Reimplemented in VSTGUI::CFrame.

◆ invalidRect()

void VSTGUI::CViewContainer::invalidRect ( const CRect rect)
overridevirtual

mark rect as invalid

Parameters
rectrect to invalidate

Reimplemented from VSTGUI::CView.

◆ isChild()

bool VSTGUI::CViewContainer::isChild ( CView pView) const
virtual

check if pView is a child view of this container

Parameters
pViewthe view which should be checked if it is a child of this container
Returns
true on success

◆ localToFrame()

CPoint & VSTGUI::CViewContainer::localToFrame ( CPoint point) const
overridevirtual

conversion from local view coordinates to frame coordinates

Parameters
pointlocation
Returns
converted point

Reimplemented from VSTGUI::CView.

◆ notify()

CMessageResult VSTGUI::CViewContainer::notify ( CBaseObject sender,
IdStringPtr  message 
)
overridevirtual
Parameters
sendermessage sender
messagemessage text
Returns
message handled or not. See #CMessageResult

Reimplemented from VSTGUI::CView.

◆ onMouseDown()

CMouseEventResult VSTGUI::CViewContainer::onMouseDown ( CPoint where,
const CButtonState buttons 
)
overridevirtual

called when a mouse down event occurs

Parameters
wheremouse location of mouse down
buttonsbutton and modifier state
Returns
event result. see #CMouseEventResult

Reimplemented from VSTGUI::CView.

◆ onMouseMoved()

CMouseEventResult VSTGUI::CViewContainer::onMouseMoved ( CPoint where,
const CButtonState buttons 
)
overridevirtual

called when a mouse move event occurs

Parameters
wheremouse location of mouse move
buttonsbutton and modifier state
Returns
event result. see #CMouseEventResult

Reimplemented from VSTGUI::CView.

◆ onMouseUp()

CMouseEventResult VSTGUI::CViewContainer::onMouseUp ( CPoint where,
const CButtonState buttons 
)
overridevirtual

called when a mouse up event occurs

Parameters
wheremouse location of mouse up
buttonsbutton and modifier state
Returns
event result. see #CMouseEventResult

Reimplemented from VSTGUI::CView.

◆ onWheel() [1/2]

bool VSTGUI::CViewContainer::onWheel ( const CPoint where,
const float &  distance,
const CButtonState buttons 
)
overridevirtual

called if a mouse wheel event is happening over this view

Parameters
wherelocation
distancewheel distance
buttonsbutton and modifier state
Returns
true if handled

Reimplemented from VSTGUI::CView.

◆ onWheel() [2/2]

bool VSTGUI::CViewContainer::onWheel ( const CPoint where,
const CMouseWheelAxis &  axis,
const float &  distance,
const CButtonState buttons 
)
overridevirtual

called if a mouse wheel event is happening over this view

Parameters
wherelocation
axismouse wheel axis
distancewheel distance
buttonsbutton and modifier state
Returns
true if handled

Reimplemented from VSTGUI::CView.

◆ removeAll()

bool VSTGUI::CViewContainer::removeAll ( bool  withForget = true)
virtual

remove all child views

Parameters
withForgetbool to indicate if the view's reference counter should be decreased after removed from the container
Returns
true on success

Reimplemented in VSTGUI::CFrame, VSTGUI::CScrollView, and VSTGUI::CSplitView.

◆ removed()

bool VSTGUI::CViewContainer::removed ( CView parent)
overridevirtual

view is removed from parent view

Parameters
parentparent view
Returns
true if view successfully removed from parent

Reimplemented from VSTGUI::CView.

Reimplemented in VSTGUI::UIViewSwitchContainer.

◆ removeView()

bool VSTGUI::CViewContainer::removeView ( CView pView,
bool  withForget = true 
)
virtual

remove a child view

Parameters
pViewthe view which should be removed from the container
withForgetbool to indicate if the view's reference counter should be decreased after removed from the container
Returns
true on success

Reimplemented in VSTGUI::CFrame, VSTGUI::CScrollView, VSTGUI::CSplitView, and VSTGUI::CAutoLayoutContainerView.

◆ setBackgroundColor()

void VSTGUI::CViewContainer::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)

Parameters
colorthe new background color of the container

Reimplemented in VSTGUI::CScrollView.

◆ setViewSize()

void VSTGUI::CViewContainer::setViewSize ( const CRect rect,
bool  invalid = true 
)
overridevirtual
Parameters
rectthe new size of the container
invalidthe views to dirty

Reimplemented from VSTGUI::CView.


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