]>
Commit | Line | Data |
---|---|---|
499b2ed8 JS |
1 | % |
2 | % automatically generated by HelpGen $Revision$ from | |
3 | % rowlayoutpl.h at 05/Jan/02 22:50:58 | |
4 | % | |
5 | ||
6 | ||
7 | \section{\class{cbRowLayoutPlugin}}\label{cbrowlayoutplugin} | |
8 | ||
9 | ||
10 | Simple implementation of plugin, which handles row-layouting | |
11 | requests sent from Frame Layout | |
12 | ||
13 | \wxheading{Derived from} | |
14 | ||
15 | \helpref{cbPluginBase}{cbpluginbase} | |
16 | ||
17 | \wxheading{Data structures} | |
18 | ||
19 | \latexignore{\rtfignore{\wxheading{Members}}} | |
20 | ||
21 | ||
22 | \membersection{cbRowLayoutPlugin::cbRowLayoutPlugin}\label{cbrowlayoutplugincbrowlayoutplugin} | |
23 | ||
24 | \func{}{cbRowLayoutPlugin}{\param{wxFrameLayout* }{pPanel}, \param{int }{paneMask = wxALL\_PANES}} | |
25 | ||
26 | ||
27 | \func{}{cbRowLayoutPlugin}{\void} | |
28 | ||
29 | ||
30 | \membersection{cbRowLayoutPlugin::AdjustLengthOfInserted}\label{cbrowlayoutpluginadjustlengthofinserted} | |
31 | ||
32 | \func{void}{AdjustLengthOfInserted}{\param{cbRowInfo* }{pRow}, \param{cbBarInfo* }{pTheBar}} | |
33 | ||
34 | ||
35 | \membersection{cbRowLayoutPlugin::ApplyLengthRatios}\label{cbrowlayoutpluginapplylengthratios} | |
36 | ||
37 | \func{void}{ApplyLengthRatios}{\param{cbRowInfo* }{pRow}} | |
38 | ||
39 | ||
40 | \membersection{cbRowLayoutPlugin::CalcRowHeight}\label{cbrowlayoutplugincalcrowheight} | |
41 | ||
42 | \func{int}{CalcRowHeight}{\param{cbRowInfo\& }{row}} | |
43 | ||
44 | row-layouting helpers (simulate "bar-friction") | |
45 | ||
46 | ||
47 | \membersection{cbRowLayoutPlugin::CheckIfAtTheBoundary}\label{cbrowlayoutplugincheckifattheboundary} | |
48 | ||
49 | \func{void}{CheckIfAtTheBoundary}{\param{cbBarInfo* }{pTheBar}, \param{cbRowInfo\& }{rowInfo}} | |
50 | ||
51 | ||
52 | \membersection{cbRowLayoutPlugin::DetectBarHandles}\label{cbrowlayoutplugindetectbarhandles} | |
53 | ||
54 | \func{void}{DetectBarHandles}{\param{cbRowInfo* }{pRow}} | |
55 | ||
56 | ||
57 | \membersection{cbRowLayoutPlugin::DoInsertBar}\label{cbrowlayoutplugindoinsertbar} | |
58 | ||
59 | \func{void}{DoInsertBar}{\param{cbBarInfo* }{pTheBar}, \param{cbRowInfo\& }{row}} | |
60 | ||
61 | ||
62 | \membersection{cbRowLayoutPlugin::ExpandNotFixedBars}\label{cbrowlayoutpluginexpandnotfixedbars} | |
63 | ||
64 | \func{void}{ExpandNotFixedBars}{\param{cbRowInfo* }{pRow}} | |
65 | ||
66 | ||
67 | \membersection{cbRowLayoutPlugin::FitBarsToRange}\label{cbrowlayoutpluginfitbarstorange} | |
68 | ||
69 | \func{void}{FitBarsToRange}{\param{int }{from}, \param{int }{till}, \param{cbBarInfo* }{pTheBar}, \param{cbRowInfo* }{pRow}} | |
70 | ||
71 | not-fixed-bars layouting related helpers | |
72 | ||
73 | ||
74 | \membersection{cbRowLayoutPlugin::GetRowFreeSpace}\label{cbrowlayoutplugingetrowfreespace} | |
75 | ||
76 | \func{int}{GetRowFreeSpace}{\param{cbRowInfo* }{pRow}} | |
77 | ||
78 | ||
79 | \membersection{cbRowLayoutPlugin::InsertBefore}\label{cbrowlayoutplugininsertbefore} | |
80 | ||
81 | \func{void}{InsertBefore}{\param{cbBarInfo* }{pBeforeBar}, \param{cbBarInfo* }{pTheBar}, \param{cbRowInfo\& }{row}} | |
82 | ||
83 | ||
84 | \membersection{cbRowLayoutPlugin::LayoutItemsVertically}\label{cbrowlayoutpluginlayoutitemsvertically} | |
85 | ||
86 | \func{void}{LayoutItemsVertically}{\param{cbRowInfo\& }{row}} | |
87 | ||
88 | ||
89 | \membersection{cbRowLayoutPlugin::MinimzeNotFixedBars}\label{cbrowlayoutpluginminimzenotfixedbars} | |
90 | ||
91 | \func{void}{MinimzeNotFixedBars}{\param{cbRowInfo* }{pRow}, \param{cbBarInfo* }{pBarToPreserve}} | |
92 | ||
93 | ||
94 | \membersection{cbRowLayoutPlugin::OnInsertBar}\label{cbrowlayoutpluginoninsertbar} | |
95 | ||
96 | \func{void}{OnInsertBar}{\param{cbInsertBarEvent\& }{event}} | |
97 | ||
98 | ||
99 | \membersection{cbRowLayoutPlugin::OnLayoutRow}\label{cbrowlayoutpluginonlayoutrow} | |
100 | ||
101 | \func{void}{OnLayoutRow}{\param{cbLayoutRowEvent\& }{event}} | |
102 | ||
103 | ||
104 | \membersection{cbRowLayoutPlugin::OnLayoutRows}\label{cbrowlayoutpluginonlayoutrows} | |
105 | ||
106 | \func{void}{OnLayoutRows}{\param{cbLayoutRowsEvent\& }{event}} | |
107 | ||
108 | ||
109 | \membersection{cbRowLayoutPlugin::OnRemoveBar}\label{cbrowlayoutpluginonremovebar} | |
110 | ||
111 | \func{void}{OnRemoveBar}{\param{cbRemoveBarEvent\& }{event}} | |
112 | ||
113 | ||
114 | \membersection{cbRowLayoutPlugin::OnResizeRow}\label{cbrowlayoutpluginonresizerow} | |
115 | ||
116 | \func{void}{OnResizeRow}{\param{cbResizeRowEvent\& }{event}} | |
117 | ||
118 | event handlers | |
119 | ||
120 | ||
121 | \membersection{cbRowLayoutPlugin::RecalcLengthRatios}\label{cbrowlayoutpluginrecalclengthratios} | |
122 | ||
123 | \func{void}{RecalcLengthRatios}{\param{cbRowInfo* }{pRow}} | |
124 | ||
125 | ||
126 | \membersection{cbRowLayoutPlugin::RelayoutNotFixedBarsAround}\label{cbrowlayoutpluginrelayoutnotfixedbarsaround} | |
127 | ||
128 | \func{void}{RelayoutNotFixedBarsAround}{\param{cbBarInfo* }{pTheBar}, \param{cbRowInfo* }{pRow}} | |
129 | ||
130 | ||
131 | \membersection{cbRowLayoutPlugin::ShiftLeftTrashold}\label{cbrowlayoutpluginshiftlefttrashold} | |
132 | ||
133 | \func{void}{ShiftLeftTrashold}{\param{cbBarInfo* }{pTheBar}, \param{cbRowInfo\& }{row}} | |
134 | ||
135 | ||
136 | \membersection{cbRowLayoutPlugin::ShiftRightTrashold}\label{cbrowlayoutpluginshiftrighttrashold} | |
137 | ||
138 | \func{void}{ShiftRightTrashold}{\param{cbBarInfo* }{pTheBar}, \param{cbRowInfo\& }{row}} | |
139 | ||
140 | ||
141 | \membersection{cbRowLayoutPlugin::SlideLeftSideBars}\label{cbrowlayoutpluginslideleftsidebars} | |
142 | ||
143 | \func{void}{SlideLeftSideBars}{\param{cbBarInfo* }{pTheBar}} | |
144 | ||
145 | ||
146 | \membersection{cbRowLayoutPlugin::SlideRightSideBars}\label{cbrowlayoutpluginsliderightsidebars} | |
147 | ||
148 | \func{void}{SlideRightSideBars}{\param{cbBarInfo* }{pTheBar}} | |
149 | ||
150 | ||
151 | \membersection{cbRowLayoutPlugin::StickRightSideBars}\label{cbrowlayoutpluginstickrightsidebars} | |
152 | ||
153 | \func{void}{StickRightSideBars}{\param{cbBarInfo* }{pToBar}} | |
154 |