Applied patched for combo box SELECTED events (no
[wxWidgets.git] / contrib / docs / latex / fl / cbbardragplugin.tex
1 %
2 % automatically generated by HelpGen $Revision$ from
3 % bardragpl.h at 21/Jan/02 21:14:17
4 %
5
6
7 \section{\class{cbBarDragPlugin}}\label{cbbardragplugin}
8
9
10 Plugin class implementing bar dragging.
11
12 \wxheading{Derived from}
13
14 \helpref{cbPluginBase}{cbpluginbase}
15
16 \wxheading{Include files}
17
18 <wx/fl/bardragpl.h>
19
20 \wxheading{Data structures}
21
22 \latexignore{\rtfignore{\wxheading{Members}}}
23
24
25 \membersection{cbBarDragPlugin::cbBarDragPlugin}\label{cbbardragplugincbbardragplugin}
26
27 \func{}{cbBarDragPlugin}{\void}
28
29 Default constructor.
30
31
32 \func{}{cbBarDragPlugin}{\param{wxFrameLayout* }{pPanel}, \param{int }{paneMask = wxALL\_PANES}}
33
34 Constructor taking a parent frame, and flag. See cbPluginBase.
35
36
37 \membersection{cbBarDragPlugin::\destruct{cbBarDragPlugin}}\label{cbbardragplugindtor}
38
39 \func{}{\destruct{cbBarDragPlugin}}{\void}
40
41 Destructor.
42
43
44 \membersection{cbBarDragPlugin::AdjustHintRect}\label{cbbardragpluginadjusthintrect}
45
46 \func{void}{AdjustHintRect}{\param{wxPoint\& }{mousePos}}
47
48 the thicker rectangle is drawn using hatched brush,
49 the default border width for this rectangle is 8 pix.
50 Internal implementation function.
51
52
53 \membersection{cbBarDragPlugin::CalcOnScreenDims}\label{cbbardragplugincalconscreendims}
54
55 \func{void}{CalcOnScreenDims}{\param{wxRect\& }{rect}}
56
57 Internal implementation function.
58
59
60 \membersection{cbBarDragPlugin::ClipPosInFrame}\label{cbbardragpluginclipposinframe}
61
62 \func{void}{ClipPosInFrame}{\param{wxPoint\& }{pos}}
63
64 Internal implementation function.
65
66
67 \membersection{cbBarDragPlugin::ClipRectInFrame}\label{cbbardragplugincliprectinframe}
68
69 \func{void}{ClipRectInFrame}{\param{wxRect\& }{rect}}
70
71 Internal implementation function.
72
73
74 \membersection{cbBarDragPlugin::DoDrawHintRect}\label{cbbardragplugindodrawhintrect}
75
76 \func{void}{DoDrawHintRect}{\param{wxRect\& }{rect}, \param{bool }{isInClientRect}}
77
78 Internal implementation function.
79 Draw the hint rectangle.
80
81
82 \membersection{cbBarDragPlugin::DrawHintRect}\label{cbbardragplugindrawhintrect}
83
84 \func{void}{DrawHintRect}{\param{wxRect\& }{rect}, \param{bool }{isInClientRect}}
85
86 Internal implementation function.
87 Draw the visual hint while dragging.
88
89
90 \membersection{cbBarDragPlugin::EraseHintRect}\label{cbbardragpluginerasehintrect}
91
92 \func{void}{EraseHintRect}{\param{wxRect\& }{rect}, \param{bool }{isInClientRect}}
93
94 Internal implementation function.
95 Erase the visual hint while dragging.
96
97
98 \membersection{cbBarDragPlugin::FinishTracking}\label{cbbardragpluginfinishtracking}
99
100 \func{void}{FinishTracking}{\void}
101
102 Internal implementation function.
103 Stop showing the visual hint while dragging.
104
105
106 \membersection{cbBarDragPlugin::GetBarHeightInPane}\label{cbbardragplugingetbarheightinpane}
107
108 \func{int}{GetBarHeightInPane}{\param{cbDockPane* }{pPane}}
109
110 Internal implementation function.
111
112
113 \membersection{cbBarDragPlugin::GetBarWidthInPane}\label{cbbardragplugingetbarwidthinpane}
114
115 \func{int}{GetBarWidthInPane}{\param{cbDockPane* }{pPane}}
116
117 Internal implementation function.
118
119
120 \membersection{cbBarDragPlugin::GetDistanceToPane}\label{cbbardragplugingetdistancetopane}
121
122 \func{int}{GetDistanceToPane}{\param{cbDockPane* }{pPane}, \param{wxPoint\& }{mousePos}}
123
124 Internal implementation function.
125
126
127 \membersection{cbBarDragPlugin::HitTestPanes}\label{cbbardragpluginhittestpanes}
128
129 \func{cbDockPane*}{HitTestPanes}{\param{wxRect\& }{rect}}
130
131 Internal implementation function. Finds the pane
132 under the specified rectangle.
133
134
135 \func{cbDockPane*}{HitTestPanes}{\param{wxPoint\& }{pos}}
136
137 Internal implementation function. Finds the pane
138 under the specified point.
139
140
141 \membersection{cbBarDragPlugin::HitsPane}\label{cbbardragpluginhitspane}
142
143 \func{bool}{HitsPane}{\param{cbDockPane* }{pPane}, \param{wxRect\& }{rect}}
144
145 Internal implementation function.
146
147
148 \membersection{cbBarDragPlugin::IsInClientArea}\label{cbbardragpluginisinclientarea}
149
150 \func{bool}{IsInClientArea}{\param{wxPoint\& }{mousePos}}
151
152 Internal implementation function.
153
154
155 \func{bool}{IsInClientArea}{\param{wxRect\& }{rect}}
156
157 Internal implementation function.
158
159
160 \membersection{cbBarDragPlugin::IsInOtherPane}\label{cbbardragpluginisinotherpane}
161
162 \func{bool}{IsInOtherPane}{\param{wxPoint\& }{mousePos}}
163
164 Internal implementation function.
165
166
167 \membersection{cbBarDragPlugin::OnDrawHintRect}\label{cbbardragpluginondrawhintrect}
168
169 \func{void}{OnDrawHintRect}{\param{cbDrawHintRectEvent\& }{event}}
170
171 Handles event, which originates from itself.
172
173
174 \membersection{cbBarDragPlugin::OnLButtonDown}\label{cbbardragpluginonlbuttondown}
175
176 \func{void}{OnLButtonDown}{\param{cbLeftDownEvent\& }{event}}
177
178 Handler for plugin event.
179
180
181 \membersection{cbBarDragPlugin::OnLButtonUp}\label{cbbardragpluginonlbuttonup}
182
183 \func{void}{OnLButtonUp}{\param{cbLeftUpEvent\& }{event}}
184
185 Handler for plugin event.
186
187
188 \membersection{cbBarDragPlugin::OnLDblClick}\label{cbbardragpluginonldblclick}
189
190 \func{void}{OnLDblClick}{\param{cbLeftDClickEvent\& }{event}}
191
192 Handler for plugin event.
193
194
195 \membersection{cbBarDragPlugin::OnMouseMove}\label{cbbardragpluginonmousemove}
196
197 \func{void}{OnMouseMove}{\param{cbMotionEvent\& }{event}}
198
199 Handler for plugin event.
200
201
202 \membersection{cbBarDragPlugin::OnStartBarDragging}\label{cbbardragpluginonstartbardragging}
203
204 \func{void}{OnStartBarDragging}{\param{cbStartBarDraggingEvent\& }{event}}
205
206 Handler for plugin event.
207
208
209 \membersection{cbBarDragPlugin::RectToScr}\label{cbbardragpluginrecttoscr}
210
211 \func{void}{RectToScr}{\param{wxRect\& }{frameRect}, \param{wxRect\& }{scrRect}}
212
213 Internal implementation function.
214 Converts the given rectangle from window to screen coordinates.
215
216
217 \membersection{cbBarDragPlugin::ShowHint}\label{cbbardragpluginshowhint}
218
219 \func{void}{ShowHint}{\param{bool }{prevWasInClient}}
220
221 Internal implementation function.
222 Show the hint; called within OnMouseMove.
223
224
225 \membersection{cbBarDragPlugin::StartTracking}\label{cbbardragpluginstarttracking}
226
227 \func{void}{StartTracking}{\void}
228
229 on-screen hint-tracking related methods
230 Internal implementation function.
231 Start showing a visual hint while dragging.
232
233
234 \membersection{cbBarDragPlugin::StickToPane}\label{cbbardragpluginsticktopane}
235
236 \func{void}{StickToPane}{\param{cbDockPane* }{pPane}, \param{wxPoint\& }{mousePos}}
237
238 Internal implementation function.
239
240
241 \membersection{cbBarDragPlugin::UnstickFromPane}\label{cbbardragpluginunstickfrompane}
242
243 \func{void}{UnstickFromPane}{\param{cbDockPane* }{pPane}, \param{wxPoint\& }{mousePos}}
244
245 Internal implementation function.
246