Tidied/commented FL header files, regenerated docs and filled out Category section.
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@13738 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Julian Smart
@@ -1,19 +1,23 @@
|
||||
%
|
||||
% automatically generated by HelpGen $Revision$ from
|
||||
% dyntbar.h at 05/Jan/02 22:50:56
|
||||
% dyntbar.h at 21/Jan/02 21:14:18
|
||||
%
|
||||
|
||||
|
||||
\section{\class{BagLayout}}\label{baglayout}
|
||||
|
||||
|
||||
layouts items in left-to-right order from
|
||||
top towards bottom
|
||||
BagLayout lays out items in left-to-right order from
|
||||
top to bottom.
|
||||
|
||||
\wxheading{Derived from}
|
||||
|
||||
\helpref{LayoutManagerBase}{layoutmanagerbase}
|
||||
|
||||
\wxheading{Include files}
|
||||
|
||||
<dyntbar.h>
|
||||
|
||||
\wxheading{Data structures}
|
||||
|
||||
\latexignore{\rtfignore{\wxheading{Members}}}
|
||||
@@ -23,3 +27,5 @@ top towards bottom
|
||||
|
||||
\func{void}{Layout}{\param{const wxSize\& }{parentDim}, \param{wxSize\& }{resultingDim}, \param{wxLayoutItemArrayT\& }{items}, \param{int }{horizGap}, \param{int }{vertGap}}
|
||||
|
||||
Constructor.
|
||||
|
||||
|
||||
@@ -1,18 +1,22 @@
|
||||
%
|
||||
% automatically generated by HelpGen $Revision$ from
|
||||
% controlbar.h at 05/Jan/02 22:50:59
|
||||
% controlbar.h at 21/Jan/02 21:14:14
|
||||
%
|
||||
|
||||
|
||||
\section{\class{wxBarIterator}}\label{wxbariterator}
|
||||
|
||||
|
||||
used for traversing through all bars of all rows in the pane
|
||||
Used for traversing through all bars of all rows in the pane.
|
||||
|
||||
\wxheading{Derived from}
|
||||
|
||||
No base class
|
||||
|
||||
\wxheading{Include files}
|
||||
|
||||
<controlbar.h>
|
||||
|
||||
\wxheading{Data structures}
|
||||
|
||||
\latexignore{\rtfignore{\wxheading{Members}}}
|
||||
@@ -22,27 +26,33 @@ No base class
|
||||
|
||||
\func{}{wxBarIterator}{\param{RowArrayT\& }{rows}}
|
||||
|
||||
Constructor, taking row array.
|
||||
|
||||
|
||||
\membersection{wxBarIterator::BarInfo}\label{wxbariteratorbarinfo}
|
||||
|
||||
\func{cbBarInfo\&}{BarInfo}{\void}
|
||||
|
||||
Gets the current bar information.
|
||||
|
||||
|
||||
\membersection{wxBarIterator::Next}\label{wxbariteratornext}
|
||||
|
||||
\func{bool}{Next}{\void}
|
||||
|
||||
TRUE, if next bar is available
|
||||
Advances the iterator and returns TRUE if a bar is available.
|
||||
|
||||
|
||||
\membersection{wxBarIterator::Reset}\label{wxbariteratorreset}
|
||||
|
||||
\func{void}{Reset}{\void}
|
||||
|
||||
Resets the iterator to the start of the first row.
|
||||
|
||||
|
||||
\membersection{wxBarIterator::RowInfo}\label{wxbariteratorrowinfo}
|
||||
|
||||
\func{cbRowInfo\&}{RowInfo}{\void}
|
||||
|
||||
returns reference to currently traversed row
|
||||
Returns a reference to the currently traversed row.
|
||||
|
||||
|
||||
@@ -3,28 +3,89 @@
|
||||
\setfooter{\thepage}{}{}{}{}{\thepage}%
|
||||
|
||||
A classification of FL classes by category.
|
||||
\twocolwidtha{5cm}
|
||||
|
||||
\begin{comment}
|
||||
{\large {\bf Service classes}}
|
||||
{\large {\bf Plugin classes}}
|
||||
|
||||
\overview{wxMPService class overview}{wxmpserviceoverview}
|
||||
|
||||
Service classes reduce the diversity of PMF classes, by making
|
||||
them comply to a common interface. A service class serves as an interface (or
|
||||
mix-in class in C++ terms), which cannot itself represent an
|
||||
independent object. It should be inherited as a second (or
|
||||
third) base class.
|
||||
|
||||
Derived services classes all derive from wxEvtHandler as well as
|
||||
wxPMService.
|
||||
Plugins can be added to frame layouts to extend behaviour.
|
||||
|
||||
\twocolwidtha{6cm}
|
||||
\begin{twocollist}\itemsep=0pt
|
||||
\twocolitem{\helpref{wxPMService}{wxpmservice}}{Base class}
|
||||
\twocolitem{\helpref{wxPMBootstrapService}{wxpmbootstrapservice}}{Boot strap service}
|
||||
\twocolitem{\helpref{wxPMLAlgorithm}{wxpmlalgorithm}}{Layout algorithm service}
|
||||
\twocolitem{\helpref{wxPMSashLayoutAlgorithm}{wxpmsashlayoutalgorithm}}{Sash layout algorithm service}
|
||||
\twocolitem{\helpref{wxPMPane}{wxpmpane}}{Base class for panes lying outside the MDI client area}
|
||||
\twocolitem{\helpref{cbAntiflickerPlugin}{cbantiflickerplugin}}{Double-buffering class}
|
||||
\twocolitem{\helpref{cbBarDragPlugin}{cbbardragplugin}}{Implements drag behaviour.}
|
||||
\twocolitem{\helpref{cbBarHintsPlugin}{cbbarhintsplugin}}{Implements bar decoration and sizing behaviour.}
|
||||
\twocolitem{\helpref{cbHintAnimationPlugin}{cbhintanimationplugin}}{Draws animated hints when the user drags a pane.}
|
||||
\twocolitem{\helpref{cbPaneDrawPlugin}{cbpanedrawplugin}}{Implements most of MFC-style control bar implementation.}
|
||||
\twocolitem{\helpref{cbPluginBase}{cbpluginbase}}{Abstract base class for all control-bar related plugins.}
|
||||
\twocolitem{\helpref{cbRowDragPlugin}{cbrowdragplugin}}{Implements row-dragging functionality.}
|
||||
\twocolitem{\helpref{cbRowLayoutPlugin}{cbrowlayoutplugin}}{Implements row layout functionality.}
|
||||
\twocolitem{\helpref{cbSimpleCustomizationPlugin}{cbsimplecustomizationplugin}}{Enables customization of a bar.}
|
||||
\twocolitem{\helpref{cbBarSpy}{cbbarspy}}{Helper class used for spying for unhandled mouse events on control bars and forwarding them to the frame layout.}
|
||||
\end{twocollist}
|
||||
|
||||
{\large {\bf Window classes}}
|
||||
|
||||
Windows classes (note that the mini-button implementations are not true windows
|
||||
in that they do not derive from wxWindow).
|
||||
|
||||
\twocolwidtha{6cm}
|
||||
\begin{twocollist}\itemsep=0pt
|
||||
\twocolitem{\helpref{wxToolWindow}{wxtoolwindow}}{A small frame that paints its own titlebar.}
|
||||
\twocolitem{\helpref{cbFloatedBarWindow}{cbfloatedbarwindow}}{A kind of wxToolWindow implementing floating windows.}
|
||||
\twocolitem{\helpref{cbMiniButton}{cbminibutton}}{Base class for wxToolWindow titlebar buttons.}
|
||||
\twocolitem{\helpref{cbCloseBox}{cbclosebox}}{Close button for wxToolWindow titlebar.}
|
||||
\twocolitem{\helpref{cbCollapseBox}{cbcollapsebox}}{Collapse button for wxToolWindow titlebar.}
|
||||
\twocolitem{\helpref{cbDockBox}{cbdockbox}}{Dock button for wxToolWindow titlebar.}
|
||||
\twocolitem{\helpref{cbCloseBox}{cbclosebox}}{Close button for wxToolWindow titlebar.}
|
||||
\twocolitem{\helpref{wxNewBitmapButton}{wxnewbitmapbutton}}{Alternative bitmap button class.}
|
||||
\end{twocollist}
|
||||
|
||||
{\large {\bf Layout management classes}}
|
||||
|
||||
These classes relate to the layout management framework.
|
||||
|
||||
\twocolwidtha{6cm}
|
||||
\begin{twocollist}\itemsep=0pt
|
||||
\twocolitem{\helpref{cbDockPane}{cbdockpane}}{Manages containment and control of bars in a prent frame.}
|
||||
\twocolitem{\helpref{BagLayout}{baglayout}}{BagLayout lays out items in left-to-right order from top to bottom.}
|
||||
\twocolitem{\helpref{cbUpdatesManagerBase}{cbupdatesmanagerbase}}{An abstract interface for display update optimization logic.}
|
||||
\twocolitem{\helpref{cbSimpleUpdatesMgr}{cbsimpleupdatesmgr}}{Implements optimized logic for refreshing areas of frame layout that need to be updated.}
|
||||
\twocolitem{\helpref{cbGCUpdatesMgr}{cbgcupdatesmgr}}{Implements optimized logic for refresh, based on a garbage collection algorithm.}
|
||||
\twocolitem{\helpref{GarbageCollector}{garbagecollector}}{A garbage collection algorithm for use in display refresh optimization.}
|
||||
\twocolitem{\helpref{wxFrameLayout}{wxframelayout}}{Manages containment and docking of control bars, which can be docked along the top, bottom, right, or left side of the parent frame.}
|
||||
\end{twocollist}
|
||||
|
||||
{\large {\bf Event classes}}
|
||||
|
||||
Events are used to decouple parts of the layout framework.
|
||||
|
||||
\twocolwidtha{6cm}
|
||||
\begin{twocollist}\itemsep=0pt
|
||||
\twocolitem{\helpref{cbCustomizeBarEvent}{cbcustomizebarevent}}{Class for bar customization events.}
|
||||
\twocolitem{\helpref{cbCustomizeLayoutEvent}{cbcustomizelayoutevent}}{Class for layout customization events.}
|
||||
\twocolitem{\helpref{cbDrawBarDecorEvent}{cbdrawbardecorevent}}{Class for bar decoration drawing events.}
|
||||
\twocolitem{\helpref{cbDrawBarHandlesEvent}{cbdrawbarhandlesevent}}{Class for bar handles drawing events.}
|
||||
\twocolitem{\helpref{cbDrawHintRectEvent}{cbdrawhintrectevent}}{Class for hint-rectangle drawing events.}
|
||||
\twocolitem{\helpref{cbDrawPaneBkGroundEvent}{cbdrawpanebkgroundevent}}{Class for pane background drawing events.}
|
||||
\twocolitem{\helpref{cbDrawPaneDecorEvent}{cbdrawpanedecorevent}}{Class for pane decoration drawing events.}
|
||||
\twocolitem{\helpref{cbDrawRowBkGroundEvent}{cbdrawrowbkgroundevent}}{Class for row background drawing events.}
|
||||
\twocolitem{\helpref{cbDrawRowDecorEvent}{cbdrawrowdecorevent}}{Class for row decoration drawing events.}
|
||||
\twocolitem{\helpref{cbDrawRowHandlesEvent}{cbdrawrowhandlesevent}}{Class for row handles drawing events.}
|
||||
\twocolitem{\helpref{cbFinishDrawInAreaEvent}{cbfinishdrawinareaevent}}{Class for finish drawing in area events.}
|
||||
\twocolitem{\helpref{cbInsertBarEvent}{cbinsertbarevent}}{Class for bar insertion events.}
|
||||
\twocolitem{\helpref{cbLayoutRowEvent}{cblayoutrowevent}}{Class for single row layout events.}
|
||||
\twocolitem{\helpref{cbLayoutRowsEvent}{cblayoutrowsevent}}{Class for multiple rows layout events.}
|
||||
\twocolitem{\helpref{cbLeftDClickEvent}{cbleftdclickevent}}{Class for mouse left double click events.}
|
||||
\twocolitem{\helpref{cbLeftDownEvent}{cbleftdownevent}}{Class for mouse left down events.}
|
||||
\twocolitem{\helpref{cbLeftUpEvent}{cbleftupevent}}{Class for mouse left up events.}
|
||||
\twocolitem{\helpref{cbMotionEvent}{cbmotionevent}}{Class for mouse motion events.}
|
||||
\twocolitem{\helpref{cbPluginEvent}{cbpluginevent}}{Base class for all control-bar plugin events.}
|
||||
\twocolitem{\helpref{cbRemoveBarEvent}{cbremovebarevent}}{Class for bar removal events.}
|
||||
\twocolitem{\helpref{cbResizeBarEvent}{cbresizebarevent}}{Class for bar resize events.}
|
||||
\twocolitem{\helpref{cbResizeRowEvent}{cbresizerowevent}}{Class for row resize events.}
|
||||
\twocolitem{\helpref{cbRightDownEvent}{cbrightdownevent}}{Class for mouse right down events.}
|
||||
\twocolitem{\helpref{cbRightUpEvent}{cbrightupevent}}{Class for mouse right up events.}
|
||||
\twocolitem{\helpref{cbSizeBarWndEvent}{cbsizebarwndevent}}{Class for bar window resize events.}
|
||||
\twocolitem{\helpref{cbStartBarDraggingEvent}{cbstartbardraggingevent}}{Class for start-bar-dragging events.}
|
||||
\twocolitem{\helpref{cbStartDrawInAreaEvent}{cbstartdrawinareaevent}}{Class for start drawing in area events.}
|
||||
\end{twocollist}
|
||||
\end{comment}
|
||||
|
||||
|
||||
@@ -1,15 +1,26 @@
|
||||
%
|
||||
% automatically generated by HelpGen $Revision$ from
|
||||
% antiflickpl.h at 05/Jan/02 22:50:56
|
||||
% antiflickpl.h at 21/Jan/02 21:14:17
|
||||
%
|
||||
|
||||
|
||||
\section{\class{cbAntiflickerPlugin}}\label{cbantiflickerplugin}
|
||||
|
||||
|
||||
Implements double-buffering to reduce flicker.
|
||||
Bitmap and memory DC buffers are shared 'resources' among all instances of
|
||||
antiflicker plugins within the application.
|
||||
|
||||
Locking for multithreaded applications is not yet implemented.
|
||||
|
||||
\wxheading{Derived from}
|
||||
|
||||
\helpref{cbPluginBase}{cbpluginbase}
|
||||
|
||||
\wxheading{Include files}
|
||||
|
||||
<antiflickpl.h>
|
||||
|
||||
\wxheading{Data structures}
|
||||
|
||||
\latexignore{\rtfignore{\wxheading{Members}}}
|
||||
@@ -19,45 +30,59 @@
|
||||
|
||||
\func{}{cbAntiflickerPlugin}{\void}
|
||||
|
||||
Default constructor.
|
||||
|
||||
|
||||
\func{}{cbAntiflickerPlugin}{\param{wxFrameLayout* }{pPanel}, \param{int }{paneMask = wxALL\_PANES}}
|
||||
|
||||
Constructor taking frame layout panel, and pane mask.
|
||||
|
||||
|
||||
\membersection{cbAntiflickerPlugin::\destruct{cbAntiflickerPlugin}}\label{cbantiflickerplugindtor}
|
||||
|
||||
\func{}{\destruct{cbAntiflickerPlugin}}{\void}
|
||||
|
||||
Destructor.
|
||||
|
||||
|
||||
\membersection{cbAntiflickerPlugin::AllocNewBuffer}\label{cbantiflickerpluginallocnewbuffer}
|
||||
|
||||
\func{wxDC*}{AllocNewBuffer}{\param{const wxRect\& }{forArea}}
|
||||
|
||||
Allocates a suitable buffer.
|
||||
|
||||
|
||||
\membersection{cbAntiflickerPlugin::FindSuitableBuffer}\label{cbantiflickerpluginfindsuitablebuffer}
|
||||
|
||||
\func{wxDC*}{FindSuitableBuffer}{\param{const wxRect\& }{forArea}}
|
||||
|
||||
returns NULL, if sutable buffer is not present
|
||||
Finds a suitable buffer. Returns NULL if a suitable buffer is not present.
|
||||
|
||||
|
||||
\membersection{cbAntiflickerPlugin::GetClientDC}\label{cbantiflickerplugingetclientdc}
|
||||
|
||||
\func{wxDC\&}{GetClientDC}{\void}
|
||||
|
||||
Gets the client device context.
|
||||
|
||||
|
||||
\membersection{cbAntiflickerPlugin::GetWindowDC}\label{cbantiflickerplugingetwindowdc}
|
||||
|
||||
\func{wxDC\&}{GetWindowDC}{\void}
|
||||
|
||||
Gets the window device context.
|
||||
|
||||
|
||||
\membersection{cbAntiflickerPlugin::OnFinishDrawInArea}\label{cbantiflickerpluginonfinishdrawinarea}
|
||||
|
||||
\func{void}{OnFinishDrawInArea}{\param{cbFinishDrawInAreaEvent\& }{event}}
|
||||
|
||||
Handler for plugin event.
|
||||
|
||||
|
||||
\membersection{cbAntiflickerPlugin::OnStartDrawInArea}\label{cbantiflickerpluginonstartdrawinarea}
|
||||
|
||||
\func{void}{OnStartDrawInArea}{\param{cbStartDrawInAreaEvent\& }{event}}
|
||||
|
||||
handlers for plugin events
|
||||
Handler for plugin event.
|
||||
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
%
|
||||
% automatically generated by HelpGen $Revision$ from
|
||||
% controlbar.h at 05/Jan/02 22:50:58
|
||||
% controlbar.h at 21/Jan/02 21:14:13
|
||||
%
|
||||
|
||||
|
||||
@@ -8,15 +8,19 @@
|
||||
|
||||
|
||||
Abstract interface for bar-size handler classes.
|
||||
These objects receive notifications, whenever the docking
|
||||
state of the bar is changed, thus they have a possibility
|
||||
to adjust the values in cbDimInfo::mSizes accordingly.
|
||||
Specific handlers can be hooked to specific types of bars.
|
||||
|
||||
These objects receive notifications whenever the docking
|
||||
state of the bar is changed, thus they provide the possibility
|
||||
to adjust the values in cbDimInfo::mSizes accordingly.
|
||||
Specific handlers can be hooked up to specific types of bar.
|
||||
|
||||
\wxheading{Derived from}
|
||||
|
||||
\helpref{wxObject}{wxobject}
|
||||
|
||||
\wxheading{Include files}
|
||||
|
||||
<controlbar.h>
|
||||
|
||||
\wxheading{Data structures}
|
||||
|
||||
\latexignore{\rtfignore{\wxheading{Members}}}
|
||||
@@ -28,28 +32,35 @@ Abstract interface for bar-size handler classes.
|
||||
|
||||
to multiple bars, it's instance is
|
||||
reference-counted
|
||||
initial reference count is 0, since handler is not used, until the
|
||||
first invocation of AddRef()
|
||||
Default constructor. The initial reference count is 0, since
|
||||
the handler is not used until the first invocation of AddRef().
|
||||
|
||||
|
||||
\membersection{cbBarDimHandlerBase::AddRef}\label{cbbardimhandlerbaseaddref}
|
||||
|
||||
\func{void}{AddRef}{\void}
|
||||
|
||||
Increments the reference count.
|
||||
|
||||
|
||||
\membersection{cbBarDimHandlerBase::OnChangeBarState}\label{cbbardimhandlerbaseonchangebarstate}
|
||||
|
||||
\func{void}{OnChangeBarState}{\param{cbBarInfo* }{pBar}, \param{int }{newState}}
|
||||
|
||||
"bar-state-changes" notification
|
||||
Responds to "bar-state-changes" notifications.
|
||||
|
||||
|
||||
\membersection{cbBarDimHandlerBase::OnResizeBar}\label{cbbardimhandlerbaseonresizebar}
|
||||
|
||||
\func{void}{OnResizeBar}{\param{cbBarInfo* }{pBar}, \param{const wxSize\& }{given}, \param{wxSize\& }{preferred}}
|
||||
|
||||
Responds to bar resize notifications.
|
||||
|
||||
|
||||
\membersection{cbBarDimHandlerBase::RemoveRef}\label{cbbardimhandlerbaseremoveref}
|
||||
|
||||
\func{void}{RemoveRef}{\void}
|
||||
|
||||
Decrements the reference count, and if the count is at zero,
|
||||
delete 'this'.
|
||||
|
||||
|
||||
@@ -1,15 +1,22 @@
|
||||
%
|
||||
% automatically generated by HelpGen $Revision$ from
|
||||
% bardragpl.h at 05/Jan/02 22:50:56
|
||||
% bardragpl.h at 21/Jan/02 21:14:17
|
||||
%
|
||||
|
||||
|
||||
\section{\class{cbBarDragPlugin}}\label{cbbardragplugin}
|
||||
|
||||
|
||||
Plugin class implementing bar dragging.
|
||||
|
||||
\wxheading{Derived from}
|
||||
|
||||
\helpref{cbPluginBase}{cbpluginbase}
|
||||
|
||||
\wxheading{Include files}
|
||||
|
||||
<bardragpl.h>
|
||||
|
||||
\wxheading{Data structures}
|
||||
|
||||
\latexignore{\rtfignore{\wxheading{Members}}}
|
||||
@@ -19,14 +26,20 @@
|
||||
|
||||
\func{}{cbBarDragPlugin}{\void}
|
||||
|
||||
Default constructor.
|
||||
|
||||
|
||||
\func{}{cbBarDragPlugin}{\param{wxFrameLayout* }{pPanel}, \param{int }{paneMask = wxALL\_PANES}}
|
||||
|
||||
Constructor taking a parent frame, and flag. See cbPluginBase.
|
||||
|
||||
|
||||
\membersection{cbBarDragPlugin::\destruct{cbBarDragPlugin}}\label{cbbardragplugindtor}
|
||||
|
||||
\func{}{\destruct{cbBarDragPlugin}}{\void}
|
||||
|
||||
Destructor.
|
||||
|
||||
|
||||
\membersection{cbBarDragPlugin::AdjustHintRect}\label{cbbardragpluginadjusthintrect}
|
||||
|
||||
@@ -34,141 +47,200 @@
|
||||
|
||||
the thicker rectangle is drawn using hatched brush,
|
||||
the default border width for this rectangle is 8 pix.
|
||||
Internal implementation function.
|
||||
|
||||
|
||||
\membersection{cbBarDragPlugin::CalcOnScreenDims}\label{cbbardragplugincalconscreendims}
|
||||
|
||||
\func{void}{CalcOnScreenDims}{\param{wxRect\& }{rect}}
|
||||
|
||||
Internal implementation function.
|
||||
|
||||
|
||||
\membersection{cbBarDragPlugin::ClipPosInFrame}\label{cbbardragpluginclipposinframe}
|
||||
|
||||
\func{void}{ClipPosInFrame}{\param{wxPoint\& }{pos}}
|
||||
|
||||
Internal implementation function.
|
||||
|
||||
|
||||
\membersection{cbBarDragPlugin::ClipRectInFrame}\label{cbbardragplugincliprectinframe}
|
||||
|
||||
\func{void}{ClipRectInFrame}{\param{wxRect\& }{rect}}
|
||||
|
||||
Internal implementation function.
|
||||
|
||||
|
||||
\membersection{cbBarDragPlugin::DoDrawHintRect}\label{cbbardragplugindodrawhintrect}
|
||||
|
||||
\func{void}{DoDrawHintRect}{\param{wxRect\& }{rect}, \param{bool }{isInClientRect}}
|
||||
|
||||
Internal implementation function.
|
||||
Draw the hint rectangle.
|
||||
|
||||
|
||||
\membersection{cbBarDragPlugin::DrawHintRect}\label{cbbardragplugindrawhintrect}
|
||||
|
||||
\func{void}{DrawHintRect}{\param{wxRect\& }{rect}, \param{bool }{isInClientRect}}
|
||||
|
||||
Internal implementation function.
|
||||
Draw the visual hint while dragging.
|
||||
|
||||
|
||||
\membersection{cbBarDragPlugin::EraseHintRect}\label{cbbardragpluginerasehintrect}
|
||||
|
||||
\func{void}{EraseHintRect}{\param{wxRect\& }{rect}, \param{bool }{isInClientRect}}
|
||||
|
||||
Internal implementation function.
|
||||
Erase the visual hint while dragging.
|
||||
|
||||
|
||||
\membersection{cbBarDragPlugin::FinishTracking}\label{cbbardragpluginfinishtracking}
|
||||
|
||||
\func{void}{FinishTracking}{\void}
|
||||
|
||||
Internal implementation function.
|
||||
Stop showing the visual hint while dragging.
|
||||
|
||||
|
||||
\membersection{cbBarDragPlugin::GetBarHeightInPane}\label{cbbardragplugingetbarheightinpane}
|
||||
|
||||
\func{int}{GetBarHeightInPane}{\param{cbDockPane* }{pPane}}
|
||||
|
||||
Internal implementation function.
|
||||
|
||||
|
||||
\membersection{cbBarDragPlugin::GetBarWidthInPane}\label{cbbardragplugingetbarwidthinpane}
|
||||
|
||||
\func{int}{GetBarWidthInPane}{\param{cbDockPane* }{pPane}}
|
||||
|
||||
Internal implementation function.
|
||||
|
||||
|
||||
\membersection{cbBarDragPlugin::GetDistanceToPane}\label{cbbardragplugingetdistancetopane}
|
||||
|
||||
\func{int}{GetDistanceToPane}{\param{cbDockPane* }{pPane}, \param{wxPoint\& }{mousePos}}
|
||||
|
||||
Internal implementation function.
|
||||
|
||||
|
||||
\membersection{cbBarDragPlugin::HitTestPanes}\label{cbbardragpluginhittestpanes}
|
||||
|
||||
\func{cbDockPane*}{HitTestPanes}{\param{wxRect\& }{rect}}
|
||||
|
||||
Internal implementation function. Finds the pane
|
||||
under the specified rectangle.
|
||||
|
||||
|
||||
\func{cbDockPane*}{HitTestPanes}{\param{wxPoint\& }{pos}}
|
||||
|
||||
Internal implementation function. Finds the pane
|
||||
under the specified point.
|
||||
|
||||
|
||||
\membersection{cbBarDragPlugin::HitsPane}\label{cbbardragpluginhitspane}
|
||||
|
||||
\func{bool}{HitsPane}{\param{cbDockPane* }{pPane}, \param{wxRect\& }{rect}}
|
||||
|
||||
Internal implementation function.
|
||||
|
||||
|
||||
\membersection{cbBarDragPlugin::IsInClientArea}\label{cbbardragpluginisinclientarea}
|
||||
|
||||
\func{bool}{IsInClientArea}{\param{wxPoint\& }{mousePos}}
|
||||
|
||||
Internal implementation function.
|
||||
|
||||
|
||||
\func{bool}{IsInClientArea}{\param{wxRect\& }{rect}}
|
||||
|
||||
Internal implementation function.
|
||||
|
||||
|
||||
\membersection{cbBarDragPlugin::IsInOtherPane}\label{cbbardragpluginisinotherpane}
|
||||
|
||||
\func{bool}{IsInOtherPane}{\param{wxPoint\& }{mousePos}}
|
||||
|
||||
Internal implementation function.
|
||||
|
||||
|
||||
\membersection{cbBarDragPlugin::OnDrawHintRect}\label{cbbardragpluginondrawhintrect}
|
||||
|
||||
\func{void}{OnDrawHintRect}{\param{cbDrawHintRectEvent\& }{event}}
|
||||
|
||||
handles event, which oriniates from itself
|
||||
Handles event, which originates from itself.
|
||||
|
||||
|
||||
\membersection{cbBarDragPlugin::OnLButtonDown}\label{cbbardragpluginonlbuttondown}
|
||||
|
||||
\func{void}{OnLButtonDown}{\param{cbLeftDownEvent\& }{event}}
|
||||
|
||||
Handler for plugin event.
|
||||
|
||||
|
||||
\membersection{cbBarDragPlugin::OnLButtonUp}\label{cbbardragpluginonlbuttonup}
|
||||
|
||||
\func{void}{OnLButtonUp}{\param{cbLeftUpEvent\& }{event}}
|
||||
|
||||
Handler for plugin event.
|
||||
|
||||
|
||||
\membersection{cbBarDragPlugin::OnLDblClick}\label{cbbardragpluginonldblclick}
|
||||
|
||||
\func{void}{OnLDblClick}{\param{cbLeftDClickEvent\& }{event}}
|
||||
|
||||
Handler for plugin event.
|
||||
|
||||
|
||||
\membersection{cbBarDragPlugin::OnMouseMove}\label{cbbardragpluginonmousemove}
|
||||
|
||||
\func{void}{OnMouseMove}{\param{cbMotionEvent\& }{event}}
|
||||
|
||||
handlers for plugin events
|
||||
Handler for plugin event.
|
||||
|
||||
|
||||
\membersection{cbBarDragPlugin::OnStartBarDragging}\label{cbbardragpluginonstartbardragging}
|
||||
|
||||
\func{void}{OnStartBarDragging}{\param{cbStartBarDraggingEvent\& }{event}}
|
||||
|
||||
Handler for plugin event.
|
||||
|
||||
|
||||
\membersection{cbBarDragPlugin::RectToScr}\label{cbbardragpluginrecttoscr}
|
||||
|
||||
\func{void}{RectToScr}{\param{wxRect\& }{frameRect}, \param{wxRect\& }{scrRect}}
|
||||
|
||||
Internal implementation function.
|
||||
Converts the given rectangle from window to screen coordinates.
|
||||
|
||||
|
||||
\membersection{cbBarDragPlugin::ShowHint}\label{cbbardragpluginshowhint}
|
||||
|
||||
\func{void}{ShowHint}{\param{bool }{prevWasInClient}}
|
||||
|
||||
Internal implementation function.
|
||||
Show the hint; called within OnMouseMove.
|
||||
|
||||
|
||||
\membersection{cbBarDragPlugin::StartTracking}\label{cbbardragpluginstarttracking}
|
||||
|
||||
\func{void}{StartTracking}{\void}
|
||||
|
||||
on-screen hint-tracking related methods
|
||||
Internal implementation function.
|
||||
Start showing a visual hint while dragging.
|
||||
|
||||
|
||||
\membersection{cbBarDragPlugin::StickToPane}\label{cbbardragpluginsticktopane}
|
||||
|
||||
\func{void}{StickToPane}{\param{cbDockPane* }{pPane}, \param{wxPoint\& }{mousePos}}
|
||||
|
||||
Internal implementation function.
|
||||
|
||||
|
||||
\membersection{cbBarDragPlugin::UnstickFromPane}\label{cbbardragpluginunstickfrompane}
|
||||
|
||||
\func{void}{UnstickFromPane}{\param{cbDockPane* }{pPane}, \param{wxPoint\& }{mousePos}}
|
||||
|
||||
Internal implementation function.
|
||||
|
||||
|
||||
@@ -1,19 +1,23 @@
|
||||
%
|
||||
% automatically generated by HelpGen $Revision$ from
|
||||
% barhintspl.h at 05/Jan/02 22:50:56
|
||||
% barhintspl.h at 21/Jan/02 21:14:18
|
||||
%
|
||||
|
||||
|
||||
\section{\class{cbBarHintsPlugin}}\label{cbbarhintsplugin}
|
||||
|
||||
|
||||
Intercepts bar-decoration and sizing events, draws 3d-hints
|
||||
around fixed and flexible bars, similar to those in Microsoft DevStudio 6.x
|
||||
|
||||
This class intercepts bar-decoration and sizing events, and draws 3D hints
|
||||
around fixed and flexible bars, similar to those in Microsoft DevStudio 6.x
|
||||
|
||||
\wxheading{Derived from}
|
||||
|
||||
\helpref{cbPluginBase}{cbpluginbase}
|
||||
|
||||
\wxheading{Include files}
|
||||
|
||||
<barhintspl.h>
|
||||
|
||||
\wxheading{Data structures}
|
||||
|
||||
\latexignore{\rtfignore{\wxheading{Members}}}
|
||||
@@ -23,95 +27,129 @@ Intercepts bar-decoration and sizing events, draws 3d-hints
|
||||
|
||||
\func{}{cbBarHintsPlugin}{\void}
|
||||
|
||||
Default constructor.
|
||||
|
||||
|
||||
\func{}{cbBarHintsPlugin}{\param{wxFrameLayout* }{pLayout}, \param{int }{paneMask = wxALL\_PANES}}
|
||||
|
||||
Constructor, taking parent frame and pane mask flag.
|
||||
|
||||
|
||||
\membersection{cbBarHintsPlugin::\destruct{cbBarHintsPlugin}}\label{cbbarhintsplugindtor}
|
||||
|
||||
\func{}{\destruct{cbBarHintsPlugin}}{\void}
|
||||
|
||||
Destructor.
|
||||
|
||||
|
||||
\membersection{cbBarHintsPlugin::CreateBoxes}\label{cbbarhintsplugincreateboxes}
|
||||
|
||||
\func{void}{CreateBoxes}{\void}
|
||||
|
||||
Helper function: creates close and collapse boxes.
|
||||
|
||||
|
||||
\membersection{cbBarHintsPlugin::DoDrawHint}\label{cbbarhintsplugindodrawhint}
|
||||
|
||||
\func{void}{DoDrawHint}{\param{wxDC\& }{dc}, \param{wxRect\& }{rect}, \param{int }{pos}, \param{int }{boxOfs}, \param{int }{grooveOfs}, \param{bool }{isFixed}}
|
||||
|
||||
Helper function: draws a hint.
|
||||
|
||||
|
||||
\membersection{cbBarHintsPlugin::Draw3DBox}\label{cbbarhintsplugindraw3dbox}
|
||||
|
||||
\func{void}{Draw3DBox}{\param{wxDC\& }{dc}, \param{const wxPoint\& }{pos}, \param{bool }{pressed}}
|
||||
|
||||
drawing helpers
|
||||
Helper function: draws a 3D box.
|
||||
|
||||
|
||||
\membersection{cbBarHintsPlugin::DrawCloseBox}\label{cbbarhintsplugindrawclosebox}
|
||||
|
||||
\func{void}{DrawCloseBox}{\param{wxDC\& }{dc}, \param{const wxPoint\& }{pos}, \param{bool }{pressed}}
|
||||
|
||||
Helper function: draws a close box.
|
||||
|
||||
|
||||
\membersection{cbBarHintsPlugin::DrawCollapseBox}\label{cbbarhintsplugindrawcollapsebox}
|
||||
|
||||
\func{void}{DrawCollapseBox}{\param{wxDC\& }{dc}, \param{const wxPoint\& }{pos}, \param{bool }{atLeft}, \param{bool }{disabled}, \param{bool }{pressed}}
|
||||
|
||||
Helper function: draws a collapse box.
|
||||
|
||||
|
||||
\membersection{cbBarHintsPlugin::DrawGrooves}\label{cbbarhintsplugindrawgrooves}
|
||||
|
||||
\func{void}{DrawGrooves}{\param{wxDC\& }{dc}, \param{const wxPoint\& }{pos}, \param{int }{length}}
|
||||
|
||||
Helper function: draws grooves.
|
||||
|
||||
|
||||
\membersection{cbBarHintsPlugin::ExcludeHints}\label{cbbarhintspluginexcludehints}
|
||||
|
||||
\func{void}{ExcludeHints}{\param{wxRect\& }{rect}, \param{cbBarInfo\& }{info}}
|
||||
|
||||
Helper function.
|
||||
|
||||
|
||||
\membersection{cbBarHintsPlugin::GetHintsLayout}\label{cbbarhintsplugingethintslayout}
|
||||
|
||||
\func{void}{GetHintsLayout}{\param{wxRect\& }{rect}, \param{cbBarInfo\& }{info}, \param{int\& }{boxOfs}, \param{int\& }{grooveOfs}, \param{int\& }{pos}}
|
||||
|
||||
Helper function: gets the layout of a hint.
|
||||
|
||||
|
||||
\membersection{cbBarHintsPlugin::HitTestHints}\label{cbbarhintspluginhittesthints}
|
||||
|
||||
\func{int}{HitTestHints}{\param{cbBarInfo\& }{info}, \param{const wxPoint\& }{pos}}
|
||||
|
||||
Helper function: returns information about the hint under the given position.
|
||||
|
||||
|
||||
\membersection{cbBarHintsPlugin::OnDrawBarDecorations}\label{cbbarhintspluginondrawbardecorations}
|
||||
|
||||
\func{void}{OnDrawBarDecorations}{\param{cbDrawBarDecorEvent\& }{event}}
|
||||
|
||||
Handles a plugin event.
|
||||
|
||||
|
||||
\membersection{cbBarHintsPlugin::OnInitPlugin}\label{cbbarhintspluginoninitplugin}
|
||||
|
||||
\func{void}{OnInitPlugin}{\void}
|
||||
|
||||
Called to initialize this plugin.
|
||||
|
||||
|
||||
\membersection{cbBarHintsPlugin::OnLeftDown}\label{cbbarhintspluginonleftdown}
|
||||
|
||||
\func{void}{OnLeftDown}{\param{cbLeftDownEvent\& }{event}}
|
||||
|
||||
Handles a plugin event.
|
||||
|
||||
|
||||
\membersection{cbBarHintsPlugin::OnLeftUp}\label{cbbarhintspluginonleftup}
|
||||
|
||||
\func{void}{OnLeftUp}{\param{cbLeftUpEvent\& }{event}}
|
||||
|
||||
Handles a plugin event.
|
||||
|
||||
|
||||
\membersection{cbBarHintsPlugin::OnMotion}\label{cbbarhintspluginonmotion}
|
||||
|
||||
\func{void}{OnMotion}{\param{cbMotionEvent\& }{event}}
|
||||
|
||||
Handles a plugin event.
|
||||
|
||||
|
||||
\membersection{cbBarHintsPlugin::OnSizeBarWindow}\label{cbbarhintspluginonsizebarwindow}
|
||||
|
||||
\func{void}{OnSizeBarWindow}{\param{cbSizeBarWndEvent\& }{event}}
|
||||
|
||||
handlers of plugin-events
|
||||
Handles a plugin event.
|
||||
|
||||
|
||||
\membersection{cbBarHintsPlugin::SetGrooveCount}\label{cbbarhintspluginsetgroovecount}
|
||||
|
||||
\func{void}{SetGrooveCount}{\param{int }{nGrooves}}
|
||||
|
||||
Set the number of grooves to be shown in the pane.
|
||||
|
||||
|
||||
@@ -1,15 +1,23 @@
|
||||
%
|
||||
% automatically generated by HelpGen $Revision$ from
|
||||
% controlbar.h at 05/Jan/02 22:50:59
|
||||
% controlbar.h at 21/Jan/02 21:14:14
|
||||
%
|
||||
|
||||
|
||||
\section{\class{cbBarInfo}}\label{cbbarinfo}
|
||||
|
||||
|
||||
Helper class used internally by the wxFrameLayout class.
|
||||
Holds and manages bar information.
|
||||
|
||||
\wxheading{Derived from}
|
||||
|
||||
\helpref{wxObject}{wxobject}
|
||||
|
||||
\wxheading{Include files}
|
||||
|
||||
<controlbar.h>
|
||||
|
||||
\wxheading{Data structures}
|
||||
|
||||
\latexignore{\rtfignore{\wxheading{Members}}}
|
||||
@@ -19,18 +27,26 @@
|
||||
|
||||
\func{}{cbBarInfo}{\void}
|
||||
|
||||
Constructor.
|
||||
|
||||
|
||||
\membersection{cbBarInfo::\destruct{cbBarInfo}}\label{cbbarinfodtor}
|
||||
|
||||
\func{}{\destruct{cbBarInfo}}{\void}
|
||||
|
||||
Destructor.
|
||||
|
||||
|
||||
\membersection{cbBarInfo::IsExpanded}\label{cbbarinfoisexpanded}
|
||||
|
||||
\constfunc{bool}{IsExpanded}{\void}
|
||||
|
||||
Returns TRUE if this bar is expanded.
|
||||
|
||||
|
||||
\membersection{cbBarInfo::IsFixed}\label{cbbarinfoisfixed}
|
||||
|
||||
\constfunc{bool}{IsFixed}{\void}
|
||||
|
||||
Returns TRUE if this bar is fixed.
|
||||
|
||||
|
||||
@@ -1,18 +1,22 @@
|
||||
%
|
||||
% automatically generated by HelpGen $Revision$ from
|
||||
% controlbar.h at 05/Jan/02 22:50:59
|
||||
% controlbar.h at 21/Jan/02 21:14:14
|
||||
%
|
||||
|
||||
|
||||
\section{\class{cbBarShapeData}}\label{cbbarshapedata}
|
||||
|
||||
|
||||
used for storing original bar's postions in the row, when the "non-destructive-friction"
|
||||
option is turned ON
|
||||
Used for storing the original bar's positions in the row, when the 'non-destructive-friction'
|
||||
option is turned on.
|
||||
|
||||
\wxheading{Derived from}
|
||||
|
||||
\helpref{wxObject}{wxobject}
|
||||
|
||||
\wxheading{Include files}
|
||||
|
||||
<controlbar.h>
|
||||
|
||||
\wxheading{Data structures}
|
||||
|
||||
|
||||
@@ -1,24 +1,47 @@
|
||||
%
|
||||
% automatically generated by HelpGen $Revision$ from
|
||||
% controlbar.h at 05/Jan/02 22:50:58
|
||||
% controlbar.h at 21/Jan/02 21:14:13
|
||||
%
|
||||
|
||||
|
||||
\section{\class{cbBarSpy}}\label{cbbarspy}
|
||||
|
||||
|
||||
FIXME:: somehow in debug v. originall wxASSERT's are not compiled in...
|
||||
\#undef wxASSERT
|
||||
\#define wxASSERT(x) if ( !(x) ) throw;
|
||||
helper class, used for spying for not-handled mouse events on control-bars
|
||||
and forwarding them to the frame layout
|
||||
Helper class, used for spying for unhandled mouse events on control bars
|
||||
and forwarding them to the frame layout.
|
||||
|
||||
\wxheading{Derived from}
|
||||
|
||||
\helpref{wxEvtHandler}{wxevthandler}
|
||||
|
||||
\wxheading{Include files}
|
||||
|
||||
<controlbar.h>
|
||||
|
||||
\wxheading{Data structures}
|
||||
|
||||
{\small \begin{verbatim}
|
||||
typedef cbBarInfo* BarInfoPtrT
|
||||
\end{verbatim}}
|
||||
forward declarations
|
||||
|
||||
{\small \begin{verbatim}
|
||||
typedef cbRowInfo* RowInfoPtrT
|
||||
\end{verbatim}}
|
||||
enumeration of hittest results, see cbDockPane::HitTestPaneItems(..)
|
||||
\begin{verbatim}
|
||||
enum CB_HITTEST_RESULT
|
||||
{
|
||||
CB_NO_ITEMS_HITTED,
|
||||
|
||||
CB_UPPER_ROW_HANDLE_HITTED,
|
||||
CB_LOWER_ROW_HANDLE_HITTED,
|
||||
CB_LEFT_BAR_HANDLE_HITTED,
|
||||
CB_RIGHT_BAR_HANDLE_HITTED,
|
||||
CB_BAR_CONTENT_HITTED
|
||||
}
|
||||
\end{verbatim}
|
||||
|
||||
\latexignore{\rtfignore{\wxheading{Members}}}
|
||||
|
||||
|
||||
@@ -26,18 +49,24 @@ and forwarding them to the frame layout
|
||||
|
||||
\func{}{cbBarSpy}{\param{wxFrameLayout* }{pPanel}}
|
||||
|
||||
Constructor, taking a parent pane.
|
||||
|
||||
|
||||
\func{}{cbBarSpy}{\void}
|
||||
|
||||
Default constructor.
|
||||
|
||||
|
||||
\membersection{cbBarSpy::ProcessEvent}\label{cbbarspyprocessevent}
|
||||
|
||||
\func{bool}{ProcessEvent}{\param{wxEvent\& }{event}}
|
||||
|
||||
overriden
|
||||
Performs special event processing.
|
||||
|
||||
|
||||
\membersection{cbBarSpy::SetBarWindow}\label{cbbarspysetbarwindow}
|
||||
|
||||
\func{void}{SetBarWindow}{\param{wxWindow* }{pWnd}}
|
||||
|
||||
Sets the bar window.
|
||||
|
||||
|
||||
@@ -1,18 +1,22 @@
|
||||
%
|
||||
% automatically generated by HelpGen $Revision$ from
|
||||
% toolwnd.h at 05/Jan/02 22:50:58
|
||||
% toolwnd.h at 21/Jan/02 21:14:17
|
||||
%
|
||||
|
||||
|
||||
\section{\class{cbCloseBox}}\label{cbclosebox}
|
||||
|
||||
|
||||
classes specific to wxFrameLayout engine (FOR NOW in here...)
|
||||
cbCloseBox is a window close button, used in a wxToolWindow titlebar.
|
||||
|
||||
\wxheading{Derived from}
|
||||
|
||||
\helpref{cbMiniButton}{cbminibutton}
|
||||
|
||||
\wxheading{Include files}
|
||||
|
||||
<toolwnd.h>
|
||||
|
||||
\wxheading{Data structures}
|
||||
|
||||
\latexignore{\rtfignore{\wxheading{Members}}}
|
||||
@@ -22,3 +26,5 @@ classes specific to wxFrameLayout engine (FOR NOW in here...)
|
||||
|
||||
\func{void}{Draw}{\param{wxDC\& }{dc}}
|
||||
|
||||
Draws the close button appearance.
|
||||
|
||||
|
||||
@@ -1,15 +1,22 @@
|
||||
%
|
||||
% automatically generated by HelpGen $Revision$ from
|
||||
% toolwnd.h at 05/Jan/02 22:50:58
|
||||
% toolwnd.h at 21/Jan/02 21:14:17
|
||||
%
|
||||
|
||||
|
||||
\section{\class{cbCollapseBox}}\label{cbcollapsebox}
|
||||
|
||||
|
||||
cbCollapseBox is a window collapse button, used in a wxToolWindow titlebar.
|
||||
|
||||
\wxheading{Derived from}
|
||||
|
||||
\helpref{cbMiniButton}{cbminibutton}
|
||||
|
||||
\wxheading{Include files}
|
||||
|
||||
<toolwnd.h>
|
||||
|
||||
\wxheading{Data structures}
|
||||
|
||||
\latexignore{\rtfignore{\wxheading{Members}}}
|
||||
@@ -19,3 +26,5 @@
|
||||
|
||||
\func{void}{Draw}{\param{wxDC\& }{dc}}
|
||||
|
||||
Draws the collapse button appearance.
|
||||
|
||||
|
||||
@@ -1,19 +1,23 @@
|
||||
%
|
||||
% automatically generated by HelpGen $Revision$ from
|
||||
% controlbar.h at 05/Jan/02 22:50:59
|
||||
% controlbar.h at 21/Jan/02 21:14:14
|
||||
%
|
||||
|
||||
|
||||
\section{\class{cbCommonPaneProperties}}\label{cbcommonpaneproperties}
|
||||
|
||||
|
||||
structure holds configuration options,
|
||||
which are usually the same for all panes in
|
||||
frame layout
|
||||
|
||||
A structure holding configuration options,
|
||||
which are usually the same for all panes in
|
||||
a frame layout.
|
||||
|
||||
\wxheading{Derived from}
|
||||
|
||||
\helpref{wxObject}{wxobject}
|
||||
|
||||
\wxheading{Include files}
|
||||
|
||||
<controlbar.h>
|
||||
|
||||
\wxheading{Data structures}
|
||||
|
||||
|
||||
@@ -1,15 +1,22 @@
|
||||
%
|
||||
% automatically generated by HelpGen $Revision$ from
|
||||
% controlbar.h at 05/Jan/02 22:51:01
|
||||
% controlbar.h at 21/Jan/02 21:14:17
|
||||
%
|
||||
|
||||
|
||||
\section{\class{cbCustomizeBarEvent}}\label{cbcustomizebarevent}
|
||||
|
||||
|
||||
Class for bar customization events.
|
||||
|
||||
\wxheading{Derived from}
|
||||
|
||||
\helpref{cbPluginEvent}{cbpluginevent}
|
||||
|
||||
\wxheading{Include files}
|
||||
|
||||
<controlbar.h>
|
||||
|
||||
\wxheading{Data structures}
|
||||
|
||||
\latexignore{\rtfignore{\wxheading{Members}}}
|
||||
@@ -19,3 +26,5 @@
|
||||
|
||||
\func{}{cbCustomizeBarEvent}{\param{cbBarInfo* }{pBar}, \param{const wxPoint\& }{clickPos}, \param{cbDockPane* }{pPane}}
|
||||
|
||||
Constructor, taking bar information, mouse position, and pane.
|
||||
|
||||
|
||||
@@ -1,15 +1,22 @@
|
||||
%
|
||||
% automatically generated by HelpGen $Revision$ from
|
||||
% controlbar.h at 05/Jan/02 22:51:01
|
||||
% controlbar.h at 21/Jan/02 21:14:17
|
||||
%
|
||||
|
||||
|
||||
\section{\class{cbCustomizeLayoutEvent}}\label{cbcustomizelayoutevent}
|
||||
|
||||
|
||||
Class for layout customization events.
|
||||
|
||||
\wxheading{Derived from}
|
||||
|
||||
\helpref{cbPluginEvent}{cbpluginevent}
|
||||
|
||||
\wxheading{Include files}
|
||||
|
||||
<controlbar.h>
|
||||
|
||||
\wxheading{Data structures}
|
||||
|
||||
\latexignore{\rtfignore{\wxheading{Members}}}
|
||||
@@ -19,3 +26,5 @@
|
||||
|
||||
\func{}{cbCustomizeLayoutEvent}{\param{const wxPoint\& }{clickPos}}
|
||||
|
||||
Constructor, taking mouse position.
|
||||
|
||||
|
||||
@@ -1,18 +1,23 @@
|
||||
%
|
||||
% automatically generated by HelpGen $Revision$ from
|
||||
% controlbar.h at 05/Jan/02 22:50:59
|
||||
% controlbar.h at 21/Jan/02 21:14:13
|
||||
%
|
||||
|
||||
|
||||
\section{\class{cbDimInfo}}\label{cbdiminfo}
|
||||
|
||||
|
||||
helper classes (used internally by wxFrameLayout class) holds and manages information about bar dimensions
|
||||
Helper class used internally by the wxFrameLayout class.
|
||||
Holds and manages information about bar dimensions.
|
||||
|
||||
\wxheading{Derived from}
|
||||
|
||||
\helpref{wxObject}{wxobject}
|
||||
|
||||
\wxheading{Include files}
|
||||
|
||||
<controlbar.h>
|
||||
|
||||
\wxheading{Data structures}
|
||||
|
||||
\latexignore{\rtfignore{\wxheading{Members}}}
|
||||
@@ -22,31 +27,54 @@ helper classes (used internally by wxFrameLayout class) holds and manages inform
|
||||
|
||||
\func{}{cbDimInfo}{\param{cbBarDimHandlerBase* }{pDimHandler}, \param{bool }{isFixed}}
|
||||
|
||||
Constructor.
|
||||
isFixed is TRUE if vertical/horizontal dimensions cannot be manually adjusted
|
||||
by the user using resizing handles. If FALSE, the frame-layout
|
||||
automatically places resizing handles among bars that do are not fixed.
|
||||
|
||||
|
||||
\func{}{cbDimInfo}{\param{int }{dh\_x}, \param{int }{dh\_y}, \param{int }{dv\_x}, \param{int }{dv\_y}, \param{int }{f\_x}, \param{int }{f\_y}, \param{bool }{isFixed = TRUE}, \param{int }{horizGap = 6}, \param{int }{vertGap = 6}, \param{cbBarDimHandlerBase* }{pDimHandler = NULL}}
|
||||
|
||||
dims when docked horizontally
|
||||
Constructor taking dimenstion information.
|
||||
dh\_x, dh\_y are the dimensions when docked horizontally.
|
||||
dv\_x, dv\_y are the dimensions when docked vertically.
|
||||
f\_x, f\_y are the dimensions when floating.
|
||||
For information on isFixed, see comments above.
|
||||
horizGap is the left/right gap, separating decorations
|
||||
from the bar's actual wndow, filled with the frame's background colour.
|
||||
The dimension is given in the frame's coordinates.
|
||||
vertGap is the top/bottom gap, separating decorations
|
||||
from the bar's actual wndow, filled with the frame's background colour.
|
||||
The dimension is given in the frame's coordinates.
|
||||
|
||||
|
||||
\func{}{cbDimInfo}{\param{int }{x}, \param{int }{y}, \param{bool }{isFixed = TRUE}, \param{int }{gap = 6}, \param{cbBarDimHandlerBase* }{pDimHandler = NULL}}
|
||||
|
||||
Constructor.
|
||||
|
||||
|
||||
\func{}{cbDimInfo}{\void}
|
||||
|
||||
Default constructor.
|
||||
|
||||
|
||||
\membersection{cbDimInfo::\destruct{cbDimInfo}}\label{cbdiminfodtor}
|
||||
|
||||
\func{}{\destruct{cbDimInfo}}{\void}
|
||||
|
||||
destroys handler automatically, if present
|
||||
Destructor. Destroys handler automatically, if present.
|
||||
|
||||
|
||||
\membersection{cbDimInfo::GetDimHandler}\label{cbdiminfogetdimhandler}
|
||||
|
||||
\func{cbBarDimHandlerBase*}{GetDimHandler}{\void}
|
||||
|
||||
Returns the handler, if any.
|
||||
|
||||
|
||||
\membersection{cbDimInfo::operator=}\label{cbdiminfooperatorassign}
|
||||
|
||||
\func{const cbDimInfo\& operator}{operator=}{\param{const cbDimInfo\& }{other}}
|
||||
|
||||
Assignment operator.
|
||||
|
||||
|
||||
@@ -1,15 +1,22 @@
|
||||
%
|
||||
% automatically generated by HelpGen $Revision$ from
|
||||
% toolwnd.h at 05/Jan/02 22:50:58
|
||||
% toolwnd.h at 21/Jan/02 21:14:17
|
||||
%
|
||||
|
||||
|
||||
\section{\class{cbDockBox}}\label{cbdockbox}
|
||||
|
||||
|
||||
cbDockBox is a window dock button, used in a wxToolWindow titlebar.
|
||||
|
||||
\wxheading{Derived from}
|
||||
|
||||
\helpref{cbMiniButton}{cbminibutton}
|
||||
|
||||
\wxheading{Include files}
|
||||
|
||||
<toolwnd.h>
|
||||
|
||||
\wxheading{Data structures}
|
||||
|
||||
\latexignore{\rtfignore{\wxheading{Members}}}
|
||||
@@ -19,3 +26,5 @@
|
||||
|
||||
\func{void}{Draw}{\param{wxDC\& }{dc}}
|
||||
|
||||
Draws the dock button appearance.
|
||||
|
||||
|
||||
@@ -1,19 +1,23 @@
|
||||
%
|
||||
% automatically generated by HelpGen $Revision$ from
|
||||
% controlbar.h at 05/Jan/02 22:50:59
|
||||
% controlbar.h at 21/Jan/02 21:14:14
|
||||
%
|
||||
|
||||
|
||||
\section{\class{cbDockPane}}\label{cbdockpane}
|
||||
|
||||
|
||||
class manages containment and control of control-bars
|
||||
along one of the four edges of the parent frame
|
||||
|
||||
This 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{Include files}
|
||||
|
||||
<controlbar.h>
|
||||
|
||||
\wxheading{Data structures}
|
||||
|
||||
\latexignore{\rtfignore{\wxheading{Members}}}
|
||||
@@ -23,413 +27,552 @@ class manages containment and control of control-bars
|
||||
|
||||
\func{}{cbDockPane}{\param{int }{alignment}, \param{wxFrameLayout* }{pPanel}}
|
||||
|
||||
Constructor, taking alignment and layout panel.
|
||||
|
||||
|
||||
\func{}{cbDockPane}{\void}
|
||||
|
||||
public members
|
||||
public members Default constructor.
|
||||
|
||||
|
||||
\membersection{cbDockPane::\destruct{cbDockPane}}\label{cbdockpanedtor}
|
||||
|
||||
\func{}{\destruct{cbDockPane}}{\void}
|
||||
|
||||
Destructor.
|
||||
|
||||
|
||||
\membersection{cbDockPane::BarPresent}\label{cbdockpanebarpresent}
|
||||
|
||||
\func{bool}{BarPresent}{\param{cbBarInfo* }{pBar}}
|
||||
|
||||
TRUE, if the given bar node presents in this pane
|
||||
Returns TRUE if the given bar is present in this pane.
|
||||
|
||||
|
||||
\membersection{cbDockPane::CalcLengthRatios}\label{cbdockpanecalclengthratios}
|
||||
|
||||
\func{void}{CalcLengthRatios}{\param{cbRowInfo* }{pInRow}}
|
||||
|
||||
Calculate lengths.
|
||||
Internal function called by plugins.
|
||||
|
||||
|
||||
\membersection{cbDockPane::ContractBar}\label{cbdockpanecontractbar}
|
||||
|
||||
\func{void}{ContractBar}{\param{cbBarInfo* }{pBar}}
|
||||
|
||||
Contracts the bar.
|
||||
Internal function called by plugins.
|
||||
|
||||
|
||||
\membersection{cbDockPane::DoInsertBar}\label{cbdockpanedoinsertbar}
|
||||
|
||||
\func{void}{DoInsertBar}{\param{cbBarInfo* }{pBar}, \param{int }{rowNo}}
|
||||
|
||||
Inserts the bar at the given row number.
|
||||
Internal function called by plugins.
|
||||
|
||||
|
||||
\membersection{cbDockPane::DrawHorizHandle}\label{cbdockpanedrawhorizhandle}
|
||||
|
||||
\func{void}{DrawHorizHandle}{\param{wxDC\& }{dc}, \param{int }{x}, \param{int }{y}, \param{int }{width}}
|
||||
|
||||
Row/bar resizing related helper-method.
|
||||
|
||||
|
||||
\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
|
||||
protected really (accessed only by plugins) Row/bar resizing related helper-method.
|
||||
|
||||
|
||||
\membersection{cbDockPane::ExpandBar}\label{cbdockpaneexpandbar}
|
||||
|
||||
\func{void}{ExpandBar}{\param{cbBarInfo* }{pBar}}
|
||||
|
||||
Expands the bar.
|
||||
Internal function called by plugins.
|
||||
|
||||
|
||||
\membersection{cbDockPane::FinishDrawInArea}\label{cbdockpanefinishdrawinarea}
|
||||
|
||||
\func{void}{FinishDrawInArea}{\param{const wxRect\& }{area}}
|
||||
|
||||
Generates cbFinishDrawInAreaEvent and sends it to the layout.
|
||||
Internal function called by plugins.
|
||||
|
||||
|
||||
\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
|
||||
Coordinate translation between parent's frame and this pane.
|
||||
Internal function called by plugins.
|
||||
|
||||
|
||||
\func{void}{FrameToPane}{\param{wxRect* }{pRect}}
|
||||
|
||||
Coordinate translation between parent's frame and this pane.
|
||||
Internal function called by plugins.
|
||||
|
||||
|
||||
\membersection{cbDockPane::GetAlignment}\label{cbdockpanegetalignment}
|
||||
|
||||
\func{int}{GetAlignment}{\void}
|
||||
|
||||
Returns the alignment for this pane. The value is one of
|
||||
FL\_ALIGN\_TOP, FL\_ALIGN\_BOTTOM, FL\_ALIGN\_LEFT, FL\_ALIGN\_RIGHT.
|
||||
|
||||
|
||||
\membersection{cbDockPane::GetBarInfoByWindow}\label{cbdockpanegetbarinfobywindow}
|
||||
|
||||
\func{cbBarInfo*}{GetBarInfoByWindow}{\param{wxWindow* }{pBarWnd}}
|
||||
|
||||
Finds the bar information by corresponding window.
|
||||
|
||||
|
||||
\membersection{cbDockPane::GetBarResizeRange}\label{cbdockpanegetbarresizerange}
|
||||
|
||||
\func{void}{GetBarResizeRange}{\param{cbBarInfo* }{pBar}, \param{int* }{from}, \param{int* }{till}, \param{bool }{forLeftHandle}}
|
||||
|
||||
Returns the bar's resize range.
|
||||
|
||||
|
||||
\membersection{cbDockPane::GetDockingState}\label{cbdockpanegetdockingstate}
|
||||
|
||||
\func{int}{GetDockingState}{\void}
|
||||
|
||||
Returns wxCBAR\_DOCKED\_HORIZONTALLY if the alignment is top or bottom,
|
||||
or wxCBAR\_DOCKED\_VERTICALLY otherwise.
|
||||
|
||||
|
||||
\membersection{cbDockPane::GetFirstRow}\label{cbdockpanegetfirstrow}
|
||||
|
||||
\func{cbRowInfo*}{GetFirstRow}{\void}
|
||||
|
||||
convenience method
|
||||
Returns the first row.
|
||||
|
||||
|
||||
\membersection{cbDockPane::GetMinimalRowHeight}\label{cbdockpanegetminimalrowheight}
|
||||
|
||||
\func{int}{GetMinimalRowHeight}{\param{cbRowInfo* }{pRow}}
|
||||
|
||||
Returns the minimal row height for the given row.
|
||||
Internal function called by plugins.
|
||||
|
||||
|
||||
\membersection{cbDockPane::GetNotFixedBarsCount}\label{cbdockpanegetnotfixedbarscount}
|
||||
|
||||
\func{int}{GetNotFixedBarsCount}{\param{cbRowInfo* }{pRow}}
|
||||
|
||||
Returns the number of bars whose size is not fixed.
|
||||
Internal function called by plugins.
|
||||
|
||||
|
||||
\membersection{cbDockPane::GetPaneHeight}\label{cbdockpanegetpaneheight}
|
||||
|
||||
\func{int}{GetPaneHeight}{\void}
|
||||
|
||||
retuns height, in pane's coordinates
|
||||
Returns the height in the pane's coordinates.
|
||||
|
||||
|
||||
\membersection{cbDockPane::GetRealRect}\label{cbdockpanegetrealrect}
|
||||
|
||||
\func{wxRect\&}{GetRealRect}{\void}
|
||||
|
||||
Returns the bounds of the pane, in parent coordinates.
|
||||
|
||||
|
||||
\membersection{cbDockPane::GetRow}\label{cbdockpanegetrow}
|
||||
|
||||
\func{cbRowInfo*}{GetRow}{\param{int }{row}}
|
||||
|
||||
protected really (accessed only by plugins)
|
||||
protected really (accessed only by plugins) Returns the row info for a row index. Internal function called 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
|
||||
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.
|
||||
|
||||
|
||||
\func{int}{GetRowAt}{\param{int }{upperY}, \param{int }{lowerY}}
|
||||
|
||||
Returns the row between the given vertical positions.
|
||||
Returns -1 if the row is not present.
|
||||
Internal function called by plugins.
|
||||
|
||||
|
||||
\membersection{cbDockPane::GetRowIndex}\label{cbdockpanegetrowindex}
|
||||
|
||||
\func{int}{GetRowIndex}{\param{cbRowInfo* }{pRow}}
|
||||
|
||||
Returns the row index for the given row info. Internal function called by plugins.
|
||||
|
||||
|
||||
\membersection{cbDockPane::GetRowList}\label{cbdockpanegetrowlist}
|
||||
|
||||
\func{RowArrayT\&}{GetRowList}{\void}
|
||||
|
||||
used by updates-managers
|
||||
Returns an array of rows. Used by updates-managers.
|
||||
|
||||
|
||||
\membersection{cbDockPane::GetRowResizeRange}\label{cbdockpanegetrowresizerange}
|
||||
|
||||
\func{void}{GetRowResizeRange}{\param{cbRowInfo* }{pRow}, \param{int* }{from}, \param{int* }{till}, \param{bool }{forUpperHandle}}
|
||||
|
||||
Returns the row's resize range.
|
||||
|
||||
|
||||
\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}}
|
||||
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.
|
||||
|
||||
|
||||
\membersection{cbDockPane::GetRowY}\label{cbdockpanegetrowy}
|
||||
|
||||
\func{int}{GetRowY}{\param{cbRowInfo* }{pRow}}
|
||||
|
||||
Gets the vertical position at the given row.
|
||||
Internal function called by plugins.
|
||||
|
||||
|
||||
\membersection{cbDockPane::HasNotFixedBarsLeft}\label{cbdockpanehasnotfixedbarsleft}
|
||||
|
||||
\func{bool}{HasNotFixedBarsLeft}{\param{cbBarInfo* }{pBar}}
|
||||
|
||||
Returns TRUE if there are any variable-sized rows to the left of this one.
|
||||
Internal function called by plugins.
|
||||
|
||||
|
||||
\membersection{cbDockPane::HasNotFixedBarsRight}\label{cbdockpanehasnotfixedbarsright}
|
||||
|
||||
\func{bool}{HasNotFixedBarsRight}{\param{cbBarInfo* }{pBar}}
|
||||
|
||||
Returns TRUE if there are any variable-sized rows to the right of this one.
|
||||
Internal function called by plugins.
|
||||
|
||||
|
||||
\membersection{cbDockPane::HasNotFixedRowsAbove}\label{cbdockpanehasnotfixedrowsabove}
|
||||
|
||||
\func{bool}{HasNotFixedRowsAbove}{\param{cbRowInfo* }{pRow}}
|
||||
|
||||
Returns TRUE if there are any variable-sized rows above this one.
|
||||
Internal function called by plugins.
|
||||
|
||||
|
||||
\membersection{cbDockPane::HasNotFixedRowsBelow}\label{cbdockpanehasnotfixedrowsbelow}
|
||||
|
||||
\func{bool}{HasNotFixedRowsBelow}{\param{cbRowInfo* }{pRow}}
|
||||
|
||||
Returns TRUE if there are any variable-sized rows below this one.
|
||||
Internal function called by plugins.
|
||||
|
||||
|
||||
\membersection{cbDockPane::HasPoint}\label{cbdockpanehaspoint}
|
||||
|
||||
\func{bool}{HasPoint}{\param{const wxPoint\& }{pos}, \param{int }{x}, \param{int }{y}, \param{int }{width}, \param{int }{height}}
|
||||
|
||||
Returns TRUE if pos is within the given rectangle.
|
||||
Internal function called by plugins.
|
||||
|
||||
|
||||
\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
|
||||
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.
|
||||
|
||||
|
||||
\membersection{cbDockPane::InitLinksForRow}\label{cbdockpaneinitlinksforrow}
|
||||
|
||||
\func{void}{InitLinksForRow}{\param{cbRowInfo* }{pRow}}
|
||||
|
||||
Sets up links between bars.
|
||||
Internal function called by plugins.
|
||||
|
||||
|
||||
\membersection{cbDockPane::InitLinksForRows}\label{cbdockpaneinitlinksforrows}
|
||||
|
||||
\func{void}{InitLinksForRows}{\void}
|
||||
|
||||
Sets up links between bars.
|
||||
Internal function called by plugins.
|
||||
|
||||
|
||||
\membersection{cbDockPane::InsertBar}\label{cbdockpaneinsertbar}
|
||||
|
||||
\func{void}{InsertBar}{\param{cbBarInfo* }{pBar}, \param{const wxRect\& }{atRect}}
|
||||
\func{void}{InsertBar}{\param{cbBarInfo* }{pBarInfo}}
|
||||
|
||||
rect given in the parent frame's coordinates
|
||||
Inserts bar and sets its position according to the preferred settings
|
||||
given in pBarInfo.
|
||||
|
||||
|
||||
\func{void}{InsertBar}{\param{cbBarInfo* }{pBar}, \param{const wxRect\& }{rect}}
|
||||
|
||||
Inserts the bar into this pane. rect is 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
|
||||
Inserts the bar into the given row, with dimensions and position
|
||||
stored in pBarInfo->mBounds. Returns the node of inserted bar.
|
||||
|
||||
|
||||
\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
|
||||
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.
|
||||
|
||||
|
||||
\membersection{cbDockPane::IsFixedSize}\label{cbdockpaneisfixedsize}
|
||||
|
||||
\func{bool}{IsFixedSize}{\param{cbBarInfo* }{pInfo}}
|
||||
|
||||
layout "AI" helpers:
|
||||
Returns TRUE if the bar's dimension information indicates a fixed size.
|
||||
Internal function called by plugins.
|
||||
|
||||
|
||||
\membersection{cbDockPane::IsHorizontal}\label{cbdockpaneishorizontal}
|
||||
|
||||
\func{bool}{IsHorizontal}{\void}
|
||||
|
||||
Returns TRUE if the pane is aligned to the top or bottom.
|
||||
|
||||
|
||||
\membersection{cbDockPane::MatchesMask}\label{cbdockpanematchesmask}
|
||||
|
||||
\func{bool}{MatchesMask}{\param{int }{paneMask}}
|
||||
|
||||
Returns TRUE if the given mask matches the pane's mask.
|
||||
|
||||
|
||||
\membersection{cbDockPane::PaintBar}\label{cbdockpanepaintbar}
|
||||
|
||||
\func{void}{PaintBar}{\param{cbBarInfo* }{pBar}, \param{wxDC\& }{dc}}
|
||||
|
||||
Calls PaintBarDecorations and PaintBarHandles.
|
||||
Internal function called by plugins.
|
||||
|
||||
|
||||
\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)
|
||||
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.
|
||||
|
||||
|
||||
\membersection{cbDockPane::PaintBarHandles}\label{cbdockpanepaintbarhandles}
|
||||
|
||||
\func{void}{PaintBarHandles}{\param{cbBarInfo* }{pBar}, \param{wxDC\& }{dc}}
|
||||
|
||||
Generates a cbDrawBarHandlesEvent and sends it to the layout to paint the bar handles.
|
||||
Internal function called by plugins.
|
||||
|
||||
|
||||
\membersection{cbDockPane::PaintPane}\label{cbdockpanepaintpane}
|
||||
|
||||
\func{void}{PaintPane}{\param{wxDC\& }{dc}}
|
||||
|
||||
Paints the pane background, the row background and decorations,
|
||||
and finally the pane decorations.
|
||||
Internal function called by plugins.
|
||||
|
||||
|
||||
\membersection{cbDockPane::PaintPaneBackground}\label{cbdockpanepaintpanebackground}
|
||||
|
||||
\func{void}{PaintPaneBackground}{\param{wxDC\& }{dc}}
|
||||
|
||||
Generates cbDrawPaneBkGroundEvent and sends it to the layout.
|
||||
Internal function called by plugins.
|
||||
|
||||
|
||||
\membersection{cbDockPane::PaintPaneDecorations}\label{cbdockpanepaintpanedecorations}
|
||||
|
||||
\func{void}{PaintPaneDecorations}{\param{wxDC\& }{dc}}
|
||||
|
||||
Generates cbDrawPaneDecorEvent and sends it to the layout.
|
||||
Internal function called by plugins.
|
||||
|
||||
|
||||
\membersection{cbDockPane::PaintRow}\label{cbdockpanepaintrow}
|
||||
|
||||
\func{void}{PaintRow}{\param{cbRowInfo* }{pRow}, \param{wxDC\& }{dc}}
|
||||
|
||||
Calls PaintRowBackground, PaintRowDecorations, PaintRowHandles.
|
||||
Internal function called by plugins.
|
||||
|
||||
|
||||
\membersection{cbDockPane::PaintRowBackground}\label{cbdockpanepaintrowbackground}
|
||||
|
||||
\func{void}{PaintRowBackground}{\param{cbRowInfo* }{pRow}, \param{wxDC\& }{dc}}
|
||||
|
||||
Generates cbDrawRowBkGroundEvent and sends it to the layout.
|
||||
Internal function called by plugins.
|
||||
|
||||
|
||||
\membersection{cbDockPane::PaintRowDecorations}\label{cbdockpanepaintrowdecorations}
|
||||
|
||||
\func{void}{PaintRowDecorations}{\param{cbRowInfo* }{pRow}, \param{wxDC\& }{dc}}
|
||||
|
||||
Calls PaintBarDecorations for each row.
|
||||
Internal function called by plugins.
|
||||
|
||||
|
||||
\membersection{cbDockPane::PaintRowHandles}\label{cbdockpanepaintrowhandles}
|
||||
|
||||
\func{void}{PaintRowHandles}{\param{cbRowInfo* }{pRow}, \param{wxDC\& }{dc}}
|
||||
|
||||
Generates cbDrawRowHandlesEvent and cbDrawRowDecorEvent and sends them to the layout.
|
||||
Internal function called by plugins.
|
||||
|
||||
|
||||
\membersection{cbDockPane::PaneToFrame}\label{cbdockpanepanetoframe}
|
||||
|
||||
\func{void}{PaneToFrame}{\param{wxRect* }{pRect}}
|
||||
|
||||
Coordinate translation between parent's frame and this pane.
|
||||
Internal function called by plugins.
|
||||
|
||||
|
||||
\func{void}{PaneToFrame}{\param{int* }{x}, \param{int* }{y}}
|
||||
|
||||
Coordinate translation between parent's frame and this pane.
|
||||
Internal function called by plugins.
|
||||
|
||||
|
||||
\membersection{cbDockPane::RecalcLayout}\label{cbdockpanerecalclayout}
|
||||
|
||||
\func{void}{RecalcLayout}{\void}
|
||||
|
||||
Generates events to perform layout calculations.
|
||||
|
||||
|
||||
\membersection{cbDockPane::RecalcRowLayout}\label{cbdockpanerecalcrowlayout}
|
||||
|
||||
\func{void}{RecalcRowLayout}{\param{cbRowInfo* }{pRow}}
|
||||
|
||||
Generates a cbLayoutRowEvent event to recalculate row layouts.
|
||||
Internal function called by plugins.
|
||||
|
||||
|
||||
\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
|
||||
Removes the bar from this pane. Does not destroy the bar.
|
||||
|
||||
|
||||
\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
|
||||
Removes the row from this pane. Does not destroy the row object.
|
||||
|
||||
|
||||
\membersection{cbDockPane::ResizeBar}\label{cbdockpaneresizebar}
|
||||
|
||||
\func{void}{ResizeBar}{\param{cbBarInfo* }{pBar}, \param{int }{ofs}, \param{bool }{forLeftHandle}}
|
||||
|
||||
Row/bar resizing related helper-method.
|
||||
|
||||
|
||||
\membersection{cbDockPane::ResizeRow}\label{cbdockpaneresizerow}
|
||||
|
||||
\func{void}{ResizeRow}{\param{cbRowInfo* }{pRow}, \param{int }{ofs}, \param{bool }{forUpperHandle}}
|
||||
|
||||
Row/bar resizing related helper-method.
|
||||
|
||||
|
||||
\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
|
||||
Set the position and dimensions of the pane in the 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
|
||||
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)
|
||||
Sets pane's width in the 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
|
||||
Sets the row height for the given height. newHeight includes the height of row handles, if present.
|
||||
Internal function called by plugins.
|
||||
|
||||
|
||||
\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
|
||||
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.
|
||||
|
||||
|
||||
\membersection{cbDockPane::SizeBar}\label{cbdockpanesizebar}
|
||||
|
||||
\func{void}{SizeBar}{\param{cbBarInfo* }{pBar}}
|
||||
|
||||
Generates a cbSizeBarWndEvent and sends it to the layout.
|
||||
Internal function called by plugins.
|
||||
|
||||
|
||||
\membersection{cbDockPane::SizePaneObjects}\label{cbdockpanesizepaneobjects}
|
||||
|
||||
\func{void}{SizePaneObjects}{\void}
|
||||
|
||||
Calls SizeRowObjects for each row.
|
||||
Internal function called by plugins.
|
||||
|
||||
|
||||
\membersection{cbDockPane::SizeRowObjects}\label{cbdockpanesizerowobjects}
|
||||
|
||||
\func{void}{SizeRowObjects}{\param{cbRowInfo* }{pRow}}
|
||||
|
||||
Calls SizeBar for each bar in the row.
|
||||
Internal function called by plugins.
|
||||
|
||||
|
||||
\membersection{cbDockPane::StartDrawInArea}\label{cbdockpanestartdrawinarea}
|
||||
|
||||
\func{wxDC*}{StartDrawInArea}{\param{const wxRect\& }{area}}
|
||||
|
||||
Generates cbStartDrawInAreaEvent and sends it to the layout.
|
||||
Internal function called by plugins.
|
||||
|
||||
|
||||
\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
|
||||
Sets up flags in the row information structure, so that
|
||||
they match the changed state of row items correctly.
|
||||
Internal function called by plugins.
|
||||
|
||||
|
||||
@@ -1,15 +1,22 @@
|
||||
%
|
||||
% automatically generated by HelpGen $Revision$ from
|
||||
% controlbar.h at 05/Jan/02 22:51:00
|
||||
% controlbar.h at 21/Jan/02 21:14:16
|
||||
%
|
||||
|
||||
|
||||
\section{\class{cbDrawBarDecorEvent}}\label{cbdrawbardecorevent}
|
||||
|
||||
|
||||
Class for bar decoration drawing events.
|
||||
|
||||
\wxheading{Derived from}
|
||||
|
||||
\helpref{cbPluginEvent}{cbpluginevent}
|
||||
|
||||
\wxheading{Include files}
|
||||
|
||||
<controlbar.h>
|
||||
|
||||
\wxheading{Data structures}
|
||||
|
||||
\latexignore{\rtfignore{\wxheading{Members}}}
|
||||
@@ -19,3 +26,5 @@
|
||||
|
||||
\func{}{cbDrawBarDecorEvent}{\param{cbBarInfo* }{pBar}, \param{wxDC\& }{dc}, \param{cbDockPane* }{pPane}}
|
||||
|
||||
Constructor, taking bar information, device context, and pane.
|
||||
|
||||
|
||||
@@ -1,15 +1,22 @@
|
||||
%
|
||||
% automatically generated by HelpGen $Revision$ from
|
||||
% controlbar.h at 05/Jan/02 22:51:01
|
||||
% controlbar.h at 21/Jan/02 21:14:16
|
||||
%
|
||||
|
||||
|
||||
\section{\class{cbDrawBarHandlesEvent}}\label{cbdrawbarhandlesevent}
|
||||
|
||||
|
||||
Class for bar handles drawing events.
|
||||
|
||||
\wxheading{Derived from}
|
||||
|
||||
\helpref{cbPluginEvent}{cbpluginevent}
|
||||
|
||||
\wxheading{Include files}
|
||||
|
||||
<controlbar.h>
|
||||
|
||||
\wxheading{Data structures}
|
||||
|
||||
\latexignore{\rtfignore{\wxheading{Members}}}
|
||||
@@ -19,3 +26,5 @@
|
||||
|
||||
\func{}{cbDrawBarHandlesEvent}{\param{cbBarInfo* }{pBar}, \param{wxDC\& }{dc}, \param{cbDockPane* }{pPane}}
|
||||
|
||||
Constructor, taking bar information, device context, and pane.
|
||||
|
||||
|
||||
@@ -1,15 +1,22 @@
|
||||
%
|
||||
% automatically generated by HelpGen $Revision$ from
|
||||
% controlbar.h at 05/Jan/02 22:51:01
|
||||
% controlbar.h at 21/Jan/02 21:14:16
|
||||
%
|
||||
|
||||
|
||||
\section{\class{cbDrawHintRectEvent}}\label{cbdrawhintrectevent}
|
||||
|
||||
|
||||
Class for hint-rectangle drawing events.
|
||||
|
||||
\wxheading{Derived from}
|
||||
|
||||
\helpref{cbPluginEvent}{cbpluginevent}
|
||||
|
||||
\wxheading{Include files}
|
||||
|
||||
<controlbar.h>
|
||||
|
||||
\wxheading{Data structures}
|
||||
|
||||
\latexignore{\rtfignore{\wxheading{Members}}}
|
||||
@@ -20,4 +27,5 @@
|
||||
\func{}{cbDrawHintRectEvent}{\param{const wxRect\& }{rect}, \param{bool }{isInClient}, \param{bool }{eraseRect}, \param{bool }{lastTime}}
|
||||
|
||||
e.g. with fat/hatched border
|
||||
Constructor, taking hint rectangle and three flags.
|
||||
|
||||
|
||||
@@ -1,15 +1,22 @@
|
||||
%
|
||||
% automatically generated by HelpGen $Revision$ from
|
||||
% controlbar.h at 05/Jan/02 22:51:01
|
||||
% controlbar.h at 21/Jan/02 21:14:16
|
||||
%
|
||||
|
||||
|
||||
\section{\class{cbDrawPaneBkGroundEvent}}\label{cbdrawpanebkgroundevent}
|
||||
|
||||
|
||||
Class for pane background drawing events.
|
||||
|
||||
\wxheading{Derived from}
|
||||
|
||||
\helpref{cbPluginEvent}{cbpluginevent}
|
||||
|
||||
\wxheading{Include files}
|
||||
|
||||
<controlbar.h>
|
||||
|
||||
\wxheading{Data structures}
|
||||
|
||||
\latexignore{\rtfignore{\wxheading{Members}}}
|
||||
@@ -19,3 +26,5 @@
|
||||
|
||||
\func{}{cbDrawPaneBkGroundEvent}{\param{wxDC\& }{dc}, \param{cbDockPane* }{pPane}}
|
||||
|
||||
Constructor, taking device context and pane.
|
||||
|
||||
|
||||
@@ -1,15 +1,22 @@
|
||||
%
|
||||
% automatically generated by HelpGen $Revision$ from
|
||||
% controlbar.h at 05/Jan/02 22:51:01
|
||||
% controlbar.h at 21/Jan/02 21:14:16
|
||||
%
|
||||
|
||||
|
||||
\section{\class{cbDrawPaneDecorEvent}}\label{cbdrawpanedecorevent}
|
||||
|
||||
|
||||
Class for pane decoration drawing events.
|
||||
|
||||
\wxheading{Derived from}
|
||||
|
||||
\helpref{cbPluginEvent}{cbpluginevent}
|
||||
|
||||
\wxheading{Include files}
|
||||
|
||||
<controlbar.h>
|
||||
|
||||
\wxheading{Data structures}
|
||||
|
||||
\latexignore{\rtfignore{\wxheading{Members}}}
|
||||
@@ -19,3 +26,5 @@
|
||||
|
||||
\func{}{cbDrawPaneDecorEvent}{\param{wxDC\& }{dc}, \param{cbDockPane* }{pPane}}
|
||||
|
||||
Constructor, taking device context and pane.
|
||||
|
||||
|
||||
@@ -1,15 +1,22 @@
|
||||
%
|
||||
% automatically generated by HelpGen $Revision$ from
|
||||
% controlbar.h at 05/Jan/02 22:51:01
|
||||
% controlbar.h at 21/Jan/02 21:14:16
|
||||
%
|
||||
|
||||
|
||||
\section{\class{cbDrawRowBkGroundEvent}}\label{cbdrawrowbkgroundevent}
|
||||
|
||||
|
||||
Class for row background drawing events.
|
||||
|
||||
\wxheading{Derived from}
|
||||
|
||||
\helpref{cbPluginEvent}{cbpluginevent}
|
||||
|
||||
\wxheading{Include files}
|
||||
|
||||
<controlbar.h>
|
||||
|
||||
\wxheading{Data structures}
|
||||
|
||||
\latexignore{\rtfignore{\wxheading{Members}}}
|
||||
@@ -19,3 +26,5 @@
|
||||
|
||||
\func{}{cbDrawRowBkGroundEvent}{\param{cbRowInfo* }{pRow}, \param{wxDC\& }{dc}, \param{cbDockPane* }{pPane}}
|
||||
|
||||
Constructor, taking row information, device context, and pane.
|
||||
|
||||
|
||||
@@ -1,15 +1,22 @@
|
||||
%
|
||||
% automatically generated by HelpGen $Revision$ from
|
||||
% controlbar.h at 05/Jan/02 22:51:00
|
||||
% controlbar.h at 21/Jan/02 21:14:16
|
||||
%
|
||||
|
||||
|
||||
\section{\class{cbDrawRowDecorEvent}}\label{cbdrawrowdecorevent}
|
||||
|
||||
|
||||
Class for row decoration drawing events.
|
||||
|
||||
\wxheading{Derived from}
|
||||
|
||||
\helpref{cbPluginEvent}{cbpluginevent}
|
||||
|
||||
\wxheading{Include files}
|
||||
|
||||
<controlbar.h>
|
||||
|
||||
\wxheading{Data structures}
|
||||
|
||||
\latexignore{\rtfignore{\wxheading{Members}}}
|
||||
@@ -19,3 +26,5 @@
|
||||
|
||||
\func{}{cbDrawRowDecorEvent}{\param{cbRowInfo* }{pRow}, \param{wxDC\& }{dc}, \param{cbDockPane* }{pPane}}
|
||||
|
||||
Constructor, taking row information, device context, and pane.
|
||||
|
||||
|
||||
@@ -1,15 +1,22 @@
|
||||
%
|
||||
% automatically generated by HelpGen $Revision$ from
|
||||
% controlbar.h at 05/Jan/02 22:51:01
|
||||
% controlbar.h at 21/Jan/02 21:14:16
|
||||
%
|
||||
|
||||
|
||||
\section{\class{cbDrawRowHandlesEvent}}\label{cbdrawrowhandlesevent}
|
||||
|
||||
|
||||
Class for row handles drawing events.
|
||||
|
||||
\wxheading{Derived from}
|
||||
|
||||
\helpref{cbPluginEvent}{cbpluginevent}
|
||||
|
||||
\wxheading{Include files}
|
||||
|
||||
<controlbar.h>
|
||||
|
||||
\wxheading{Data structures}
|
||||
|
||||
\latexignore{\rtfignore{\wxheading{Members}}}
|
||||
@@ -19,3 +26,5 @@
|
||||
|
||||
\func{}{cbDrawRowHandlesEvent}{\param{cbRowInfo* }{pRow}, \param{wxDC\& }{dc}, \param{cbDockPane* }{pPane}}
|
||||
|
||||
Constructor, taking row information, device context, and pane.
|
||||
|
||||
|
||||
@@ -1,15 +1,22 @@
|
||||
%
|
||||
% automatically generated by HelpGen $Revision$ from
|
||||
% dyntbarhnd.h at 05/Jan/02 22:50:56
|
||||
% dyntbarhnd.h at 21/Jan/02 21:14:19
|
||||
%
|
||||
|
||||
|
||||
\section{\class{cbDynToolBarDimHandler}}\label{cbdyntoolbardimhandler}
|
||||
|
||||
|
||||
Dynamic toolbar dimension handler.
|
||||
|
||||
\wxheading{Derived from}
|
||||
|
||||
\helpref{cbBarDimHandlerBase}{cbbardimhandlerbase}
|
||||
|
||||
\wxheading{Include files}
|
||||
|
||||
<dyntbarhnd.h>
|
||||
|
||||
\wxheading{Data structures}
|
||||
|
||||
\latexignore{\rtfignore{\wxheading{Members}}}
|
||||
@@ -19,8 +26,12 @@
|
||||
|
||||
\func{void}{OnChangeBarState}{\param{cbBarInfo* }{pBar}, \param{int }{newState}}
|
||||
|
||||
Called when the bar changes state.
|
||||
|
||||
|
||||
\membersection{cbDynToolBarDimHandler::OnResizeBar}\label{cbdyntoolbardimhandleronresizebar}
|
||||
|
||||
\func{void}{OnResizeBar}{\param{cbBarInfo* }{pBar}, \param{const wxSize\& }{given}, \param{wxSize\& }{preferred}}
|
||||
|
||||
Called when a bar is resized.
|
||||
|
||||
|
||||
@@ -1,15 +1,22 @@
|
||||
%
|
||||
% automatically generated by HelpGen $Revision$ from
|
||||
% controlbar.h at 05/Jan/02 22:51:01
|
||||
% controlbar.h at 21/Jan/02 21:14:16
|
||||
%
|
||||
|
||||
|
||||
\section{\class{cbFinishDrawInAreaEvent}}\label{cbfinishdrawinareaevent}
|
||||
|
||||
|
||||
Class for finish drawing in area events.
|
||||
|
||||
\wxheading{Derived from}
|
||||
|
||||
\helpref{cbPluginEvent}{cbpluginevent}
|
||||
|
||||
\wxheading{Include files}
|
||||
|
||||
<controlbar.h>
|
||||
|
||||
\wxheading{Data structures}
|
||||
|
||||
\latexignore{\rtfignore{\wxheading{Members}}}
|
||||
@@ -19,3 +26,5 @@
|
||||
|
||||
\func{}{cbFinishDrawInAreaEvent}{\param{const wxRect\& }{area}, \param{cbDockPane* }{pPane}}
|
||||
|
||||
Constructor, taking rectangular area and pane.
|
||||
|
||||
|
||||
@@ -1,15 +1,23 @@
|
||||
%
|
||||
% automatically generated by HelpGen $Revision$ from
|
||||
% toolwnd.h at 05/Jan/02 22:50:58
|
||||
% toolwnd.h at 21/Jan/02 21:14:17
|
||||
%
|
||||
|
||||
|
||||
\section{\class{cbFloatedBarWindow}}\label{cbfloatedbarwindow}
|
||||
|
||||
|
||||
cbFloatedBarWindow is a kind of wxToolWindow,
|
||||
implementing floating toolbars.
|
||||
|
||||
\wxheading{Derived from}
|
||||
|
||||
\helpref{wxToolWindow}{wxtoolwindow}
|
||||
|
||||
\wxheading{Include files}
|
||||
|
||||
<toolwnd.h>
|
||||
|
||||
\wxheading{Data structures}
|
||||
|
||||
\latexignore{\rtfignore{\wxheading{Members}}}
|
||||
@@ -19,49 +27,63 @@
|
||||
|
||||
\func{}{cbFloatedBarWindow}{\void}
|
||||
|
||||
Default constructor.
|
||||
|
||||
|
||||
\membersection{cbFloatedBarWindow::GetBar}\label{cbfloatedbarwindowgetbar}
|
||||
|
||||
\func{cbBarInfo*}{GetBar}{\void}
|
||||
|
||||
Returns the bar information for this window.
|
||||
|
||||
|
||||
\membersection{cbFloatedBarWindow::GetPreferredSize}\label{cbfloatedbarwindowgetpreferredsize}
|
||||
|
||||
\func{wxSize}{GetPreferredSize}{\param{const wxSize\& }{given}}
|
||||
|
||||
overriden methods of wxToolWindow
|
||||
Overridden function returning the preferred size.
|
||||
|
||||
|
||||
\membersection{cbFloatedBarWindow::HandleTitleClick}\label{cbfloatedbarwindowhandletitleclick}
|
||||
|
||||
\func{bool}{HandleTitleClick}{\param{wxMouseEvent\& }{event}}
|
||||
|
||||
Overridden function responding to mouse button clicks on the titlebar.
|
||||
|
||||
|
||||
\membersection{cbFloatedBarWindow::OnDblClick}\label{cbfloatedbarwindowondblclick}
|
||||
|
||||
\func{void}{OnDblClick}{\param{wxMouseEvent\& }{event}}
|
||||
|
||||
Responds to double-click mouse events.
|
||||
|
||||
|
||||
\membersection{cbFloatedBarWindow::OnMiniButtonClicked}\label{cbfloatedbarwindowonminibuttonclicked}
|
||||
|
||||
\func{void}{OnMiniButtonClicked}{\param{int }{btnIdx}}
|
||||
|
||||
Overridden function responding to mouse clicks on mini-buttons.
|
||||
|
||||
|
||||
\membersection{cbFloatedBarWindow::PositionFloatedWnd}\label{cbfloatedbarwindowpositionfloatedwnd}
|
||||
|
||||
\func{void}{PositionFloatedWnd}{\param{int }{scrX}, \param{int }{scrY}, \param{int }{width}, \param{int }{height}}
|
||||
|
||||
given coordinates are those of the bar itself
|
||||
floated container window's position and size
|
||||
are ajusted accordingly
|
||||
Position the floating window. The given coordinates
|
||||
are those of the bar itself; the floated container window's
|
||||
position and size are ajusted accordingly.
|
||||
|
||||
|
||||
\membersection{cbFloatedBarWindow::SetBar}\label{cbfloatedbarwindowsetbar}
|
||||
|
||||
\func{void}{SetBar}{\param{cbBarInfo* }{pBar}}
|
||||
|
||||
Sets the bar information for this window.
|
||||
|
||||
|
||||
\membersection{cbFloatedBarWindow::SetLayout}\label{cbfloatedbarwindowsetlayout}
|
||||
|
||||
\func{void}{SetLayout}{\param{wxFrameLayout* }{pLayout}}
|
||||
|
||||
Sets the layout for this window.
|
||||
|
||||
|
||||
@@ -1,83 +1,90 @@
|
||||
%
|
||||
% automatically generated by HelpGen $Revision$ from
|
||||
% gcupdatesmgr.h at 05/Jan/02 22:50:57
|
||||
% gcupdatesmgr.h at 21/Jan/02 21:14:19
|
||||
%
|
||||
|
||||
|
||||
\section{\class{cbGCUpdatesMgr}}\label{cbgcupdatesmgr}
|
||||
|
||||
|
||||
class implements optimized logic for refreshing
|
||||
areas of frame layout - which actually need to be updated.
|
||||
Is used as default updates-manager by wxFrameLayout.
|
||||
|
||||
it is called "Garbage Collecting" u.mgr for it's implementation
|
||||
tries to find out dependencies between bars, and to order
|
||||
them ito "hierarchy", this hierarchical sorting resembles
|
||||
implemenation of heap-garbage collectors, which resolve
|
||||
dependencies between references.
|
||||
|
||||
Example: there are situations where the order of moving
|
||||
the windows does matter:
|
||||
|
||||
case 1)
|
||||
------ ---
|
||||
| A | |B|
|
||||
------ ---> | |
|
||||
--- --- ------
|
||||
|B| | A |
|
||||
| | ------
|
||||
---
|
||||
(future)
|
||||
(past)
|
||||
|
||||
past/future positions of A and B windows completely overlapp, i.e.
|
||||
depend on each other, and there is not solution for
|
||||
moving the windows witout refreshing both of them,
|
||||
-- we have cyclic dependency here. The gc. alg will
|
||||
find this cyclic dependecy and will force "refresh"
|
||||
after movement.
|
||||
|
||||
case 2)
|
||||
|
||||
------
|
||||
| A |
|
||||
------ --->
|
||||
---
|
||||
|B| ------
|
||||
| | | A |
|
||||
--- ------
|
||||
---
|
||||
|B|
|
||||
| |
|
||||
---
|
||||
|
||||
(future)
|
||||
(past)
|
||||
|
||||
in this case past/future positions do not overlapp, thus
|
||||
it's enough only to move windows, without refreshing them.
|
||||
GC will "notice" it.
|
||||
|
||||
there is also third case, when overlapping is partial
|
||||
in this case the refershing can be also avoided by
|
||||
moving windows in the order of "most-dependant" towards the
|
||||
"least-dependent". GC handles this automatically, by
|
||||
sorting windows by their dependency-level (or "hierarchy")
|
||||
|
||||
See garbagec.h for more details of this method, garbagec.h/cpp
|
||||
implement sorting of generic-dependencies (does not deal
|
||||
with graphical objects directly)
|
||||
|
||||
Summary: improves performance when complex/large windows are
|
||||
moved around, by reducing number of repaints. Also helps
|
||||
to avoid dirty non-client areas of moved windows
|
||||
in some special cases of "overlapping anomalies"
|
||||
|
||||
This class implements optimized logic for refreshing
|
||||
the areas of frame layout that actually need to be updated.
|
||||
It is used as the default updates manager by wxFrameLayout.
|
||||
|
||||
It is called 'Garbage Collecting' updates manager because
|
||||
its implementation tries to find out dependencies between bars,
|
||||
and to order them into a 'hierarchy'. This hierarchical sorting resembles
|
||||
the implementation of heap-garbage collectors, which resolve
|
||||
dependencies between references.
|
||||
|
||||
Example: there are situations where the order in which the user
|
||||
moves windows does matter.
|
||||
|
||||
\begin{verbatim}
|
||||
case 1)
|
||||
------ ---
|
||||
| A | |B|
|
||||
------ ---> | |
|
||||
--- --- ------
|
||||
|B| | A |
|
||||
| | ------
|
||||
---
|
||||
(future)
|
||||
(past)
|
||||
\end{verbatim}
|
||||
|
||||
Past/future positions of A and B windows completely overlap, i.e.
|
||||
depend on each other, and there is no solution for
|
||||
moving the windows without refreshing both of them
|
||||
-- we have a cyclic dependency here. The garbage collection algorithm will
|
||||
find this cyclic dependecy and will force refresh after movement.
|
||||
|
||||
\begin{verbatim}
|
||||
case 2)
|
||||
|
||||
------
|
||||
| A |
|
||||
------ --->
|
||||
---
|
||||
|B| ------
|
||||
| | | A |
|
||||
--- ------
|
||||
---
|
||||
|B|
|
||||
| |
|
||||
---
|
||||
|
||||
(future)
|
||||
(past)
|
||||
\end{verbatim}
|
||||
|
||||
In this case past/future positions do not overlap, so
|
||||
it is enough only to move windows without refreshing them.
|
||||
Garbage collection will 'notice' this.
|
||||
|
||||
There is also a third case, when overlapping is partial.
|
||||
In this case the refreshing can also be avoided by
|
||||
moving windows in the order of 'most-dependant' towards the
|
||||
'least-dependent'. GC handles this automatically, by
|
||||
sorting windows by their dependency-level (or 'hierarchy').
|
||||
|
||||
See garbagec.h for more details of this method; garbagec.h/cpp
|
||||
implement sorting of generic dependencies and does not deal
|
||||
with graphical objects directly.
|
||||
|
||||
Summary: garbage collection improves performance when complex or large
|
||||
windows are moved around, by reducing the number of repaints. It also helps
|
||||
to avoid dirty non-client areas of moved windows
|
||||
in some special cases of 'overlapping anomalies'.
|
||||
|
||||
\wxheading{Derived from}
|
||||
|
||||
\helpref{cbSimpleUpdatesMgr}{cbsimpleupdatesmgr}
|
||||
|
||||
\wxheading{Include files}
|
||||
|
||||
<gcupdatesmgr.h>
|
||||
|
||||
\wxheading{Data structures}
|
||||
|
||||
\latexignore{\rtfignore{\wxheading{Members}}}
|
||||
@@ -87,30 +94,38 @@ class implements optimized logic for refreshing
|
||||
|
||||
\func{}{cbGCUpdatesMgr}{\void}
|
||||
|
||||
Default constructor.
|
||||
|
||||
|
||||
\func{}{cbGCUpdatesMgr}{\param{wxFrameLayout* }{pPanel}}
|
||||
|
||||
Constructor, taking a frame layout.
|
||||
|
||||
|
||||
\membersection{cbGCUpdatesMgr::AddItem}\label{cbgcupdatesmgradditem}
|
||||
|
||||
\func{void}{AddItem}{\param{wxList\& }{itemList}, \param{cbBarInfo* }{pBar}, \param{cbDockPane* }{pPane}, \param{wxRect\& }{curBounds}, \param{wxRect\& }{prevBounds}}
|
||||
|
||||
Internal function for repositioning items.
|
||||
|
||||
|
||||
\membersection{cbGCUpdatesMgr::DoRepositionItems}\label{cbgcupdatesmgrdorepositionitems}
|
||||
|
||||
\func{void}{DoRepositionItems}{\param{wxList\& }{items}}
|
||||
|
||||
Internal function for repositioning items.
|
||||
|
||||
|
||||
\membersection{cbGCUpdatesMgr::OnStartChanges}\label{cbgcupdatesmgronstartchanges}
|
||||
|
||||
\func{void}{OnStartChanges}{\void}
|
||||
|
||||
notificiactions received from Frame Layout :
|
||||
Receives notifications from the frame layout.
|
||||
|
||||
|
||||
\membersection{cbGCUpdatesMgr::UpdateNow}\label{cbgcupdatesmgrupdatenow}
|
||||
|
||||
\func{void}{UpdateNow}{\void}
|
||||
|
||||
refreshes parts of the frame layout, which need an update
|
||||
Refreshes the parts of the frame layout which need an update.
|
||||
|
||||
|
||||
@@ -1,17 +1,21 @@
|
||||
%
|
||||
% automatically generated by HelpGen $Revision$ from
|
||||
% rowdragpl.h at 05/Jan/02 22:50:57
|
||||
% rowdragpl.h at 21/Jan/02 21:14:19
|
||||
%
|
||||
|
||||
|
||||
\section{\class{cbHiddenBarInfo}}\label{cbhiddenbarinfo}
|
||||
|
||||
|
||||
internal helper-class
|
||||
Internal helper class.
|
||||
|
||||
\wxheading{Derived from}
|
||||
|
||||
\helpref{wxObject}{wxobject}
|
||||
|
||||
\wxheading{Include files}
|
||||
|
||||
<rowdragpl.h>
|
||||
|
||||
\wxheading{Data structures}
|
||||
|
||||
|
||||
@@ -1,15 +1,22 @@
|
||||
%
|
||||
% automatically generated by HelpGen $Revision$ from
|
||||
% hintanimpl.h at 05/Jan/02 22:50:57
|
||||
% hintanimpl.h at 21/Jan/02 21:14:18
|
||||
%
|
||||
|
||||
|
||||
\section{\class{cbHintAnimationPlugin}}\label{cbhintanimationplugin}
|
||||
|
||||
|
||||
A plugin to draw animated hints when the user drags a pane.
|
||||
|
||||
\wxheading{Derived from}
|
||||
|
||||
\helpref{cbPluginBase}{cbpluginbase}
|
||||
|
||||
\wxheading{Include files}
|
||||
|
||||
<hintanimpl.h>
|
||||
|
||||
\wxheading{Data structures}
|
||||
|
||||
\latexignore{\rtfignore{\wxheading{Members}}}
|
||||
@@ -19,44 +26,62 @@
|
||||
|
||||
\func{}{cbHintAnimationPlugin}{\void}
|
||||
|
||||
Default constructor.
|
||||
|
||||
|
||||
\func{}{cbHintAnimationPlugin}{\param{wxFrameLayout* }{pPanel}, \param{int }{paneMask = wxALL\_PANES}}
|
||||
|
||||
Constructor, taking a layout panel and pane mask.
|
||||
|
||||
|
||||
\membersection{cbHintAnimationPlugin::\destruct{cbHintAnimationPlugin}}\label{cbhintanimationplugindtor}
|
||||
|
||||
\func{}{\destruct{cbHintAnimationPlugin}}{\void}
|
||||
|
||||
Destructor.
|
||||
|
||||
|
||||
\membersection{cbHintAnimationPlugin::DoDrawHintRect}\label{cbhintanimationplugindodrawhintrect}
|
||||
|
||||
\func{void}{DoDrawHintRect}{\param{wxRect\& }{rect}, \param{bool }{isInClientRect}}
|
||||
|
||||
Internal function for drawing a hint rectangle.
|
||||
|
||||
|
||||
\membersection{cbHintAnimationPlugin::DrawHintRect}\label{cbhintanimationplugindrawhintrect}
|
||||
|
||||
\func{void}{DrawHintRect}{\param{wxRect\& }{rect}, \param{bool }{isInClientRect}}
|
||||
|
||||
Internal function for drawing a hint rectangle.
|
||||
|
||||
|
||||
\membersection{cbHintAnimationPlugin::EraseHintRect}\label{cbhintanimationpluginerasehintrect}
|
||||
|
||||
\func{void}{EraseHintRect}{\param{wxRect\& }{rect}, \param{bool }{isInClientRect}}
|
||||
|
||||
Internal function for erasing a hint rectangle.
|
||||
|
||||
|
||||
\membersection{cbHintAnimationPlugin::FinishTracking}\label{cbhintanimationpluginfinishtracking}
|
||||
|
||||
\func{void}{FinishTracking}{\void}
|
||||
|
||||
Internal function for finishing tracking.
|
||||
|
||||
|
||||
\membersection{cbHintAnimationPlugin::OnDrawHintRect}\label{cbhintanimationpluginondrawhintrect}
|
||||
|
||||
\func{void}{OnDrawHintRect}{\param{cbDrawHintRectEvent\& }{event}}
|
||||
|
||||
Event handler respoding to hint draw events.
|
||||
|
||||
|
||||
\membersection{cbHintAnimationPlugin::RectToScr}\label{cbhintanimationpluginrecttoscr}
|
||||
|
||||
\func{void}{RectToScr}{\param{wxRect\& }{frameRect}, \param{wxRect\& }{scrRect}}
|
||||
|
||||
Internal function for translating coordinates.
|
||||
|
||||
|
||||
\membersection{cbHintAnimationPlugin::StartTracking}\label{cbhintanimationpluginstarttracking}
|
||||
|
||||
@@ -64,4 +89,5 @@
|
||||
|
||||
speed is constant. Default: TRUE
|
||||
TBD:: get/set methods for above members
|
||||
Internal function for starting tracking.
|
||||
|
||||
|
||||
@@ -1,15 +1,22 @@
|
||||
%
|
||||
% automatically generated by HelpGen $Revision$ from
|
||||
% hintanimpl.h at 05/Jan/02 22:50:57
|
||||
% hintanimpl.h at 21/Jan/02 21:14:19
|
||||
%
|
||||
|
||||
|
||||
\section{\class{cbHintAnimTimer}}\label{cbhintanimtimer}
|
||||
|
||||
|
||||
A private helper class.
|
||||
|
||||
\wxheading{Derived from}
|
||||
|
||||
\helpref{wxTimer}{wxtimer}
|
||||
|
||||
\wxheading{Include files}
|
||||
|
||||
<hintanimpl.h>
|
||||
|
||||
\wxheading{Data structures}
|
||||
|
||||
\latexignore{\rtfignore{\wxheading{Members}}}
|
||||
|
||||
@@ -1,15 +1,22 @@
|
||||
%
|
||||
% automatically generated by HelpGen $Revision$ from
|
||||
% controlbar.h at 05/Jan/02 22:51:00
|
||||
% controlbar.h at 21/Jan/02 21:14:15
|
||||
%
|
||||
|
||||
|
||||
\section{\class{cbInsertBarEvent}}\label{cbinsertbarevent}
|
||||
|
||||
|
||||
Class for bar insertion events.
|
||||
|
||||
\wxheading{Derived from}
|
||||
|
||||
\helpref{cbPluginEvent}{cbpluginevent}
|
||||
|
||||
\wxheading{Include files}
|
||||
|
||||
<controlbar.h>
|
||||
|
||||
\wxheading{Data structures}
|
||||
|
||||
\latexignore{\rtfignore{\wxheading{Members}}}
|
||||
@@ -19,3 +26,5 @@
|
||||
|
||||
\func{}{cbInsertBarEvent}{\param{cbBarInfo* }{pBar}, \param{cbRowInfo* }{pIntoRow}, \param{cbDockPane* }{pPane}}
|
||||
|
||||
Constructor, taking bar information, row information, and pane.
|
||||
|
||||
|
||||
@@ -1,18 +1,22 @@
|
||||
%
|
||||
% automatically generated by HelpGen $Revision$ from
|
||||
% controlbar.h at 05/Jan/02 22:51:00
|
||||
% controlbar.h at 21/Jan/02 21:14:15
|
||||
%
|
||||
|
||||
|
||||
\section{\class{cbLayoutRowEvent}}\label{cblayoutrowevent}
|
||||
|
||||
|
||||
bar/row events category
|
||||
Class for single row layout events.
|
||||
|
||||
\wxheading{Derived from}
|
||||
|
||||
\helpref{cbPluginEvent}{cbpluginevent}
|
||||
|
||||
\wxheading{Include files}
|
||||
|
||||
<controlbar.h>
|
||||
|
||||
\wxheading{Data structures}
|
||||
|
||||
\latexignore{\rtfignore{\wxheading{Members}}}
|
||||
@@ -22,3 +26,5 @@ bar/row events category
|
||||
|
||||
\func{}{cbLayoutRowEvent}{\param{cbRowInfo* }{pRow}, \param{cbDockPane* }{pPane}}
|
||||
|
||||
Constructor, taking row information and pane.
|
||||
|
||||
|
||||
@@ -1,15 +1,22 @@
|
||||
%
|
||||
% automatically generated by HelpGen $Revision$ from
|
||||
% controlbar.h at 05/Jan/02 22:51:00
|
||||
% controlbar.h at 21/Jan/02 21:14:15
|
||||
%
|
||||
|
||||
|
||||
\section{\class{cbLayoutRowsEvent}}\label{cblayoutrowsevent}
|
||||
|
||||
|
||||
Class for multiple rows layout events.
|
||||
|
||||
\wxheading{Derived from}
|
||||
|
||||
\helpref{cbPluginEvent}{cbpluginevent}
|
||||
|
||||
\wxheading{Include files}
|
||||
|
||||
<controlbar.h>
|
||||
|
||||
\wxheading{Data structures}
|
||||
|
||||
\latexignore{\rtfignore{\wxheading{Members}}}
|
||||
@@ -19,3 +26,5 @@
|
||||
|
||||
\func{}{cbLayoutRowsEvent}{\param{cbDockPane* }{pPane}}
|
||||
|
||||
Constructor, taking pane.
|
||||
|
||||
|
||||
@@ -1,15 +1,22 @@
|
||||
%
|
||||
% automatically generated by HelpGen $Revision$ from
|
||||
% controlbar.h at 05/Jan/02 22:51:00
|
||||
% controlbar.h at 21/Jan/02 21:14:15
|
||||
%
|
||||
|
||||
|
||||
\section{\class{cbLeftDClickEvent}}\label{cbleftdclickevent}
|
||||
|
||||
|
||||
Class for mouse left double click events.
|
||||
|
||||
\wxheading{Derived from}
|
||||
|
||||
\helpref{cbPluginEvent}{cbpluginevent}
|
||||
|
||||
\wxheading{Include files}
|
||||
|
||||
<controlbar.h>
|
||||
|
||||
\wxheading{Data structures}
|
||||
|
||||
\latexignore{\rtfignore{\wxheading{Members}}}
|
||||
@@ -19,3 +26,5 @@
|
||||
|
||||
\func{}{cbLeftDClickEvent}{\param{const wxPoint\& }{pos}, \param{cbDockPane* }{pPane}}
|
||||
|
||||
Constructor, taking mouse position and pane.
|
||||
|
||||
|
||||
@@ -1,18 +1,22 @@
|
||||
%
|
||||
% automatically generated by HelpGen $Revision$ from
|
||||
% controlbar.h at 05/Jan/02 22:50:59
|
||||
% controlbar.h at 21/Jan/02 21:14:15
|
||||
%
|
||||
|
||||
|
||||
\section{\class{cbLeftDownEvent}}\label{cbleftdownevent}
|
||||
|
||||
|
||||
event classes, for each corresponding event type (24 currnetly...uhh) **mouse-events category
|
||||
Class for mouse left down events.
|
||||
|
||||
\wxheading{Derived from}
|
||||
|
||||
\helpref{cbPluginEvent}{cbpluginevent}
|
||||
|
||||
\wxheading{Include files}
|
||||
|
||||
<controlbar.h>
|
||||
|
||||
\wxheading{Data structures}
|
||||
|
||||
\latexignore{\rtfignore{\wxheading{Members}}}
|
||||
@@ -22,3 +26,5 @@ event classes, for each corresponding event type (24 currnetly...uhh) **mouse-ev
|
||||
|
||||
\func{}{cbLeftDownEvent}{\param{const wxPoint\& }{pos}, \param{cbDockPane* }{pPane}}
|
||||
|
||||
Constructor, taking mouse position and pane.
|
||||
|
||||
|
||||
@@ -1,15 +1,22 @@
|
||||
%
|
||||
% automatically generated by HelpGen $Revision$ from
|
||||
% controlbar.h at 05/Jan/02 22:50:59
|
||||
% controlbar.h at 21/Jan/02 21:14:15
|
||||
%
|
||||
|
||||
|
||||
\section{\class{cbLeftUpEvent}}\label{cbleftupevent}
|
||||
|
||||
|
||||
Class for mouse left up events.
|
||||
|
||||
\wxheading{Derived from}
|
||||
|
||||
\helpref{cbPluginEvent}{cbpluginevent}
|
||||
|
||||
\wxheading{Include files}
|
||||
|
||||
<controlbar.h>
|
||||
|
||||
\wxheading{Data structures}
|
||||
|
||||
\latexignore{\rtfignore{\wxheading{Members}}}
|
||||
@@ -19,3 +26,5 @@
|
||||
|
||||
\func{}{cbLeftUpEvent}{\param{const wxPoint\& }{pos}, \param{cbDockPane* }{pPane}}
|
||||
|
||||
Constructor, taking mouse position and pane.
|
||||
|
||||
|
||||
@@ -1,15 +1,23 @@
|
||||
%
|
||||
% automatically generated by HelpGen $Revision$ from
|
||||
% toolwnd.h at 05/Jan/02 22:50:58
|
||||
% toolwnd.h at 21/Jan/02 21:14:17
|
||||
%
|
||||
|
||||
|
||||
\section{\class{cbMiniButton}}\label{cbminibutton}
|
||||
|
||||
|
||||
cbMiniButton is the base class for a small button that can be placed in a wxToolWindow
|
||||
titlebar.
|
||||
|
||||
\wxheading{Derived from}
|
||||
|
||||
\helpref{wxObject}{wxobject}
|
||||
|
||||
\wxheading{Include files}
|
||||
|
||||
<toolwnd.h>
|
||||
|
||||
\wxheading{Data structures}
|
||||
|
||||
\latexignore{\rtfignore{\wxheading{Members}}}
|
||||
@@ -19,58 +27,83 @@
|
||||
|
||||
\func{}{cbMiniButton}{\void}
|
||||
|
||||
Default constructor.
|
||||
|
||||
|
||||
\membersection{cbMiniButton::Draw}\label{cbminibuttondraw}
|
||||
|
||||
\func{void}{Draw}{\param{wxDC\& }{dc}}
|
||||
|
||||
Draws the button. Override this to implement
|
||||
the desired appearance.
|
||||
|
||||
|
||||
\membersection{cbMiniButton::Enable}\label{cbminibuttonenable}
|
||||
|
||||
\func{void}{Enable}{\param{bool }{enable}}
|
||||
|
||||
Enable or disable the button.
|
||||
|
||||
|
||||
\membersection{cbMiniButton::HitTest}\label{cbminibuttonhittest}
|
||||
|
||||
\func{bool}{HitTest}{\param{const wxPoint\& }{pos}}
|
||||
|
||||
Returns TRUE if the given position was over the button.
|
||||
|
||||
|
||||
\membersection{cbMiniButton::IsPressed}\label{cbminibuttonispressed}
|
||||
|
||||
\func{bool}{IsPressed}{\void}
|
||||
|
||||
Returns TRUE if this button is pressed.
|
||||
|
||||
|
||||
\membersection{cbMiniButton::OnLeftDown}\label{cbminibuttononleftdown}
|
||||
|
||||
\func{void}{OnLeftDown}{\param{const wxPoint\& }{pos}}
|
||||
|
||||
Responds to a left down event.
|
||||
|
||||
|
||||
\membersection{cbMiniButton::OnLeftUp}\label{cbminibuttononleftup}
|
||||
|
||||
\func{void}{OnLeftUp}{\param{const wxPoint\& }{pos}}
|
||||
|
||||
Responds to a left up event.
|
||||
|
||||
|
||||
\membersection{cbMiniButton::OnMotion}\label{cbminibuttononmotion}
|
||||
|
||||
\func{void}{OnMotion}{\param{const wxPoint\& }{pos}}
|
||||
|
||||
Responds to a mouse move event.
|
||||
|
||||
|
||||
\membersection{cbMiniButton::Refresh}\label{cbminibuttonrefresh}
|
||||
|
||||
\func{void}{Refresh}{\void}
|
||||
|
||||
Refreshes the button.
|
||||
|
||||
|
||||
\membersection{cbMiniButton::Reset}\label{cbminibuttonreset}
|
||||
|
||||
\func{void}{Reset}{\void}
|
||||
|
||||
Reset the button.
|
||||
|
||||
|
||||
\membersection{cbMiniButton::SetPos}\label{cbminibuttonsetpos}
|
||||
|
||||
\func{void}{SetPos}{\param{const wxPoint\& }{pos}}
|
||||
|
||||
Set the position of the button.
|
||||
|
||||
|
||||
\membersection{cbMiniButton::WasClicked}\label{cbminibuttonwasclicked}
|
||||
|
||||
\func{bool}{WasClicked}{\void}
|
||||
|
||||
Returns TRUE if the button was clicked.
|
||||
|
||||
|
||||
@@ -1,15 +1,22 @@
|
||||
%
|
||||
% automatically generated by HelpGen $Revision$ from
|
||||
% controlbar.h at 05/Jan/02 22:51:00
|
||||
% controlbar.h at 21/Jan/02 21:14:15
|
||||
%
|
||||
|
||||
|
||||
\section{\class{cbMotionEvent}}\label{cbmotionevent}
|
||||
|
||||
|
||||
Class for mouse motion events.
|
||||
|
||||
\wxheading{Derived from}
|
||||
|
||||
\helpref{cbPluginEvent}{cbpluginevent}
|
||||
|
||||
\wxheading{Include files}
|
||||
|
||||
<controlbar.h>
|
||||
|
||||
\wxheading{Data structures}
|
||||
|
||||
\latexignore{\rtfignore{\wxheading{Members}}}
|
||||
@@ -19,3 +26,5 @@
|
||||
|
||||
\func{}{cbMotionEvent}{\param{const wxPoint\& }{pos}, \param{cbDockPane* }{pPane}}
|
||||
|
||||
Constructor, taking mouse position and pane.
|
||||
|
||||
|
||||
@@ -1,23 +1,27 @@
|
||||
%
|
||||
% automatically generated by HelpGen $Revision$ from
|
||||
% panedrawpl.h at 05/Jan/02 22:50:57
|
||||
% panedrawpl.h at 21/Jan/02 21:14:19
|
||||
%
|
||||
|
||||
|
||||
\section{\class{cbPaneDrawPlugin}}\label{cbpanedrawplugin}
|
||||
|
||||
|
||||
Simple, but all-in-one plugin implementation. Resembles look \& feel of
|
||||
to MFC control-bars. Handles painting of pane and items in it.
|
||||
Fires bar/layout customization event, when user right-clicks bar/pane.
|
||||
Hooking an instance of this and row-layouting plugins per each pane,
|
||||
would be enough for the frame layout to function properly.
|
||||
(they are plugged in autimatically by wxFrameLayout class)
|
||||
|
||||
Simple but all-in-one plugin implementation. Resembles the look and feel of
|
||||
to MFC control-bars. The class handles painting of the pane and the items in it;
|
||||
it generates bar/layout customization events, when the user right-clicks the bar/pane.
|
||||
Hooking an instance of this and row-layout plugins for each pane
|
||||
would be enough for the frame layout to function properly
|
||||
(they are plugged in automatically by the wxFrameLayout class).
|
||||
|
||||
\wxheading{Derived from}
|
||||
|
||||
\helpref{cbPluginBase}{cbpluginbase}
|
||||
|
||||
\wxheading{Include files}
|
||||
|
||||
<panedrawpl.h>
|
||||
|
||||
\wxheading{Data structures}
|
||||
|
||||
\latexignore{\rtfignore{\wxheading{Members}}}
|
||||
@@ -27,155 +31,213 @@ Simple, but all-in-one plugin implementation. Resembles look \& feel of
|
||||
|
||||
\func{}{cbPaneDrawPlugin}{\param{wxFrameLayout* }{pPanel}, \param{int }{paneMask = wxALL\_PANES}}
|
||||
|
||||
Constructor taking frame layout pane and a pane mask.
|
||||
|
||||
|
||||
\func{}{cbPaneDrawPlugin}{\void}
|
||||
|
||||
Default constructor.
|
||||
|
||||
|
||||
\membersection{cbPaneDrawPlugin::\destruct{cbPaneDrawPlugin}}\label{cbpanedrawplugindtor}
|
||||
|
||||
\func{}{\destruct{cbPaneDrawPlugin}}{\void}
|
||||
|
||||
Destructor.
|
||||
|
||||
|
||||
\membersection{cbPaneDrawPlugin::Clone}\label{cbpanedrawpluginclone}
|
||||
|
||||
\func{cbPluginBase*}{Clone}{\void}
|
||||
|
||||
Clone function, returning a new instance of this class.
|
||||
|
||||
|
||||
\membersection{cbPaneDrawPlugin::DrawBarInnerShadeRect}\label{cbpanedrawplugindrawbarinnershaderect}
|
||||
|
||||
\func{void}{DrawBarInnerShadeRect}{\param{cbBarInfo* }{pBar}, \param{wxDC\& }{dc}}
|
||||
|
||||
Internal helper: draws the inner bar shading.
|
||||
|
||||
|
||||
\membersection{cbPaneDrawPlugin::DrawDraggedHandle}\label{cbpanedrawplugindrawdraggedhandle}
|
||||
|
||||
\func{void}{DrawDraggedHandle}{\param{const wxPoint\& }{pos}, \param{cbDockPane\& }{pane}}
|
||||
|
||||
helpers
|
||||
Internal helper: draws the dragged handle.
|
||||
|
||||
|
||||
\membersection{cbPaneDrawPlugin::DrawLowerRowHandle}\label{cbpanedrawplugindrawlowerrowhandle}
|
||||
|
||||
\func{void}{DrawLowerRowHandle}{\param{cbRowInfo* }{pRow}, \param{wxDC\& }{dc}}
|
||||
|
||||
Internal helper: draws the lower row handle.
|
||||
|
||||
|
||||
\membersection{cbPaneDrawPlugin::DrawLowerRowShades}\label{cbpanedrawplugindrawlowerrowshades}
|
||||
|
||||
\func{void}{DrawLowerRowShades}{\param{cbRowInfo* }{pRow}, \param{wxDC\& }{dc}, \param{int }{level}}
|
||||
|
||||
Internal helper: draws the lower row shading.
|
||||
|
||||
|
||||
\membersection{cbPaneDrawPlugin::DrawPaneShade}\label{cbpanedrawplugindrawpaneshade}
|
||||
|
||||
\func{void}{DrawPaneShade}{\param{wxDC\& }{dc}, \param{int }{alignment}}
|
||||
|
||||
Internal helper: draws the pane shading.
|
||||
|
||||
|
||||
\membersection{cbPaneDrawPlugin::DrawPaneShadeForRow}\label{cbpanedrawplugindrawpaneshadeforrow}
|
||||
|
||||
\func{void}{DrawPaneShadeForRow}{\param{cbRowInfo* }{pRow}, \param{wxDC\& }{dc}}
|
||||
|
||||
Internal helper: draws the pane shading for a row.
|
||||
|
||||
|
||||
\membersection{cbPaneDrawPlugin::DrawShade}\label{cbpanedrawplugindrawshade}
|
||||
|
||||
\func{void}{DrawShade}{\param{int }{level}, \param{wxRect\& }{rect}, \param{int }{alignment}, \param{wxDC\& }{dc}}
|
||||
|
||||
Internal helper: draws shading.
|
||||
|
||||
|
||||
\membersection{cbPaneDrawPlugin::DrawShade1}\label{cbpanedrawplugindrawshade1}
|
||||
|
||||
\func{void}{DrawShade1}{\param{int }{level}, \param{wxRect\& }{rect}, \param{int }{alignment}, \param{wxDC\& }{dc}}
|
||||
|
||||
Internal helper: draws shading.
|
||||
|
||||
|
||||
\membersection{cbPaneDrawPlugin::DrawUpperRowHandle}\label{cbpanedrawplugindrawupperrowhandle}
|
||||
|
||||
\func{void}{DrawUpperRowHandle}{\param{cbRowInfo* }{pRow}, \param{wxDC\& }{dc}}
|
||||
|
||||
Internal helper: draws the upper row handle.
|
||||
|
||||
|
||||
\membersection{cbPaneDrawPlugin::DrawUpperRowShades}\label{cbpanedrawplugindrawupperrowshades}
|
||||
|
||||
\func{void}{DrawUpperRowShades}{\param{cbRowInfo* }{pRow}, \param{wxDC\& }{dc}, \param{int }{level}}
|
||||
|
||||
Internal helper: draws the upper row shading.
|
||||
|
||||
|
||||
\membersection{cbPaneDrawPlugin::OnDrawBarDecorations}\label{cbpanedrawpluginondrawbardecorations}
|
||||
|
||||
\func{void}{OnDrawBarDecorations}{\param{cbDrawBarDecorEvent\& }{event}}
|
||||
|
||||
Handler for draw bar decorations events.
|
||||
|
||||
|
||||
\membersection{cbPaneDrawPlugin::OnDrawBarHandles}\label{cbpanedrawpluginondrawbarhandles}
|
||||
|
||||
\func{void}{OnDrawBarHandles}{\param{cbDrawBarHandlesEvent\& }{event}}
|
||||
|
||||
Handler for draw bar handles events.
|
||||
|
||||
|
||||
\membersection{cbPaneDrawPlugin::OnDrawPaneBackground}\label{cbpanedrawpluginondrawpanebackground}
|
||||
|
||||
\func{void}{OnDrawPaneBackground}{\param{cbDrawPaneBkGroundEvent\& }{event}}
|
||||
|
||||
Handler for draw pane background events.
|
||||
|
||||
|
||||
\membersection{cbPaneDrawPlugin::OnDrawPaneDecorations}\label{cbpanedrawpluginondrawpanedecorations}
|
||||
|
||||
\func{void}{OnDrawPaneDecorations}{\param{cbDrawPaneDecorEvent\& }{event}}
|
||||
|
||||
Handler for draw pane decoration events.
|
||||
|
||||
|
||||
\membersection{cbPaneDrawPlugin::OnDrawRowBackground}\label{cbpanedrawpluginondrawrowbackground}
|
||||
|
||||
\func{void}{OnDrawRowBackground}{\param{cbDrawRowBkGroundEvent\& }{event}}
|
||||
|
||||
Handler for draw row background events.
|
||||
|
||||
|
||||
\membersection{cbPaneDrawPlugin::OnDrawRowDecorations}\label{cbpanedrawpluginondrawrowdecorations}
|
||||
|
||||
\func{void}{OnDrawRowDecorations}{\param{cbDrawRowDecorEvent\& }{event}}
|
||||
|
||||
Handler for draw row decoration events.
|
||||
|
||||
|
||||
\membersection{cbPaneDrawPlugin::OnDrawRowHandles}\label{cbpanedrawpluginondrawrowhandles}
|
||||
|
||||
\func{void}{OnDrawRowHandles}{\param{cbDrawRowHandlesEvent\& }{event}}
|
||||
|
||||
Handler for draw row handles events.
|
||||
|
||||
|
||||
\membersection{cbPaneDrawPlugin::OnFinishDrawInArea}\label{cbpanedrawpluginonfinishdrawinarea}
|
||||
|
||||
\func{void}{OnFinishDrawInArea}{\param{cbFinishDrawInAreaEvent\& }{event}}
|
||||
|
||||
Handler for finish draw in area events.
|
||||
|
||||
|
||||
\membersection{cbPaneDrawPlugin::OnLButtonDown}\label{cbpanedrawpluginonlbuttondown}
|
||||
|
||||
\func{void}{OnLButtonDown}{\param{cbLeftDownEvent\& }{event}}
|
||||
|
||||
handlers for plugin-events
|
||||
Handler for left mouse button down events.
|
||||
|
||||
|
||||
\membersection{cbPaneDrawPlugin::OnLButtonUp}\label{cbpanedrawpluginonlbuttonup}
|
||||
|
||||
\func{void}{OnLButtonUp}{\param{cbLeftUpEvent\& }{event}}
|
||||
|
||||
Handler for left mouse button up events.
|
||||
|
||||
|
||||
\membersection{cbPaneDrawPlugin::OnLDblClick}\label{cbpanedrawpluginonldblclick}
|
||||
|
||||
\func{void}{OnLDblClick}{\param{cbLeftDClickEvent\& }{event}}
|
||||
|
||||
Handler for left double-click mouse button down events.
|
||||
|
||||
|
||||
\membersection{cbPaneDrawPlugin::OnMouseMove}\label{cbpanedrawpluginonmousemove}
|
||||
|
||||
\func{void}{OnMouseMove}{\param{cbMotionEvent\& }{event}}
|
||||
|
||||
Handler for mouse move events.
|
||||
|
||||
|
||||
\membersection{cbPaneDrawPlugin::OnRButtonUp}\label{cbpanedrawpluginonrbuttonup}
|
||||
|
||||
\func{void}{OnRButtonUp}{\param{cbRightUpEvent\& }{event}}
|
||||
|
||||
Handler for right mouse button up events.
|
||||
|
||||
|
||||
\membersection{cbPaneDrawPlugin::OnSizeBarWindow}\label{cbpanedrawpluginonsizebarwindow}
|
||||
|
||||
\func{void}{OnSizeBarWindow}{\param{cbSizeBarWndEvent\& }{event}}
|
||||
|
||||
Handler for bar size events.
|
||||
|
||||
|
||||
\membersection{cbPaneDrawPlugin::OnStartDrawInArea}\label{cbpanedrawpluginonstartdrawinarea}
|
||||
|
||||
\func{void}{OnStartDrawInArea}{\param{cbStartDrawInAreaEvent\& }{event}}
|
||||
|
||||
Handler for start draw in area events.
|
||||
|
||||
|
||||
\membersection{cbPaneDrawPlugin::SetDarkPixel}\label{cbpanedrawpluginsetdarkpixel}
|
||||
|
||||
\func{void}{SetDarkPixel}{\param{int }{x}, \param{int }{y}, \param{wxDC\& }{dc}}
|
||||
|
||||
Internal helper: sets a dark pixel at the given location.
|
||||
|
||||
|
||||
\membersection{cbPaneDrawPlugin::SetLightPixel}\label{cbpanedrawpluginsetlightpixel}
|
||||
|
||||
\func{void}{SetLightPixel}{\param{int }{x}, \param{int }{y}, \param{wxDC\& }{dc}}
|
||||
|
||||
Internal helper: sets a light pixel at the given location.
|
||||
|
||||
|
||||
@@ -1,18 +1,25 @@
|
||||
%
|
||||
% automatically generated by HelpGen $Revision$ from
|
||||
% controlbar.h at 05/Jan/02 22:50:59
|
||||
% controlbar.h at 21/Jan/02 21:14:14
|
||||
%
|
||||
|
||||
|
||||
\section{\class{cbPluginBase}}\label{cbpluginbase}
|
||||
|
||||
|
||||
abstract base class for all control-bar related plugins
|
||||
|
||||
Abstract base class for all control-bar related plugins.
|
||||
Note: pointer positions of mouse events sent to plugins
|
||||
are always in the pane's coordinates (the pane to which
|
||||
this plugin is hooked).
|
||||
|
||||
\wxheading{Derived from}
|
||||
|
||||
\helpref{wxEvtHandler}{wxevthandler}
|
||||
|
||||
\wxheading{Include files}
|
||||
|
||||
<controlbar.h>
|
||||
|
||||
\wxheading{Data structures}
|
||||
|
||||
\latexignore{\rtfignore{\wxheading{Members}}}
|
||||
@@ -22,44 +29,49 @@ abstract base class for all control-bar related plugins
|
||||
|
||||
\func{}{cbPluginBase}{\param{wxFrameLayout* }{pPanel}, \param{int }{paneMask = wxALL\_PANES}}
|
||||
|
||||
Constructor taking layout panel and a mask.
|
||||
|
||||
|
||||
\func{}{cbPluginBase}{\void}
|
||||
|
||||
Default constructor.
|
||||
|
||||
|
||||
\membersection{cbPluginBase::\destruct{cbPluginBase}}\label{cbpluginbasedtor}
|
||||
|
||||
\func{}{\destruct{cbPluginBase}}{\void}
|
||||
|
||||
NOTE:: pointer positions of mouse-events sent to plugins
|
||||
are always in pane's coordinates (pane's to which
|
||||
this plugin is hooked)
|
||||
destroys the whole plugin chain of connected plagins
|
||||
Destructor. Destroys the whole plugin chain of connected plugins.
|
||||
|
||||
|
||||
\membersection{cbPluginBase::GetPaneMask}\label{cbpluginbasegetpanemask}
|
||||
|
||||
\func{int}{GetPaneMask}{\void}
|
||||
|
||||
Returns the pane mask.
|
||||
|
||||
|
||||
\membersection{cbPluginBase::IsReady}\label{cbpluginbaseisready}
|
||||
|
||||
\func{bool}{IsReady}{\void}
|
||||
|
||||
Returns TRUE if the plugin is ready to receive events.
|
||||
|
||||
|
||||
\membersection{cbPluginBase::OnInitPlugin}\label{cbpluginbaseoninitplugin}
|
||||
|
||||
\func{void}{OnInitPlugin}{\void}
|
||||
|
||||
override this method to do plugin-specific initialization
|
||||
(at this point plugin is already attached to the frame layout,
|
||||
and pane masks are set)
|
||||
Override this method to do plugin-specific initialization.
|
||||
At this point plugin is already attached to the frame layout,
|
||||
and pane masks are set.
|
||||
|
||||
|
||||
\membersection{cbPluginBase::ProcessEvent}\label{cbpluginbaseprocessevent}
|
||||
|
||||
\func{bool}{ProcessEvent}{\param{wxEvent\& }{event}}
|
||||
|
||||
overriden, to determine whether the target pane specified in the
|
||||
event, matches the pane mask of this plugin (specific plugins
|
||||
do not override this method)
|
||||
Overridden to determine whether the target pane specified in the
|
||||
event matches the pane mask of this plugin (specific plugins
|
||||
do not override this method).
|
||||
|
||||
|
||||
@@ -1,22 +1,23 @@
|
||||
%
|
||||
% automatically generated by HelpGen $Revision$ from
|
||||
% controlbar.h at 05/Jan/02 22:50:59
|
||||
% controlbar.h at 21/Jan/02 21:14:14
|
||||
%
|
||||
|
||||
|
||||
\section{\class{cbPluginEvent}}\label{cbpluginevent}
|
||||
|
||||
|
||||
------------------------------------------------------------
|
||||
"API" for developing custom plugins of Frame Layout Engine
|
||||
TODO:: documentation
|
||||
------------------------------------------------------------
|
||||
base class for all control-bar plugin events
|
||||
Base class for all control-bar plugin events.
|
||||
This is not a dynamically-creatable class.
|
||||
|
||||
\wxheading{Derived from}
|
||||
|
||||
\helpref{wxEvent}{wxevent}
|
||||
|
||||
\wxheading{Include files}
|
||||
|
||||
<controlbar.h>
|
||||
|
||||
\wxheading{Data structures}
|
||||
|
||||
\latexignore{\rtfignore{\wxheading{Members}}}
|
||||
@@ -26,18 +27,12 @@
|
||||
|
||||
\func{}{cbPluginEvent}{\param{wxEventType }{eventType}, \param{cbDockPane* }{pPane}}
|
||||
|
||||
Constructor, taking event type and pane.
|
||||
|
||||
|
||||
\membersection{cbPluginEvent::Clone}\label{cbplugineventclone}
|
||||
|
||||
\constfunc{wxEvent*}{Clone}{\void}
|
||||
|
||||
OLD STUFF::
|
||||
// FOR NOW FOR NOW:: all-in-one plugin event structure
|
||||
wxNode* mpObjNode;
|
||||
wxNode* mpObjNodeAux;
|
||||
wxPoint mPos;
|
||||
wxSize mSize;
|
||||
wxDC* mpDC;
|
||||
bool mAuxBoolVal;
|
||||
Not used, but required
|
||||
Not used, but required.
|
||||
|
||||
|
||||
@@ -1,15 +1,22 @@
|
||||
%
|
||||
% automatically generated by HelpGen $Revision$ from
|
||||
% controlbar.h at 05/Jan/02 22:51:00
|
||||
% controlbar.h at 21/Jan/02 21:14:15
|
||||
%
|
||||
|
||||
|
||||
\section{\class{cbRemoveBarEvent}}\label{cbremovebarevent}
|
||||
|
||||
|
||||
Class for bar removal events.
|
||||
|
||||
\wxheading{Derived from}
|
||||
|
||||
\helpref{cbPluginEvent}{cbpluginevent}
|
||||
|
||||
\wxheading{Include files}
|
||||
|
||||
<controlbar.h>
|
||||
|
||||
\wxheading{Data structures}
|
||||
|
||||
\latexignore{\rtfignore{\wxheading{Members}}}
|
||||
@@ -19,3 +26,5 @@
|
||||
|
||||
\func{}{cbRemoveBarEvent}{\param{cbBarInfo* }{pBar}, \param{cbDockPane* }{pPane}}
|
||||
|
||||
Constructor, taking bar information and pane.
|
||||
|
||||
|
||||
@@ -1,15 +1,22 @@
|
||||
%
|
||||
% automatically generated by HelpGen $Revision$ from
|
||||
% controlbar.h at 05/Jan/02 22:51:00
|
||||
% controlbar.h at 21/Jan/02 21:14:15
|
||||
%
|
||||
|
||||
|
||||
\section{\class{cbResizeBarEvent}}\label{cbresizebarevent}
|
||||
|
||||
|
||||
Class for bar resize events.
|
||||
|
||||
\wxheading{Derived from}
|
||||
|
||||
\helpref{cbPluginEvent}{cbpluginevent}
|
||||
|
||||
\wxheading{Include files}
|
||||
|
||||
<controlbar.h>
|
||||
|
||||
\wxheading{Data structures}
|
||||
|
||||
\latexignore{\rtfignore{\wxheading{Members}}}
|
||||
@@ -19,3 +26,5 @@
|
||||
|
||||
\func{}{cbResizeBarEvent}{\param{cbBarInfo* }{pBar}, \param{cbRowInfo* }{pRow}, \param{cbDockPane* }{pPane}}
|
||||
|
||||
Constructor, taking bar information, row information, and pane.
|
||||
|
||||
|
||||
@@ -1,15 +1,22 @@
|
||||
%
|
||||
% automatically generated by HelpGen $Revision$ from
|
||||
% controlbar.h at 05/Jan/02 22:51:00
|
||||
% controlbar.h at 21/Jan/02 21:14:15
|
||||
%
|
||||
|
||||
|
||||
\section{\class{cbResizeRowEvent}}\label{cbresizerowevent}
|
||||
|
||||
|
||||
Class for row resize events.
|
||||
|
||||
\wxheading{Derived from}
|
||||
|
||||
\helpref{cbPluginEvent}{cbpluginevent}
|
||||
|
||||
\wxheading{Include files}
|
||||
|
||||
<controlbar.h>
|
||||
|
||||
\wxheading{Data structures}
|
||||
|
||||
\latexignore{\rtfignore{\wxheading{Members}}}
|
||||
@@ -19,3 +26,5 @@
|
||||
|
||||
\func{}{cbResizeRowEvent}{\param{cbRowInfo* }{pRow}, \param{int }{handleOfs}, \param{bool }{forUpperHandle}, \param{cbDockPane* }{pPane}}
|
||||
|
||||
Constructor, taking row information, two parameters of currently unknown use, and pane.
|
||||
|
||||
|
||||
@@ -1,15 +1,22 @@
|
||||
%
|
||||
% automatically generated by HelpGen $Revision$ from
|
||||
% controlbar.h at 05/Jan/02 22:51:00
|
||||
% controlbar.h at 21/Jan/02 21:14:15
|
||||
%
|
||||
|
||||
|
||||
\section{\class{cbRightDownEvent}}\label{cbrightdownevent}
|
||||
|
||||
|
||||
Class for mouse right down events.
|
||||
|
||||
\wxheading{Derived from}
|
||||
|
||||
\helpref{cbPluginEvent}{cbpluginevent}
|
||||
|
||||
\wxheading{Include files}
|
||||
|
||||
<controlbar.h>
|
||||
|
||||
\wxheading{Data structures}
|
||||
|
||||
\latexignore{\rtfignore{\wxheading{Members}}}
|
||||
@@ -19,3 +26,5 @@
|
||||
|
||||
\func{}{cbRightDownEvent}{\param{const wxPoint\& }{pos}, \param{cbDockPane* }{pPane}}
|
||||
|
||||
Constructor, taking mouse position and pane.
|
||||
|
||||
|
||||
@@ -1,15 +1,22 @@
|
||||
%
|
||||
% automatically generated by HelpGen $Revision$ from
|
||||
% controlbar.h at 05/Jan/02 22:51:00
|
||||
% controlbar.h at 21/Jan/02 21:14:15
|
||||
%
|
||||
|
||||
|
||||
\section{\class{cbRightUpEvent}}\label{cbrightupevent}
|
||||
|
||||
|
||||
Class for mouse right up events.
|
||||
|
||||
\wxheading{Derived from}
|
||||
|
||||
\helpref{cbPluginEvent}{cbpluginevent}
|
||||
|
||||
\wxheading{Include files}
|
||||
|
||||
<controlbar.h>
|
||||
|
||||
\wxheading{Data structures}
|
||||
|
||||
\latexignore{\rtfignore{\wxheading{Members}}}
|
||||
@@ -19,3 +26,5 @@
|
||||
|
||||
\func{}{cbRightUpEvent}{\param{const wxPoint\& }{pos}, \param{cbDockPane* }{pPane}}
|
||||
|
||||
Constructor, taking mouse position and pane.
|
||||
|
||||
|
||||
@@ -1,21 +1,25 @@
|
||||
%
|
||||
% automatically generated by HelpGen $Revision$ from
|
||||
% rowdragpl.h at 05/Jan/02 22:50:57
|
||||
% rowdragpl.h at 21/Jan/02 21:14:19
|
||||
%
|
||||
|
||||
|
||||
\section{\class{cbRowDragPlugin}}\label{cbrowdragplugin}
|
||||
|
||||
|
||||
Plugin adds row-dragging fuctionality to the pane.
|
||||
Handles mouse/movement and pane-background erasing plugin-events.
|
||||
Behaviour and appearence resembles drag \& drop posotioning
|
||||
of the toolbar-rows int Netscape Comunicator 4.xx.
|
||||
|
||||
This plugin adds row-dragging functionality to the pane.
|
||||
It handles mouse movement and pane background-erasing plugin events.
|
||||
The behaviour and appearance resembles drag and drop positioning
|
||||
of the toolbar rows in Netscape Communicator 4.xx.
|
||||
|
||||
\wxheading{Derived from}
|
||||
|
||||
\helpref{cbPluginBase}{cbpluginbase}
|
||||
|
||||
\wxheading{Include files}
|
||||
|
||||
<rowdragpl.h>
|
||||
|
||||
\wxheading{Data structures}
|
||||
|
||||
\latexignore{\rtfignore{\wxheading{Members}}}
|
||||
@@ -25,229 +29,311 @@ Plugin adds row-dragging fuctionality to the pane.
|
||||
|
||||
\func{}{cbRowDragPlugin}{\param{wxFrameLayout* }{pLayout}, \param{int }{paneMask = wxALL\_PANES}}
|
||||
|
||||
Constructor, taking paren layout frame and pane mask.
|
||||
|
||||
|
||||
\func{}{cbRowDragPlugin}{\void}
|
||||
|
||||
Default constructor.
|
||||
|
||||
|
||||
\membersection{cbRowDragPlugin::\destruct{cbRowDragPlugin}}\label{cbrowdragplugindtor}
|
||||
|
||||
\func{}{\destruct{cbRowDragPlugin}}{\void}
|
||||
|
||||
Destructor.
|
||||
|
||||
|
||||
\membersection{cbRowDragPlugin::CaptureDCArea}\label{cbrowdragplugincapturedcarea}
|
||||
|
||||
\func{wxBitmap*}{CaptureDCArea}{\param{wxDC\& }{dc}, \param{wxRect\& }{area}}
|
||||
|
||||
Helper for drag and drop.
|
||||
|
||||
|
||||
\membersection{cbRowDragPlugin::CheckPrevItemInFocus}\label{cbrowdragplugincheckpreviteminfocus}
|
||||
|
||||
\func{void}{CheckPrevItemInFocus}{\param{cbRowInfo* }{pRow}, \param{int }{iconIdx}}
|
||||
|
||||
Helper for drag and drop.
|
||||
|
||||
|
||||
\membersection{cbRowDragPlugin::Clone}\label{cbrowdragpluginclone}
|
||||
|
||||
\func{cbPluginBase*}{Clone}{\void}
|
||||
|
||||
Clone function, returning a new instance of this class.
|
||||
|
||||
|
||||
\membersection{cbRowDragPlugin::CollapseRow}\label{cbrowdragplugincollapserow}
|
||||
|
||||
\func{void}{CollapseRow}{\param{cbRowInfo* }{pRow}}
|
||||
|
||||
Helper for drag and drop.
|
||||
|
||||
|
||||
\membersection{cbRowDragPlugin::Draw3DPattern}\label{cbrowdragplugindraw3dpattern}
|
||||
|
||||
\func{void}{Draw3DPattern}{\param{wxRect\& }{inRect}, \param{wxDC\& }{dc}}
|
||||
|
||||
Implements 'hard-coded metafile' for Netscape Navigator look.
|
||||
|
||||
|
||||
\membersection{cbRowDragPlugin::Draw3DRect}\label{cbrowdragplugindraw3drect}
|
||||
|
||||
\func{void}{Draw3DRect}{\param{wxRect\& }{inRect}, \param{wxDC\& }{dc}, \param{wxBrush\& }{bkBrush}}
|
||||
|
||||
Implements 'hard-coded metafile' for Netscape Navigator look.
|
||||
|
||||
|
||||
\membersection{cbRowDragPlugin::DrawCollapsedRowIcon}\label{cbrowdragplugindrawcollapsedrowicon}
|
||||
|
||||
\func{void}{DrawCollapsedRowIcon}{\param{int }{index}, \param{wxDC\& }{dc}, \param{bool }{isHighlighted}}
|
||||
|
||||
overridables (appearence-depedent)
|
||||
Draws collapsed row icon (appearance-dependent).
|
||||
|
||||
|
||||
\membersection{cbRowDragPlugin::DrawCollapsedRowsBorder}\label{cbrowdragplugindrawcollapsedrowsborder}
|
||||
|
||||
\func{void}{DrawCollapsedRowsBorder}{\param{wxDC\& }{dc}}
|
||||
|
||||
Draws collapsed rows border (appearance-dependent).
|
||||
|
||||
|
||||
\membersection{cbRowDragPlugin::DrawEmptyRow}\label{cbrowdragplugindrawemptyrow}
|
||||
|
||||
\func{void}{DrawEmptyRow}{\param{wxDC\& }{dc}, \param{wxRect\& }{rowBounds}}
|
||||
|
||||
Draws empty row (appearance-dependent).
|
||||
|
||||
|
||||
\membersection{cbRowDragPlugin::DrawOrtoRomb}\label{cbrowdragplugindrawortoromb}
|
||||
|
||||
\func{void}{DrawOrtoRomb}{\param{wxRect\& }{inRect}, \param{wxDC\& }{dc}, \param{wxBrush\& }{bkBrush}}
|
||||
|
||||
Implements 'hard-coded metafile' for Netscape Navigator look.
|
||||
|
||||
|
||||
\membersection{cbRowDragPlugin::DrawRectShade}\label{cbrowdragplugindrawrectshade}
|
||||
|
||||
\func{void}{DrawRectShade}{\param{wxRect\& }{inRect}, \param{wxDC\& }{dc}, \param{int }{level}, \param{wxPen\& }{upperPen}, \param{wxPen\& }{lowerPen}}
|
||||
|
||||
Implements 'hard-coded metafile' for Netscape Navigator look.
|
||||
|
||||
|
||||
\membersection{cbRowDragPlugin::DrawRomb}\label{cbrowdragplugindrawromb}
|
||||
|
||||
\func{void}{DrawRomb}{\param{wxRect\& }{inRect}, \param{wxDC\& }{dc}, \param{wxBrush\& }{bkBrush}}
|
||||
|
||||
Implements 'hard-coded metafile' for Netscape Navigator look.
|
||||
|
||||
|
||||
\membersection{cbRowDragPlugin::DrawRombShades}\label{cbrowdragplugindrawrombshades}
|
||||
|
||||
\func{void}{DrawRombShades}{\param{wxPoint\& }{p1}, \param{wxPoint\& }{p2}, \param{wxPoint\& }{p3}, \param{wxPoint\& }{p4}, \param{wxDC\& }{dc}}
|
||||
|
||||
Implements 'hard-coded metafile' for Netscape Navigator look.
|
||||
|
||||
|
||||
\membersection{cbRowDragPlugin::DrawRowDragHint}\label{cbrowdragplugindrawrowdraghint}
|
||||
|
||||
\func{void}{DrawRowDragHint}{\param{cbRowInfo* }{pRow}, \param{wxDC\& }{dc}, \param{bool }{isHighlighted}}
|
||||
|
||||
Draws row drag hint (appearance-dependent).
|
||||
|
||||
|
||||
\membersection{cbRowDragPlugin::DrawRowsDragHintsBorder}\label{cbrowdragplugindrawrowsdraghintsborder}
|
||||
|
||||
\func{void}{DrawRowsDragHintsBorder}{\param{wxDC\& }{dc}}
|
||||
|
||||
Draws rows drag hints border (appearance-dependent).
|
||||
|
||||
|
||||
\membersection{cbRowDragPlugin::DrawTrianDown}\label{cbrowdragplugindrawtriandown}
|
||||
|
||||
\func{void}{DrawTrianDown}{\param{wxRect\& }{inRect}, \param{wxDC\& }{dc}}
|
||||
|
||||
Implements 'hard-coded metafile' for Netscape Navigator look.
|
||||
|
||||
|
||||
\membersection{cbRowDragPlugin::DrawTrianRight}\label{cbrowdragplugindrawtrianright}
|
||||
|
||||
\func{void}{DrawTrianRight}{\param{wxRect\& }{inRect}, \param{wxDC\& }{dc}}
|
||||
|
||||
Implements 'hard-coded metafile' for Netscape Navigator look.
|
||||
|
||||
|
||||
\membersection{cbRowDragPlugin::DrawTrianUp}\label{cbrowdragplugindrawtrianup}
|
||||
|
||||
\func{void}{DrawTrianUp}{\param{wxRect\& }{inRect}, \param{wxDC\& }{dc}}
|
||||
|
||||
"hard-coded metafile" for NN-look
|
||||
Implements 'hard-coded metafile' for Netscape Navigator look.
|
||||
|
||||
|
||||
\membersection{cbRowDragPlugin::ExpandRow}\label{cbrowdragpluginexpandrow}
|
||||
|
||||
\func{void}{ExpandRow}{\param{int }{collapsedIconIdx}}
|
||||
|
||||
Helper for drag and drop.
|
||||
|
||||
|
||||
\membersection{cbRowDragPlugin::FinishOnScreenDraw}\label{cbrowdragpluginfinishonscreendraw}
|
||||
|
||||
\func{void}{FinishOnScreenDraw}{\void}
|
||||
|
||||
Helper for drag and drop.
|
||||
|
||||
|
||||
\membersection{cbRowDragPlugin::GetCollapsedIconsPos}\label{cbrowdragplugingetcollapsediconspos}
|
||||
|
||||
\func{int}{GetCollapsedIconsPos}{\void}
|
||||
|
||||
Helper for drag and drop.
|
||||
|
||||
|
||||
\membersection{cbRowDragPlugin::GetCollapsedInconRect}\label{cbrowdragplugingetcollapsedinconrect}
|
||||
|
||||
\func{void}{GetCollapsedInconRect}{\param{int }{iconIdx}, \param{wxRect\& }{rect}}
|
||||
|
||||
Helper for drag and drop.
|
||||
|
||||
|
||||
\membersection{cbRowDragPlugin::GetCollapsedRowIconHeight}\label{cbrowdragplugingetcollapsedrowiconheight}
|
||||
|
||||
\func{int}{GetCollapsedRowIconHeight}{\void}
|
||||
|
||||
Gets the collapsed row icon height.
|
||||
|
||||
|
||||
\membersection{cbRowDragPlugin::GetFirstRow}\label{cbrowdragplugingetfirstrow}
|
||||
|
||||
\func{cbRowInfo*}{GetFirstRow}{\void}
|
||||
|
||||
Helper for drag and drop.
|
||||
|
||||
|
||||
\membersection{cbRowDragPlugin::GetHRowsCountForPane}\label{cbrowdragplugingethrowscountforpane}
|
||||
|
||||
\func{int}{GetHRowsCountForPane}{\param{cbDockPane* }{pPane}}
|
||||
|
||||
helpers for drag\&drop
|
||||
Helper for drag and drop.
|
||||
|
||||
|
||||
\membersection{cbRowDragPlugin::GetRowDragHintWidth}\label{cbrowdragplugingetrowdraghintwidth}
|
||||
|
||||
\func{int}{GetRowDragHintWidth}{\void}
|
||||
|
||||
Gets the row drag hint width.
|
||||
|
||||
|
||||
\membersection{cbRowDragPlugin::GetRowHintRect}\label{cbrowdragplugingetrowhintrect}
|
||||
|
||||
\func{void}{GetRowHintRect}{\param{cbRowInfo* }{pRow}, \param{wxRect\& }{rect}}
|
||||
|
||||
Helper for drag and drop.
|
||||
|
||||
|
||||
\membersection{cbRowDragPlugin::HitTestCollapsedRowIcon}\label{cbrowdragpluginhittestcollapsedrowicon}
|
||||
|
||||
\func{bool}{HitTestCollapsedRowIcon}{\param{int }{iconIdx}, \param{const wxPoint\& }{pos}}
|
||||
|
||||
Test for the collapsed row icon position.
|
||||
|
||||
|
||||
\membersection{cbRowDragPlugin::HitTestRowDragHint}\label{cbrowdragpluginhittestrowdraghint}
|
||||
|
||||
\func{bool}{HitTestRowDragHint}{\param{cbRowInfo* }{pRow}, \param{const wxPoint\& }{pos}}
|
||||
|
||||
Test for the row drag hint position.
|
||||
|
||||
|
||||
\membersection{cbRowDragPlugin::InsertDraggedRowBefore}\label{cbrowdragplugininsertdraggedrowbefore}
|
||||
|
||||
\func{void}{InsertDraggedRowBefore}{\param{cbRowInfo* }{pBeforeRow}}
|
||||
|
||||
Helper for drag and drop.
|
||||
|
||||
|
||||
\membersection{cbRowDragPlugin::ItemIsInFocus}\label{cbrowdragpluginitemisinfocus}
|
||||
|
||||
\func{bool}{ItemIsInFocus}{\void}
|
||||
|
||||
Helper for drag and drop.
|
||||
|
||||
|
||||
\membersection{cbRowDragPlugin::OnDrawPaneBackground}\label{cbrowdragpluginondrawpanebackground}
|
||||
|
||||
\func{void}{OnDrawPaneBackground}{\param{cbDrawPaneDecorEvent\& }{event}}
|
||||
|
||||
Handles pane drawing plugin events (appearance-independent logic).
|
||||
|
||||
|
||||
\membersection{cbRowDragPlugin::OnInitPlugin}\label{cbrowdragpluginoninitplugin}
|
||||
|
||||
\func{void}{OnInitPlugin}{\void}
|
||||
|
||||
Called to initialize this plugin.
|
||||
|
||||
|
||||
\membersection{cbRowDragPlugin::OnLButtonDown}\label{cbrowdragpluginonlbuttondown}
|
||||
|
||||
\func{void}{OnLButtonDown}{\param{cbLeftDownEvent\& }{event}}
|
||||
|
||||
Handles left button down plugin events (appearance-independent logic).
|
||||
|
||||
|
||||
\membersection{cbRowDragPlugin::OnLButtonUp}\label{cbrowdragpluginonlbuttonup}
|
||||
|
||||
\func{void}{OnLButtonUp}{\param{cbLeftUpEvent\& }{event}}
|
||||
|
||||
Handles left button up plugin events (appearance-independent logic).
|
||||
|
||||
|
||||
\membersection{cbRowDragPlugin::OnMouseMove}\label{cbrowdragpluginonmousemove}
|
||||
|
||||
\func{void}{OnMouseMove}{\param{cbMotionEvent\& }{event}}
|
||||
|
||||
handlers for plugin events (appearence-independent logic)
|
||||
Handles mouse move plugin events (appearance-independent logic).
|
||||
|
||||
|
||||
\membersection{cbRowDragPlugin::PrepareForRowDrag}\label{cbrowdragpluginprepareforrowdrag}
|
||||
|
||||
\func{void}{PrepareForRowDrag}{\void}
|
||||
|
||||
Helper for drag and drop.
|
||||
|
||||
|
||||
\membersection{cbRowDragPlugin::SetMouseCapture}\label{cbrowdragpluginsetmousecapture}
|
||||
|
||||
\func{void}{SetMouseCapture}{\param{bool }{captureOn}}
|
||||
|
||||
Helper for drag and drop.
|
||||
|
||||
|
||||
\membersection{cbRowDragPlugin::SetPaneMargins}\label{cbrowdragpluginsetpanemargins}
|
||||
|
||||
\func{void}{SetPaneMargins}{\void}
|
||||
|
||||
Sets the pane margins.
|
||||
|
||||
|
||||
\membersection{cbRowDragPlugin::ShowDraggedRow}\label{cbrowdragpluginshowdraggedrow}
|
||||
|
||||
\func{void}{ShowDraggedRow}{\param{int }{offset}}
|
||||
|
||||
Helper for drag and drop.
|
||||
|
||||
|
||||
\membersection{cbRowDragPlugin::ShowPaneImage}\label{cbrowdragpluginshowpaneimage}
|
||||
|
||||
\func{void}{ShowPaneImage}{\void}
|
||||
|
||||
Helper for drag and drop.
|
||||
|
||||
\membersection{cbRowDragPlugin::UnhiglightItemInFocus}\label{cbrowdragpluginunhiglightiteminfocus}
|
||||
|
||||
\func{void}{UnhiglightItemInFocus}{\void}
|
||||
\membersection{cbRowDragPlugin::UnhighlightItemInFocus}\label{cbrowdragpluginunhighlightiteminfocus}
|
||||
|
||||
\func{void}{UnhighlightItemInFocus}{\void}
|
||||
|
||||
Helper for drag and drop.
|
||||
|
||||
|
||||
@@ -1,15 +1,23 @@
|
||||
%
|
||||
% automatically generated by HelpGen $Revision$ from
|
||||
% controlbar.h at 05/Jan/02 22:50:59
|
||||
% controlbar.h at 21/Jan/02 21:14:13
|
||||
%
|
||||
|
||||
|
||||
\section{\class{cbRowInfo}}\label{cbrowinfo}
|
||||
|
||||
|
||||
Helper class used internally by the wxFrameLayout class.
|
||||
Holds and manages information about bar rows.
|
||||
|
||||
\wxheading{Derived from}
|
||||
|
||||
\helpref{wxObject}{wxobject}
|
||||
|
||||
\wxheading{Include files}
|
||||
|
||||
<controlbar.h>
|
||||
|
||||
\wxheading{Data structures}
|
||||
|
||||
\latexignore{\rtfignore{\wxheading{Members}}}
|
||||
@@ -19,15 +27,19 @@
|
||||
|
||||
\func{}{cbRowInfo}{\void}
|
||||
|
||||
Constructor.
|
||||
|
||||
|
||||
\membersection{cbRowInfo::\destruct{cbRowInfo}}\label{cbrowinfodtor}
|
||||
|
||||
\func{}{\destruct{cbRowInfo}}{\void}
|
||||
|
||||
Destructor.
|
||||
|
||||
|
||||
\membersection{cbRowInfo::GetFirstBar}\label{cbrowinfogetfirstbar}
|
||||
|
||||
\func{cbBarInfo*}{GetFirstBar}{\void}
|
||||
|
||||
convenience method
|
||||
Returns the first bar.
|
||||
|
||||
|
||||
@@ -1,19 +1,23 @@
|
||||
%
|
||||
% automatically generated by HelpGen $Revision$ from
|
||||
% rowlayoutpl.h at 05/Jan/02 22:50:58
|
||||
% rowlayoutpl.h at 21/Jan/02 21:14:19
|
||||
%
|
||||
|
||||
|
||||
\section{\class{cbRowLayoutPlugin}}\label{cbrowlayoutplugin}
|
||||
|
||||
|
||||
Simple implementation of plugin, which handles row-layouting
|
||||
requests sent from Frame Layout
|
||||
|
||||
Simple implementation of a plugin which handles row layout
|
||||
requests sent from a frame layout.
|
||||
|
||||
\wxheading{Derived from}
|
||||
|
||||
\helpref{cbPluginBase}{cbpluginbase}
|
||||
|
||||
\wxheading{Include files}
|
||||
|
||||
<rowlayoutpl.h>
|
||||
|
||||
\wxheading{Data structures}
|
||||
|
||||
\latexignore{\rtfignore{\wxheading{Members}}}
|
||||
@@ -23,132 +27,178 @@ Simple implementation of plugin, which handles row-layouting
|
||||
|
||||
\func{}{cbRowLayoutPlugin}{\param{wxFrameLayout* }{pPanel}, \param{int }{paneMask = wxALL\_PANES}}
|
||||
|
||||
Constructor taking frame layout pane and pane mask.
|
||||
|
||||
|
||||
\func{}{cbRowLayoutPlugin}{\void}
|
||||
|
||||
Default constructor.
|
||||
|
||||
|
||||
\membersection{cbRowLayoutPlugin::AdjustLengthOfInserted}\label{cbrowlayoutpluginadjustlengthofinserted}
|
||||
|
||||
\func{void}{AdjustLengthOfInserted}{\param{cbRowInfo* }{pRow}, \param{cbBarInfo* }{pTheBar}}
|
||||
|
||||
Internal helper relating to not-fixed-bars layout.
|
||||
|
||||
|
||||
\membersection{cbRowLayoutPlugin::ApplyLengthRatios}\label{cbrowlayoutpluginapplylengthratios}
|
||||
|
||||
\func{void}{ApplyLengthRatios}{\param{cbRowInfo* }{pRow}}
|
||||
|
||||
Internal helper relating to not-fixed-bars layout.
|
||||
|
||||
|
||||
\membersection{cbRowLayoutPlugin::CalcRowHeight}\label{cbrowlayoutplugincalcrowheight}
|
||||
|
||||
\func{int}{CalcRowHeight}{\param{cbRowInfo\& }{row}}
|
||||
|
||||
row-layouting helpers (simulate "bar-friction")
|
||||
Row layout helper simulating bar 'friction'.
|
||||
|
||||
|
||||
\membersection{cbRowLayoutPlugin::CheckIfAtTheBoundary}\label{cbrowlayoutplugincheckifattheboundary}
|
||||
|
||||
\func{void}{CheckIfAtTheBoundary}{\param{cbBarInfo* }{pTheBar}, \param{cbRowInfo\& }{rowInfo}}
|
||||
|
||||
Internal helper relating to not-fixed-bars layout.
|
||||
|
||||
|
||||
\membersection{cbRowLayoutPlugin::DetectBarHandles}\label{cbrowlayoutplugindetectbarhandles}
|
||||
|
||||
\func{void}{DetectBarHandles}{\param{cbRowInfo* }{pRow}}
|
||||
|
||||
Internal helper relating to not-fixed-bars layout.
|
||||
|
||||
|
||||
\membersection{cbRowLayoutPlugin::DoInsertBar}\label{cbrowlayoutplugindoinsertbar}
|
||||
|
||||
\func{void}{DoInsertBar}{\param{cbBarInfo* }{pTheBar}, \param{cbRowInfo\& }{row}}
|
||||
|
||||
Insert the bar before the given row.
|
||||
|
||||
|
||||
\membersection{cbRowLayoutPlugin::ExpandNotFixedBars}\label{cbrowlayoutpluginexpandnotfixedbars}
|
||||
|
||||
\func{void}{ExpandNotFixedBars}{\param{cbRowInfo* }{pRow}}
|
||||
|
||||
Internal helper relating to not-fixed-bars layout.
|
||||
|
||||
|
||||
\membersection{cbRowLayoutPlugin::FitBarsToRange}\label{cbrowlayoutpluginfitbarstorange}
|
||||
|
||||
\func{void}{FitBarsToRange}{\param{int }{from}, \param{int }{till}, \param{cbBarInfo* }{pTheBar}, \param{cbRowInfo* }{pRow}}
|
||||
|
||||
not-fixed-bars layouting related helpers
|
||||
Internal helper relating to not-fixed-bars layout.
|
||||
|
||||
|
||||
\membersection{cbRowLayoutPlugin::GetRowFreeSpace}\label{cbrowlayoutplugingetrowfreespace}
|
||||
|
||||
\func{int}{GetRowFreeSpace}{\param{cbRowInfo* }{pRow}}
|
||||
|
||||
Internal helper relating to not-fixed-bars layout.
|
||||
|
||||
|
||||
\membersection{cbRowLayoutPlugin::InsertBefore}\label{cbrowlayoutplugininsertbefore}
|
||||
|
||||
\func{void}{InsertBefore}{\param{cbBarInfo* }{pBeforeBar}, \param{cbBarInfo* }{pTheBar}, \param{cbRowInfo\& }{row}}
|
||||
|
||||
Insert the bar before the given row.
|
||||
|
||||
|
||||
\membersection{cbRowLayoutPlugin::LayoutItemsVertically}\label{cbrowlayoutpluginlayoutitemsvertically}
|
||||
|
||||
\func{void}{LayoutItemsVertically}{\param{cbRowInfo\& }{row}}
|
||||
|
||||
Row layout helper simulating bar 'friction'.
|
||||
|
||||
|
||||
\membersection{cbRowLayoutPlugin::MinimzeNotFixedBars}\label{cbrowlayoutpluginminimzenotfixedbars}
|
||||
|
||||
\func{void}{MinimzeNotFixedBars}{\param{cbRowInfo* }{pRow}, \param{cbBarInfo* }{pBarToPreserve}}
|
||||
|
||||
Internal helper relating to not-fixed-bars layout.
|
||||
|
||||
|
||||
\membersection{cbRowLayoutPlugin::OnInsertBar}\label{cbrowlayoutpluginoninsertbar}
|
||||
|
||||
\func{void}{OnInsertBar}{\param{cbInsertBarEvent\& }{event}}
|
||||
|
||||
Responds to bar insertion event.
|
||||
|
||||
|
||||
\membersection{cbRowLayoutPlugin::OnLayoutRow}\label{cbrowlayoutpluginonlayoutrow}
|
||||
|
||||
\func{void}{OnLayoutRow}{\param{cbLayoutRowEvent\& }{event}}
|
||||
|
||||
Responds to row layout event.
|
||||
|
||||
|
||||
\membersection{cbRowLayoutPlugin::OnLayoutRows}\label{cbrowlayoutpluginonlayoutrows}
|
||||
|
||||
\func{void}{OnLayoutRows}{\param{cbLayoutRowsEvent\& }{event}}
|
||||
|
||||
Responds to rows layout event.
|
||||
|
||||
|
||||
\membersection{cbRowLayoutPlugin::OnRemoveBar}\label{cbrowlayoutpluginonremovebar}
|
||||
|
||||
\func{void}{OnRemoveBar}{\param{cbRemoveBarEvent\& }{event}}
|
||||
|
||||
Responds to bar removal event.
|
||||
|
||||
|
||||
\membersection{cbRowLayoutPlugin::OnResizeRow}\label{cbrowlayoutpluginonresizerow}
|
||||
|
||||
\func{void}{OnResizeRow}{\param{cbResizeRowEvent\& }{event}}
|
||||
|
||||
event handlers
|
||||
Responds to row resize event.
|
||||
|
||||
|
||||
\membersection{cbRowLayoutPlugin::RecalcLengthRatios}\label{cbrowlayoutpluginrecalclengthratios}
|
||||
|
||||
\func{void}{RecalcLengthRatios}{\param{cbRowInfo* }{pRow}}
|
||||
|
||||
Internal helper relating to not-fixed-bars layout.
|
||||
|
||||
|
||||
\membersection{cbRowLayoutPlugin::RelayoutNotFixedBarsAround}\label{cbrowlayoutpluginrelayoutnotfixedbarsaround}
|
||||
|
||||
\func{void}{RelayoutNotFixedBarsAround}{\param{cbBarInfo* }{pTheBar}, \param{cbRowInfo* }{pRow}}
|
||||
|
||||
Internal helper relating to not-fixed-bars layout.
|
||||
|
||||
|
||||
\membersection{cbRowLayoutPlugin::ShiftLeftTrashold}\label{cbrowlayoutpluginshiftlefttrashold}
|
||||
|
||||
\func{void}{ShiftLeftTrashold}{\param{cbBarInfo* }{pTheBar}, \param{cbRowInfo\& }{row}}
|
||||
|
||||
Row layout helper simulating bar 'friction'.
|
||||
|
||||
|
||||
\membersection{cbRowLayoutPlugin::ShiftRightTrashold}\label{cbrowlayoutpluginshiftrighttrashold}
|
||||
|
||||
\func{void}{ShiftRightTrashold}{\param{cbBarInfo* }{pTheBar}, \param{cbRowInfo\& }{row}}
|
||||
|
||||
Row layout helper simulating bar 'friction'.
|
||||
|
||||
|
||||
\membersection{cbRowLayoutPlugin::SlideLeftSideBars}\label{cbrowlayoutpluginslideleftsidebars}
|
||||
|
||||
\func{void}{SlideLeftSideBars}{\param{cbBarInfo* }{pTheBar}}
|
||||
|
||||
Row layout helper simulating bar 'friction'.
|
||||
|
||||
|
||||
\membersection{cbRowLayoutPlugin::SlideRightSideBars}\label{cbrowlayoutpluginsliderightsidebars}
|
||||
|
||||
\func{void}{SlideRightSideBars}{\param{cbBarInfo* }{pTheBar}}
|
||||
|
||||
Row layout helper simulating bar 'friction'.
|
||||
|
||||
|
||||
\membersection{cbRowLayoutPlugin::StickRightSideBars}\label{cbrowlayoutpluginstickrightsidebars}
|
||||
|
||||
\func{void}{StickRightSideBars}{\param{cbBarInfo* }{pToBar}}
|
||||
|
||||
Row layout helper simulating bar 'friction'.
|
||||
|
||||
|
||||
@@ -1,15 +1,24 @@
|
||||
%
|
||||
% automatically generated by HelpGen $Revision$ from
|
||||
% cbcustom.h at 05/Jan/02 22:50:56
|
||||
% cbcustom.h at 21/Jan/02 21:14:18
|
||||
%
|
||||
|
||||
|
||||
\section{\class{cbSimpleCustomizationPlugin}}\label{cbsimplecustomizationplugin}
|
||||
|
||||
|
||||
This class enables customization of a bar, popping up a
|
||||
menu and handling basic customization such as floating
|
||||
and horizontal/vertical alignment of the bar.
|
||||
|
||||
\wxheading{Derived from}
|
||||
|
||||
\helpref{cbPluginBase}{cbpluginbase}
|
||||
|
||||
\wxheading{Include files}
|
||||
|
||||
<cbcustom.h>
|
||||
|
||||
\wxheading{Data structures}
|
||||
|
||||
\latexignore{\rtfignore{\wxheading{Members}}}
|
||||
@@ -19,25 +28,31 @@
|
||||
|
||||
\func{}{cbSimpleCustomizationPlugin}{\param{wxFrameLayout* }{pPanel}, \param{int }{paneMask = wxALL\_PANES}}
|
||||
|
||||
Constructor, taking parent pane and a pane mask flag.
|
||||
|
||||
|
||||
\func{}{cbSimpleCustomizationPlugin}{\void}
|
||||
|
||||
Default constructor.
|
||||
|
||||
|
||||
\membersection{cbSimpleCustomizationPlugin::OnCustomizeBar}\label{cbsimplecustomizationpluginoncustomizebar}
|
||||
|
||||
\func{void}{OnCustomizeBar}{\param{cbCustomizeBarEvent\& }{event}}
|
||||
|
||||
plugin-event handlers
|
||||
Plugin event handler for cbCustomizeBarEvent.
|
||||
|
||||
|
||||
\membersection{cbSimpleCustomizationPlugin::OnCustomizeLayout}\label{cbsimplecustomizationpluginoncustomizelayout}
|
||||
|
||||
\func{void}{OnCustomizeLayout}{\param{cbCustomizeLayoutEvent\& }{event}}
|
||||
|
||||
Plugin event handler for cbCustomizeLayoutEvent.
|
||||
|
||||
|
||||
\membersection{cbSimpleCustomizationPlugin::OnMenuItemSelected}\label{cbsimplecustomizationpluginonmenuitemselected}
|
||||
|
||||
\func{void}{OnMenuItemSelected}{\param{wxCommandEvent\& }{event}}
|
||||
|
||||
menu-event handler
|
||||
Menu event handler.
|
||||
|
||||
|
||||
@@ -1,19 +1,23 @@
|
||||
%
|
||||
% automatically generated by HelpGen $Revision$ from
|
||||
% updatesmgr.h at 05/Jan/02 22:50:58
|
||||
% updatesmgr.h at 21/Jan/02 21:14:18
|
||||
%
|
||||
|
||||
|
||||
\section{\class{cbSimpleUpdatesMgr}}\label{cbsimpleupdatesmgr}
|
||||
|
||||
|
||||
class implements slightly optimized logic for refreshing
|
||||
areas of frame layout - which actually need to be updated.
|
||||
|
||||
This class implements slightly optimized logic for refreshing
|
||||
the areas of frame layout that actually need to be updated.
|
||||
|
||||
\wxheading{Derived from}
|
||||
|
||||
\helpref{cbUpdatesManagerBase}{cbupdatesmanagerbase}
|
||||
|
||||
\wxheading{Include files}
|
||||
|
||||
<updatesmgr.h>
|
||||
|
||||
\wxheading{Data structures}
|
||||
|
||||
\latexignore{\rtfignore{\wxheading{Members}}}
|
||||
@@ -23,51 +27,72 @@ class implements slightly optimized logic for refreshing
|
||||
|
||||
\func{}{cbSimpleUpdatesMgr}{\void}
|
||||
|
||||
Default constructor.
|
||||
|
||||
|
||||
\func{}{cbSimpleUpdatesMgr}{\param{wxFrameLayout* }{pPanel}}
|
||||
|
||||
Constructor taking frame layout panel.
|
||||
|
||||
|
||||
\membersection{cbSimpleUpdatesMgr::OnBarWillChange}\label{cbsimpleupdatesmgronbarwillchange}
|
||||
|
||||
\func{void}{OnBarWillChange}{\param{cbBarInfo* }{pBar}, \param{cbRowInfo* }{pInRow}, \param{cbDockPane* }{pInPane}}
|
||||
|
||||
Notification received from Frame Layout in the order in which
|
||||
they would usually be invoked.
|
||||
|
||||
|
||||
\membersection{cbSimpleUpdatesMgr::OnFinishChanges}\label{cbsimpleupdatesmgronfinishchanges}
|
||||
|
||||
\func{void}{OnFinishChanges}{\void}
|
||||
|
||||
Notification received from Frame Layout in the order in which
|
||||
they would usually be invoked.
|
||||
|
||||
|
||||
\membersection{cbSimpleUpdatesMgr::OnPaneMarginsWillChange}\label{cbsimpleupdatesmgronpanemarginswillchange}
|
||||
|
||||
\func{void}{OnPaneMarginsWillChange}{\param{cbDockPane* }{pPane}}
|
||||
|
||||
Notification received from Frame Layout in the order in which
|
||||
they would usually be invoked.
|
||||
|
||||
|
||||
\membersection{cbSimpleUpdatesMgr::OnPaneWillChange}\label{cbsimpleupdatesmgronpanewillchange}
|
||||
|
||||
\func{void}{OnPaneWillChange}{\param{cbDockPane* }{pPane}}
|
||||
|
||||
Notification received from Frame Layout in the order in which
|
||||
they would usually be invoked.
|
||||
|
||||
|
||||
\membersection{cbSimpleUpdatesMgr::OnRowWillChange}\label{cbsimpleupdatesmgronrowwillchange}
|
||||
|
||||
\func{void}{OnRowWillChange}{\param{cbRowInfo* }{pRow}, \param{cbDockPane* }{pInPane}}
|
||||
|
||||
Notification received from Frame Layout in the order in which
|
||||
they would usually be invoked.
|
||||
|
||||
|
||||
\membersection{cbSimpleUpdatesMgr::OnStartChanges}\label{cbsimpleupdatesmgronstartchanges}
|
||||
|
||||
\func{void}{OnStartChanges}{\void}
|
||||
|
||||
notificiactions received from Frame Layout (in the order, in which
|
||||
they usually would be invoked)
|
||||
Notification received from Frame Layout in the order in which
|
||||
they would usually be invoked.
|
||||
|
||||
|
||||
\membersection{cbSimpleUpdatesMgr::UpdateNow}\label{cbsimpleupdatesmgrupdatenow}
|
||||
|
||||
\func{void}{UpdateNow}{\void}
|
||||
|
||||
refreshes parts of the frame layout, which need an update
|
||||
Refreshes the parts of the frame layoutthat need an update.
|
||||
|
||||
|
||||
\membersection{cbSimpleUpdatesMgr::WasChanged}\label{cbsimpleupdatesmgrwaschanged}
|
||||
|
||||
\func{bool}{WasChanged}{\param{cbUpdateMgrData\& }{data}, \param{wxRect\& }{currentBounds}}
|
||||
|
||||
Helper function.
|
||||
|
||||
|
||||
@@ -1,15 +1,22 @@
|
||||
%
|
||||
% automatically generated by HelpGen $Revision$ from
|
||||
% controlbar.h at 05/Jan/02 22:51:00
|
||||
% controlbar.h at 21/Jan/02 21:14:16
|
||||
%
|
||||
|
||||
|
||||
\section{\class{cbSizeBarWndEvent}}\label{cbsizebarwndevent}
|
||||
|
||||
|
||||
Class for bar window resize events.
|
||||
|
||||
\wxheading{Derived from}
|
||||
|
||||
\helpref{cbPluginEvent}{cbpluginevent}
|
||||
|
||||
\wxheading{Include files}
|
||||
|
||||
<controlbar.h>
|
||||
|
||||
\wxheading{Data structures}
|
||||
|
||||
\latexignore{\rtfignore{\wxheading{Members}}}
|
||||
@@ -19,3 +26,5 @@
|
||||
|
||||
\func{}{cbSizeBarWndEvent}{\param{cbBarInfo* }{pBar}, \param{cbDockPane* }{pPane}}
|
||||
|
||||
Constructor, taking bar information and pane.
|
||||
|
||||
|
||||
@@ -1,15 +1,22 @@
|
||||
%
|
||||
% automatically generated by HelpGen $Revision$ from
|
||||
% controlbar.h at 05/Jan/02 22:51:01
|
||||
% controlbar.h at 21/Jan/02 21:14:16
|
||||
%
|
||||
|
||||
|
||||
\section{\class{cbStartBarDraggingEvent}}\label{cbstartbardraggingevent}
|
||||
|
||||
|
||||
Class for start-bar-dragging events.
|
||||
|
||||
\wxheading{Derived from}
|
||||
|
||||
\helpref{cbPluginEvent}{cbpluginevent}
|
||||
|
||||
\wxheading{Include files}
|
||||
|
||||
<controlbar.h>
|
||||
|
||||
\wxheading{Data structures}
|
||||
|
||||
\latexignore{\rtfignore{\wxheading{Members}}}
|
||||
@@ -19,3 +26,5 @@
|
||||
|
||||
\func{}{cbStartBarDraggingEvent}{\param{cbBarInfo* }{pBar}, \param{const wxPoint\& }{pos}, \param{cbDockPane* }{pPane}}
|
||||
|
||||
Constructor, taking bar information, mouse position, and pane.
|
||||
|
||||
|
||||
@@ -1,15 +1,22 @@
|
||||
%
|
||||
% automatically generated by HelpGen $Revision$ from
|
||||
% controlbar.h at 05/Jan/02 22:51:01
|
||||
% controlbar.h at 21/Jan/02 21:14:16
|
||||
%
|
||||
|
||||
|
||||
\section{\class{cbStartDrawInAreaEvent}}\label{cbstartdrawinareaevent}
|
||||
|
||||
|
||||
Class for start drawing in area events.
|
||||
|
||||
\wxheading{Derived from}
|
||||
|
||||
\helpref{cbPluginEvent}{cbpluginevent}
|
||||
|
||||
\wxheading{Include files}
|
||||
|
||||
<controlbar.h>
|
||||
|
||||
\wxheading{Data structures}
|
||||
|
||||
\latexignore{\rtfignore{\wxheading{Members}}}
|
||||
@@ -20,4 +27,5 @@
|
||||
\func{}{cbStartDrawInAreaEvent}{\param{const wxRect\& }{area}, \param{wxDC** }{ppDCForArea}, \param{cbDockPane* }{pPane}}
|
||||
|
||||
to the obtained buffer-context should be placed
|
||||
Constructor, taking rectangular area, device context pointer to a pointer, and pane.
|
||||
|
||||
|
||||
@@ -1,21 +1,24 @@
|
||||
%
|
||||
% automatically generated by HelpGen $Revision$ from
|
||||
% controlbar.h at 05/Jan/02 22:50:58
|
||||
% controlbar.h at 21/Jan/02 21:14:13
|
||||
%
|
||||
|
||||
|
||||
\section{\class{cbUpdateMgrData}}\label{cbupdatemgrdata}
|
||||
|
||||
|
||||
structure, which is present in each item of layout,
|
||||
it used by any specific updates-manager to store
|
||||
auxilary information to be used by it's specific
|
||||
updating algorithm
|
||||
|
||||
A structure that is present in each item of layout,
|
||||
used by any particular updates-manager to store
|
||||
auxiliary information to be used by its updating algorithm.
|
||||
|
||||
\wxheading{Derived from}
|
||||
|
||||
\helpref{wxObject}{wxobject}
|
||||
|
||||
\wxheading{Include files}
|
||||
|
||||
<controlbar.h>
|
||||
|
||||
\wxheading{Data structures}
|
||||
|
||||
\latexignore{\rtfignore{\wxheading{Members}}}
|
||||
@@ -25,25 +28,33 @@ structure, which is present in each item of layout,
|
||||
|
||||
\func{}{cbUpdateMgrData}{\void}
|
||||
|
||||
is-dirty flag is set TRUE initially
|
||||
Default constructor. Is-dirty flag is set TRUE initially.
|
||||
|
||||
|
||||
\membersection{cbUpdateMgrData::IsDirty}\label{cbupdatemgrdataisdirty}
|
||||
|
||||
\func{bool}{IsDirty}{\void}
|
||||
|
||||
Returns the is-dirty flag.
|
||||
|
||||
|
||||
\membersection{cbUpdateMgrData::SetCustomData}\label{cbupdatemgrdatasetcustomdata}
|
||||
|
||||
\func{void}{SetCustomData}{\param{wxObject* }{pCustomData}}
|
||||
|
||||
Set custom data.
|
||||
|
||||
|
||||
\membersection{cbUpdateMgrData::SetDirty}\label{cbupdatemgrdatasetdirty}
|
||||
|
||||
\func{void}{SetDirty}{\param{bool }{isDirty = TRUE}}
|
||||
|
||||
Set the dirty flag.
|
||||
|
||||
|
||||
\membersection{cbUpdateMgrData::StoreItemState}\label{cbupdatemgrdatastoreitemstate}
|
||||
|
||||
\func{void}{StoreItemState}{\param{const wxRect\& }{boundsInParent}}
|
||||
|
||||
Store the item state.
|
||||
|
||||
|
||||
@@ -1,20 +1,24 @@
|
||||
%
|
||||
% automatically generated by HelpGen $Revision$ from
|
||||
% controlbar.h at 05/Jan/02 22:50:59
|
||||
% controlbar.h at 21/Jan/02 21:14:14
|
||||
%
|
||||
|
||||
|
||||
\section{\class{cbUpdatesManagerBase}}\label{cbupdatesmanagerbase}
|
||||
|
||||
|
||||
class declares abstract interface for optimized logic, which should refresh
|
||||
areas of frame layout - that actually need to be updated. Should be extended,
|
||||
to implement custom updating strategy
|
||||
|
||||
This class declares an abstract interface for optimized logic that should refresh
|
||||
areas of frame layout that actually need to be updated. This should be extended in future
|
||||
to implement a custom updating strategy.
|
||||
|
||||
\wxheading{Derived from}
|
||||
|
||||
\helpref{wxObject}{wxobject}
|
||||
|
||||
\wxheading{Include files}
|
||||
|
||||
<controlbar.h>
|
||||
|
||||
\wxheading{Data structures}
|
||||
|
||||
\latexignore{\rtfignore{\wxheading{Members}}}
|
||||
@@ -24,57 +28,85 @@ class declares abstract interface for optimized logic, which should refresh
|
||||
|
||||
\func{}{cbUpdatesManagerBase}{\param{wxFrameLayout* }{pPanel}}
|
||||
|
||||
Constructor taking layout panel.
|
||||
|
||||
|
||||
\func{}{cbUpdatesManagerBase}{\void}
|
||||
|
||||
Default constructor
|
||||
|
||||
|
||||
\membersection{cbUpdatesManagerBase::\destruct{cbUpdatesManagerBase}}\label{cbupdatesmanagerbasedtor}
|
||||
|
||||
\func{}{\destruct{cbUpdatesManagerBase}}{\void}
|
||||
|
||||
Destructor.
|
||||
|
||||
|
||||
\membersection{cbUpdatesManagerBase::OnBarWillChange}\label{cbupdatesmanagerbaseonbarwillchange}
|
||||
|
||||
\func{void}{OnBarWillChange}{\param{cbBarInfo* }{pBar}, \param{cbRowInfo* }{pInRow}, \param{cbDockPane* }{pInPane}}
|
||||
|
||||
This function receives a notification from the frame layout (in the order in which
|
||||
they would usually be invoked). Custom updates-managers may utilize
|
||||
these notifications to implement a more fine-grained updating strategy.
|
||||
|
||||
|
||||
\membersection{cbUpdatesManagerBase::OnFinishChanges}\label{cbupdatesmanagerbaseonfinishchanges}
|
||||
|
||||
\func{void}{OnFinishChanges}{\void}
|
||||
|
||||
This function receives a notification from the frame layout (in the order in which
|
||||
they would usually be invoked). Custom updates-managers may utilize
|
||||
these notifications to implement a more fine-grained updating strategy.
|
||||
|
||||
|
||||
\membersection{cbUpdatesManagerBase::OnPaneMarginsWillChange}\label{cbupdatesmanagerbaseonpanemarginswillchange}
|
||||
|
||||
\func{void}{OnPaneMarginsWillChange}{\param{cbDockPane* }{pPane}}
|
||||
|
||||
This function receives a notification from the frame layout (in the order in which
|
||||
they would usually be invoked). Custom updates-managers may utilize
|
||||
these notifications to implement a more fine-grained updating strategy.
|
||||
|
||||
|
||||
\membersection{cbUpdatesManagerBase::OnPaneWillChange}\label{cbupdatesmanagerbaseonpanewillchange}
|
||||
|
||||
\func{void}{OnPaneWillChange}{\param{cbDockPane* }{pPane}}
|
||||
|
||||
This function receives a notification from the frame layout (in the order in which
|
||||
they would usually be invoked). Custom updates-managers may utilize
|
||||
these notifications to implement a more fine-grained updating strategy.
|
||||
|
||||
|
||||
\membersection{cbUpdatesManagerBase::OnRowWillChange}\label{cbupdatesmanagerbaseonrowwillchange}
|
||||
|
||||
\func{void}{OnRowWillChange}{\param{cbRowInfo* }{pRow}, \param{cbDockPane* }{pInPane}}
|
||||
|
||||
This function receives a notification from the frame layout (in the order in which
|
||||
they would usually be invoked). Custom updates-managers may utilize
|
||||
these notifications to implement a more fine-grained updating strategy.
|
||||
|
||||
|
||||
\membersection{cbUpdatesManagerBase::OnStartChanges}\label{cbupdatesmanagerbaseonstartchanges}
|
||||
|
||||
\func{void}{OnStartChanges}{\void}
|
||||
|
||||
notificiactions received from frame-layout (in the order, in which
|
||||
they usually would be invoked). Custom updates-managers may utilize
|
||||
these notifications to implement more "fine-grained" updating strategy
|
||||
This function receives a notification from the frame layout (in the order in which
|
||||
they would usually be invoked). Custom updates-managers may utilize
|
||||
these notifications to implement a more fine-grained updating strategy.
|
||||
|
||||
|
||||
\membersection{cbUpdatesManagerBase::SetLayout}\label{cbupdatesmanagerbasesetlayout}
|
||||
|
||||
\func{void}{SetLayout}{\param{wxFrameLayout* }{pLayout}}
|
||||
|
||||
Sets the associated layout.
|
||||
|
||||
|
||||
\membersection{cbUpdatesManagerBase::UpdateNow}\label{cbupdatesmanagerbaseupdatenow}
|
||||
|
||||
\func{void}{UpdateNow}{\void}
|
||||
|
||||
refreshes parts of the frame layout, which need an update
|
||||
Refreshes parts of the frame layout that need an update.
|
||||
|
||||
|
||||
@@ -34,9 +34,9 @@
|
||||
\input cbfinishdrawinareaevent.tex
|
||||
\input cbfloatedbarwindow.tex
|
||||
\input cbgcupdatesmgr.tex
|
||||
\input cbhiddenbarinfo.tex
|
||||
%\input cbhiddenbarinfo.tex
|
||||
\input cbhintanimationplugin.tex
|
||||
\input cbhintanimtimer.tex
|
||||
%\input cbhintanimtimer.tex
|
||||
\input cbinsertbarevent.tex
|
||||
\input cblayoutrowevent.tex
|
||||
\input cblayoutrowsevent.tex
|
||||
@@ -67,11 +67,10 @@
|
||||
\input dyntoolinfo.tex
|
||||
\input framelayout.tex
|
||||
\input framemanager.tex
|
||||
\input frameview.tex
|
||||
%\input frameview.tex
|
||||
\input garbagecollector.tex
|
||||
\input gcitem.tex
|
||||
\input layoutmanagerbase.tex
|
||||
\input morphinfot.tex
|
||||
%\input morphinfot.tex
|
||||
\input newbitmapbutton.tex
|
||||
\input toollayoutitem.tex
|
||||
\input toolwindow.tex
|
||||
|
||||
@@ -1,18 +1,22 @@
|
||||
%
|
||||
% automatically generated by HelpGen $Revision$ from
|
||||
% dyntbar.h at 05/Jan/02 22:50:56
|
||||
% dyntbar.h at 21/Jan/02 21:14:18
|
||||
%
|
||||
|
||||
|
||||
\section{\class{wxDynamicToolBar}}\label{wxdynamictoolbar}
|
||||
|
||||
|
||||
class manages containment and layouting of tool-windows
|
||||
wxDynamicToolBar manages containment and layout of tool windows.
|
||||
|
||||
\wxheading{Derived from}
|
||||
|
||||
\helpref{wxToolBarBase}{wxtoolbarbase}
|
||||
|
||||
\wxheading{Include files}
|
||||
|
||||
<dyntbar.h>
|
||||
|
||||
\wxheading{Data structures}
|
||||
|
||||
\latexignore{\rtfignore{\wxheading{Members}}}
|
||||
@@ -22,164 +26,202 @@ class manages containment and layouting of tool-windows
|
||||
|
||||
\func{}{wxDynamicToolBar}{\void}
|
||||
|
||||
Default constructor.
|
||||
|
||||
|
||||
\func{}{wxDynamicToolBar}{\param{wxWindow* }{parent}, \param{const wxWindowID }{id}, \param{const wxPoint\& }{pos = wxDefaultPosition}, \param{const wxSize\& }{size = wxDefaultSize}, \param{const long }{style = wxNO\_BORDER}, \param{const int }{orientation = wxVERTICAL}, \param{const int }{RowsOrColumns = 1}, \param{const wxString\& }{name = wxToolBarNameStr}}
|
||||
|
||||
Constructor: see the documentation for wxToolBar for details.
|
||||
|
||||
|
||||
\membersection{wxDynamicToolBar::\destruct{wxDynamicToolBar}}\label{wxdynamictoolbardtor}
|
||||
|
||||
\func{}{\destruct{wxDynamicToolBar}}{\void}
|
||||
|
||||
Destructor.
|
||||
|
||||
|
||||
\membersection{wxDynamicToolBar::AddSeparator}\label{wxdynamictoolbaraddseparator}
|
||||
|
||||
\func{void}{AddSeparator}{\param{wxWindow* }{pSepartorWnd = NULL}}
|
||||
|
||||
Adds a separator. See the documentation for wxToolBar for details.
|
||||
|
||||
|
||||
\membersection{wxDynamicToolBar::AddTool}\label{wxdynamictoolbaraddtool}
|
||||
|
||||
\func{void}{AddTool}{\param{int }{toolIndex}, \param{wxWindow* }{pToolWindow}, \param{const wxSize\& }{size = wxDefaultSize}}
|
||||
|
||||
overridables
|
||||
Adds a tool. See the documentation for wxToolBar for details.
|
||||
|
||||
|
||||
\func{void}{AddTool}{\param{int }{toolIndex}, \param{const wxString\& }{imageFileName}, \param{wxBitmapType }{imageFileType = wxBITMAP\_TYPE\_BMP}, \param{const wxString\& }{labelText = ""}, \param{bool }{alignTextRight = FALSE}, \param{bool }{isFlat = TRUE}}
|
||||
|
||||
Adds a tool. See the documentation for wxToolBar for details.
|
||||
|
||||
|
||||
\func{void}{AddTool}{\param{int }{toolIndex}, \param{wxBitmap }{labelBmp}, \param{const wxString\& }{labelText = ""}, \param{bool }{alignTextRight = FALSE}, \param{bool }{isFlat = TRUE}}
|
||||
|
||||
Adds a tool. See the documentation for wxToolBar for details.
|
||||
|
||||
|
||||
\func{wxToolBarToolBase*}{AddTool}{\param{const int }{toolIndex}, \param{const wxBitmap\& }{bitmap}, \param{const wxBitmap\& }{pushedBitmap = wxNullBitmap}, \param{const bool }{toggle = FALSE}, \param{const long }{xPos = -1}, \param{const long }{yPos = -1}, \param{wxObject* }{clientData = NULL}, \param{const wxString\& }{helpString1 = ""}, \param{const wxString\& }{helpString2 = ""}}
|
||||
|
||||
method from wxToolBarBase (for compatibility), only
|
||||
first two arguments are valid
|
||||
Method from wxToolBarBase (for compatibility), only
|
||||
the first two arguments are valid.
|
||||
See the documentation for wxToolBar for details.
|
||||
|
||||
|
||||
\membersection{wxDynamicToolBar::Create}\label{wxdynamictoolbarcreate}
|
||||
|
||||
\func{bool}{Create}{\param{wxWindow* }{parent}, \param{const wxWindowID }{id}, \param{const wxPoint\& }{pos = wxDefaultPosition}, \param{const wxSize\& }{size = wxDefaultSize}, \param{const long }{style = wxNO\_BORDER}, \param{const int }{orientation = wxVERTICAL}, \param{const int }{RowsOrColumns = 1}, \param{const wxString\& }{name = wxToolBarNameStr}}
|
||||
|
||||
Creation function: see the documentation for wxToolBar for details.
|
||||
|
||||
\membersection{wxDynamicToolBar::CreateDefaulLayout}\label{wxdynamictoolbarcreatedefaullayout}
|
||||
|
||||
\func{LayoutManagerBase*}{CreateDefaulLayout}{\void}
|
||||
\membersection{wxDynamicToolBar::CreateDefaultLayout}\label{wxdynamictoolbarcreatedefaultlayout}
|
||||
|
||||
\func{LayoutManagerBase*}{CreateDefaultLayout}{\void}
|
||||
|
||||
Creates the default layout (BagLayout).
|
||||
|
||||
|
||||
\membersection{wxDynamicToolBar::CreateTool}\label{wxdynamictoolbarcreatetool}
|
||||
|
||||
\func{wxToolBarToolBase*}{CreateTool}{\param{wxControl* }{control}}
|
||||
|
||||
Creates a toolbar tool.
|
||||
|
||||
|
||||
\func{wxToolBarToolBase*}{CreateTool}{\param{int }{id}, \param{const wxBitmap\& }{bitmap1}, \param{const wxBitmap\& }{bitmap2}, \param{bool }{toggle}, \param{wxObject* }{clientData}, \param{const wxString\& }{shortHelpString}, \param{const wxString\& }{longHelpString}}
|
||||
|
||||
the functions to create toolbar tools
|
||||
Creates a toolbar tool.
|
||||
|
||||
|
||||
\membersection{wxDynamicToolBar::DoDeleteTool}\label{wxdynamictoolbardodeletetool}
|
||||
|
||||
\func{bool}{DoDeleteTool}{\param{size\_t }{pos}, \param{wxToolBarToolBase* }{tool}}
|
||||
|
||||
the tool is still in m\_tools list when this function is called, it will
|
||||
only be deleted from it if it succeeds
|
||||
Deletes a tool. The tool is still in m\_tools list when this function is called, and it will
|
||||
only be deleted from it if it succeeds.
|
||||
|
||||
|
||||
\membersection{wxDynamicToolBar::DoEnableTool}\label{wxdynamictoolbardoenabletool}
|
||||
|
||||
\func{void}{DoEnableTool}{\param{wxToolBarToolBase* }{tool}, \param{bool }{enable}}
|
||||
|
||||
called when the tools enabled flag changes
|
||||
Called when the tools enabled flag changes.
|
||||
|
||||
|
||||
\membersection{wxDynamicToolBar::DoInsertTool}\label{wxdynamictoolbardoinserttool}
|
||||
|
||||
\func{bool}{DoInsertTool}{\param{size\_t }{pos}, \param{wxToolBarToolBase* }{tool}}
|
||||
|
||||
Inserts a tool at the given position.
|
||||
|
||||
|
||||
\membersection{wxDynamicToolBar::DoSetToggle}\label{wxdynamictoolbardosettoggle}
|
||||
|
||||
\func{void}{DoSetToggle}{\param{wxToolBarToolBase* }{tool}, \param{bool }{toggle}}
|
||||
|
||||
called when the tools "can be toggled" flag changes
|
||||
Called when the tools 'can be toggled' flag changes.
|
||||
|
||||
|
||||
\membersection{wxDynamicToolBar::DoToggleTool}\label{wxdynamictoolbardotoggletool}
|
||||
|
||||
\func{void}{DoToggleTool}{\param{wxToolBarToolBase* }{tool}, \param{bool }{toggle}}
|
||||
|
||||
called when the tool is toggled
|
||||
Called when the tool is toggled.
|
||||
|
||||
|
||||
\membersection{wxDynamicToolBar::DrawSeparator}\label{wxdynamictoolbardrawseparator}
|
||||
|
||||
\func{void}{DrawSeparator}{\param{wxDynToolInfo\& }{info}, \param{wxDC\& }{dc}}
|
||||
|
||||
the default implementation draws shaded line
|
||||
Draws a separator. The default implementation draws a shaded line.
|
||||
|
||||
|
||||
\membersection{wxDynamicToolBar::EnableTool}\label{wxdynamictoolbarenabletool}
|
||||
|
||||
\func{void}{EnableTool}{\param{const int }{toolIndex}, \param{const bool }{enable = TRUE}}
|
||||
|
||||
Enables or disables the given tool.
|
||||
|
||||
|
||||
\membersection{wxDynamicToolBar::FindToolForPosition}\label{wxdynamictoolbarfindtoolforposition}
|
||||
|
||||
\constfunc{wxToolBarToolBase*}{FindToolForPosition}{\param{wxCoord }{x}, \param{wxCoord }{y}}
|
||||
|
||||
stuff from the 2.1.15
|
||||
Finds a tool for the given position.
|
||||
|
||||
|
||||
\membersection{wxDynamicToolBar::GetPreferredDim}\label{wxdynamictoolbargetpreferreddim}
|
||||
|
||||
\func{void}{GetPreferredDim}{\param{const wxSize\& }{givenDim}, \param{wxSize\& }{prefDim}}
|
||||
|
||||
Returns the preferred dimension, taking the given dimension and a reference to the result.
|
||||
|
||||
|
||||
\membersection{wxDynamicToolBar::GetToolInfo}\label{wxdynamictoolbargettoolinfo}
|
||||
|
||||
\func{wxDynToolInfo*}{GetToolInfo}{\param{int }{toolIndex}}
|
||||
|
||||
Returns tool information for the given tool index.
|
||||
|
||||
|
||||
\membersection{wxDynamicToolBar::Layout}\label{wxdynamictoolbarlayout}
|
||||
|
||||
\func{bool}{Layout}{\void}
|
||||
|
||||
see definitions of orientation types
|
||||
Performs layout. See definitions of orientation types.
|
||||
|
||||
|
||||
\membersection{wxDynamicToolBar::OnEraseBackground}\label{wxdynamictoolbaronerasebackground}
|
||||
|
||||
\func{void}{OnEraseBackground}{\param{wxEraseEvent\& }{event}}
|
||||
|
||||
Responds to background erase events. Currently does nothing.
|
||||
|
||||
|
||||
\membersection{wxDynamicToolBar::OnPaint}\label{wxdynamictoolbaronpaint}
|
||||
|
||||
\func{void}{OnPaint}{\param{wxPaintEvent\& }{event}}
|
||||
|
||||
Responds to paint events, drawing separators.
|
||||
|
||||
|
||||
\membersection{wxDynamicToolBar::OnSize}\label{wxdynamictoolbaronsize}
|
||||
|
||||
\func{void}{OnSize}{\param{wxSizeEvent\& }{event}}
|
||||
|
||||
event handlers
|
||||
Responds to size events, calling Layout.
|
||||
|
||||
|
||||
\membersection{wxDynamicToolBar::Realize}\label{wxdynamictoolbarrealize}
|
||||
|
||||
\func{bool}{Realize}{\void}
|
||||
|
||||
overriden from wxToolBarBase
|
||||
Overriden from wxToolBarBase; does nothing.
|
||||
|
||||
|
||||
\membersection{wxDynamicToolBar::RemveTool}\label{wxdynamictoolbarremvetool}
|
||||
|
||||
\func{void}{RemveTool}{\param{int }{toolIndex}}
|
||||
|
||||
Removes the given tool. Misspelt in order not to clash with a similar function
|
||||
in the base class.
|
||||
|
||||
|
||||
\membersection{wxDynamicToolBar::SetLayout}\label{wxdynamictoolbarsetlayout}
|
||||
|
||||
\func{void}{SetLayout}{\param{LayoutManagerBase* }{pLayout}}
|
||||
|
||||
Sets the layout for this toolbar.
|
||||
|
||||
|
||||
\membersection{wxDynamicToolBar::SizeToolWindows}\label{wxdynamictoolbarsizetoolwindows}
|
||||
|
||||
\func{void}{SizeToolWindows}{\void}
|
||||
|
||||
Internal function for sizing tool windows.
|
||||
|
||||
|
||||
@@ -1,14 +1,21 @@
|
||||
%
|
||||
% automatically generated by HelpGen $Revision$ from
|
||||
% dyntbar.h at 05/Jan/02 22:50:56
|
||||
% dyntbar.h at 21/Jan/02 21:14:18
|
||||
%
|
||||
|
||||
|
||||
\section{\class{wxDynToolInfo}}\label{wxdyntoolinfo}
|
||||
|
||||
|
||||
This class holds dynamic toolbar item information.
|
||||
|
||||
\wxheading{Derived from}
|
||||
|
||||
\helpref{wxToolLayoutItem}{wxtoollayoutitem}
|
||||
|
||||
\wxheading{Include files}
|
||||
|
||||
<dyntbar.h>
|
||||
|
||||
\wxheading{Data structures}
|
||||
|
||||
|
||||
@@ -1,20 +1,24 @@
|
||||
%
|
||||
% automatically generated by HelpGen $Revision$ from
|
||||
% controlbar.h at 05/Jan/02 22:50:58
|
||||
% controlbar.h at 21/Jan/02 21:14:13
|
||||
%
|
||||
|
||||
|
||||
\section{\class{wxFrameLayout}}\label{wxframelayout}
|
||||
|
||||
|
||||
wxFrameLayout manages containment and docking of control bars.
|
||||
which can be docked along top, bottom, righ, or left side of the
|
||||
parent frame
|
||||
|
||||
wxFrameLayout manages containment and docking of control bars,
|
||||
which can be docked along the top, bottom, right, or left side of the
|
||||
parent frame.
|
||||
|
||||
\wxheading{Derived from}
|
||||
|
||||
\helpref{wxEvtHandler}{wxevthandler}
|
||||
|
||||
\wxheading{Include files}
|
||||
|
||||
<controlbar.h>
|
||||
|
||||
\wxheading{Data structures}
|
||||
|
||||
\latexignore{\rtfignore{\wxheading{Members}}}
|
||||
@@ -24,160 +28,188 @@ wxFrameLayout manages containment and docking of control bars.
|
||||
|
||||
\func{}{wxFrameLayout}{\param{wxWindow* }{pParentFrame}, \param{wxWindow* }{pFrameClient = NULL}, \param{bool }{activateNow = TRUE}}
|
||||
|
||||
Constructor, taking parent window, the (MDI) client of the parent if there
|
||||
is one, and flag specifying whether to activate the layout.
|
||||
|
||||
|
||||
\func{}{wxFrameLayout}{\void}
|
||||
|
||||
used only while serializing
|
||||
Default constructor, used only for serialization.
|
||||
|
||||
|
||||
\membersection{wxFrameLayout::\destruct{wxFrameLayout}}\label{wxframelayoutdtor}
|
||||
|
||||
\func{}{\destruct{wxFrameLayout}}{\void}
|
||||
|
||||
(doesn't destroy bar windows)
|
||||
Destructor. It does not destroy the bar windows.
|
||||
|
||||
|
||||
\membersection{wxFrameLayout::Activate}\label{wxframelayoutactivate}
|
||||
|
||||
\func{void}{Activate}{\void}
|
||||
|
||||
Can be called after some other layout has been deactivated,
|
||||
and this one must "take over" the current contents of frame window.
|
||||
Effectively hooks itself to the frame window, re-displays all not-hidden
|
||||
bar-windows and repaints decorations
|
||||
Activate can be called after some other layout has been deactivated,
|
||||
and this one must take over the current contents of the frame window.
|
||||
Effectively hooks itself to the frame window, re-displays all non-hidden
|
||||
bar windows and repaints the decorations.
|
||||
|
||||
|
||||
\membersection{wxFrameLayout::AddBar}\label{wxframelayoutaddbar}
|
||||
|
||||
\func{void}{AddBar}{\param{wxWindow* }{pBarWnd}, \param{const cbDimInfo\& }{dimInfo}, \param{int }{alignment = FL\_ALIGN\_TOP}, \param{int }{rowNo = 0}, \param{int }{columnPos = 0}, \param{const wxString\& }{name = "bar"}, \param{bool }{spyEvents = FALSE}, \param{int }{state = wxCBAR\_DOCKED\_HORIZONTALLY}}
|
||||
|
||||
Adds bar information to frame-layout, appearence of layout is not refreshed
|
||||
immediately, RefreshNow() can be called if necessary.
|
||||
NOTES:: argument pBarWnd can by NULL, resulting bar decorations to be drawn
|
||||
Adds bar information to the frame layout. The appearance of the layout is not refreshed
|
||||
immediately; RefreshNow() can be called if necessary.
|
||||
Notes: the argument pBarWnd can by NULL, resulting in bar decorations to be drawn
|
||||
around the empty rectangle (filled with default background colour).
|
||||
Argument dimInfo, can be re-used for adding any number of bars, since
|
||||
it is not used directly, instead it's members are copied. If dimensions-
|
||||
handler is present, it's instance shared (reference counted). Dimension
|
||||
handler should always be allocated on the heap!)
|
||||
Argument dimInfo can be reused for adding any number of bars, since
|
||||
it is not used directly - instead its members are copied. If the dimensions
|
||||
handler is present, its instance is shared (reference counted). The dimension
|
||||
handler should always be allocated on the heap.
|
||||
pBarWnd is the window to be managed.
|
||||
dimInfo contains dimension information.
|
||||
alignment is a value such as FL\_ALIGN\_TOP.
|
||||
rowNo is the vertical position or row in the pane (if in docked state).
|
||||
columnPos is the horizontal position within the row in pixels (if in docked state).
|
||||
name is a name by which the bar can be referred in layout customization dialogs.
|
||||
If spyEvents is TRUE, input events for the bar should be "spyed" in order
|
||||
to forward unhandled mouse clicks to the frame layout, for example to enable
|
||||
easy draggablity of toolbars just by clicking on their interior regions.
|
||||
For widgets like text/tree control this value should be FALSE,
|
||||
since there's no certain way to detect whether the event was actually handled.
|
||||
state is the initial state, such as wxCBAR\_DOCKED\_HORIZONTALLY,
|
||||
wxCBAR\_FLOATING, wxCBAR\_HIDDEN.
|
||||
|
||||
|
||||
\membersection{wxFrameLayout::AddPlugin}\label{wxframelayoutaddplugin}
|
||||
|
||||
\func{void}{AddPlugin}{\param{wxClassInfo* }{pPlInfo}, \param{int }{paneMask = wxALL\_PANES}}
|
||||
|
||||
"Advanced" methods for plugin-configuration using their dynamic class information (e.g. CLASSINFO(pluginClass) ) first checks if plugin of the given class is already "hooked up",
|
||||
if not, adds it to the top of plugins chain
|
||||
An advanced methods for plugin configuration using their
|
||||
dynamic class information, for example CLASSINFO(pluginClass).
|
||||
First checks if the plugin of the given class is already "hooked up".
|
||||
If not, adds it to the top of the plugins chain.
|
||||
|
||||
|
||||
\membersection{wxFrameLayout::AddPluginBefore}\label{wxframelayoutaddpluginbefore}
|
||||
|
||||
\func{void}{AddPluginBefore}{\param{wxClassInfo* }{pNextPlInfo}, \param{wxClassInfo* }{pPlInfo}, \param{int }{paneMask = wxALL\_PANES}}
|
||||
|
||||
first checks if plugin of the givne class already hooked,
|
||||
if so, removes it, and then inserts it to the chain
|
||||
before plugin of the class given by "pNextPlInfo"
|
||||
NOTE:: this method is "handy" in some cases, where the order
|
||||
of plugin-chain could be important, e.g. one plugin overrides
|
||||
some functionallity of the other already hooked plugin,
|
||||
thefore the former should be hooked before the one
|
||||
who's functionality is being overriden
|
||||
First checks if the plugin of the given class is already hooked.
|
||||
If so, removes it, and then inserts it into the chain
|
||||
before the plugin of the class given by pNextPlInfo.
|
||||
Note: this method is handy in some cases where the order
|
||||
of the plugin-chain could be important, for example when one plugin overrides
|
||||
some functionality of another already-hooked plugin,
|
||||
so that the former plugin should be hooked before the one
|
||||
whose functionality is being overridden.
|
||||
|
||||
|
||||
\membersection{wxFrameLayout::ApplyBarProperties}\label{wxframelayoutapplybarproperties}
|
||||
|
||||
\func{void}{ApplyBarProperties}{\param{cbBarInfo* }{pBar}}
|
||||
|
||||
reflects changes in bar information structure visually
|
||||
(e.g. moves bar, changes it's dimension info, pane to which it is docked)
|
||||
Reflects changes in bar information structure visually.
|
||||
For example, moves the bar, changes its dimension information,
|
||||
or changes the pane to which it is docked.
|
||||
|
||||
|
||||
\membersection{wxFrameLayout::CanReparent}\label{wxframelayoutcanreparent}
|
||||
|
||||
\func{bool}{CanReparent}{\void}
|
||||
|
||||
NOTE:: reparenting of windows may NOT work on all platforms
|
||||
(reparenting allows control-bars to be floated)
|
||||
Returns TRUE if the platform allows reparenting. This may not return TRUE
|
||||
for all platforms. Reparenting allows control bars to be floated.
|
||||
|
||||
|
||||
\membersection{wxFrameLayout::CaptureEventsForPane}\label{wxframelayoutcaptureeventsforpane}
|
||||
|
||||
\func{void}{CaptureEventsForPane}{\param{cbDockPane* }{toPane}}
|
||||
|
||||
called by plugins ( also captures/releases mouse in parent frame)
|
||||
Called by plugins; also captures the mouse in the parent frame.
|
||||
|
||||
|
||||
\membersection{wxFrameLayout::CaptureEventsForPlugin}\label{wxframelayoutcaptureeventsforplugin}
|
||||
|
||||
\func{void}{CaptureEventsForPlugin}{\param{cbPluginBase* }{pPlugin}}
|
||||
|
||||
captures/releases user-input event's for the given plugin
|
||||
Input events are: mouse movement, mouse clicks, keyboard input
|
||||
Captures user input events for the given plugin.
|
||||
Input events are: mouse movement, mouse clicks, keyboard input.
|
||||
|
||||
|
||||
\membersection{wxFrameLayout::CreateCursors}\label{wxframelayoutcreatecursors}
|
||||
|
||||
\func{void}{CreateCursors}{\void}
|
||||
|
||||
Creates the cursors.
|
||||
|
||||
|
||||
\membersection{wxFrameLayout::CreateUpdatesManager}\label{wxframelayoutcreateupdatesmanager}
|
||||
|
||||
\func{cbUpdatesManagerBase*}{CreateUpdatesManager}{\void}
|
||||
|
||||
factory method
|
||||
Returns a new cbGCUpdatesMgr object.
|
||||
|
||||
|
||||
\membersection{wxFrameLayout::Deactivate}\label{wxframelayoutdeactivate}
|
||||
|
||||
\func{void}{Deactivate}{\void}
|
||||
|
||||
unhooks itself from frame window, and hides all not-hidden windows
|
||||
NOTE:: two frame-layouts should not be active at the same time in the
|
||||
same frame window, it would cause messy overlapping of bar windows
|
||||
from both layouts
|
||||
Deactivate unhooks itself from frame window, and hides all non-hidden windows.
|
||||
Note: two frame layouts should not be active at the same time in the
|
||||
same frame window, since it would cause messy overlapping of bar windows
|
||||
from both layouts.
|
||||
|
||||
|
||||
\membersection{wxFrameLayout::DestroyBarWindows}\label{wxframelayoutdestroybarwindows}
|
||||
|
||||
\func{void}{DestroyBarWindows}{\void}
|
||||
|
||||
Destroys the bar windows.
|
||||
|
||||
|
||||
\membersection{wxFrameLayout::DoSetBarState}\label{wxframelayoutdosetbarstate}
|
||||
|
||||
\func{void}{DoSetBarState}{\param{cbBarInfo* }{pBar}}
|
||||
|
||||
Applies the state to the window objects.
|
||||
|
||||
|
||||
\membersection{wxFrameLayout::EnableFloating}\label{wxframelayoutenablefloating}
|
||||
|
||||
\func{void}{EnableFloating}{\param{bool }{enable = TRUE}}
|
||||
|
||||
(by default floating of control-bars is ON)
|
||||
Enables floating behaviour. By default floating of control bars is on.
|
||||
|
||||
|
||||
\membersection{wxFrameLayout::FindBarByName}\label{wxframelayoutfindbarbyname}
|
||||
|
||||
\func{cbBarInfo*}{FindBarByName}{\param{const wxString\& }{name}}
|
||||
|
||||
methods for access and modification of bars in frame layout
|
||||
Finds the bar in the framelayout, by name.
|
||||
|
||||
|
||||
\membersection{wxFrameLayout::FindBarByWindow}\label{wxframelayoutfindbarbywindow}
|
||||
|
||||
\func{cbBarInfo*}{FindBarByWindow}{\param{const wxWindow* }{pWnd}}
|
||||
|
||||
Finds the bar in the framelayout, by window.
|
||||
|
||||
|
||||
\membersection{wxFrameLayout::FindPlugin}\label{wxframelayoutfindplugin}
|
||||
|
||||
\func{cbPluginBase*}{FindPlugin}{\param{wxClassInfo* }{pPlInfo}}
|
||||
|
||||
returns NULL, if plugin of the given class is not hooked
|
||||
Finds a plugin with the given class, or returns NULL if a plugin of the given
|
||||
class is not hooked.
|
||||
|
||||
|
||||
\membersection{wxFrameLayout::FirePluginEvent}\label{wxframelayoutfirepluginevent}
|
||||
|
||||
\func{void}{FirePluginEvent}{\param{cbPluginEvent\& }{event}}
|
||||
|
||||
plugin-related methods **should be used, instead of passing the event to ProcessEvent(..) method
|
||||
of the top-plugin directly. This method checks if events are currently
|
||||
This function should be used instead of passing the event to the ProcessEvent method
|
||||
of the top-level plugin directly. This method checks if events are currently
|
||||
captured and ensures that plugin-event is routed correctly.
|
||||
|
||||
|
||||
@@ -185,361 +217,439 @@ captured and ensures that plugin-event is routed correctly.
|
||||
|
||||
\func{void}{ForwardMouseEvent}{\param{wxMouseEvent\& }{event}, \param{cbDockPane* }{pToPane}, \param{int }{eventType}}
|
||||
|
||||
delegated from "bar-spy"
|
||||
Delegated from "bar-spy".
|
||||
|
||||
|
||||
\membersection{wxFrameLayout::GetBarPane}\label{wxframelayoutgetbarpane}
|
||||
|
||||
\func{cbDockPane*}{GetBarPane}{\param{cbBarInfo* }{pBar}}
|
||||
|
||||
returns panes, to which the given bar belongs
|
||||
Returns the pane to which the given bar belongs.
|
||||
|
||||
|
||||
\membersection{wxFrameLayout::GetBars}\label{wxframelayoutgetbars}
|
||||
|
||||
\func{BarArrayT\&}{GetBars}{\void}
|
||||
|
||||
Gets an array of bars.
|
||||
|
||||
|
||||
\membersection{wxFrameLayout::GetClientHeight}\label{wxframelayoutgetclientheight}
|
||||
|
||||
\func{int}{GetClientHeight}{\void}
|
||||
|
||||
Returns the client height.
|
||||
|
||||
|
||||
\membersection{wxFrameLayout::GetClientRect}\label{wxframelayoutgetclientrect}
|
||||
|
||||
\func{wxRect\&}{GetClientRect}{\void}
|
||||
|
||||
Returns the client's rectangle.
|
||||
|
||||
|
||||
\membersection{wxFrameLayout::GetClientWidth}\label{wxframelayoutgetclientwidth}
|
||||
|
||||
\func{int}{GetClientWidth}{\void}
|
||||
|
||||
Returns the client width.
|
||||
|
||||
|
||||
\membersection{wxFrameLayout::GetFrameClient}\label{wxframelayoutgetframeclient}
|
||||
|
||||
\func{wxWindow*}{GetFrameClient}{\void}
|
||||
|
||||
Returns the frame client, or NULL if not present.
|
||||
|
||||
|
||||
\membersection{wxFrameLayout::GetPane}\label{wxframelayoutgetpane}
|
||||
|
||||
\func{cbDockPane*}{GetPane}{\param{int }{alignment}}
|
||||
|
||||
see pane alignment types
|
||||
Returns a pane for the given alignment. See pane alignment types.
|
||||
|
||||
|
||||
\membersection{wxFrameLayout::GetPaneProperties}\label{wxframelayoutgetpaneproperties}
|
||||
|
||||
\func{void}{GetPaneProperties}{\param{cbCommonPaneProperties\& }{props}, \param{int }{alignment = FL\_ALIGN\_TOP}}
|
||||
|
||||
NOTE:: changing properties of panes, does not result immediate on-screen update
|
||||
Gets the pane properties for the given alignment.
|
||||
|
||||
|
||||
\membersection{wxFrameLayout::GetPanesArray}\label{wxframelayoutgetpanesarray}
|
||||
|
||||
\func{cbDockPane**}{GetPanesArray}{\void}
|
||||
|
||||
used by updates-managers
|
||||
Returns an array of panes. Used by update managers.
|
||||
|
||||
|
||||
\membersection{wxFrameLayout::GetParentFrame}\label{wxframelayoutgetparentframe}
|
||||
|
||||
\func{wxWindow\&}{GetParentFrame}{\void}
|
||||
|
||||
Returns the parent frame.
|
||||
|
||||
|
||||
\membersection{wxFrameLayout::GetPrevClientRect}\label{wxframelayoutgetprevclientrect}
|
||||
|
||||
\func{wxRect\&}{GetPrevClientRect}{\void}
|
||||
|
||||
Returns the previous client window rectangle.
|
||||
|
||||
|
||||
\membersection{wxFrameLayout::GetTopPlugin}\label{wxframelayoutgettopplugin}
|
||||
|
||||
\func{cbPluginBase\&}{GetTopPlugin}{\void}
|
||||
|
||||
returns current top-level plugin (the one which receives events first,
|
||||
with an exception if input-events are currently captured by some other plugin)
|
||||
Returns the current top-level plugin (the one that receives events first,
|
||||
except if input events are currently captured by some other plugin).
|
||||
|
||||
|
||||
\membersection{wxFrameLayout::GetUpdatesManager}\label{wxframelayoutgetupdatesmanager}
|
||||
|
||||
\func{cbUpdatesManagerBase\&}{GetUpdatesManager}{\void}
|
||||
|
||||
NOTE:: in future ubdates-manager will become a normal plugin
|
||||
Returns a reference to the updates manager.
|
||||
Note: in future, the updates manager will become a normal plugin.
|
||||
|
||||
|
||||
\membersection{wxFrameLayout::HasTopPlugin}\label{wxframelayouthastopplugin}
|
||||
|
||||
\func{bool}{HasTopPlugin}{\void}
|
||||
|
||||
Returns true if there is a top plugin.
|
||||
|
||||
|
||||
\membersection{wxFrameLayout::HideBarWindows}\label{wxframelayouthidebarwindows}
|
||||
|
||||
\func{void}{HideBarWindows}{\void}
|
||||
|
||||
also hides the client window if presents
|
||||
Hides the bar windows, and also the client window if present.
|
||||
|
||||
|
||||
\membersection{wxFrameLayout::HitTestPane}\label{wxframelayouthittestpane}
|
||||
|
||||
\func{bool}{HitTestPane}{\param{cbDockPane* }{pPane}, \param{int }{x}, \param{int }{y}}
|
||||
|
||||
Returns TRUE if the position is within the given pane.
|
||||
|
||||
|
||||
\membersection{wxFrameLayout::HitTestPanes}\label{wxframelayouthittestpanes}
|
||||
|
||||
\func{cbDockPane*}{HitTestPanes}{\param{const wxRect\& }{rect}, \param{cbDockPane* }{pCurPane}}
|
||||
|
||||
Returns the pane for which the rectangle hit test succeeds, giving
|
||||
preference to the given pane if supplied.
|
||||
|
||||
|
||||
\membersection{wxFrameLayout::HookUpToFrame}\label{wxframelayouthookuptoframe}
|
||||
|
||||
\func{void}{HookUpToFrame}{\void}
|
||||
|
||||
Hooks the layout up to the frame (pushes the layout onto the
|
||||
frame's event handler stack).
|
||||
|
||||
|
||||
\membersection{wxFrameLayout::InverseVisibility}\label{wxframelayoutinversevisibility}
|
||||
|
||||
\func{void}{InverseVisibility}{\param{cbBarInfo* }{pBar}}
|
||||
|
||||
Toggles the bar between visible and hidden.
|
||||
|
||||
|
||||
\membersection{wxFrameLayout::LocateBar}\label{wxframelayoutlocatebar}
|
||||
|
||||
\func{bool}{LocateBar}{\param{cbBarInfo* }{pBarInfo}, \param{cbRowInfo** }{ppRow}, \param{cbDockPane** }{ppPane}}
|
||||
|
||||
The purpose of this function is unknown.
|
||||
|
||||
|
||||
\membersection{wxFrameLayout::OnActivate}\label{wxframelayoutonactivate}
|
||||
|
||||
\func{void}{OnActivate}{\param{wxActivateEvent\& }{event}}
|
||||
|
||||
Handles activation events. Currently does nothing.
|
||||
|
||||
|
||||
\membersection{wxFrameLayout::OnEraseBackground}\label{wxframelayoutonerasebackground}
|
||||
|
||||
\func{void}{OnEraseBackground}{\param{wxEraseEvent\& }{event}}
|
||||
|
||||
Handles background erase events. Currently does nothing.
|
||||
|
||||
|
||||
\membersection{wxFrameLayout::OnIdle}\label{wxframelayoutonidle}
|
||||
|
||||
\func{void}{OnIdle}{\param{wxIdleEvent\& }{event}}
|
||||
|
||||
Handles idle events.
|
||||
|
||||
|
||||
\membersection{wxFrameLayout::OnKillFocus}\label{wxframelayoutonkillfocus}
|
||||
|
||||
\func{void}{OnKillFocus}{\param{wxFocusEvent\& }{event}}
|
||||
|
||||
Handles focus kill events. Currently does nothing.
|
||||
|
||||
|
||||
\membersection{wxFrameLayout::OnLButtonDown}\label{wxframelayoutonlbuttondown}
|
||||
|
||||
\func{void}{OnLButtonDown}{\param{wxMouseEvent\& }{event}}
|
||||
|
||||
Event handler for a left down button event.
|
||||
|
||||
|
||||
\membersection{wxFrameLayout::OnLButtonUp}\label{wxframelayoutonlbuttonup}
|
||||
|
||||
\func{void}{OnLButtonUp}{\param{wxMouseEvent\& }{event}}
|
||||
|
||||
Event handler for a left button up event.
|
||||
|
||||
|
||||
\membersection{wxFrameLayout::OnLDblClick}\label{wxframelayoutonldblclick}
|
||||
|
||||
\func{void}{OnLDblClick}{\param{wxMouseEvent\& }{event}}
|
||||
|
||||
Event handler for a left doubleclick button event.
|
||||
|
||||
|
||||
\membersection{wxFrameLayout::OnMouseMove}\label{wxframelayoutonmousemove}
|
||||
|
||||
\func{void}{OnMouseMove}{\param{wxMouseEvent\& }{event}}
|
||||
|
||||
Event handler for a mouse move event.
|
||||
|
||||
|
||||
\membersection{wxFrameLayout::OnPaint}\label{wxframelayoutonpaint}
|
||||
|
||||
\func{void}{OnPaint}{\param{wxPaintEvent\& }{event}}
|
||||
|
||||
Handles paint events, calling PaintPane for each pane.
|
||||
|
||||
|
||||
\membersection{wxFrameLayout::OnRButtonDown}\label{wxframelayoutonrbuttondown}
|
||||
|
||||
\func{void}{OnRButtonDown}{\param{wxMouseEvent\& }{event}}
|
||||
|
||||
Event handler for a right button down event.
|
||||
|
||||
|
||||
\membersection{wxFrameLayout::OnRButtonUp}\label{wxframelayoutonrbuttonup}
|
||||
|
||||
\func{void}{OnRButtonUp}{\param{wxMouseEvent\& }{event}}
|
||||
|
||||
Event handler for a right button up event.
|
||||
|
||||
|
||||
\membersection{wxFrameLayout::OnSetFocus}\label{wxframelayoutonsetfocus}
|
||||
|
||||
\func{void}{OnSetFocus}{\param{wxFocusEvent\& }{event}}
|
||||
|
||||
Handles focus set events. Currently does nothing.
|
||||
|
||||
|
||||
\membersection{wxFrameLayout::OnSize}\label{wxframelayoutonsize}
|
||||
|
||||
\func{void}{OnSize}{\param{wxSizeEvent\& }{event}}
|
||||
|
||||
event handlers
|
||||
Event handler for a size event.
|
||||
|
||||
|
||||
\membersection{wxFrameLayout::PopAllPlugins}\label{wxframelayoutpopallplugins}
|
||||
|
||||
\func{void}{PopAllPlugins}{\void}
|
||||
|
||||
Pop all plugins.
|
||||
|
||||
|
||||
\membersection{wxFrameLayout::PopPlugin}\label{wxframelayoutpopplugin}
|
||||
|
||||
\func{void}{PopPlugin}{\void}
|
||||
|
||||
Similar to wxWindow's "push/pop-event-handler" methods, execept
|
||||
that the plugin is deleted upon "popping".
|
||||
|
||||
|
||||
\membersection{wxFrameLayout::PositionClientWindow}\label{wxframelayoutpositionclientwindow}
|
||||
|
||||
\func{void}{PositionClientWindow}{\void}
|
||||
|
||||
called to set calculated layout to window objects
|
||||
Called to apply the calculated layout to window objects.
|
||||
|
||||
|
||||
\membersection{wxFrameLayout::PositionPanes}\label{wxframelayoutpositionpanes}
|
||||
|
||||
\func{void}{PositionPanes}{\void}
|
||||
|
||||
Called to apply the calculated layout to window objects.
|
||||
|
||||
|
||||
\membersection{wxFrameLayout::PushDefaultPlugins}\label{wxframelayoutpushdefaultplugins}
|
||||
|
||||
\func{void}{PushDefaultPlugins}{\void}
|
||||
|
||||
default plugins are : cbPaneDrawPlugin, cbRowLayoutPlugin, cbBarDragPlugin,
|
||||
cbAntiflickerPlugin, cbSimpleCustomizePlugin
|
||||
this method is automatically invoked, if no plugins were found upon
|
||||
fireing of the first plugin-event, i.e. wxFrameLayout *CONFIGURES* itself
|
||||
Adds the default plugins. These are cbPaneDrawPlugin, cbRowLayoutPlugin, cbBarDragPlugin,
|
||||
cbAntiflickerPlugin, cbSimpleCustomizePlugin.
|
||||
This method is automatically invoked if no plugins were found upon
|
||||
firing of the first plugin-event, i.e. when wxFrameLayout configures itself.
|
||||
|
||||
|
||||
\membersection{wxFrameLayout::PushPlugin}\label{wxframelayoutpushplugin}
|
||||
|
||||
\func{void}{PushPlugin}{\param{cbPluginBase* }{pPugin}}
|
||||
|
||||
similar to wxWindow's "push/pop-event-handler" methods, execept
|
||||
that plugin is *deleted* upon "popping"
|
||||
Similar to wxWindow's "push/pop-event-handler" methods, execept
|
||||
that the plugin is deleted upon "popping".
|
||||
|
||||
|
||||
\membersection{wxFrameLayout::RecalcLayout}\label{wxframelayoutrecalclayout}
|
||||
|
||||
\func{void}{RecalcLayout}{\param{bool }{repositionBarsNow = FALSE}}
|
||||
|
||||
recalcualtes layout of panes, and all bars/rows in each pane
|
||||
Recalculates the layout of panes, and all bars/rows in each pane.
|
||||
|
||||
|
||||
\membersection{wxFrameLayout::RedockBar}\label{wxframelayoutredockbar}
|
||||
|
||||
\func{bool}{RedockBar}{\param{cbBarInfo* }{pBar}, \param{const wxRect\& }{shapeInParent}, \param{cbDockPane* }{pToPane = NULL}, \param{bool }{updateNow = TRUE}}
|
||||
|
||||
can be used for repositioning already existing bars. The given bar is first removed
|
||||
ReddockBar can be used for repositioning existing bars. The given bar is first removed
|
||||
from the pane it currently belongs to, and inserted into the pane, which "matches"
|
||||
the given recantular area. If pToPane is not NULL, bar is docked to this given pane
|
||||
to dock the bar which is floated, use wxFrameLayout::DockBar(..) method
|
||||
the given rectangular area. If pToPane is not NULL, the bar is docked to this given pane.
|
||||
To dock a bar which is floating, use the wxFrameLayout::DockBar method.
|
||||
|
||||
|
||||
\membersection{wxFrameLayout::RefreshNow}\label{wxframelayoutrefreshnow}
|
||||
|
||||
\func{void}{RefreshNow}{\param{bool }{recalcLayout = TRUE}}
|
||||
|
||||
recalculates layoute and performs on-screen update of all panes
|
||||
Recalculates layout and performs on-screen update of all panes.
|
||||
|
||||
|
||||
\membersection{wxFrameLayout::ReleaseEventsFromPane}\label{wxframelayoutreleaseeventsfrompane}
|
||||
|
||||
\func{void}{ReleaseEventsFromPane}{\param{cbDockPane* }{fromPane}}
|
||||
|
||||
Called by plugins; also releases mouse in the parent frame.
|
||||
|
||||
|
||||
\membersection{wxFrameLayout::ReleaseEventsFromPlugin}\label{wxframelayoutreleaseeventsfromplugin}
|
||||
|
||||
\func{void}{ReleaseEventsFromPlugin}{\param{cbPluginBase* }{pPlugin}}
|
||||
|
||||
Releases user input events for the given plugin.
|
||||
Input events are: mouse movement, mouse clicks, keyboard input
|
||||
|
||||
|
||||
\membersection{wxFrameLayout::RemoveBar}\label{wxframelayoutremovebar}
|
||||
|
||||
\func{void}{RemoveBar}{\param{cbBarInfo* }{pBar}}
|
||||
|
||||
removes bar from layout permanently, hides it's corresponding window if present
|
||||
Removes the bar from the layout permanently, and hides its corresponding window if present.
|
||||
|
||||
|
||||
\membersection{wxFrameLayout::RemovePlugin}\label{wxframelayoutremoveplugin}
|
||||
|
||||
\func{void}{RemovePlugin}{\param{wxClassInfo* }{pPlInfo}}
|
||||
|
||||
checks if plugin of the given class is hooked, removes
|
||||
it if found
|
||||
@param pPlInfo class information structure for the plugin
|
||||
@note
|
||||
@see wxFrameLayout::Method
|
||||
Checks if the plugin of the given class is hooked, and removes
|
||||
it if found.
|
||||
|
||||
|
||||
\membersection{wxFrameLayout::ReparentWindow}\label{wxframelayoutreparentwindow}
|
||||
|
||||
\func{void}{ReparentWindow}{\param{wxWindow* }{pChild}, \param{wxWindow* }{pNewParent}}
|
||||
|
||||
Reparents pChild to have parent pNewParent.
|
||||
|
||||
|
||||
\membersection{wxFrameLayout::RepositionFloatedBar}\label{wxframelayoutrepositionfloatedbar}
|
||||
|
||||
\func{void}{RepositionFloatedBar}{\param{cbBarInfo* }{pBar}}
|
||||
|
||||
Applies the calculated layout to a floating bar.
|
||||
|
||||
|
||||
\membersection{wxFrameLayout::RouteMouseEvent}\label{wxframelayoutroutemouseevent}
|
||||
|
||||
\func{void}{RouteMouseEvent}{\param{wxMouseEvent\& }{event}, \param{int }{pluginEvtType}}
|
||||
|
||||
Routes the mouse event to the appropriate pane.
|
||||
|
||||
|
||||
\membersection{wxFrameLayout::SetBarState}\label{wxframelayoutsetbarstate}
|
||||
|
||||
\func{void}{SetBarState}{\param{cbBarInfo* }{pBar}, \param{int }{newStatem}, \param{bool }{updateNow}}
|
||||
|
||||
changes bar's docking state (see possible control bar states)
|
||||
Changes the bar's docking state (see possible control bar states).
|
||||
|
||||
|
||||
\membersection{wxFrameLayout::SetFrameClient}\label{wxframelayoutsetframeclient}
|
||||
|
||||
\func{void}{SetFrameClient}{\param{wxWindow* }{pFrameClient}}
|
||||
|
||||
passes the client window (e.g. MDI-client frame) to be controled by
|
||||
Passes the client window (e.g. MDI client window) to be controlled by
|
||||
frame layout, the size and position of which should be adjusted to be
|
||||
surrounded by controlbar panes, whenever frame is resized, or dimensions
|
||||
of control panes change
|
||||
surrounded by controlbar panes, whenever the frame is resized or the dimensions
|
||||
of control panes change.
|
||||
|
||||
|
||||
\membersection{wxFrameLayout::SetMargins}\label{wxframelayoutsetmargins}
|
||||
|
||||
\func{void}{SetMargins}{\param{int }{top}, \param{int }{bottom}, \param{int }{left}, \param{int }{right}, \param{int }{paneMask = wxALL\_PANES}}
|
||||
|
||||
TODO:: margins should go into cbCommonPaneProperties in the future
|
||||
NOTE:: this method should be called before any custom plugins are attached
|
||||
Sets the margins for the given panes.
|
||||
The margins should go into cbCommonPaneProperties in the future.
|
||||
Note: this method should be called before any custom plugins are attached.
|
||||
|
||||
|
||||
\membersection{wxFrameLayout::SetPaneBackground}\label{wxframelayoutsetpanebackground}
|
||||
|
||||
\func{void}{SetPaneBackground}{\param{const wxColour\& }{colour}}
|
||||
|
||||
Sets the pane background colour.
|
||||
|
||||
|
||||
\membersection{wxFrameLayout::SetPaneProperties}\label{wxframelayoutsetpaneproperties}
|
||||
|
||||
\func{void}{SetPaneProperties}{\param{const cbCommonPaneProperties\& }{props}, \param{int }{paneMask = wxALL\_PANES}}
|
||||
|
||||
Sets the pane properties for the given alignment.
|
||||
Note: changing properties of panes does not result immediate on-screen update.
|
||||
|
||||
|
||||
\membersection{wxFrameLayout::SetTopPlugin}\label{wxframelayoutsettopplugin}
|
||||
|
||||
\func{void}{SetTopPlugin}{\param{cbPluginBase* }{pPlugin}}
|
||||
|
||||
hooking custom plugins to frame layout
|
||||
NOTE:: when hooking one plugin on top of the other -
|
||||
use SetNextHandler(..) or similar methods
|
||||
Hooking custom plugins to frame layout.
|
||||
Note: when hooking one plugin on top of the other,
|
||||
use SetNextHandler or similar methods
|
||||
of wxEvtHandler class to compose the chain of plugins,
|
||||
than pass the left-most handler in this chain to
|
||||
the above methods (assuming that events are delegated
|
||||
from left-most towards right-most handler)
|
||||
NOTE2:: this secenario is very inconvenient and "low-level",
|
||||
use Add/Push/PopPlugin methods instead
|
||||
from left-most towards right-most handler).
|
||||
This secenario is very inconvenient and "low-level",
|
||||
so use the Add/Push/PopPlugin methods instead.
|
||||
|
||||
|
||||
\membersection{wxFrameLayout::SetUpdatesManager}\label{wxframelayoutsetupdatesmanager}
|
||||
|
||||
\func{void}{SetUpdatesManager}{\param{cbUpdatesManagerBase* }{pUMgr}}
|
||||
|
||||
destroys the previous manager if any, set the new one
|
||||
Destroys the previous manager if any, and sets the new one.
|
||||
|
||||
|
||||
\membersection{wxFrameLayout::ShowFloatedWindows}\label{wxframelayoutshowfloatedwindows}
|
||||
|
||||
\func{void}{ShowFloatedWindows}{\param{bool }{show}}
|
||||
|
||||
Shows all floated windows.
|
||||
|
||||
|
||||
\membersection{wxFrameLayout::UnhookFromFrame}\label{wxframelayoutunhookfromframe}
|
||||
|
||||
\func{void}{UnhookFromFrame}{\void}
|
||||
|
||||
Unhooks the layout from the frame.
|
||||
|
||||
|
||||
@@ -1,18 +1,22 @@
|
||||
%
|
||||
% automatically generated by HelpGen $Revision$ from
|
||||
% garbagec.h at 05/Jan/02 22:50:57
|
||||
% garbagec.h at 21/Jan/02 21:14:19
|
||||
%
|
||||
|
||||
|
||||
\section{\class{GarbageCollector}}\label{garbagecollector}
|
||||
|
||||
|
||||
class implements extremely slow, but probably one of the most simple GC algorithms
|
||||
This class implements an extremely slow but simple garbage collection algorithm.
|
||||
|
||||
\wxheading{Derived from}
|
||||
|
||||
No base class
|
||||
|
||||
\wxheading{Include files}
|
||||
|
||||
<garbagec.h>
|
||||
|
||||
\wxheading{Data structures}
|
||||
|
||||
\latexignore{\rtfignore{\wxheading{Members}}}
|
||||
@@ -22,71 +26,89 @@ No base class
|
||||
|
||||
\func{}{GarbageCollector}{\void}
|
||||
|
||||
Default constructor.
|
||||
|
||||
|
||||
\membersection{GarbageCollector::\destruct{GarbageCollector}}\label{garbagecollectordtor}
|
||||
|
||||
\func{}{\destruct{GarbageCollector}}{\void}
|
||||
|
||||
Destructor.
|
||||
|
||||
|
||||
\membersection{GarbageCollector::AddDependency}\label{garbagecollectoradddependency}
|
||||
|
||||
\func{void}{AddDependency}{\param{void* }{pObj}, \param{void* }{pDependsOnObj}}
|
||||
|
||||
Prepare data for garbage collection.
|
||||
|
||||
|
||||
\membersection{GarbageCollector::AddObject}\label{garbagecollectoraddobject}
|
||||
|
||||
\func{void}{AddObject}{\param{void* }{pObj}, \param{int }{refCnt = 1}}
|
||||
|
||||
prepare data for GC alg.
|
||||
Prepare data for garbage collection.
|
||||
|
||||
|
||||
\membersection{GarbageCollector::ArrangeCollection}\label{garbagecollectorarrangecollection}
|
||||
|
||||
\func{void}{ArrangeCollection}{\void}
|
||||
|
||||
executes GC alg.
|
||||
Executes garbage collection algorithm.
|
||||
|
||||
|
||||
\membersection{GarbageCollector::DestroyItemList}\label{garbagecollectordestroyitemlist}
|
||||
|
||||
\func{void}{DestroyItemList}{\param{wxList\& }{lst}}
|
||||
|
||||
Destroys a list of items.
|
||||
|
||||
|
||||
\membersection{GarbageCollector::FindItemNode}\label{garbagecollectorfinditemnode}
|
||||
|
||||
\func{wxNode*}{FindItemNode}{\param{void* }{pForObj}}
|
||||
|
||||
Internal method for finding a node.
|
||||
|
||||
|
||||
\membersection{GarbageCollector::FindReferenceFreeItemNode}\label{garbagecollectorfindreferencefreeitemnode}
|
||||
|
||||
\func{wxNode*}{FindReferenceFreeItemNode}{\void}
|
||||
|
||||
Internal method for findind and freeing a node.
|
||||
|
||||
|
||||
\membersection{GarbageCollector::GetCycledObjects}\label{garbagecollectorgetcycledobjects}
|
||||
|
||||
\func{wxList\&}{GetCycledObjects}{\void}
|
||||
|
||||
Get cycled objects.
|
||||
|
||||
|
||||
\membersection{GarbageCollector::GetRegularObjects}\label{garbagecollectorgetregularobjects}
|
||||
|
||||
\func{wxList\&}{GetRegularObjects}{\void}
|
||||
|
||||
access results of the alg.
|
||||
Accesses the results of the algorithm.
|
||||
|
||||
|
||||
\membersection{GarbageCollector::RemoveReferencesToNode}\label{garbagecollectorremovereferencestonode}
|
||||
|
||||
\func{void}{RemoveReferencesToNode}{\param{wxNode* }{pItemNode}}
|
||||
|
||||
Remove references to this node.
|
||||
|
||||
|
||||
\membersection{GarbageCollector::Reset}\label{garbagecollectorreset}
|
||||
|
||||
\func{void}{Reset}{\void}
|
||||
|
||||
removes all data from GC
|
||||
Removes all data from the garbage collector.
|
||||
|
||||
|
||||
\membersection{GarbageCollector::ResolveReferences}\label{garbagecollectorresolvereferences}
|
||||
|
||||
\func{void}{ResolveReferences}{\void}
|
||||
|
||||
Internal method for resolving references.
|
||||
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
%
|
||||
% automatically generated by HelpGen $Revision$ from
|
||||
% garbagec.h at 05/Jan/02 22:50:57
|
||||
% garbagec.h at 21/Jan/02 21:14:19
|
||||
%
|
||||
|
||||
|
||||
@@ -10,5 +10,9 @@
|
||||
|
||||
No base class
|
||||
|
||||
\wxheading{Include files}
|
||||
|
||||
<garbagec.h>
|
||||
|
||||
\wxheading{Data structures}
|
||||
|
||||
|
||||
@@ -1,18 +1,22 @@
|
||||
%
|
||||
% automatically generated by HelpGen $Revision$ from
|
||||
% dyntbar.h at 05/Jan/02 22:50:56
|
||||
% dyntbar.h at 21/Jan/02 21:14:18
|
||||
%
|
||||
|
||||
|
||||
\section{\class{LayoutManagerBase}}\label{layoutmanagerbase}
|
||||
|
||||
|
||||
base class for layouting algorithm implementations
|
||||
This is a base class for layout algorithm implementations.
|
||||
|
||||
\wxheading{Derived from}
|
||||
|
||||
No base class
|
||||
|
||||
\wxheading{Include files}
|
||||
|
||||
<dyntbar.h>
|
||||
|
||||
\wxheading{Data structures}
|
||||
|
||||
\latexignore{\rtfignore{\wxheading{Members}}}
|
||||
@@ -22,8 +26,12 @@ No base class
|
||||
|
||||
\func{}{\destruct{LayoutManagerBase}}{\void}
|
||||
|
||||
Destructor.
|
||||
|
||||
|
||||
\membersection{LayoutManagerBase::Layout}\label{layoutmanagerbaselayout}
|
||||
|
||||
\func{void}{Layout}{\param{const wxSize\& }{parentDim}, \param{wxSize\& }{resultingDim}, \param{wxLayoutItemArrayT\& }{items}, \param{int }{horizGap}, \param{int }{vertGap}}
|
||||
|
||||
Constructor.
|
||||
|
||||
|
||||
@@ -85,7 +85,7 @@ $(DOCDIR)\htb\fl.htb: $(DOCDIR)\html\fl\fl.htm
|
||||
|
||||
# In order to force document reprocessing
|
||||
touchmanual:
|
||||
-touch $(WXDIR)\docs\latex\fl\manual.tex
|
||||
-touch $(WXDIR)\contrib\docs\latex\fl\manual.tex
|
||||
|
||||
updatedocs: touchmanual alldocs
|
||||
|
||||
|
||||
@@ -1,17 +1,21 @@
|
||||
%
|
||||
% automatically generated by HelpGen $Revision$ from
|
||||
% hintanimpl.h at 05/Jan/02 22:50:57
|
||||
% hintanimpl.h at 21/Jan/02 21:14:19
|
||||
%
|
||||
|
||||
|
||||
\section{\class{MorphInfoT}}\label{morphinfot}
|
||||
|
||||
|
||||
helper classes
|
||||
A private helper class.
|
||||
|
||||
\wxheading{Derived from}
|
||||
|
||||
No base class
|
||||
|
||||
\wxheading{Include files}
|
||||
|
||||
<hintanimpl.h>
|
||||
|
||||
\wxheading{Data structures}
|
||||
|
||||
|
||||
@@ -1,18 +1,23 @@
|
||||
%
|
||||
% automatically generated by HelpGen $Revision$ from
|
||||
% newbmpbtn.h at 05/Jan/02 22:50:57
|
||||
% newbmpbtn.h at 21/Jan/02 21:14:19
|
||||
%
|
||||
|
||||
|
||||
\section{\class{wxNewBitmapButton}}\label{wxnewbitmapbutton}
|
||||
|
||||
|
||||
alternative class for wxBmpButton
|
||||
This is an alternative class to wxBitmapButton. It is used
|
||||
in the implementation of dynamic toolbars.
|
||||
|
||||
\wxheading{Derived from}
|
||||
|
||||
\helpref{wxPanel}{wxpanel}
|
||||
|
||||
\wxheading{Include files}
|
||||
|
||||
<newbmpbtn.h>
|
||||
|
||||
\wxheading{Data structures}
|
||||
|
||||
\latexignore{\rtfignore{\wxheading{Members}}}
|
||||
@@ -22,116 +27,151 @@ alternative class for wxBmpButton
|
||||
|
||||
\func{}{wxNewBitmapButton}{\param{const wxBitmap\& }{labelBitmap = wxNullBitmap}, \param{const wxString\& }{labelText = ""}, \param{int }{alignText = NB\_ALIGN\_TEXT\_BOTTOM}, \param{bool }{isFlat = TRUE}, \param{int }{firedEventType = wxEVT\_COMMAND\_MENU\_SELECTED}, \param{int }{marginX = 2}, \param{int }{marginY = 2}, \param{int }{textToLabelGap = 2}, \param{bool }{isSticky = FALSE}}
|
||||
|
||||
Constructor.
|
||||
|
||||
|
||||
\func{}{wxNewBitmapButton}{\param{const wxString\& }{bitmapFileName}, \param{const wxBitmapType }{bitmapFileType = wxBITMAP\_TYPE\_BMP}, \param{const wxString\& }{labelText = ""}, \param{int }{alignText = NB\_ALIGN\_TEXT\_BOTTOM}, \param{bool }{isFlat = TRUE}, \param{int }{firedEventType = wxEVT\_COMMAND\_MENU\_SELECTED}, \param{int }{marginX = 2}, \param{int }{marginY = 2}, \param{int }{textToLabelGap = 2}, \param{bool }{isSticky = FALSE}}
|
||||
|
||||
use this constructor if buttons have to be persistant
|
||||
Use this constructor if buttons have to be persistant
|
||||
|
||||
|
||||
\membersection{wxNewBitmapButton::\destruct{wxNewBitmapButton}}\label{wxnewbitmapbuttondtor}
|
||||
|
||||
\func{}{\destruct{wxNewBitmapButton}}{\void}
|
||||
|
||||
Destructor.
|
||||
|
||||
|
||||
\membersection{wxNewBitmapButton::DestroyLabels}\label{wxnewbitmapbuttondestroylabels}
|
||||
|
||||
\func{void}{DestroyLabels}{\void}
|
||||
|
||||
Internal function for destroying labels.
|
||||
|
||||
|
||||
\membersection{wxNewBitmapButton::DrawDecorations}\label{wxnewbitmapbuttondrawdecorations}
|
||||
|
||||
\func{void}{DrawDecorations}{\param{wxDC\& }{dc}}
|
||||
|
||||
Draws the decorations.
|
||||
|
||||
|
||||
\membersection{wxNewBitmapButton::DrawLabel}\label{wxnewbitmapbuttondrawlabel}
|
||||
|
||||
\func{void}{DrawLabel}{\param{wxDC\& }{dc}}
|
||||
|
||||
Draws the label.
|
||||
|
||||
|
||||
\membersection{wxNewBitmapButton::DrawShade}\label{wxnewbitmapbuttondrawshade}
|
||||
|
||||
\func{void}{DrawShade}{\param{int }{outerLevel}, \param{wxDC\& }{dc}, \param{wxPen\& }{upperLeftSidePen}, \param{wxPen\& }{lowerRightSidePen}}
|
||||
|
||||
Draws shading on the button.
|
||||
|
||||
|
||||
\membersection{wxNewBitmapButton::GetStateLabel}\label{wxnewbitmapbuttongetstatelabel}
|
||||
|
||||
\func{wxBitmap*}{GetStateLabel}{\void}
|
||||
|
||||
returns the label which match the current button state
|
||||
Returns the label that matches the current button state.
|
||||
|
||||
|
||||
\membersection{wxNewBitmapButton::IsInWindow}\label{wxnewbitmapbuttonisinwindow}
|
||||
|
||||
\func{bool}{IsInWindow}{\param{int }{x}, \param{int }{y}}
|
||||
|
||||
Returns TRUE if the given point is in the window.
|
||||
|
||||
|
||||
\membersection{wxNewBitmapButton::OnEraseBackground}\label{wxnewbitmapbuttononerasebackground}
|
||||
|
||||
\func{void}{OnEraseBackground}{\param{wxEraseEvent\& }{event}}
|
||||
|
||||
Responds to an erase background event.
|
||||
|
||||
|
||||
\membersection{wxNewBitmapButton::OnKillFocus}\label{wxnewbitmapbuttononkillfocus}
|
||||
|
||||
\func{void}{OnKillFocus}{\param{wxFocusEvent\& }{event}}
|
||||
|
||||
Responds to a kill focus event.
|
||||
|
||||
|
||||
\membersection{wxNewBitmapButton::OnLButtonDown}\label{wxnewbitmapbuttononlbuttondown}
|
||||
|
||||
\func{void}{OnLButtonDown}{\param{wxMouseEvent\& }{event}}
|
||||
|
||||
event handlers
|
||||
Responds to a left mouse button down event.
|
||||
|
||||
|
||||
\membersection{wxNewBitmapButton::OnLButtonUp}\label{wxnewbitmapbuttononlbuttonup}
|
||||
|
||||
\func{void}{OnLButtonUp}{\param{wxMouseEvent\& }{event}}
|
||||
|
||||
Responds to a left mouse button up event.
|
||||
|
||||
|
||||
\membersection{wxNewBitmapButton::OnMouseMove}\label{wxnewbitmapbuttononmousemove}
|
||||
|
||||
\func{void}{OnMouseMove}{\param{wxMouseEvent\& }{event}}
|
||||
|
||||
Responds to a mouse move event.
|
||||
|
||||
|
||||
\membersection{wxNewBitmapButton::OnPaint}\label{wxnewbitmapbuttononpaint}
|
||||
|
||||
\func{void}{OnPaint}{\param{wxPaintEvent\& }{event}}
|
||||
|
||||
Responds to a paint event.
|
||||
|
||||
|
||||
\membersection{wxNewBitmapButton::OnSize}\label{wxnewbitmapbuttononsize}
|
||||
|
||||
\func{void}{OnSize}{\param{wxSizeEvent\& }{event}}
|
||||
|
||||
Responds to a size event.
|
||||
|
||||
|
||||
\membersection{wxNewBitmapButton::RenderAllLabelImages}\label{wxnewbitmapbuttonrenderalllabelimages}
|
||||
|
||||
\func{void}{RenderAllLabelImages}{\void}
|
||||
|
||||
Renders label images.
|
||||
|
||||
|
||||
\membersection{wxNewBitmapButton::RenderLabelImage}\label{wxnewbitmapbuttonrenderlabelimage}
|
||||
|
||||
\func{void}{RenderLabelImage}{\param{wxBitmap*\& }{destBmp}, \param{wxBitmap* }{srcBmp}, \param{bool }{isEnabled = TRUE}, \param{bool }{isPressed = FALSE}}
|
||||
|
||||
Renders the label image.
|
||||
|
||||
|
||||
\membersection{wxNewBitmapButton::RenderLabelImages}\label{wxnewbitmapbuttonrenderlabelimages}
|
||||
|
||||
\func{void}{RenderLabelImages}{\void}
|
||||
|
||||
Renders label images.
|
||||
|
||||
|
||||
\membersection{wxNewBitmapButton::Reshape}\label{wxnewbitmapbuttonreshape}
|
||||
|
||||
\func{void}{Reshape}{\void}
|
||||
|
||||
should be called after Create();
|
||||
This function should be called after Create. It renders the labels, having
|
||||
reloaded the button image if necessary.
|
||||
|
||||
|
||||
\membersection{wxNewBitmapButton::SetAlignments}\label{wxnewbitmapbuttonsetalignments}
|
||||
|
||||
\func{void}{SetAlignments}{\param{int }{alignText = NB\_ALIGN\_TEXT\_BOTTOM}, \param{int }{marginX = 2}, \param{int }{marginY = 2}, \param{int }{textToLabelGap = 2}}
|
||||
|
||||
Sets the text alignment and margins.
|
||||
|
||||
|
||||
\membersection{wxNewBitmapButton::SetLabel}\label{wxnewbitmapbuttonsetlabel}
|
||||
|
||||
\func{void}{SetLabel}{\param{const wxBitmap\& }{labelBitmap}, \param{const wxString\& }{labelText = ""}}
|
||||
|
||||
overridables
|
||||
Sets the label and optionally label text.
|
||||
|
||||
|
||||
@@ -1,18 +1,22 @@
|
||||
%
|
||||
% automatically generated by HelpGen $Revision$ from
|
||||
% dyntbar.h at 05/Jan/02 22:50:56
|
||||
% dyntbar.h at 21/Jan/02 21:14:18
|
||||
%
|
||||
|
||||
|
||||
\section{\class{wxToolLayoutItem}}\label{wxtoollayoutitem}
|
||||
|
||||
|
||||
layout item
|
||||
Tool layout item.
|
||||
|
||||
\wxheading{Derived from}
|
||||
|
||||
\helpref{wxObject}{wxobject}
|
||||
|
||||
\wxheading{Include files}
|
||||
|
||||
<dyntbar.h>
|
||||
|
||||
\wxheading{Data structures}
|
||||
|
||||
{\small \begin{verbatim}
|
||||
|
||||
@@ -1,15 +1,23 @@
|
||||
%
|
||||
% automatically generated by HelpGen $Revision$ from
|
||||
% toolwnd.h at 05/Jan/02 22:50:58
|
||||
% toolwnd.h at 21/Jan/02 21:14:17
|
||||
%
|
||||
|
||||
|
||||
\section{\class{wxToolWindow}}\label{wxtoolwindow}
|
||||
|
||||
|
||||
A tool window is a special kind of frame that paints its own title, and
|
||||
can be used to implement small floating windows.
|
||||
|
||||
\wxheading{Derived from}
|
||||
|
||||
\helpref{wxFrame}{wxframe}
|
||||
|
||||
\wxheading{Include files}
|
||||
|
||||
<toolwnd.h>
|
||||
|
||||
\wxheading{Data structures}
|
||||
|
||||
\latexignore{\rtfignore{\wxheading{Members}}}
|
||||
@@ -19,122 +27,167 @@
|
||||
|
||||
\func{}{wxToolWindow}{\void}
|
||||
|
||||
Default constructor.
|
||||
|
||||
|
||||
\membersection{wxToolWindow::\destruct{wxToolWindow}}\label{wxtoolwindowdtor}
|
||||
|
||||
\func{}{\destruct{wxToolWindow}}{\void}
|
||||
|
||||
Destructor.
|
||||
|
||||
|
||||
\membersection{wxToolWindow::AddMiniButton}\label{wxtoolwindowaddminibutton}
|
||||
|
||||
\func{void}{AddMiniButton}{\param{cbMiniButton* }{pBtn}}
|
||||
|
||||
buttons are added in right-to-left order
|
||||
Adds a button. Buttons are added in right-to-left order.
|
||||
|
||||
|
||||
\membersection{wxToolWindow::AdjustRectPos}\label{wxtoolwindowadjustrectpos}
|
||||
|
||||
\func{void}{AdjustRectPos}{\param{const wxRect\& }{original}, \param{const wxSize\& }{newDim}, \param{wxRect\& }{newRect}}
|
||||
|
||||
Helper function.
|
||||
|
||||
|
||||
\membersection{wxToolWindow::CalcResizedRect}\label{wxtoolwindowcalcresizedrect}
|
||||
|
||||
\func{void}{CalcResizedRect}{\param{wxRect\& }{rect}, \param{wxPoint\& }{delta}, \param{const wxSize\& }{minDim}}
|
||||
|
||||
Calculate resized rectangle.
|
||||
|
||||
|
||||
\membersection{wxToolWindow::DrawHintRect}\label{wxtoolwindowdrawhintrect}
|
||||
|
||||
\func{void}{DrawHintRect}{\param{const wxRect\& }{r}}
|
||||
|
||||
Draws the hint rectangle.
|
||||
|
||||
|
||||
\membersection{wxToolWindow::GetClient}\label{wxtoolwindowgetclient}
|
||||
|
||||
\func{wxWindow*}{GetClient}{\void}
|
||||
|
||||
Returns the client window.
|
||||
|
||||
|
||||
\membersection{wxToolWindow::GetMinimalWndDim}\label{wxtoolwindowgetminimalwnddim}
|
||||
|
||||
\func{wxSize}{GetMinimalWndDim}{\void}
|
||||
|
||||
Helper function.
|
||||
|
||||
|
||||
\membersection{wxToolWindow::GetPreferredSize}\label{wxtoolwindowgetpreferredsize}
|
||||
|
||||
\func{wxSize}{GetPreferredSize}{\param{const wxSize\& }{given}}
|
||||
|
||||
overridables:
|
||||
Returns the preferred size for the window.
|
||||
|
||||
|
||||
\membersection{wxToolWindow::GetScrMousePos}\label{wxtoolwindowgetscrmousepos}
|
||||
|
||||
\func{void}{GetScrMousePos}{\param{wxMouseEvent\& }{event}, \param{wxPoint\& }{pos}}
|
||||
|
||||
Gets the mouse position in screen coordinates.
|
||||
|
||||
|
||||
\membersection{wxToolWindow::GetScrWindowRect}\label{wxtoolwindowgetscrwindowrect}
|
||||
|
||||
\func{void}{GetScrWindowRect}{\param{wxRect\& }{r}}
|
||||
|
||||
Maps client coordinates to screen coordinates.
|
||||
|
||||
|
||||
\membersection{wxToolWindow::HandleTitleClick}\label{wxtoolwindowhandletitleclick}
|
||||
|
||||
\func{bool}{HandleTitleClick}{\param{wxMouseEvent\& }{event}}
|
||||
|
||||
Handles clicking on the title. By default, does nothing.
|
||||
|
||||
|
||||
\membersection{wxToolWindow::HitTestWindow}\label{wxtoolwindowhittestwindow}
|
||||
|
||||
\func{int}{HitTestWindow}{\param{wxMouseEvent\& }{event}}
|
||||
|
||||
Tests if the mouse position is in this window.
|
||||
|
||||
|
||||
\membersection{wxToolWindow::LayoutMiniButtons}\label{wxtoolwindowlayoutminibuttons}
|
||||
|
||||
\func{void}{LayoutMiniButtons}{\void}
|
||||
|
||||
Lays out the buttons.
|
||||
|
||||
|
||||
\membersection{wxToolWindow::OnEraseBackground}\label{wxtoolwindowonerasebackground}
|
||||
|
||||
\func{void}{OnEraseBackground}{\param{wxEraseEvent\& }{event}}
|
||||
|
||||
Responds to an erase background event.
|
||||
|
||||
|
||||
\membersection{wxToolWindow::OnLeftDown}\label{wxtoolwindowonleftdown}
|
||||
|
||||
\func{void}{OnLeftDown}{\param{wxMouseEvent\& }{event}}
|
||||
|
||||
Responds to a mouse left down event.
|
||||
|
||||
|
||||
\membersection{wxToolWindow::OnLeftUp}\label{wxtoolwindowonleftup}
|
||||
|
||||
\func{void}{OnLeftUp}{\param{wxMouseEvent\& }{event}}
|
||||
|
||||
Responds to a mouse left up event.
|
||||
|
||||
|
||||
\membersection{wxToolWindow::OnMiniButtonClicked}\label{wxtoolwindowonminibuttonclicked}
|
||||
|
||||
\func{void}{OnMiniButtonClicked}{\param{int }{btnIdx}}
|
||||
|
||||
Called when a mini button is clicked.
|
||||
By default, does nothing.
|
||||
|
||||
|
||||
\membersection{wxToolWindow::OnMotion}\label{wxtoolwindowonmotion}
|
||||
|
||||
\func{void}{OnMotion}{\param{wxMouseEvent\& }{event}}
|
||||
|
||||
Responds to a mouse move event.
|
||||
|
||||
|
||||
\membersection{wxToolWindow::OnPaint}\label{wxtoolwindowonpaint}
|
||||
|
||||
\func{void}{OnPaint}{\param{wxPaintEvent\& }{event}}
|
||||
|
||||
Responds to a paint event.
|
||||
|
||||
|
||||
\membersection{wxToolWindow::OnSize}\label{wxtoolwindowonsize}
|
||||
|
||||
\func{void}{OnSize}{\param{wxSizeEvent\& }{event}}
|
||||
|
||||
Responds to a size event.
|
||||
|
||||
|
||||
\membersection{wxToolWindow::SetClient}\label{wxtoolwindowsetclient}
|
||||
|
||||
\func{void}{SetClient}{\param{wxWindow* }{pWnd}}
|
||||
|
||||
Sets the client for this tool window.
|
||||
|
||||
|
||||
\membersection{wxToolWindow::SetHintCursor}\label{wxtoolwindowsethintcursor}
|
||||
|
||||
\func{void}{SetHintCursor}{\param{int }{type}}
|
||||
|
||||
Sets the hint cursor.
|
||||
|
||||
|
||||
\membersection{wxToolWindow::SetTitleFont}\label{wxtoolwindowsettitlefont}
|
||||
|
||||
\func{void}{SetTitleFont}{\param{wxFont\& }{font}}
|
||||
|
||||
Sets the title font.
|
||||
|
||||
|
||||
Reference in New Issue
Block a user