499b2ed82c
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@13394 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
436 lines
12 KiB
TeX
436 lines
12 KiB
TeX
%
|
|
% automatically generated by HelpGen $Revision$ from
|
|
% controlbar.h at 05/Jan/02 22:50:59
|
|
%
|
|
|
|
|
|
\section{\class{cbDockPane}}\label{cbdockpane}
|
|
|
|
|
|
class manages containment and control of control-bars
|
|
along one of the four edges of the parent frame
|
|
|
|
\wxheading{Derived from}
|
|
|
|
\helpref{wxObject}{wxobject}
|
|
|
|
\wxheading{Data structures}
|
|
|
|
\latexignore{\rtfignore{\wxheading{Members}}}
|
|
|
|
|
|
\membersection{cbDockPane::cbDockPane}\label{cbdockpanecbdockpane}
|
|
|
|
\func{}{cbDockPane}{\param{int }{alignment}, \param{wxFrameLayout* }{pPanel}}
|
|
|
|
|
|
\func{}{cbDockPane}{\void}
|
|
|
|
public members
|
|
|
|
\membersection{cbDockPane::\destruct{cbDockPane}}\label{cbdockpanedtor}
|
|
|
|
\func{}{\destruct{cbDockPane}}{\void}
|
|
|
|
|
|
\membersection{cbDockPane::BarPresent}\label{cbdockpanebarpresent}
|
|
|
|
\func{bool}{BarPresent}{\param{cbBarInfo* }{pBar}}
|
|
|
|
TRUE, if the given bar node presents in this pane
|
|
|
|
|
|
\membersection{cbDockPane::CalcLengthRatios}\label{cbdockpanecalclengthratios}
|
|
|
|
\func{void}{CalcLengthRatios}{\param{cbRowInfo* }{pInRow}}
|
|
|
|
|
|
\membersection{cbDockPane::ContractBar}\label{cbdockpanecontractbar}
|
|
|
|
\func{void}{ContractBar}{\param{cbBarInfo* }{pBar}}
|
|
|
|
|
|
\membersection{cbDockPane::DoInsertBar}\label{cbdockpanedoinsertbar}
|
|
|
|
\func{void}{DoInsertBar}{\param{cbBarInfo* }{pBar}, \param{int }{rowNo}}
|
|
|
|
|
|
\membersection{cbDockPane::DrawHorizHandle}\label{cbdockpanedrawhorizhandle}
|
|
|
|
\func{void}{DrawHorizHandle}{\param{wxDC\& }{dc}, \param{int }{x}, \param{int }{y}, \param{int }{width}}
|
|
|
|
|
|
\membersection{cbDockPane::DrawVertHandle}\label{cbdockpanedrawverthandle}
|
|
|
|
\func{void}{DrawVertHandle}{\param{wxDC\& }{dc}, \param{int }{x}, \param{int }{y}, \param{int }{height}}
|
|
|
|
protected really (accessed only by plugins) row/bar resizing related helper-methods
|
|
|
|
|
|
\membersection{cbDockPane::ExpandBar}\label{cbdockpaneexpandbar}
|
|
|
|
\func{void}{ExpandBar}{\param{cbBarInfo* }{pBar}}
|
|
|
|
|
|
\membersection{cbDockPane::FinishDrawInArea}\label{cbdockpanefinishdrawinarea}
|
|
|
|
\func{void}{FinishDrawInArea}{\param{const wxRect\& }{area}}
|
|
|
|
|
|
\membersection{cbDockPane::FrameToPane}\label{cbdockpaneframetopane}
|
|
|
|
\func{void}{FrameToPane}{\param{wxRect* }{pRect}}
|
|
|
|
|
|
\func{void}{FrameToPane}{\param{int* }{x}, \param{int* }{y}}
|
|
|
|
coordinate translation between parent's frame and this pane
|
|
|
|
|
|
\membersection{cbDockPane::GetAlignment}\label{cbdockpanegetalignment}
|
|
|
|
\func{int}{GetAlignment}{\void}
|
|
|
|
|
|
\membersection{cbDockPane::GetBarInfoByWindow}\label{cbdockpanegetbarinfobywindow}
|
|
|
|
\func{cbBarInfo*}{GetBarInfoByWindow}{\param{wxWindow* }{pBarWnd}}
|
|
|
|
|
|
\membersection{cbDockPane::GetBarResizeRange}\label{cbdockpanegetbarresizerange}
|
|
|
|
\func{void}{GetBarResizeRange}{\param{cbBarInfo* }{pBar}, \param{int* }{from}, \param{int* }{till}, \param{bool }{forLeftHandle}}
|
|
|
|
|
|
\membersection{cbDockPane::GetDockingState}\label{cbdockpanegetdockingstate}
|
|
|
|
\func{int}{GetDockingState}{\void}
|
|
|
|
|
|
\membersection{cbDockPane::GetFirstRow}\label{cbdockpanegetfirstrow}
|
|
|
|
\func{cbRowInfo*}{GetFirstRow}{\void}
|
|
|
|
convenience method
|
|
|
|
|
|
\membersection{cbDockPane::GetMinimalRowHeight}\label{cbdockpanegetminimalrowheight}
|
|
|
|
\func{int}{GetMinimalRowHeight}{\param{cbRowInfo* }{pRow}}
|
|
|
|
|
|
\membersection{cbDockPane::GetNotFixedBarsCount}\label{cbdockpanegetnotfixedbarscount}
|
|
|
|
\func{int}{GetNotFixedBarsCount}{\param{cbRowInfo* }{pRow}}
|
|
|
|
|
|
\membersection{cbDockPane::GetPaneHeight}\label{cbdockpanegetpaneheight}
|
|
|
|
\func{int}{GetPaneHeight}{\void}
|
|
|
|
retuns height, in pane's coordinates
|
|
|
|
|
|
\membersection{cbDockPane::GetRealRect}\label{cbdockpanegetrealrect}
|
|
|
|
\func{wxRect\&}{GetRealRect}{\void}
|
|
|
|
|
|
\membersection{cbDockPane::GetRow}\label{cbdockpanegetrow}
|
|
|
|
\func{cbRowInfo*}{GetRow}{\param{int }{row}}
|
|
|
|
protected really (accessed only by plugins)
|
|
|
|
\membersection{cbDockPane::GetRowAt}\label{cbdockpanegetrowat}
|
|
|
|
\func{int}{GetRowAt}{\param{int }{upperY}, \param{int }{lowerY}}
|
|
|
|
|
|
\func{int}{GetRowAt}{\param{int }{paneY}}
|
|
|
|
return -1, if row is not present at given vertical position
|
|
|
|
|
|
\membersection{cbDockPane::GetRowIndex}\label{cbdockpanegetrowindex}
|
|
|
|
\func{int}{GetRowIndex}{\param{cbRowInfo* }{pRow}}
|
|
|
|
|
|
\membersection{cbDockPane::GetRowList}\label{cbdockpanegetrowlist}
|
|
|
|
\func{RowArrayT\&}{GetRowList}{\void}
|
|
|
|
used by updates-managers
|
|
|
|
|
|
\membersection{cbDockPane::GetRowResizeRange}\label{cbdockpanegetrowresizerange}
|
|
|
|
\func{void}{GetRowResizeRange}{\param{cbRowInfo* }{pRow}, \param{int* }{from}, \param{int* }{till}, \param{bool }{forUpperHandle}}
|
|
|
|
|
|
\membersection{cbDockPane::GetRowShapeData}\label{cbdockpanegetrowshapedata}
|
|
|
|
\func{void}{GetRowShapeData}{\param{cbRowInfo* }{pRow}, \param{wxList* }{pLst}}
|
|
|
|
cbBarShapeData objects will be placed to given pLst (see comments on cbBarShapeData)
|
|
|
|
|
|
\membersection{cbDockPane::GetRowWidth}\label{cbdockpanegetrowwidth}
|
|
|
|
\func{int}{GetRowWidth}{\param{wxList* }{pRow}}
|
|
|
|
|
|
\membersection{cbDockPane::GetRowY}\label{cbdockpanegetrowy}
|
|
|
|
\func{int}{GetRowY}{\param{cbRowInfo* }{pRow}}
|
|
|
|
|
|
\membersection{cbDockPane::HasNotFixedBarsLeft}\label{cbdockpanehasnotfixedbarsleft}
|
|
|
|
\func{bool}{HasNotFixedBarsLeft}{\param{cbBarInfo* }{pBar}}
|
|
|
|
|
|
\membersection{cbDockPane::HasNotFixedBarsRight}\label{cbdockpanehasnotfixedbarsright}
|
|
|
|
\func{bool}{HasNotFixedBarsRight}{\param{cbBarInfo* }{pBar}}
|
|
|
|
|
|
\membersection{cbDockPane::HasNotFixedRowsAbove}\label{cbdockpanehasnotfixedrowsabove}
|
|
|
|
\func{bool}{HasNotFixedRowsAbove}{\param{cbRowInfo* }{pRow}}
|
|
|
|
|
|
\membersection{cbDockPane::HasNotFixedRowsBelow}\label{cbdockpanehasnotfixedrowsbelow}
|
|
|
|
\func{bool}{HasNotFixedRowsBelow}{\param{cbRowInfo* }{pRow}}
|
|
|
|
|
|
\membersection{cbDockPane::HasPoint}\label{cbdockpanehaspoint}
|
|
|
|
\func{bool}{HasPoint}{\param{const wxPoint\& }{pos}, \param{int }{x}, \param{int }{y}, \param{int }{width}, \param{int }{height}}
|
|
|
|
|
|
\membersection{cbDockPane::HitTestPaneItems}\label{cbdockpanehittestpaneitems}
|
|
|
|
\func{int}{HitTestPaneItems}{\param{const wxPoint\& }{pos}, \param{cbRowInfo** }{ppRow}, \param{cbBarInfo** }{ppBar}}
|
|
|
|
returns result of hit-testing items in the pane,
|
|
see CB\_HITTEST\_RESULTS enumeration
|
|
position in pane's coordinates
|
|
|
|
|
|
\membersection{cbDockPane::InitLinksForRow}\label{cbdockpaneinitlinksforrow}
|
|
|
|
\func{void}{InitLinksForRow}{\param{cbRowInfo* }{pRow}}
|
|
|
|
|
|
\membersection{cbDockPane::InitLinksForRows}\label{cbdockpaneinitlinksforrows}
|
|
|
|
\func{void}{InitLinksForRows}{\void}
|
|
|
|
|
|
\membersection{cbDockPane::InsertBar}\label{cbdockpaneinsertbar}
|
|
|
|
\func{void}{InsertBar}{\param{cbBarInfo* }{pBar}, \param{const wxRect\& }{atRect}}
|
|
|
|
rect given in the parent frame's coordinates
|
|
|
|
|
|
\func{void}{InsertBar}{\param{cbBarInfo* }{pBar}, \param{cbRowInfo* }{pIntoRow}}
|
|
|
|
inserts bar into the given row, with dimensions and position
|
|
stored in pBarInfo->mBounds. Returns the node of inserted bar
|
|
|
|
|
|
\func{void}{InsertBar}{\param{cbBarInfo* }{pBarInfo}}
|
|
|
|
inserts bar, sets its position according to the preferred settings
|
|
given in (*pBarInfo) structure
|
|
|
|
|
|
\membersection{cbDockPane::InsertRow}\label{cbdockpaneinsertrow}
|
|
|
|
\func{void}{InsertRow}{\param{cbRowInfo* }{pRow}, \param{cbRowInfo* }{pBeforeRow}}
|
|
|
|
does not refresh the inserted row immediately,
|
|
if pBeforeRowNode arg. is NULL, row is appended to the end of pane's row list
|
|
|
|
|
|
\membersection{cbDockPane::IsFixedSize}\label{cbdockpaneisfixedsize}
|
|
|
|
\func{bool}{IsFixedSize}{\param{cbBarInfo* }{pInfo}}
|
|
|
|
layout "AI" helpers:
|
|
|
|
|
|
\membersection{cbDockPane::IsHorizontal}\label{cbdockpaneishorizontal}
|
|
|
|
\func{bool}{IsHorizontal}{\void}
|
|
|
|
|
|
\membersection{cbDockPane::MatchesMask}\label{cbdockpanematchesmask}
|
|
|
|
\func{bool}{MatchesMask}{\param{int }{paneMask}}
|
|
|
|
|
|
\membersection{cbDockPane::PaintBar}\label{cbdockpanepaintbar}
|
|
|
|
\func{void}{PaintBar}{\param{cbBarInfo* }{pBar}, \param{wxDC\& }{dc}}
|
|
|
|
|
|
\membersection{cbDockPane::PaintBarDecorations}\label{cbdockpanepaintbardecorations}
|
|
|
|
\func{void}{PaintBarDecorations}{\param{cbBarInfo* }{pBar}, \param{wxDC\& }{dc}}
|
|
|
|
protected really (accessed only by plugins) methods for incramental on-screen refreshing of the pane
|
|
(simply, they are wrappers around corresponding plugin-events)
|
|
|
|
|
|
\membersection{cbDockPane::PaintBarHandles}\label{cbdockpanepaintbarhandles}
|
|
|
|
\func{void}{PaintBarHandles}{\param{cbBarInfo* }{pBar}, \param{wxDC\& }{dc}}
|
|
|
|
|
|
\membersection{cbDockPane::PaintPane}\label{cbdockpanepaintpane}
|
|
|
|
\func{void}{PaintPane}{\param{wxDC\& }{dc}}
|
|
|
|
|
|
\membersection{cbDockPane::PaintPaneBackground}\label{cbdockpanepaintpanebackground}
|
|
|
|
\func{void}{PaintPaneBackground}{\param{wxDC\& }{dc}}
|
|
|
|
|
|
\membersection{cbDockPane::PaintPaneDecorations}\label{cbdockpanepaintpanedecorations}
|
|
|
|
\func{void}{PaintPaneDecorations}{\param{wxDC\& }{dc}}
|
|
|
|
|
|
\membersection{cbDockPane::PaintRow}\label{cbdockpanepaintrow}
|
|
|
|
\func{void}{PaintRow}{\param{cbRowInfo* }{pRow}, \param{wxDC\& }{dc}}
|
|
|
|
|
|
\membersection{cbDockPane::PaintRowBackground}\label{cbdockpanepaintrowbackground}
|
|
|
|
\func{void}{PaintRowBackground}{\param{cbRowInfo* }{pRow}, \param{wxDC\& }{dc}}
|
|
|
|
|
|
\membersection{cbDockPane::PaintRowDecorations}\label{cbdockpanepaintrowdecorations}
|
|
|
|
\func{void}{PaintRowDecorations}{\param{cbRowInfo* }{pRow}, \param{wxDC\& }{dc}}
|
|
|
|
|
|
\membersection{cbDockPane::PaintRowHandles}\label{cbdockpanepaintrowhandles}
|
|
|
|
\func{void}{PaintRowHandles}{\param{cbRowInfo* }{pRow}, \param{wxDC\& }{dc}}
|
|
|
|
|
|
\membersection{cbDockPane::PaneToFrame}\label{cbdockpanepanetoframe}
|
|
|
|
\func{void}{PaneToFrame}{\param{wxRect* }{pRect}}
|
|
|
|
|
|
\func{void}{PaneToFrame}{\param{int* }{x}, \param{int* }{y}}
|
|
|
|
|
|
\membersection{cbDockPane::RecalcLayout}\label{cbdockpanerecalclayout}
|
|
|
|
\func{void}{RecalcLayout}{\void}
|
|
|
|
|
|
\membersection{cbDockPane::RecalcRowLayout}\label{cbdockpanerecalcrowlayout}
|
|
|
|
\func{void}{RecalcRowLayout}{\param{cbRowInfo* }{pRow}}
|
|
|
|
|
|
\membersection{cbDockPane::RemoveBar}\label{cbdockpaneremovebar}
|
|
|
|
\func{void}{RemoveBar}{\param{cbBarInfo* }{pBar}}
|
|
|
|
does not destroys the info bar , only removes it's reference
|
|
from this pane
|
|
|
|
|
|
\membersection{cbDockPane::RemoveRow}\label{cbdockpaneremoverow}
|
|
|
|
\func{void}{RemoveRow}{\param{cbRowInfo* }{pRow}}
|
|
|
|
does not destroy the row object, only removes the corresponding
|
|
node from this pane
|
|
|
|
|
|
\membersection{cbDockPane::ResizeBar}\label{cbdockpaneresizebar}
|
|
|
|
\func{void}{ResizeBar}{\param{cbBarInfo* }{pBar}, \param{int }{ofs}, \param{bool }{forLeftHandle}}
|
|
|
|
|
|
\membersection{cbDockPane::ResizeRow}\label{cbdockpaneresizerow}
|
|
|
|
\func{void}{ResizeRow}{\param{cbRowInfo* }{pRow}, \param{int }{ofs}, \param{bool }{forUpperHandle}}
|
|
|
|
|
|
\membersection{cbDockPane::SetBoundsInParent}\label{cbdockpanesetboundsinparent}
|
|
|
|
\func{void}{SetBoundsInParent}{\param{const wxRect\& }{rect}}
|
|
|
|
set the position and dims. of the pane in parent frame's coordinates
|
|
|
|
|
|
\membersection{cbDockPane::SetMargins}\label{cbdockpanesetmargins}
|
|
|
|
\func{void}{SetMargins}{\param{int }{top}, \param{int }{bottom}, \param{int }{left}, \param{int }{right}}
|
|
|
|
sets pane's margins in frame's coordinate orientations
|
|
|
|
|
|
\membersection{cbDockPane::SetPaneWidth}\label{cbdockpanesetpanewidth}
|
|
|
|
\func{void}{SetPaneWidth}{\param{int }{width}}
|
|
|
|
sets pane's width in pane's coordinates (including margins)
|
|
|
|
|
|
\membersection{cbDockPane::SetRowHeight}\label{cbdockpanesetrowheight}
|
|
|
|
\func{void}{SetRowHeight}{\param{cbRowInfo* }{pRow}, \param{int }{newHeight}}
|
|
|
|
given row height includes height of row handles, if present
|
|
|
|
|
|
\membersection{cbDockPane::SetRowShapeData}\label{cbdockpanesetrowshapedata}
|
|
|
|
\func{void}{SetRowShapeData}{\param{cbRowInfo* }{pRowNode}, \param{wxList* }{pLst}}
|
|
|
|
sets the shape to the given row, using the data provided in pLst
|
|
|
|
|
|
\membersection{cbDockPane::SizeBar}\label{cbdockpanesizebar}
|
|
|
|
\func{void}{SizeBar}{\param{cbBarInfo* }{pBar}}
|
|
|
|
|
|
\membersection{cbDockPane::SizePaneObjects}\label{cbdockpanesizepaneobjects}
|
|
|
|
\func{void}{SizePaneObjects}{\void}
|
|
|
|
|
|
\membersection{cbDockPane::SizeRowObjects}\label{cbdockpanesizerowobjects}
|
|
|
|
\func{void}{SizeRowObjects}{\param{cbRowInfo* }{pRow}}
|
|
|
|
|
|
\membersection{cbDockPane::StartDrawInArea}\label{cbdockpanestartdrawinarea}
|
|
|
|
\func{wxDC*}{StartDrawInArea}{\param{const wxRect\& }{area}}
|
|
|
|
|
|
\membersection{cbDockPane::SyncRowFlags}\label{cbdockpanesyncrowflags}
|
|
|
|
\func{void}{SyncRowFlags}{\param{cbRowInfo* }{pRow}}
|
|
|
|
re-setups flags in the row-information structure, so that
|
|
the would match the changed state of row-items correctly
|
|
|