]> git.saurik.com Git - wxWidgets.git/blame - contrib/docs/latex/fl/cbrowlayoutplugin.tex
test undividable words
[wxWidgets.git] / contrib / docs / latex / fl / cbrowlayoutplugin.tex
CommitLineData
499b2ed8
JS
1%
2% automatically generated by HelpGen $Revision$ from
4cbc57f0 3% rowlayoutpl.h at 21/Jan/02 21:14:19
499b2ed8
JS
4%
5
6
7\section{\class{cbRowLayoutPlugin}}\label{cbrowlayoutplugin}
8
9
4cbc57f0
JS
10Simple implementation of a plugin which handles row layout
11requests sent from a frame layout.
12
499b2ed8
JS
13\wxheading{Derived from}
14
15\helpref{cbPluginBase}{cbpluginbase}
16
4cbc57f0
JS
17\wxheading{Include files}
18
6e8515a3 19<wx/fl/rowlayoutpl.h>
4cbc57f0 20
499b2ed8
JS
21\wxheading{Data structures}
22
23\latexignore{\rtfignore{\wxheading{Members}}}
24
25
26\membersection{cbRowLayoutPlugin::cbRowLayoutPlugin}\label{cbrowlayoutplugincbrowlayoutplugin}
27
28\func{}{cbRowLayoutPlugin}{\param{wxFrameLayout* }{pPanel}, \param{int }{paneMask = wxALL\_PANES}}
29
4cbc57f0
JS
30Constructor taking frame layout pane and pane mask.
31
499b2ed8
JS
32
33\func{}{cbRowLayoutPlugin}{\void}
34
4cbc57f0
JS
35Default constructor.
36
499b2ed8
JS
37
38\membersection{cbRowLayoutPlugin::AdjustLengthOfInserted}\label{cbrowlayoutpluginadjustlengthofinserted}
39
40\func{void}{AdjustLengthOfInserted}{\param{cbRowInfo* }{pRow}, \param{cbBarInfo* }{pTheBar}}
41
4cbc57f0
JS
42Internal helper relating to not-fixed-bars layout.
43
499b2ed8
JS
44
45\membersection{cbRowLayoutPlugin::ApplyLengthRatios}\label{cbrowlayoutpluginapplylengthratios}
46
47\func{void}{ApplyLengthRatios}{\param{cbRowInfo* }{pRow}}
48
4cbc57f0
JS
49Internal helper relating to not-fixed-bars layout.
50
499b2ed8
JS
51
52\membersection{cbRowLayoutPlugin::CalcRowHeight}\label{cbrowlayoutplugincalcrowheight}
53
54\func{int}{CalcRowHeight}{\param{cbRowInfo\& }{row}}
55
4cbc57f0 56Row layout helper simulating bar 'friction'.
499b2ed8
JS
57
58
59\membersection{cbRowLayoutPlugin::CheckIfAtTheBoundary}\label{cbrowlayoutplugincheckifattheboundary}
60
61\func{void}{CheckIfAtTheBoundary}{\param{cbBarInfo* }{pTheBar}, \param{cbRowInfo\& }{rowInfo}}
62
4cbc57f0
JS
63Internal helper relating to not-fixed-bars layout.
64
499b2ed8
JS
65
66\membersection{cbRowLayoutPlugin::DetectBarHandles}\label{cbrowlayoutplugindetectbarhandles}
67
68\func{void}{DetectBarHandles}{\param{cbRowInfo* }{pRow}}
69
4cbc57f0
JS
70Internal helper relating to not-fixed-bars layout.
71
499b2ed8
JS
72
73\membersection{cbRowLayoutPlugin::DoInsertBar}\label{cbrowlayoutplugindoinsertbar}
74
75\func{void}{DoInsertBar}{\param{cbBarInfo* }{pTheBar}, \param{cbRowInfo\& }{row}}
76
4cbc57f0
JS
77Insert the bar before the given row.
78
499b2ed8
JS
79
80\membersection{cbRowLayoutPlugin::ExpandNotFixedBars}\label{cbrowlayoutpluginexpandnotfixedbars}
81
82\func{void}{ExpandNotFixedBars}{\param{cbRowInfo* }{pRow}}
83
4cbc57f0
JS
84Internal helper relating to not-fixed-bars layout.
85
499b2ed8
JS
86
87\membersection{cbRowLayoutPlugin::FitBarsToRange}\label{cbrowlayoutpluginfitbarstorange}
88
89\func{void}{FitBarsToRange}{\param{int }{from}, \param{int }{till}, \param{cbBarInfo* }{pTheBar}, \param{cbRowInfo* }{pRow}}
90
4cbc57f0 91Internal helper relating to not-fixed-bars layout.
499b2ed8
JS
92
93
94\membersection{cbRowLayoutPlugin::GetRowFreeSpace}\label{cbrowlayoutplugingetrowfreespace}
95
96\func{int}{GetRowFreeSpace}{\param{cbRowInfo* }{pRow}}
97
4cbc57f0
JS
98Internal helper relating to not-fixed-bars layout.
99
499b2ed8
JS
100
101\membersection{cbRowLayoutPlugin::InsertBefore}\label{cbrowlayoutplugininsertbefore}
102
103\func{void}{InsertBefore}{\param{cbBarInfo* }{pBeforeBar}, \param{cbBarInfo* }{pTheBar}, \param{cbRowInfo\& }{row}}
104
4cbc57f0
JS
105Insert the bar before the given row.
106
499b2ed8
JS
107
108\membersection{cbRowLayoutPlugin::LayoutItemsVertically}\label{cbrowlayoutpluginlayoutitemsvertically}
109
110\func{void}{LayoutItemsVertically}{\param{cbRowInfo\& }{row}}
111
4cbc57f0
JS
112Row layout helper simulating bar 'friction'.
113
499b2ed8
JS
114
115\membersection{cbRowLayoutPlugin::MinimzeNotFixedBars}\label{cbrowlayoutpluginminimzenotfixedbars}
116
117\func{void}{MinimzeNotFixedBars}{\param{cbRowInfo* }{pRow}, \param{cbBarInfo* }{pBarToPreserve}}
118
4cbc57f0
JS
119Internal helper relating to not-fixed-bars layout.
120
499b2ed8
JS
121
122\membersection{cbRowLayoutPlugin::OnInsertBar}\label{cbrowlayoutpluginoninsertbar}
123
124\func{void}{OnInsertBar}{\param{cbInsertBarEvent\& }{event}}
125
4cbc57f0
JS
126Responds to bar insertion event.
127
499b2ed8
JS
128
129\membersection{cbRowLayoutPlugin::OnLayoutRow}\label{cbrowlayoutpluginonlayoutrow}
130
131\func{void}{OnLayoutRow}{\param{cbLayoutRowEvent\& }{event}}
132
4cbc57f0
JS
133Responds to row layout event.
134
499b2ed8
JS
135
136\membersection{cbRowLayoutPlugin::OnLayoutRows}\label{cbrowlayoutpluginonlayoutrows}
137
138\func{void}{OnLayoutRows}{\param{cbLayoutRowsEvent\& }{event}}
139
4cbc57f0
JS
140Responds to rows layout event.
141
499b2ed8
JS
142
143\membersection{cbRowLayoutPlugin::OnRemoveBar}\label{cbrowlayoutpluginonremovebar}
144
145\func{void}{OnRemoveBar}{\param{cbRemoveBarEvent\& }{event}}
146
4cbc57f0
JS
147Responds to bar removal event.
148
499b2ed8
JS
149
150\membersection{cbRowLayoutPlugin::OnResizeRow}\label{cbrowlayoutpluginonresizerow}
151
152\func{void}{OnResizeRow}{\param{cbResizeRowEvent\& }{event}}
153
4cbc57f0 154Responds to row resize event.
499b2ed8
JS
155
156
157\membersection{cbRowLayoutPlugin::RecalcLengthRatios}\label{cbrowlayoutpluginrecalclengthratios}
158
159\func{void}{RecalcLengthRatios}{\param{cbRowInfo* }{pRow}}
160
4cbc57f0
JS
161Internal helper relating to not-fixed-bars layout.
162
499b2ed8
JS
163
164\membersection{cbRowLayoutPlugin::RelayoutNotFixedBarsAround}\label{cbrowlayoutpluginrelayoutnotfixedbarsaround}
165
166\func{void}{RelayoutNotFixedBarsAround}{\param{cbBarInfo* }{pTheBar}, \param{cbRowInfo* }{pRow}}
167
4cbc57f0
JS
168Internal helper relating to not-fixed-bars layout.
169
499b2ed8
JS
170
171\membersection{cbRowLayoutPlugin::ShiftLeftTrashold}\label{cbrowlayoutpluginshiftlefttrashold}
172
173\func{void}{ShiftLeftTrashold}{\param{cbBarInfo* }{pTheBar}, \param{cbRowInfo\& }{row}}
174
4cbc57f0
JS
175Row layout helper simulating bar 'friction'.
176
499b2ed8
JS
177
178\membersection{cbRowLayoutPlugin::ShiftRightTrashold}\label{cbrowlayoutpluginshiftrighttrashold}
179
180\func{void}{ShiftRightTrashold}{\param{cbBarInfo* }{pTheBar}, \param{cbRowInfo\& }{row}}
181
4cbc57f0
JS
182Row layout helper simulating bar 'friction'.
183
499b2ed8
JS
184
185\membersection{cbRowLayoutPlugin::SlideLeftSideBars}\label{cbrowlayoutpluginslideleftsidebars}
186
187\func{void}{SlideLeftSideBars}{\param{cbBarInfo* }{pTheBar}}
188
4cbc57f0
JS
189Row layout helper simulating bar 'friction'.
190
499b2ed8
JS
191
192\membersection{cbRowLayoutPlugin::SlideRightSideBars}\label{cbrowlayoutpluginsliderightsidebars}
193
194\func{void}{SlideRightSideBars}{\param{cbBarInfo* }{pTheBar}}
195
4cbc57f0
JS
196Row layout helper simulating bar 'friction'.
197
499b2ed8
JS
198
199\membersection{cbRowLayoutPlugin::StickRightSideBars}\label{cbrowlayoutpluginstickrightsidebars}
200
201\func{void}{StickRightSideBars}{\param{cbBarInfo* }{pToBar}}
202
4cbc57f0
JS
203Row layout helper simulating bar 'friction'.
204