VSTGUI: DataBrowserDelegateAdapter Class Reference

VSTGUI 4.10 Graphical User Interface Framework not only for VST plugins

Loading...
Searching...
No Matches
Public Member Functions | List of all members
DataBrowserDelegateAdapter Class Referenceabstract

`#include <idatabrowserdelegate.h>`

Inheritance diagram for DataBrowserDelegateAdapter:

## Public Member Functions
int32_t | dbGetNumRows (CDataBrowser *browser) override=0
| return number of rows for CDataBrowser browser
int32_t | dbGetNumColumns (CDataBrowser *browser) override=0
| return number of columns for CDataBrowser browser
CCoord | dbGetRowHeight (CDataBrowser *browser) override=0
| return height of one row
CCoord | dbGetCurrentColumnWidth (int32_t index, CDataBrowser *browser) override=0
| return current width of index column
void | dbDrawCell (CDrawContext *context, const CRect &size, int32_t row, int32_t column, int32_t flags, CDataBrowser *browser) override=0
| draw a db cell
bool | dbGetColumnDescription (int32_t index, CCoord &minWidth, CCoord &maxWidth, CDataBrowser *browser) override
void | dbSetCurrentColumnWidth (int32_t index, const CCoord &width, CDataBrowser *browser) override
| the width of a column has changed
CCoord | dbGetHeaderHeight (CDataBrowser *browser) override
| return height of header
bool | dbGetLineWidthAndColor (CCoord &width, CColor &color, CDataBrowser *browser) override
| return the line width and color
void | dbDrawHeader (CDrawContext *context, const CRect &size, int32_t column, int32_t flags, CDataBrowser *browser) override
| draw the db header
void | dbAttached (CDataBrowser *browser) override
| databrowser view was attached to a parent
void | dbRemoved (CDataBrowser *browser) override
| databrowser view will be removed from its parent
CMouseEventResult | dbOnMouseDown (const CPoint &where, const CButtonState &buttons, int32_t row, int32_t column, CDataBrowser *browser) override
| mouse button was pressed on a cell
CMouseEventResult | dbOnMouseMoved (const CPoint &where, const CButtonState &buttons, int32_t row, int32_t column, CDataBrowser *browser) override
| mouse was moved over a cell
CMouseEventResult | dbOnMouseUp (const CPoint &where, const CButtonState &buttons, int32_t row, int32_t column, CDataBrowser *browser) override
| mouse button was released on a cell
void | dbOnDragEnterBrowser (IDataPackage *drag, CDataBrowser *browser) override
void | dbOnDragExitBrowser (IDataPackage *drag, CDataBrowser *browser) override
DragOperation | dbOnDragEnterCell (int32_t row, int32_t column, const CPoint &where, IDataPackage *drag, CDataBrowser *browser) override
DragOperation | dbOnDragMoveInCell (int32_t row, int32_t column, const CPoint &where, IDataPackage *drag, CDataBrowser *browser) override
void | dbOnDragExitCell (int32_t row, int32_t column, IDataPackage *drag, CDataBrowser *browser) override
bool | dbOnDropInCell (int32_t row, int32_t column, const CPoint &where, IDataPackage *drag, CDataBrowser *browser) override
void | dbSelectionChanged (CDataBrowser *browser) override
| the selection of the db changed
void | dbCellTextChanged (int32_t row, int32_t column, UTF8StringPtr newText, CDataBrowser *browser) override
| the text of the cell changed beginTextEdit was called for
void | dbCellSetupTextEdit (int32_t row, int32_t column, CTextEdit *textEditControl, CDataBrowser *browser) override
| beginTextEdit calls this, so you can setup the textedit control
void | dbOnKeyboardEvent (KeyboardEvent &event, CDataBrowser *browser) override
virtual int32_t | dbOnKeyDown (const VstKeyCode &keyCode, CDataBrowser *browser)
Public Member Functions inherited from IDataBrowserDelegate
virtual | ~IDataBrowserDelegate () noexcept=default

## Additional Inherited Members
Public Types inherited from IDataBrowserDelegate
enum | Flags { kRowSelected = 1 << 1 }

## Member Function Documentation

## ◆ dbAttached()

void dbAttached | ( | CDataBrowser * | browser | ) |
| inlineoverridevirtual

databrowser view was attached to a parent

Implements IDataBrowserDelegate.

Reimplemented in GenericStringListDataBrowserSource.

## ◆ dbCellSetupTextEdit()

void dbCellSetupTextEdit | ( | int32_t | row,
|  | int32_t | column,
|  | CTextEdit * | textEditControl,
|  | CDataBrowser * | browser )
| inlineoverridevirtual

beginTextEdit calls this, so you can setup the textedit control

Implements IDataBrowserDelegate.

Reimplemented in GenericStringListDataBrowserSource.

## ◆ dbCellTextChanged()

void dbCellTextChanged | ( | int32_t | row,
|  | int32_t | column,
|  | UTF8StringPtr | newText,
|  | CDataBrowser * | browser )
| inlineoverridevirtual

the text of the cell changed beginTextEdit was called for

Implements IDataBrowserDelegate.

Reimplemented in GenericStringListDataBrowserSource.

## ◆ dbDrawCell()

void dbDrawCell | ( | CDrawContext * | context,
|  | const CRect & | size,
|  | int32_t | row,
|  | int32_t | column,
|  | int32_t | flags,
|  | CDataBrowser * | browser )
| overridepure virtual

draw a db cell

Implements IDataBrowserDelegate.

Implemented in GenericStringListDataBrowserSource.

## ◆ dbDrawHeader()

void dbDrawHeader | ( | CDrawContext * | context,
|  | const CRect & | size,
|  | int32_t | column,
|  | int32_t | flags,
|  | CDataBrowser * | browser )
| inlineoverridevirtual

draw the db header

Implements IDataBrowserDelegate.

Reimplemented in GenericStringListDataBrowserSource.

## ◆ dbGetColumnDescription()

bool dbGetColumnDescription | ( | int32_t | index,
|  | CCoord & | minWidth,
|  | CCoord & | maxWidth,
|  | CDataBrowser * | browser )
| inlineoverridevirtual

Implements IDataBrowserDelegate.

Reimplemented in GenericStringListDataBrowserSource.

## ◆ dbGetCurrentColumnWidth()

CCoord dbGetCurrentColumnWidth | ( | int32_t | index,
|  | CDataBrowser * | browser )
| overridepure virtual

return current width of index column

Implements IDataBrowserDelegate.

Implemented in GenericStringListDataBrowserSource.

## ◆ dbGetHeaderHeight()

CCoord dbGetHeaderHeight | ( | CDataBrowser * | browser | ) |
| inlineoverridevirtual

return height of header

Implements IDataBrowserDelegate.

## ◆ dbGetLineWidthAndColor()

bool dbGetLineWidthAndColor | ( | CCoord & | width,
|  | CColor & | color,
|  | CDataBrowser * | browser )
| inlineoverridevirtual

return the line width and color

Implements IDataBrowserDelegate.

Reimplemented in GenericStringListDataBrowserSource.

## ◆ dbGetNumColumns()

int32_t dbGetNumColumns | ( | CDataBrowser * | browser | ) |
| overridepure virtual

return number of columns for CDataBrowser browser

Implements IDataBrowserDelegate.

Implemented in GenericStringListDataBrowserSource.

## ◆ dbGetNumRows()

int32_t dbGetNumRows | ( | CDataBrowser * | browser | ) |
| overridepure virtual

return number of rows for CDataBrowser browser

Implements IDataBrowserDelegate.

Implemented in GenericStringListDataBrowserSource.

## ◆ dbGetRowHeight()

CCoord dbGetRowHeight | ( | CDataBrowser * | browser | ) |
| overridepure virtual

return height of one row

Implements IDataBrowserDelegate.

Implemented in GenericStringListDataBrowserSource.

## ◆ dbOnDragEnterBrowser()

void dbOnDragEnterBrowser | ( | IDataPackage * | drag,
|  | CDataBrowser * | browser )
| inlineoverridevirtual

Implements IDataBrowserDelegate.

## ◆ dbOnDragEnterCell()

DragOperation dbOnDragEnterCell | ( | int32_t | row,
|  | int32_t | column,
|  | const CPoint & | where,
|  | IDataPackage * | drag,
|  | CDataBrowser * | browser )
| inlineoverridevirtual

Implements IDataBrowserDelegate.

## ◆ dbOnDragExitBrowser()

void dbOnDragExitBrowser | ( | IDataPackage * | drag,
|  | CDataBrowser * | browser )
| inlineoverridevirtual

Implements IDataBrowserDelegate.

## ◆ dbOnDragExitCell()

void dbOnDragExitCell | ( | int32_t | row,
|  | int32_t | column,
|  | IDataPackage * | drag,
|  | CDataBrowser * | browser )
| inlineoverridevirtual

Implements IDataBrowserDelegate.

## ◆ dbOnDragMoveInCell()

DragOperation dbOnDragMoveInCell | ( | int32_t | row,
|  | int32_t | column,
|  | const CPoint & | where,
|  | IDataPackage * | drag,
|  | CDataBrowser * | browser )
| inlineoverridevirtual

Implements IDataBrowserDelegate.

## ◆ dbOnDropInCell()

bool dbOnDropInCell | ( | int32_t | row,
|  | int32_t | column,
|  | const CPoint & | where,
|  | IDataPackage * | drag,
|  | CDataBrowser * | browser )
| inlineoverridevirtual

Implements IDataBrowserDelegate.

## ◆ dbOnKeyboardEvent()

void dbOnKeyboardEvent | ( | KeyboardEvent & | event,
|  | CDataBrowser * | browser )
| inlineoverridevirtual

Implements IDataBrowserDelegate.

Reimplemented in GenericStringListDataBrowserSource.

## ◆ dbOnKeyDown()

virtual int32_t dbOnKeyDown | ( | const VstKeyCode & | keyCode,
|  | CDataBrowser * | browser )
| inlinevirtual

## ◆ dbOnMouseDown()

CMouseEventResult dbOnMouseDown | ( | const CPoint & | where,
|  | const CButtonState & | buttons,
|  | int32_t | row,
|  | int32_t | column,
|  | CDataBrowser * | browser )
| inlineoverridevirtual

mouse button was pressed on a cell

Implements IDataBrowserDelegate.

Reimplemented in GenericStringListDataBrowserSource.

## ◆ dbOnMouseMoved()

CMouseEventResult dbOnMouseMoved | ( | const CPoint & | where,
|  | const CButtonState & | buttons,
|  | int32_t | row,
|  | int32_t | column,
|  | CDataBrowser * | browser )
| inlineoverridevirtual

mouse was moved over a cell

Implements IDataBrowserDelegate.

Reimplemented in GenericStringListDataBrowserSource.

## ◆ dbOnMouseUp()

CMouseEventResult dbOnMouseUp | ( | const CPoint & | where,
|  | const CButtonState & | buttons,
|  | int32_t | row,
|  | int32_t | column,
|  | CDataBrowser * | browser )
| inlineoverridevirtual

mouse button was released on a cell

Implements IDataBrowserDelegate.

Reimplemented in GenericStringListDataBrowserSource.

## ◆ dbRemoved()

void dbRemoved | ( | CDataBrowser * | browser | ) |
| inlineoverridevirtual

databrowser view will be removed from its parent

Implements IDataBrowserDelegate.

Reimplemented in GenericStringListDataBrowserSource.

## ◆ dbSelectionChanged()

void dbSelectionChanged | ( | CDataBrowser * | browser | ) |
| inlineoverridevirtual

the selection of the db changed

Implements IDataBrowserDelegate.

Reimplemented in GenericStringListDataBrowserSource.

## ◆ dbSetCurrentColumnWidth()

void dbSetCurrentColumnWidth | ( | int32_t | index,
|  | const CCoord & | width,
|  | CDataBrowser * | browser )
| inlineoverridevirtual

the width of a column has changed

Implements IDataBrowserDelegate.

Reimplemented in GenericStringListDataBrowserSource.

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

- idatabrowserdelegate.h