]>
Commit | Line | Data |
---|---|---|
499b2ed8 JS |
1 | % |
2 | % automatically generated by HelpGen $Revision$ from | |
3 | % panedrawpl.h at 05/Jan/02 22:50:57 | |
4 | % | |
5 | ||
6 | ||
7 | \section{\class{cbPaneDrawPlugin}}\label{cbpanedrawplugin} | |
8 | ||
9 | ||
10 | Simple, but all-in-one plugin implementation. Resembles look \& feel of | |
11 | to MFC control-bars. Handles painting of pane and items in it. | |
12 | Fires bar/layout customization event, when user right-clicks bar/pane. | |
13 | Hooking an instance of this and row-layouting plugins per each pane, | |
14 | would be enough for the frame layout to function properly. | |
15 | (they are plugged in autimatically by wxFrameLayout class) | |
16 | ||
17 | \wxheading{Derived from} | |
18 | ||
19 | \helpref{cbPluginBase}{cbpluginbase} | |
20 | ||
21 | \wxheading{Data structures} | |
22 | ||
23 | \latexignore{\rtfignore{\wxheading{Members}}} | |
24 | ||
25 | ||
26 | \membersection{cbPaneDrawPlugin::cbPaneDrawPlugin}\label{cbpanedrawplugincbpanedrawplugin} | |
27 | ||
28 | \func{}{cbPaneDrawPlugin}{\param{wxFrameLayout* }{pPanel}, \param{int }{paneMask = wxALL\_PANES}} | |
29 | ||
30 | ||
31 | \func{}{cbPaneDrawPlugin}{\void} | |
32 | ||
33 | ||
34 | \membersection{cbPaneDrawPlugin::\destruct{cbPaneDrawPlugin}}\label{cbpanedrawplugindtor} | |
35 | ||
36 | \func{}{\destruct{cbPaneDrawPlugin}}{\void} | |
37 | ||
38 | ||
39 | \membersection{cbPaneDrawPlugin::Clone}\label{cbpanedrawpluginclone} | |
40 | ||
41 | \func{cbPluginBase*}{Clone}{\void} | |
42 | ||
43 | ||
44 | \membersection{cbPaneDrawPlugin::DrawBarInnerShadeRect}\label{cbpanedrawplugindrawbarinnershaderect} | |
45 | ||
46 | \func{void}{DrawBarInnerShadeRect}{\param{cbBarInfo* }{pBar}, \param{wxDC\& }{dc}} | |
47 | ||
48 | ||
49 | \membersection{cbPaneDrawPlugin::DrawDraggedHandle}\label{cbpanedrawplugindrawdraggedhandle} | |
50 | ||
51 | \func{void}{DrawDraggedHandle}{\param{const wxPoint\& }{pos}, \param{cbDockPane\& }{pane}} | |
52 | ||
53 | helpers | |
54 | ||
55 | ||
56 | \membersection{cbPaneDrawPlugin::DrawLowerRowHandle}\label{cbpanedrawplugindrawlowerrowhandle} | |
57 | ||
58 | \func{void}{DrawLowerRowHandle}{\param{cbRowInfo* }{pRow}, \param{wxDC\& }{dc}} | |
59 | ||
60 | ||
61 | \membersection{cbPaneDrawPlugin::DrawLowerRowShades}\label{cbpanedrawplugindrawlowerrowshades} | |
62 | ||
63 | \func{void}{DrawLowerRowShades}{\param{cbRowInfo* }{pRow}, \param{wxDC\& }{dc}, \param{int }{level}} | |
64 | ||
65 | ||
66 | \membersection{cbPaneDrawPlugin::DrawPaneShade}\label{cbpanedrawplugindrawpaneshade} | |
67 | ||
68 | \func{void}{DrawPaneShade}{\param{wxDC\& }{dc}, \param{int }{alignment}} | |
69 | ||
70 | ||
71 | \membersection{cbPaneDrawPlugin::DrawPaneShadeForRow}\label{cbpanedrawplugindrawpaneshadeforrow} | |
72 | ||
73 | \func{void}{DrawPaneShadeForRow}{\param{cbRowInfo* }{pRow}, \param{wxDC\& }{dc}} | |
74 | ||
75 | ||
76 | \membersection{cbPaneDrawPlugin::DrawShade}\label{cbpanedrawplugindrawshade} | |
77 | ||
78 | \func{void}{DrawShade}{\param{int }{level}, \param{wxRect\& }{rect}, \param{int }{alignment}, \param{wxDC\& }{dc}} | |
79 | ||
80 | ||
81 | \membersection{cbPaneDrawPlugin::DrawShade1}\label{cbpanedrawplugindrawshade1} | |
82 | ||
83 | \func{void}{DrawShade1}{\param{int }{level}, \param{wxRect\& }{rect}, \param{int }{alignment}, \param{wxDC\& }{dc}} | |
84 | ||
85 | ||
86 | \membersection{cbPaneDrawPlugin::DrawUpperRowHandle}\label{cbpanedrawplugindrawupperrowhandle} | |
87 | ||
88 | \func{void}{DrawUpperRowHandle}{\param{cbRowInfo* }{pRow}, \param{wxDC\& }{dc}} | |
89 | ||
90 | ||
91 | \membersection{cbPaneDrawPlugin::DrawUpperRowShades}\label{cbpanedrawplugindrawupperrowshades} | |
92 | ||
93 | \func{void}{DrawUpperRowShades}{\param{cbRowInfo* }{pRow}, \param{wxDC\& }{dc}, \param{int }{level}} | |
94 | ||
95 | ||
96 | \membersection{cbPaneDrawPlugin::OnDrawBarDecorations}\label{cbpanedrawpluginondrawbardecorations} | |
97 | ||
98 | \func{void}{OnDrawBarDecorations}{\param{cbDrawBarDecorEvent\& }{event}} | |
99 | ||
100 | ||
101 | \membersection{cbPaneDrawPlugin::OnDrawBarHandles}\label{cbpanedrawpluginondrawbarhandles} | |
102 | ||
103 | \func{void}{OnDrawBarHandles}{\param{cbDrawBarHandlesEvent\& }{event}} | |
104 | ||
105 | ||
106 | \membersection{cbPaneDrawPlugin::OnDrawPaneBackground}\label{cbpanedrawpluginondrawpanebackground} | |
107 | ||
108 | \func{void}{OnDrawPaneBackground}{\param{cbDrawPaneBkGroundEvent\& }{event}} | |
109 | ||
110 | ||
111 | \membersection{cbPaneDrawPlugin::OnDrawPaneDecorations}\label{cbpanedrawpluginondrawpanedecorations} | |
112 | ||
113 | \func{void}{OnDrawPaneDecorations}{\param{cbDrawPaneDecorEvent\& }{event}} | |
114 | ||
115 | ||
116 | \membersection{cbPaneDrawPlugin::OnDrawRowBackground}\label{cbpanedrawpluginondrawrowbackground} | |
117 | ||
118 | \func{void}{OnDrawRowBackground}{\param{cbDrawRowBkGroundEvent\& }{event}} | |
119 | ||
120 | ||
121 | \membersection{cbPaneDrawPlugin::OnDrawRowDecorations}\label{cbpanedrawpluginondrawrowdecorations} | |
122 | ||
123 | \func{void}{OnDrawRowDecorations}{\param{cbDrawRowDecorEvent\& }{event}} | |
124 | ||
125 | ||
126 | \membersection{cbPaneDrawPlugin::OnDrawRowHandles}\label{cbpanedrawpluginondrawrowhandles} | |
127 | ||
128 | \func{void}{OnDrawRowHandles}{\param{cbDrawRowHandlesEvent\& }{event}} | |
129 | ||
130 | ||
131 | \membersection{cbPaneDrawPlugin::OnFinishDrawInArea}\label{cbpanedrawpluginonfinishdrawinarea} | |
132 | ||
133 | \func{void}{OnFinishDrawInArea}{\param{cbFinishDrawInAreaEvent\& }{event}} | |
134 | ||
135 | ||
136 | \membersection{cbPaneDrawPlugin::OnLButtonDown}\label{cbpanedrawpluginonlbuttondown} | |
137 | ||
138 | \func{void}{OnLButtonDown}{\param{cbLeftDownEvent\& }{event}} | |
139 | ||
140 | handlers for plugin-events | |
141 | ||
142 | ||
143 | \membersection{cbPaneDrawPlugin::OnLButtonUp}\label{cbpanedrawpluginonlbuttonup} | |
144 | ||
145 | \func{void}{OnLButtonUp}{\param{cbLeftUpEvent\& }{event}} | |
146 | ||
147 | ||
148 | \membersection{cbPaneDrawPlugin::OnLDblClick}\label{cbpanedrawpluginonldblclick} | |
149 | ||
150 | \func{void}{OnLDblClick}{\param{cbLeftDClickEvent\& }{event}} | |
151 | ||
152 | ||
153 | \membersection{cbPaneDrawPlugin::OnMouseMove}\label{cbpanedrawpluginonmousemove} | |
154 | ||
155 | \func{void}{OnMouseMove}{\param{cbMotionEvent\& }{event}} | |
156 | ||
157 | ||
158 | \membersection{cbPaneDrawPlugin::OnRButtonUp}\label{cbpanedrawpluginonrbuttonup} | |
159 | ||
160 | \func{void}{OnRButtonUp}{\param{cbRightUpEvent\& }{event}} | |
161 | ||
162 | ||
163 | \membersection{cbPaneDrawPlugin::OnSizeBarWindow}\label{cbpanedrawpluginonsizebarwindow} | |
164 | ||
165 | \func{void}{OnSizeBarWindow}{\param{cbSizeBarWndEvent\& }{event}} | |
166 | ||
167 | ||
168 | \membersection{cbPaneDrawPlugin::OnStartDrawInArea}\label{cbpanedrawpluginonstartdrawinarea} | |
169 | ||
170 | \func{void}{OnStartDrawInArea}{\param{cbStartDrawInAreaEvent\& }{event}} | |
171 | ||
172 | ||
173 | \membersection{cbPaneDrawPlugin::SetDarkPixel}\label{cbpanedrawpluginsetdarkpixel} | |
174 | ||
175 | \func{void}{SetDarkPixel}{\param{int }{x}, \param{int }{y}, \param{wxDC\& }{dc}} | |
176 | ||
177 | ||
178 | \membersection{cbPaneDrawPlugin::SetLightPixel}\label{cbpanedrawpluginsetlightpixel} | |
179 | ||
180 | \func{void}{SetLightPixel}{\param{int }{x}, \param{int }{y}, \param{wxDC\& }{dc}} | |
181 |