VSTGUI  4.4
Graphical User Interface Framework not only for VST plugins
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Groups Pages
IDataBrowserDelegate Class Referenceabstract

DataBrowser Interface. More...

+ Inheritance diagram for IDataBrowserDelegate:

Public Types

enum  { kRowSelected = 1 << 1 }
 

Public Member Functions

Setup
virtual int32_t dbGetNumRows (CDataBrowser *browser)=0
 return number of rows for CDataBrowser browser More...
 
virtual int32_t dbGetNumColumns (CDataBrowser *browser)=0
 return number of columns for CDataBrowser browser More...
 
virtual bool dbGetColumnDescription (int32_t index, CCoord &minWidth, CCoord &maxWidth, CDataBrowser *browser)
 
virtual CCoord dbGetCurrentColumnWidth (int32_t index, CDataBrowser *browser)=0
 return current width of index column More...
 
virtual void dbSetCurrentColumnWidth (int32_t index, const CCoord &width, CDataBrowser *browser)
 the width of a column has changed More...
 
virtual CCoord dbGetRowHeight (CDataBrowser *browser)=0
 return height of one row More...
 
virtual bool dbGetLineWidthAndColor (CCoord &width, CColor &color, CDataBrowser *browser)
 return the line width and color More...
 
virtual void dbAttached (CDataBrowser *browser)
 databrowser view was attached to a parent More...
 
virtual void dbRemoved (CDataBrowser *browser)
 databrowser view will be removed from its parent More...
 
Drawing
virtual void dbDrawHeader (CDrawContext *context, const CRect &size, int32_t column, int32_t flags, CDataBrowser *browser)=0
 draw the db header More...
 
virtual void dbDrawCell (CDrawContext *context, const CRect &size, int32_t row, int32_t column, int32_t flags, CDataBrowser *browser)=0
 draw a db cell More...
 
Mouse Handling
virtual CMouseEventResult dbOnMouseDown (const CPoint &where, const CButtonState &buttons, int32_t row, int32_t column, CDataBrowser *browser)
 mouse button was pressed on a cell More...
 
virtual CMouseEventResult dbOnMouseMoved (const CPoint &where, const CButtonState &buttons, int32_t row, int32_t column, CDataBrowser *browser)
 mouse was moved over a cell More...
 
virtual CMouseEventResult dbOnMouseUp (const CPoint &where, const CButtonState &buttons, int32_t row, int32_t column, CDataBrowser *browser)
 mouse button was released on a cell More...
 
Drag'n Drop Handling
virtual void dbOnDragEnterBrowser (IDataPackage *drag, CDataBrowser *browser)
 
virtual void dbOnDragExitBrowser (IDataPackage *drag, CDataBrowser *browser)
 
virtual void dbOnDragEnterCell (int32_t row, int32_t column, const CPoint &where, IDataPackage *drag, CDataBrowser *browser)
 
virtual void dbOnDragMoveInCell (int32_t row, int32_t column, const CPoint &where, IDataPackage *drag, CDataBrowser *browser)
 
virtual void dbOnDragExitCell (int32_t row, int32_t column, IDataPackage *drag, CDataBrowser *browser)
 
virtual bool dbOnDropInCell (int32_t row, int32_t column, const CPoint &where, IDataPackage *drag, CDataBrowser *browser)
 
Selection
virtual void dbSelectionChanged (CDataBrowser *browser)
 the selection of the db changed More...
 
Cell Text Editing
virtual void dbCellTextChanged (int32_t row, int32_t column, UTF8StringPtr newText, CDataBrowser *browser)
 the text of the cell changed beginTextEdit was called for More...
 
virtual void dbCellSetupTextEdit (int32_t row, int32_t column, CTextEdit *textEditControl, CDataBrowser *browser)
 beginTextEdit calls this, so you can setup the textedit control More...
 
Keyboard Handling
virtual int32_t dbOnKeyDown (const VstKeyCode &key, CDataBrowser *browser)
 

Detailed Description

DataBrowser Interface.

Member Enumeration Documentation

anonymous enum
Enumerator
kRowSelected 

Member Function Documentation

virtual void dbAttached ( CDataBrowser browser)
inlinevirtual

databrowser view was attached to a parent

Reimplemented in GenericStringListDataBrowserSource.

virtual void dbCellSetupTextEdit ( int32_t  row,
int32_t  column,
CTextEdit textEditControl,
CDataBrowser browser 
)
inlinevirtual

beginTextEdit calls this, so you can setup the textedit control

Reimplemented in GenericStringListDataBrowserSource.

virtual void dbCellTextChanged ( int32_t  row,
int32_t  column,
UTF8StringPtr  newText,
CDataBrowser browser 
)
inlinevirtual

the text of the cell changed beginTextEdit was called for

Reimplemented in GenericStringListDataBrowserSource.

virtual void dbDrawCell ( CDrawContext context,
const CRect size,
int32_t  row,
int32_t  column,
int32_t  flags,
CDataBrowser browser 
)
pure virtual

draw a db cell

Implemented in GenericStringListDataBrowserSource.

virtual void dbDrawHeader ( CDrawContext context,
const CRect size,
int32_t  column,
int32_t  flags,
CDataBrowser browser 
)
pure virtual

draw the db header

Implemented in GenericStringListDataBrowserSource.

virtual bool dbGetColumnDescription ( int32_t  index,
CCoord minWidth,
CCoord maxWidth,
CDataBrowser browser 
)
inlinevirtual
virtual CCoord dbGetCurrentColumnWidth ( int32_t  index,
CDataBrowser browser 
)
pure virtual

return current width of index column

Implemented in GenericStringListDataBrowserSource.

virtual bool dbGetLineWidthAndColor ( CCoord width,
CColor color,
CDataBrowser browser 
)
inlinevirtual

return the line width and color

Reimplemented in GenericStringListDataBrowserSource.

virtual int32_t dbGetNumColumns ( CDataBrowser browser)
pure virtual

return number of columns for CDataBrowser browser

Implemented in GenericStringListDataBrowserSource.

virtual int32_t dbGetNumRows ( CDataBrowser browser)
pure virtual

return number of rows for CDataBrowser browser

Implemented in GenericStringListDataBrowserSource.

virtual CCoord dbGetRowHeight ( CDataBrowser browser)
pure virtual

return height of one row

Implemented in GenericStringListDataBrowserSource.

virtual void dbOnDragEnterBrowser ( IDataPackage drag,
CDataBrowser browser 
)
inlinevirtual
virtual void dbOnDragEnterCell ( int32_t  row,
int32_t  column,
const CPoint where,
IDataPackage drag,
CDataBrowser browser 
)
inlinevirtual
virtual void dbOnDragExitBrowser ( IDataPackage drag,
CDataBrowser browser 
)
inlinevirtual
virtual void dbOnDragExitCell ( int32_t  row,
int32_t  column,
IDataPackage drag,
CDataBrowser browser 
)
inlinevirtual
virtual void dbOnDragMoveInCell ( int32_t  row,
int32_t  column,
const CPoint where,
IDataPackage drag,
CDataBrowser browser 
)
inlinevirtual
virtual bool dbOnDropInCell ( int32_t  row,
int32_t  column,
const CPoint where,
IDataPackage drag,
CDataBrowser browser 
)
inlinevirtual
virtual int32_t dbOnKeyDown ( const VstKeyCode key,
CDataBrowser browser 
)
inlinevirtual
virtual CMouseEventResult dbOnMouseDown ( const CPoint where,
const CButtonState buttons,
int32_t  row,
int32_t  column,
CDataBrowser browser 
)
inlinevirtual

mouse button was pressed on a cell

Reimplemented in GenericStringListDataBrowserSource.

virtual CMouseEventResult dbOnMouseMoved ( const CPoint where,
const CButtonState buttons,
int32_t  row,
int32_t  column,
CDataBrowser browser 
)
inlinevirtual

mouse was moved over a cell

Reimplemented in GenericStringListDataBrowserSource.

virtual CMouseEventResult dbOnMouseUp ( const CPoint where,
const CButtonState buttons,
int32_t  row,
int32_t  column,
CDataBrowser browser 
)
inlinevirtual

mouse button was released on a cell

Reimplemented in GenericStringListDataBrowserSource.

virtual void dbRemoved ( CDataBrowser browser)
inlinevirtual

databrowser view will be removed from its parent

Reimplemented in GenericStringListDataBrowserSource.

virtual void dbSelectionChanged ( CDataBrowser browser)
inlinevirtual

the selection of the db changed

Reimplemented in GenericStringListDataBrowserSource.

virtual void dbSetCurrentColumnWidth ( int32_t  index,
const CCoord width,
CDataBrowser browser 
)
inlinevirtual

the width of a column has changed

Reimplemented in GenericStringListDataBrowserSource.


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