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