Contents Up Previous Next

cbDockPane

This class manages containment and control of control bars along one of the four edges of the parent frame.

Derived from

wxObject

Include files

<wx/fl/controlbar.h>

Data structures

Members

cbDockPane::cbDockPane
cbDockPane::~cbDockPane
cbDockPane::BarPresent
cbDockPane::CalcLengthRatios
cbDockPane::ContractBar
cbDockPane::DoInsertBar
cbDockPane::DrawHorizHandle
cbDockPane::DrawVertHandle
cbDockPane::ExpandBar
cbDockPane::FinishDrawInArea
cbDockPane::FrameToPane
cbDockPane::GetAlignment
cbDockPane::GetBarInfoByWindow
cbDockPane::GetBarResizeRange
cbDockPane::GetDockingState
cbDockPane::GetFirstRow
cbDockPane::GetMinimalRowHeight
cbDockPane::GetNotFixedBarsCount
cbDockPane::GetPaneHeight
cbDockPane::GetRealRect
cbDockPane::GetRow
cbDockPane::GetRowAt
cbDockPane::GetRowIndex
cbDockPane::GetRowList
cbDockPane::GetRowResizeRange
cbDockPane::GetRowShapeData
cbDockPane::GetRowY
cbDockPane::HasNotFixedBarsLeft
cbDockPane::HasNotFixedBarsRight
cbDockPane::HasNotFixedRowsAbove
cbDockPane::HasNotFixedRowsBelow
cbDockPane::HasPoint
cbDockPane::HitTestPaneItems
cbDockPane::InitLinksForRow
cbDockPane::InitLinksForRows
cbDockPane::InsertBar
cbDockPane::InsertRow
cbDockPane::IsFixedSize
cbDockPane::IsHorizontal
cbDockPane::MatchesMask
cbDockPane::PaintBar
cbDockPane::PaintBarDecorations
cbDockPane::PaintBarHandles
cbDockPane::PaintPane
cbDockPane::PaintPaneBackground
cbDockPane::PaintPaneDecorations
cbDockPane::PaintRow
cbDockPane::PaintRowBackground
cbDockPane::PaintRowDecorations
cbDockPane::PaintRowHandles
cbDockPane::PaneToFrame
cbDockPane::RecalcLayout
cbDockPane::RecalcRowLayout
cbDockPane::RemoveBar
cbDockPane::RemoveRow
cbDockPane::ResizeBar
cbDockPane::ResizeRow
cbDockPane::SetBoundsInParent
cbDockPane::SetMargins
cbDockPane::SetPaneWidth
cbDockPane::SetRowHeight
cbDockPane::SetRowShapeData
cbDockPane::SizeBar
cbDockPane::SizePaneObjects
cbDockPane::SizeRowObjects
cbDockPane::StartDrawInArea
cbDockPane::SyncRowFlags


cbDockPane::cbDockPane

cbDockPane(int alignment, wxFrameLayout* pPanel)

Constructor, taking alignment and layout panel.

cbDockPane()

public members Default constructor.


cbDockPane::~cbDockPane

~cbDockPane()

Destructor.


cbDockPane::BarPresent

bool BarPresent(cbBarInfo* pBar)

Returns TRUE if the given bar is present in this pane.


cbDockPane::CalcLengthRatios

void CalcLengthRatios(cbRowInfo* pInRow)

Calculate lengths. Internal function called by plugins.


cbDockPane::ContractBar

void ContractBar(cbBarInfo* pBar)

Contracts the bar. Internal function called by plugins.


cbDockPane::DoInsertBar

void DoInsertBar(cbBarInfo* pBar, int rowNo)

Inserts the bar at the given row number. Internal function called by plugins.


cbDockPane::DrawHorizHandle

void DrawHorizHandle(wxDC& dc, int x, int y, int width)

Row/bar resizing related helper-method.


cbDockPane::DrawVertHandle

void DrawVertHandle(wxDC& dc, int x, int y, int height)

protected really (accessed only by plugins) Row/bar resizing related helper-method.


cbDockPane::ExpandBar

void ExpandBar(cbBarInfo* pBar)

Expands the bar. Internal function called by plugins.


cbDockPane::FinishDrawInArea

void FinishDrawInArea(const wxRect& area)

Generates cbFinishDrawInAreaEvent and sends it to the layout. Internal function called by plugins.


cbDockPane::FrameToPane

void FrameToPane(int* x, int* y)

Coordinate translation between parent's frame and this pane. Internal function called by plugins.

void FrameToPane(wxRect* pRect)

Coordinate translation between parent's frame and this pane. Internal function called by plugins.


cbDockPane::GetAlignment

int GetAlignment()

Returns the alignment for this pane. The value is one of FL_ALIGN_TOP, FL_ALIGN_BOTTOM, FL_ALIGN_LEFT, FL_ALIGN_RIGHT.


cbDockPane::GetBarInfoByWindow

cbBarInfo* GetBarInfoByWindow(wxWindow* pBarWnd)

Finds the bar information by corresponding window.


cbDockPane::GetBarResizeRange

void GetBarResizeRange(cbBarInfo* pBar, int* from, int* till, bool forLeftHandle)

Returns the bar's resize range.


cbDockPane::GetDockingState

int GetDockingState()

Returns wxCBAR_DOCKED_HORIZONTALLY if the alignment is top or bottom, or wxCBAR_DOCKED_VERTICALLY otherwise.


cbDockPane::GetFirstRow

cbRowInfo* GetFirstRow()

Returns the first row.


cbDockPane::GetMinimalRowHeight

int GetMinimalRowHeight(cbRowInfo* pRow)

Returns the minimal row height for the given row. Internal function called by plugins.


cbDockPane::GetNotFixedBarsCount

int GetNotFixedBarsCount(cbRowInfo* pRow)

Returns the number of bars whose size is not fixed. Internal function called by plugins.


cbDockPane::GetPaneHeight

int GetPaneHeight()

Returns the height in the pane's coordinates.


cbDockPane::GetRealRect

wxRect& GetRealRect()

Returns the bounds of the pane, in parent coordinates.


cbDockPane::GetRow

cbRowInfo* GetRow(int row)

protected really (accessed only by plugins) Returns the row info for a row index. Internal function called by plugins.


cbDockPane::GetRowAt

int GetRowAt(int paneY)

Returns the row at the given vertical position. Returns -1 if the row is not present at given vertical position. Internal function called by plugins.

int GetRowAt(int upperY, int lowerY)

Returns the row between the given vertical positions. Returns -1 if the row is not present. Internal function called by plugins.


cbDockPane::GetRowIndex

int GetRowIndex(cbRowInfo* pRow)

Returns the row index for the given row info. Internal function called by plugins.


cbDockPane::GetRowList

RowArrayT& GetRowList()

Returns an array of rows. Used by updates-managers.


cbDockPane::GetRowResizeRange

void GetRowResizeRange(cbRowInfo* pRow, int* from, int* till, bool forUpperHandle)

Returns the row's resize range.


cbDockPane::GetRowShapeData

void GetRowShapeData(cbRowInfo* pRow, wxList* pLst)

Returns row shape data. cbBarShapeData objects will be added to the given pLst. cbBarShapeData is used for storing the original bar's positions in the row, when the 'non-destructive-friction' option is turned on.


cbDockPane::GetRowY

int GetRowY(cbRowInfo* pRow)

Gets the vertical position at the given row. Internal function called by plugins.


cbDockPane::HasNotFixedBarsLeft

bool HasNotFixedBarsLeft(cbBarInfo* pBar)

Returns TRUE if there are any variable-sized rows to the left of this one. Internal function called by plugins.


cbDockPane::HasNotFixedBarsRight

bool HasNotFixedBarsRight(cbBarInfo* pBar)

Returns TRUE if there are any variable-sized rows to the right of this one. Internal function called by plugins.


cbDockPane::HasNotFixedRowsAbove

bool HasNotFixedRowsAbove(cbRowInfo* pRow)

Returns TRUE if there are any variable-sized rows above this one. Internal function called by plugins.


cbDockPane::HasNotFixedRowsBelow

bool HasNotFixedRowsBelow(cbRowInfo* pRow)

Returns TRUE if there are any variable-sized rows below this one. Internal function called by plugins.


cbDockPane::HasPoint

bool HasPoint(const wxPoint& pos, int x, int y, int width, int height)

Returns TRUE if pos is within the given rectangle. Internal function called by plugins.


cbDockPane::HitTestPaneItems

int HitTestPaneItems(const wxPoint& pos, cbRowInfo** ppRow, cbBarInfo** ppBar)

Returns the result of hit-testing items in the pane. See CB_HITTEST_RESULT enumerated type. pos is the position in this pane's coordinates.


cbDockPane::InitLinksForRow

void InitLinksForRow(cbRowInfo* pRow)

Sets up links between bars. Internal function called by plugins.


cbDockPane::InitLinksForRows

void InitLinksForRows()

Sets up links between bars. Internal function called by plugins.


cbDockPane::InsertBar

void InsertBar(cbBarInfo* pBarInfo)

Inserts bar and sets its position according to the preferred settings given in pBarInfo.

void InsertBar(cbBarInfo* pBar, const wxRect& rect)

Inserts the bar into this pane. rect is given in the parent frame's coordinates.

void InsertBar(cbBarInfo* pBar, cbRowInfo* pIntoRow)

Inserts the bar into the given row, with dimensions and position stored in pBarInfo->mBounds. Returns the node of inserted bar.


cbDockPane::InsertRow

void InsertRow(cbRowInfo* pRow, cbRowInfo* pBeforeRow)

Inserts a row. Does not refresh the inserted row immediately. If pBeforeRowNode is NULL, the row is appended to the end of pane's row list.


cbDockPane::IsFixedSize

bool IsFixedSize(cbBarInfo* pInfo)

Returns TRUE if the bar's dimension information indicates a fixed size. Internal function called by plugins.


cbDockPane::IsHorizontal

bool IsHorizontal()

Returns TRUE if the pane is aligned to the top or bottom.


cbDockPane::MatchesMask

bool MatchesMask(int paneMask)

Returns TRUE if the given mask matches the pane's mask.


cbDockPane::PaintBar

void PaintBar(cbBarInfo* pBar, wxDC& dc)

Calls PaintBarDecorations and PaintBarHandles. Internal function called by plugins.


cbDockPane::PaintBarDecorations

void PaintBarDecorations(cbBarInfo* pBar, wxDC& dc)

protected really (accessed only by plugins) Generates a cbDrawBarDecorEvent and sends it to the layout to paint the bar decorations. Internal function called by plugins.


cbDockPane::PaintBarHandles

void PaintBarHandles(cbBarInfo* pBar, wxDC& dc)

Generates a cbDrawBarHandlesEvent and sends it to the layout to paint the bar handles. Internal function called by plugins.


cbDockPane::PaintPane

void PaintPane(wxDC& dc)

Paints the pane background, the row background and decorations, and finally the pane decorations. Internal function called by plugins.


cbDockPane::PaintPaneBackground

void PaintPaneBackground(wxDC& dc)

Generates cbDrawPaneBkGroundEvent and sends it to the layout. Internal function called by plugins.


cbDockPane::PaintPaneDecorations

void PaintPaneDecorations(wxDC& dc)

Generates cbDrawPaneDecorEvent and sends it to the layout. Internal function called by plugins.


cbDockPane::PaintRow

void PaintRow(cbRowInfo* pRow, wxDC& dc)

Calls PaintRowBackground, PaintRowDecorations, PaintRowHandles. Internal function called by plugins.


cbDockPane::PaintRowBackground

void PaintRowBackground(cbRowInfo* pRow, wxDC& dc)

Generates cbDrawRowBkGroundEvent and sends it to the layout. Internal function called by plugins.


cbDockPane::PaintRowDecorations

void PaintRowDecorations(cbRowInfo* pRow, wxDC& dc)

Calls PaintBarDecorations for each row. Internal function called by plugins.


cbDockPane::PaintRowHandles

void PaintRowHandles(cbRowInfo* pRow, wxDC& dc)

Generates cbDrawRowHandlesEvent and cbDrawRowDecorEvent and sends them to the layout. Internal function called by plugins.


cbDockPane::PaneToFrame

void PaneToFrame(wxRect* pRect)

Coordinate translation between parent's frame and this pane. Internal function called by plugins.

void PaneToFrame(int* x, int* y)

Coordinate translation between parent's frame and this pane. Internal function called by plugins.


cbDockPane::RecalcLayout

void RecalcLayout()

Generates events to perform layout calculations.


cbDockPane::RecalcRowLayout

void RecalcRowLayout(cbRowInfo* pRow)

Generates a cbLayoutRowEvent event to recalculate row layouts. Internal function called by plugins.


cbDockPane::RemoveBar

void RemoveBar(cbBarInfo* pBar)

Removes the bar from this pane. Does not destroy the bar.


cbDockPane::RemoveRow

void RemoveRow(cbRowInfo* pRow)

Removes the row from this pane. Does not destroy the row object.


cbDockPane::ResizeBar

void ResizeBar(cbBarInfo* pBar, int ofs, bool forLeftHandle)

Row/bar resizing related helper-method.


cbDockPane::ResizeRow

void ResizeRow(cbRowInfo* pRow, int ofs, bool forUpperHandle)

Row/bar resizing related helper-method.


cbDockPane::SetBoundsInParent

void SetBoundsInParent(const wxRect& rect)

Set the position and dimensions of the pane in the parent frame's coordinates.


cbDockPane::SetMargins

void SetMargins(int top, int bottom, int left, int right)

Sets pane's margins in frame's coordinate orientations.


cbDockPane::SetPaneWidth

void SetPaneWidth(int width)

Sets pane's width in the pane's coordinates (including margins).


cbDockPane::SetRowHeight

void SetRowHeight(cbRowInfo* pRow, int newHeight)

Sets the row height for the given height. newHeight includes the height of row handles, if present. Internal function called by plugins.


cbDockPane::SetRowShapeData

void SetRowShapeData(cbRowInfo* pRowNode, wxList* pLst)

Sets the shape data for the given row, using the data provided in pLst. cbBarShapeData is used for storing the original bar's positions in the row, when the 'non-destructive-friction' option is turned on.


cbDockPane::SizeBar

void SizeBar(cbBarInfo* pBar)

Generates a cbSizeBarWndEvent and sends it to the layout. Internal function called by plugins.


cbDockPane::SizePaneObjects

void SizePaneObjects()

Calls SizeRowObjects for each row. Internal function called by plugins.


cbDockPane::SizeRowObjects

void SizeRowObjects(cbRowInfo* pRow)

Calls SizeBar for each bar in the row. Internal function called by plugins.


cbDockPane::StartDrawInArea

wxDC* StartDrawInArea(const wxRect& area)

Generates cbStartDrawInAreaEvent and sends it to the layout. Internal function called by plugins.


cbDockPane::SyncRowFlags

void SyncRowFlags(cbRowInfo* pRow)

Sets up flags in the row information structure, so that they match the changed state of row items correctly. Internal function called by plugins.