]> git.saurik.com Git - wxWidgets.git/blob - contrib/docs/latex/fl/cbpanedrawplugin.tex
removed enum that was causing more problems than it was worth
[wxWidgets.git] / contrib / docs / latex / fl / cbpanedrawplugin.tex
1 %
2 % automatically generated by HelpGen $Revision$ from
3 % panedrawpl.h at 21/Jan/02 21:14:19
4 %
5
6
7 \section{\class{cbPaneDrawPlugin}}\label{cbpanedrawplugin}
8
9
10 Simple but all-in-one plugin implementation. Resembles the look and feel of
11 to MFC control-bars. The class handles painting of the pane and the items in it;
12 it generates bar/layout customization events, when the user right-clicks the bar/pane.
13 Hooking an instance of this and row-layout plugins for each pane
14 would be enough for the frame layout to function properly
15 (they are plugged in automatically by the wxFrameLayout class).
16
17 \wxheading{Derived from}
18
19 \helpref{cbPluginBase}{cbpluginbase}
20
21 \wxheading{Include files}
22
23 <wx/fl/panedrawpl.h>
24
25 \wxheading{Data structures}
26
27 \latexignore{\rtfignore{\wxheading{Members}}}
28
29
30 \membersection{cbPaneDrawPlugin::cbPaneDrawPlugin}\label{cbpanedrawplugincbpanedrawplugin}
31
32 \func{}{cbPaneDrawPlugin}{\param{wxFrameLayout* }{pPanel}, \param{int }{paneMask = wxALL\_PANES}}
33
34 Constructor taking frame layout pane and a pane mask.
35
36
37 \func{}{cbPaneDrawPlugin}{\void}
38
39 Default constructor.
40
41
42 \membersection{cbPaneDrawPlugin::\destruct{cbPaneDrawPlugin}}\label{cbpanedrawplugindtor}
43
44 \func{}{\destruct{cbPaneDrawPlugin}}{\void}
45
46 Destructor.
47
48
49 \membersection{cbPaneDrawPlugin::Clone}\label{cbpanedrawpluginclone}
50
51 \func{cbPluginBase*}{Clone}{\void}
52
53 Clone function, returning a new instance of this class.
54
55
56 \membersection{cbPaneDrawPlugin::DrawBarInnerShadeRect}\label{cbpanedrawplugindrawbarinnershaderect}
57
58 \func{void}{DrawBarInnerShadeRect}{\param{cbBarInfo* }{pBar}, \param{wxDC\& }{dc}}
59
60 Internal helper: draws the inner bar shading.
61
62
63 \membersection{cbPaneDrawPlugin::DrawDraggedHandle}\label{cbpanedrawplugindrawdraggedhandle}
64
65 \func{void}{DrawDraggedHandle}{\param{const wxPoint\& }{pos}, \param{cbDockPane\& }{pane}}
66
67 Internal helper: draws the dragged handle.
68
69
70 \membersection{cbPaneDrawPlugin::DrawLowerRowHandle}\label{cbpanedrawplugindrawlowerrowhandle}
71
72 \func{void}{DrawLowerRowHandle}{\param{cbRowInfo* }{pRow}, \param{wxDC\& }{dc}}
73
74 Internal helper: draws the lower row handle.
75
76
77 \membersection{cbPaneDrawPlugin::DrawLowerRowShades}\label{cbpanedrawplugindrawlowerrowshades}
78
79 \func{void}{DrawLowerRowShades}{\param{cbRowInfo* }{pRow}, \param{wxDC\& }{dc}, \param{int }{level}}
80
81 Internal helper: draws the lower row shading.
82
83
84 \membersection{cbPaneDrawPlugin::DrawPaneShade}\label{cbpanedrawplugindrawpaneshade}
85
86 \func{void}{DrawPaneShade}{\param{wxDC\& }{dc}, \param{int }{alignment}}
87
88 Internal helper: draws the pane shading.
89
90
91 \membersection{cbPaneDrawPlugin::DrawPaneShadeForRow}\label{cbpanedrawplugindrawpaneshadeforrow}
92
93 \func{void}{DrawPaneShadeForRow}{\param{cbRowInfo* }{pRow}, \param{wxDC\& }{dc}}
94
95 Internal helper: draws the pane shading for a row.
96
97
98 \membersection{cbPaneDrawPlugin::DrawShade}\label{cbpanedrawplugindrawshade}
99
100 \func{void}{DrawShade}{\param{int }{level}, \param{wxRect\& }{rect}, \param{int }{alignment}, \param{wxDC\& }{dc}}
101
102 Internal helper: draws shading.
103
104
105 \membersection{cbPaneDrawPlugin::DrawShade1}\label{cbpanedrawplugindrawshade1}
106
107 \func{void}{DrawShade1}{\param{int }{level}, \param{wxRect\& }{rect}, \param{int }{alignment}, \param{wxDC\& }{dc}}
108
109 Internal helper: draws shading.
110
111
112 \membersection{cbPaneDrawPlugin::DrawUpperRowHandle}\label{cbpanedrawplugindrawupperrowhandle}
113
114 \func{void}{DrawUpperRowHandle}{\param{cbRowInfo* }{pRow}, \param{wxDC\& }{dc}}
115
116 Internal helper: draws the upper row handle.
117
118
119 \membersection{cbPaneDrawPlugin::DrawUpperRowShades}\label{cbpanedrawplugindrawupperrowshades}
120
121 \func{void}{DrawUpperRowShades}{\param{cbRowInfo* }{pRow}, \param{wxDC\& }{dc}, \param{int }{level}}
122
123 Internal helper: draws the upper row shading.
124
125
126 \membersection{cbPaneDrawPlugin::OnDrawBarDecorations}\label{cbpanedrawpluginondrawbardecorations}
127
128 \func{void}{OnDrawBarDecorations}{\param{cbDrawBarDecorEvent\& }{event}}
129
130 Handler for draw bar decorations events.
131
132
133 \membersection{cbPaneDrawPlugin::OnDrawBarHandles}\label{cbpanedrawpluginondrawbarhandles}
134
135 \func{void}{OnDrawBarHandles}{\param{cbDrawBarHandlesEvent\& }{event}}
136
137 Handler for draw bar handles events.
138
139
140 \membersection{cbPaneDrawPlugin::OnDrawPaneBackground}\label{cbpanedrawpluginondrawpanebackground}
141
142 \func{void}{OnDrawPaneBackground}{\param{cbDrawPaneBkGroundEvent\& }{event}}
143
144 Handler for draw pane background events.
145
146
147 \membersection{cbPaneDrawPlugin::OnDrawPaneDecorations}\label{cbpanedrawpluginondrawpanedecorations}
148
149 \func{void}{OnDrawPaneDecorations}{\param{cbDrawPaneDecorEvent\& }{event}}
150
151 Handler for draw pane decoration events.
152
153
154 \membersection{cbPaneDrawPlugin::OnDrawRowBackground}\label{cbpanedrawpluginondrawrowbackground}
155
156 \func{void}{OnDrawRowBackground}{\param{cbDrawRowBkGroundEvent\& }{event}}
157
158 Handler for draw row background events.
159
160
161 \membersection{cbPaneDrawPlugin::OnDrawRowDecorations}\label{cbpanedrawpluginondrawrowdecorations}
162
163 \func{void}{OnDrawRowDecorations}{\param{cbDrawRowDecorEvent\& }{event}}
164
165 Handler for draw row decoration events.
166
167
168 \membersection{cbPaneDrawPlugin::OnDrawRowHandles}\label{cbpanedrawpluginondrawrowhandles}
169
170 \func{void}{OnDrawRowHandles}{\param{cbDrawRowHandlesEvent\& }{event}}
171
172 Handler for draw row handles events.
173
174
175 \membersection{cbPaneDrawPlugin::OnFinishDrawInArea}\label{cbpanedrawpluginonfinishdrawinarea}
176
177 \func{void}{OnFinishDrawInArea}{\param{cbFinishDrawInAreaEvent\& }{event}}
178
179 Handler for finish draw in area events.
180
181
182 \membersection{cbPaneDrawPlugin::OnLButtonDown}\label{cbpanedrawpluginonlbuttondown}
183
184 \func{void}{OnLButtonDown}{\param{cbLeftDownEvent\& }{event}}
185
186 Handler for left mouse button down events.
187
188
189 \membersection{cbPaneDrawPlugin::OnLButtonUp}\label{cbpanedrawpluginonlbuttonup}
190
191 \func{void}{OnLButtonUp}{\param{cbLeftUpEvent\& }{event}}
192
193 Handler for left mouse button up events.
194
195
196 \membersection{cbPaneDrawPlugin::OnLDblClick}\label{cbpanedrawpluginonldblclick}
197
198 \func{void}{OnLDblClick}{\param{cbLeftDClickEvent\& }{event}}
199
200 Handler for left double-click mouse button down events.
201
202
203 \membersection{cbPaneDrawPlugin::OnMouseMove}\label{cbpanedrawpluginonmousemove}
204
205 \func{void}{OnMouseMove}{\param{cbMotionEvent\& }{event}}
206
207 Handler for mouse move events.
208
209
210 \membersection{cbPaneDrawPlugin::OnRButtonUp}\label{cbpanedrawpluginonrbuttonup}
211
212 \func{void}{OnRButtonUp}{\param{cbRightUpEvent\& }{event}}
213
214 Handler for right mouse button up events.
215
216
217 \membersection{cbPaneDrawPlugin::OnSizeBarWindow}\label{cbpanedrawpluginonsizebarwindow}
218
219 \func{void}{OnSizeBarWindow}{\param{cbSizeBarWndEvent\& }{event}}
220
221 Handler for bar size events.
222
223
224 \membersection{cbPaneDrawPlugin::OnStartDrawInArea}\label{cbpanedrawpluginonstartdrawinarea}
225
226 \func{void}{OnStartDrawInArea}{\param{cbStartDrawInAreaEvent\& }{event}}
227
228 Handler for start draw in area events.
229
230
231 \membersection{cbPaneDrawPlugin::SetDarkPixel}\label{cbpanedrawpluginsetdarkpixel}
232
233 \func{void}{SetDarkPixel}{\param{int }{x}, \param{int }{y}, \param{wxDC\& }{dc}}
234
235 Internal helper: sets a dark pixel at the given location.
236
237
238 \membersection{cbPaneDrawPlugin::SetLightPixel}\label{cbpanedrawpluginsetlightpixel}
239
240 \func{void}{SetLightPixel}{\param{int }{x}, \param{int }{y}, \param{wxDC\& }{dc}}
241
242 Internal helper: sets a light pixel at the given location.
243