VSTGUI 4.10
Graphical User Interface Framework not only for VST plugins
CDataBrowser Class Reference

DataBrowser view. More...

#include <cdatabrowser.h>

+ Inheritance diagram for CDataBrowser:

Classes

struct  Cell
 CDataBrowser Cell position description. More...
 

Public Types

enum  CDataBrowserStyle { kDrawRowLines = 1 << kDrawRowLinesFlag , kDrawColumnLines = 1 << kDrawColumnLinesFlag , kDrawHeader = 1 << kDrawHeaderFlag , kMultiSelectionStyle = 1 << kMultiSelectionStyleFlag }
 
enum  { kNoSelection = -1 }
 
using Selection = std::vector< int32_t >
 
- Public Types inherited from CScrollView
enum  CScrollViewStyle {
  kHorizontalScrollbar = 1 << kHorizontalScrollbarFlag , kVerticalScrollbar = 1 << kVerticalScrollbarFlag , kDontDrawFrame = 1 << kDontDrawFrameFlag , kAutoDragScrolling = 1 << kAutoDragScollingFlag ,
  kOverlayScrollbars = 1 << kOverlayScrollbarsFlag , kFollowFocusView = 1 << kFollowFocusViewFlag , kAutoHideScrollbars = 1 << kAutoHideScrollbarsFlag
}
 Scroll View Style Flags. More...
 
- Public Types inherited from CViewContainer
using ViewList = std::list< SharedPointer< CView > >
 
using ChildViewConstIterator = ViewList::const_iterator
 
using ChildViewConstReverseIterator = ViewList::const_reverse_iterator
 
- Public Types inherited from CView
enum class  MouseListenerCall { MouseDown , MouseMoved , MouseUp , MouseCancel }
 

Public Member Functions

 CDataBrowser (const CRect &size, IDataBrowserDelegate *db, int32_t style=0, CCoord scrollbarWidth=16, CBitmap *pBackground=nullptr)
 
- Public Member Functions inherited from CScrollView
 CScrollView (const CRect &size, const CRect &containerSize, int32_t style, CCoord scrollbarWidth=16, CBitmap *pBackground=nullptr)
 
 CScrollView (const CScrollView &scrollView)
 
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 More...
 
const CRectgetContainerSize () const
 
const CPointgetScrollOffset () const
 get scroll offset More...
 
void resetScrollOffset ()
 
CScrollbargetVerticalScrollbar () const
 get the vertical scrollbar More...
 
CScrollbargetHorizontalScrollbar () const
 get the horizontal scrollbar More...
 
virtual void makeRectVisible (const CRect &rect)
 set scrollview to show rect More...
 
CRect calculateOptimalContainerSize () const
 calculate the maximum rect where the scrollbars are inactive More...
 
bool addView (CView *pView, CView *pBefore=nullptr) override
 add a child view before another view More...
 
bool removeView (CView *pView, bool withForget=true) override
 remove a child view More...
 
bool removeAll (bool withForget=true) override
 remove all child views More...
 
uint32_t getNbViews () const override
 get the number of child views More...
 
CViewgetView (uint32_t index) const override
 get the child view at index More...
 
bool changeViewZOrder (CView *view, uint32_t newIndex) override
 change view z order position More...
 
void drawBackgroundRect (CDrawContext *pContext, const CRect &_updateRect) override
 draw the background More...
 
void onMouseWheelEvent (MouseWheelEvent &event) override
 called when a mouse wheel event occurs More...
 
void valueChanged (CControl *pControl) override
 
void setTransparency (bool val) override
 set views transparent state More...
 
void setBackgroundColor (const CColor &color) override
 set the background color (will only be drawn if this container is not set to transparent and does not have a background bitmap) More...
 
void setViewSize (const CRect &rect, bool invalid=true) override
 set views size More...
 
void setAutosizeFlags (int32_t flags) override
 set autosize flags More...
 
CMessageResult notify (CBaseObject *sender, IdStringPtr message) override
 
CBaseObjectnewCopy () const override
 
- Public Member Functions inherited from CViewContainer
 CViewContainer (const CRect &size)
 CViewContainer constructor. More...
 
 CViewContainer (const CViewContainer &viewContainer)
 
bool addView (CView *pView, const CRect &mouseableArea, bool mouseEnabled=true)
 add a child view More...
 
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 More...
 
virtual bool hasChildren () const
 check if container has child views 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 hitTestSubViews (const CPoint &where, const Event &event)
 
virtual void setAutosizingEnabled (bool state)
 enable or disable autosizing subviews. More...
 
bool getAutosizingEnabled () const
 
template<class ViewClass , class ContainerClass >
uint32_t getChildViewsOfType (ContainerClass &result, bool deep=false) const
 get child views of type ViewClass. More...
 
template<typename Proc >
void forEachChild (Proc proc) const
 execute proc for each child view More...
 
virtual CColor getBackgroundColor () const
 get the background color More...
 
virtual void setBackgroundOffset (const CPoint &p)
 set the offset of the background bitmap More...
 
virtual CPoint getBackgroundOffset () const
 get the offset of the background bitmap More...
 
virtual void setBackgroundColorDrawStyle (CDrawStyle style)
 
CDrawStyle getBackgroundColorDrawStyle () const
 
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
 
void onMouseDownEvent (MouseDownEvent &event) override
 called when a mouse down event occurs More...
 
void onMouseMoveEvent (MouseMoveEvent &event) override
 called when a mouse move event occurs More...
 
void onMouseUpEvent (MouseUpEvent &event) override
 called when a mouse up event occurs More...
 
void onMouseCancelEvent (MouseCancelEvent &event) override
 called when mouse tracking should be canceled More...
 
void onMouseWheelEvent (MouseWheelEvent &event) override
 called when a mouse wheel event occurs More...
 
void onZoomGestureEvent (ZoomGestureEvent &event) override
 called when a zoom gesture event occurs More...
 
CMessageResult notify (CBaseObject *sender, IdStringPtr message) override
 
bool onWheel (const CPoint &where, const CMouseWheelAxis &axis, const float &distance, const CButtonState &buttons) final
 
SharedPointer< IDropTargetgetDropTarget () override
 get the drag target for drag and drop handling More...
 
void looseFocus () override
 called if view should loose focus More...
 
void takeFocus () override
 called if view should take focus More...
 
bool isDirty () const override
 check if view is dirty More...
 
void invalid () override
 mark whole view as invalid More...
 
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 More...
 
bool sizeToFit () override
 resize view to optimal size More...
 
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...
 
CBaseObjectnewCopy () const override
 
CViewContainerasViewContainer () final
 
const CViewContainerasViewContainer () const final
 
- Public Member Functions inherited from CView
 CView (const CRect &size)
 
 CView (const CView &view)
 
virtual void dispatchEvent (Event &event)
 dispatch an event More...
 
virtual void onMouseEnterEvent (MouseEnterEvent &event)
 called when the mouse enters this view More...
 
virtual void onMouseExitEvent (MouseExitEvent &event)
 called when the mouse leaves this view More...
 
virtual void setMouseEnabled (bool bEnable=true)
 turn on/off mouse usage for this view More...
 
bool getMouseEnabled () const
 get the state of wheather this view uses the mouse or not More...
 
virtual void setMouseableArea (const CRect &rect)
 set the area in which the view reacts to the mouse More...
 
CRect getMouseableArea () const
 get the area in which the view reacts to the mouse More...
 
virtual CMouseEventResult onMouseUp (CPoint &where, const CButtonState &buttons)
 do not use any longer. More...
 
virtual CMouseEventResult onMouseMoved (CPoint &where, const CButtonState &buttons)
 do not use any longer. More...
 
virtual CMouseEventResult onMouseCancel ()
 do not use any longer. More...
 
virtual CMouseEventResult onMouseEntered (CPoint &where, const CButtonState &buttons)
 do not use any longer. More...
 
virtual CMouseEventResult onMouseExited (CPoint &where, const CButtonState &buttons)
 do not use any longer. More...
 
virtual bool onWheel (const CPoint &where, const float &distance, const CButtonState &buttons) final
 
CRectgetMouseableArea (CRect &rect) const
 get the area in which the view reacts to the mouse More...
 
void setHitTestPath (CGraphicsPath *path)
 
virtual bool hitTest (const CPoint &where, const Event &event=noEvent())
 check if where hits this view More...
 
virtual bool hitTest (const CPoint &where, const CButtonState &buttons)
 
bool doDrag (const DragDescription &dragDescription, const SharedPointer< IDragCallback > &callback={})
 start a drag operation More...
 
void setDropTarget (const SharedPointer< IDropTarget > &dt)
 set a custom drop target More...
 
DragResult doDrag (IDataPackage *source, const CPoint &offset=CPoint(0, 0), CBitmap *dragBitmap=nullptr)
 a drag can only be started from within onMouseDown 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 More...
 
CCoord getWidth () const
 get the width of the view More...
 
const CRectgetViewSize () const
 read only access to view size More...
 
virtual CRect getVisibleViewSize () const
 returns the visible size of the view More...
 
int32_t getAutosizeFlags () const
 get autosize flags More...
 
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 More...
 
template<typename T >
bool setAttribute (const CViewAttributeID id, const T &data)
 set an attribute More...
 
template<typename T >
bool getAttribute (const CViewAttributeID id, T &data) const
 get an attribute More...
 
virtual void setBackground (CBitmap *background)
 set the background image of this view More...
 
CBitmapgetBackground () const
 get the background image of this view More...
 
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 More...
 
CBitmapgetDrawBackground () const
 get the bitmap which is drawn depending on the enabled state. More...
 
bool getTransparency () const
 get views transparent state More...
 
virtual void setAlphaValue (float alpha)
 set alpha value which will be applied when drawing this view More...
 
float getAlphaValue () const
 get alpha value More...
 
bool isAttached () const
 is view attached to a parentView More...
 
void setSubviewState (bool state)
 
bool isSubview () const
 
CViewgetParentView () const
 get parent view More...
 
CFramegetFrame () const
 get frame More...
 
virtual VSTGUIEditorInterfacegetEditor () const
 get editor More...
 
void addAnimation (IdStringPtr name, Animation::IAnimationTarget *target, Animation::ITimingFunction *timingFunction, CBaseObject *notificationObject)
 
void addAnimation (IdStringPtr name, Animation::IAnimationTarget *target, Animation::ITimingFunction *timingFunction, const Animation::DoneFunction &doneFunc=nullptr, bool callDoneOnCancel=false)
 
void removeAnimation (IdStringPtr name)
 
void removeAllAnimations ()
 
void registerViewListener (IViewListener *listener)
 
void unregisterViewListener (IViewListener *listener)
 
void registerViewEventListener (IViewEventListener *listener)
 
void unregisterViewEventListener (IViewEventListener *listener)
 
void registerViewMouseListener (IViewMouseListener *listener)
 
void unregisterViewMouseListener (IViewMouseListener *listener)
 
CGraphicsTransform getGlobalTransform (bool ignoreFrame=false) const
 get the active global transform for this view More...
 
template<typename T >
T & translateToGlobal (T &t, bool ignoreFrame=false) const
 translates a local coordinate to a global one using parent transforms More...
 
template<typename T >
translateToGlobal (const T &t, bool ignoreFrame=false) const
 translates a local coordinate to a global one using parent transforms More...
 
template<typename T >
T & translateToLocal (T &t, bool ignoreFrame=false) const
 translates a global coordinate to a local one using parent transforms More...
 
template<typename T >
translateToLocal (const T &t, bool ignoreFrame=false) const
 translates a local coordinate to a global one using parent transforms More...
 
CMouseEventResult callMouseListener (MouseListenerCall type, CPoint pos, CButtonState buttons)
 
void callMouseListenerEnteredExited (bool mouseEntered)
 
CBaseObjectnewCopy () const override
 
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. More...
 
virtual void setVisible (bool state)
 set visibility state More...
 
bool isVisible () const
 get visibility state More...
 
virtual void onIdle ()
 called on idle when view wants idle More...
 
void setWantsIdle (bool state)
 enable/disable onIdle() callback More...
 
bool wantsIdle () const
 returns if the view wants idle callback or not More...
 
virtual bool wantsWindowActiveStateChangeNotification () const
 whether this view wants to be informed if the window's active state changes More...
 
virtual void onWindowActivate (bool state)
 called when the active state of the window changes More...
 
void setTooltipText (UTF8StringPtr text)
 
- Public Member Functions inherited from CBaseObject
 CBaseObject ()=default
 
 ~CBaseObject () noexcept override=default
 
 CBaseObject (const CBaseObject &)
 
CBaseObjectoperator= (const CBaseObject &)
 
- Public Member Functions inherited from ReferenceCounted< T >
 ReferenceCounted ()=default
 
virtual ~ReferenceCounted () noexcept=default
 
 ReferenceCounted (const ReferenceCounted &)
 
ReferenceCountedoperator= (const ReferenceCounted &)
 
void forget () override
 decrease refcount and delete object if refcount == 0 More...
 
void remember () override
 increase refcount More...
 
virtual int32_t getNbReference () const
 get refcount More...
 
virtual void forget ()=0
 decrease refcount and delete object if refcount == 0 More...
 
virtual void remember ()=0
 increase refcount More...
 
- Public Member Functions inherited from IControlListener
virtual ~IControlListener () noexcept=default
 
virtual void valueChanged (CControl *pControl)=0
 
virtual int32_t controlModifierClicked (CControl *pControl, CButtonState button)
 return 1 if you want the control to not handle it, otherwise 0 More...
 
virtual void controlBeginEdit (CControl *pControl)
 
virtual void controlEndEdit (CControl *pControl)
 
virtual void controlTagWillChange (CControl *pControl)
 
virtual void controlTagDidChange (CControl *pControl)
 
- Public Member Functions inherited from ViewListenerAdapter
void viewSizeChanged (CView *view, const CRect &oldSize) override
 called when the view's size changed More...
 
void viewAttached (CView *view) override
 called when a view was attached to a view hierarchy More...
 
void viewRemoved (CView *view) override
 called when a view was removed from the view hierarchy More...
 
void viewLostFocus (CView *view) override
 called when a view lost focus More...
 
void viewTookFocus (CView *view) override
 called when a view took focus More...
 
void viewWillDelete (CView *view) override
 called when a view is going to be destroyed More...
 
void viewOnMouseEnabled (CView *view, bool state) override
 called when a view's mouse handling is enabled or disabled More...
 
- Public Member Functions inherited from IViewListener
virtual ~IViewListener () noexcept=default
 
virtual void viewSizeChanged (CView *view, const CRect &oldSize)=0
 called when the view's size changed More...
 
virtual void viewAttached (CView *view)=0
 called when a view was attached to a view hierarchy More...
 
virtual void viewRemoved (CView *view)=0
 called when a view was removed from the view hierarchy More...
 
virtual void viewLostFocus (CView *view)=0
 called when a view lost focus More...
 
virtual void viewTookFocus (CView *view)=0
 called when a view took focus More...
 
virtual void viewWillDelete (CView *view)=0
 called when a view is going to be destroyed More...
 
virtual void viewOnMouseEnabled (CView *view, bool state)=0
 called when a view's mouse handling is enabled or disabled More...
 

Protected Types

enum  { kDrawRowLinesFlag = kLastScrollViewStyleFlag , kDrawColumnLinesFlag , kDrawHeaderFlag , kMultiSelectionStyleFlag }
 
- Protected Types inherited from CScrollView
enum  {
  kHorizontalScrollbarFlag , kVerticalScrollbarFlag , kDontDrawFrameFlag , kAutoDragScollingFlag ,
  kOverlayScrollbarsFlag , kFollowFocusViewFlag , kAutoHideScrollbarsFlag , kLastScrollViewStyleFlag
}
 
enum  { kHSBTag , kVSBTag }
 
- Protected Types inherited from CViewContainer
enum  { kAutosizeSubviews = 1 << (CView::kLastCViewFlag + 1) }
 
- Protected Types inherited from 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 ,
  kHasAlpha = 1 << 8 , kHasBackground = 1 << 9 , kHasDisabledBackground = 1 << 10 , kHasMouseableArea = 1 << 11 ,
  kLastCViewFlag = 11
}
 

CDataBrowser Methods

IDataBrowserDelegatedb
 
CDataBrowserView * dbView
 
CDataBrowserHeader * dbHeader
 
CViewContainerdbHeaderContainer
 
Selection selection
 
virtual void recalculateLayout (bool rememberSelection=false)
 trigger recalculation, call if numRows or numColumns changed More...
 
virtual void invalidate (const Cell &cell)
 invalidates an individual cell More...
 
virtual void invalidateRow (int32_t row)
 invalidates a complete row More...
 
virtual void makeRowVisible (int32_t row)
 scrolls the scrollview so that row is visible More...
 
virtual CRect getCellBounds (const Cell &cell)
 get bounds of a cell More...
 
virtual Cell getCellAt (const CPoint &where) const
 get the cell at position where More...
 
virtual int32_t getSelectedRow () const
 get first selected row More...
 
virtual void setSelectedRow (int32_t row, bool makeVisible=false)
 set the exclusive selected row More...
 
const SelectiongetSelection () const
 get all selected rows More...
 
virtual void selectRow (int32_t row)
 add row to selection More...
 
virtual void unselectRow (int32_t row)
 remove row from selection More...
 
virtual void unselectAll ()
 empty selection More...
 
virtual void beginTextEdit (const Cell &cell, UTF8StringPtr initialText)
 starts a text edit for a cell More...
 
IDataBrowserDelegategetDelegate () const
 get delegate object More...
 
void setAutosizeFlags (int32_t flags) override
 set autosize flags More...
 
void setViewSize (const CRect &size, bool invalid) override
 set views size More...
 
void setWantsFocus (bool state) override
 set focus support on/off More...
 
void onKeyboardEvent (KeyboardEvent &event) override
 called when a keyboard event is dispatched to this view More...
 
CMouseEventResult onMouseDown (CPoint &where, const CButtonState &buttons) override
 do not use any longer. More...
 
 ~CDataBrowser () noexcept override
 
void valueChanged (CControl *pControl) override
 
CMessageResult notify (CBaseObject *sender, IdStringPtr message) override
 
bool attached (CView *parent) override
 view is attached to a parent view More...
 
bool removed (CView *parent) override
 view is removed from parent view More...
 
bool wantsFocus () const override
 check if view supports focus More...
 
void recalculateSubViews () override
 
void validateSelection ()
 

Additional Inherited Members

- Static Public Attributes inherited from CView
static bool kDirtyCallAlwaysOnMainThread = false
 if this is true, setting a view dirty will call invalid() instead of checking it in idle. More...
 
static uint32_t idleRate = 30
 global idle rate in Hz, defaults to 30 Hz More...
 
- Protected Member Functions inherited from CScrollView
 ~CScrollView () noexcept override=default
 
void viewSizeChanged (CView *view, const CRect &oldSize) override
 called when the view's size changed More...
 
void viewWillDelete (CView *view) override
 called when a view is going to be destroyed More...
 
- Protected Member Functions inherited from CViewContainer
 ~CViewContainer () noexcept override
 
void beforeDelete () override
 
virtual bool checkUpdateRect (CView *view, const CRect &rect)
 check if view needs to be updated for rect More...
 
void setMouseDownView (CView *view)
 
CViewgetMouseDownView () const
 
const ViewListgetChildren () const
 
- Protected Member Functions inherited from CView
 ~CView () noexcept override
 
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)
 
- Protected Attributes inherited from CScrollView
CScrollContainer * sc
 
CScrollbarvsb
 
CScrollbarhsb
 
CRect containerSize
 
CCoord scrollbarWidth
 
int32_t style
 
int32_t activeScrollbarStyle
 
bool recalculateSubViewsRecursionGard {false}
 

Detailed Description

DataBrowser view.

Member Typedef Documentation

◆ Selection

using Selection = std::vector<int32_t>

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
protected
Enumerator
kDrawRowLinesFlag 
kDrawColumnLinesFlag 
kDrawHeaderFlag 
kMultiSelectionStyleFlag 

◆ anonymous enum

anonymous enum
Enumerator
kNoSelection 

◆ CDataBrowserStyle

Enumerator
kDrawRowLines 
kDrawColumnLines 
kDrawHeader 
kMultiSelectionStyle 

Constructor & Destructor Documentation

◆ CDataBrowser()

CDataBrowser ( const CRect size,
IDataBrowserDelegate db,
int32_t  style = 0,
CCoord  scrollbarWidth = 16,
CBitmap pBackground = nullptr 
)
Parameters
sizesize of data browser
dbdata browser interface. If db is inheritated from CBaseObject it will be remembered and released if data browser is destroyed
styledata browser and scroll view style see CDataBrowserStyle and CScrollViewStyle
scrollbarWidthwidth of scrollbars
pBackgroundbackground bitmap

◆ ~CDataBrowser()

~CDataBrowser ( )
overrideprotectednoexcept

Member Function Documentation

◆ attached()

bool attached ( CView parent)
overrideprotectedvirtual

view is attached to a parent view

Parameters
parentparent view
Returns
true if view successfully attached to parent

Reimplemented from CView.

◆ beginTextEdit()

void beginTextEdit ( const Cell cell,
UTF8StringPtr  initialText 
)
virtual

starts a text edit for a cell

Parameters
cellcell
initialTextUTF-8 string the text edit field will be initialized with

◆ getCellAt()

CDataBrowser::Cell getCellAt ( const CPoint where) const
virtual

get the cell at position where

◆ getCellBounds()

CRect getCellBounds ( const Cell cell)
virtual

get bounds of a cell

Parameters
cellcell
Returns
bounds of cell

◆ getDelegate()

IDataBrowserDelegate * getDelegate ( ) const
inline

get delegate object

◆ getSelectedRow()

int32_t getSelectedRow ( ) const
virtual

get first selected row

◆ getSelection()

const Selection & getSelection ( ) const
inline

get all selected rows

◆ invalidate()

void invalidate ( const Cell cell)
virtual

invalidates an individual cell

Parameters
cellcell to invalidate

◆ invalidateRow()

void invalidateRow ( int32_t  row)
virtual

invalidates a complete row

Parameters
rowrow to invalidate

◆ makeRowVisible()

void makeRowVisible ( int32_t  row)
virtual

scrolls the scrollview so that row is visible

Parameters
rowrow to make visible

◆ notify()

CMessageResult notify ( CBaseObject sender,
IdStringPtr  message 
)
overrideprotectedvirtual

Reimplemented from CBaseObject.

◆ onKeyboardEvent()

void onKeyboardEvent ( KeyboardEvent event)
overridevirtual

called when a keyboard event is dispatched to this view

This happens normally only if the view is the focus view.

Reimplemented from CView.

◆ onMouseDown()

CMouseEventResult onMouseDown ( CPoint where,
const CButtonState buttons 
)
overridevirtual

do not use any longer.

if possible refactor your classes to use the newer mouse event methods above.

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

Reimplemented from CView.

◆ recalculateLayout()

void recalculateLayout ( bool  rememberSelection = false)
virtual

trigger recalculation, call if numRows or numColumns changed

Parameters
rememberSelectionif true selection will be remembered

◆ recalculateSubViews()

void recalculateSubViews ( )
overrideprotectedvirtual

Reimplemented from CScrollView.

◆ removed()

bool removed ( CView parent)
overrideprotectedvirtual

view is removed from parent view

Parameters
parentparent view
Returns
true if view successfully removed from parent

Reimplemented from CView.

◆ selectRow()

void selectRow ( int32_t  row)
virtual

add row to selection

◆ setAutosizeFlags()

void setAutosizeFlags ( int32_t  flags)
overridevirtual

set autosize flags

Reimplemented from CView.

◆ setSelectedRow()

void setSelectedRow ( int32_t  index,
bool  makeVisible = false 
)
virtual

set the exclusive selected row

Parameters
indexrow to select
makeVisibleif true makes row visible

◆ setViewSize()

void setViewSize ( const CRect newSize,
bool  doInvalid 
)
overridevirtual

set views size

Parameters
newSizerect of new size of view
doInvalidif true set view dirty

Reimplemented from CView.

◆ setWantsFocus()

void setWantsFocus ( bool  state)
overridevirtual

set focus support on/off

Reimplemented from CView.

◆ unselectAll()

void unselectAll ( )
virtual

empty selection

◆ unselectRow()

void unselectRow ( int32_t  row)
virtual

remove row from selection

◆ validateSelection()

void validateSelection ( )
protected

◆ valueChanged()

void valueChanged ( CControl pControl)
overrideprotectedvirtual

Implements IControlListener.

◆ wantsFocus()

bool wantsFocus ( ) const
overrideprotectedvirtual

check if view supports focus

Reimplemented from CView.

Member Data Documentation

◆ db

IDataBrowserDelegate* db
protected

◆ dbHeader

CDataBrowserHeader* dbHeader
protected

◆ dbHeaderContainer

CViewContainer* dbHeaderContainer
protected

◆ dbView

CDataBrowserView* dbView
protected

◆ selection

Selection selection
protected

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