1%
2% automatically generated by HelpGen $Revision: 44233 $ from
3% dockart.h at 04/Nov/06 21:54:42
4%
5
6\section{\class{wxAuiDockArt}}\label{wxauidockart}
7
8wxAuiDockArt is part of the wxAUI class framework.
9See also \helpref{wxAUI overview}{wxauioverview}.
10
11Dock art provider code - a dock provider provides all drawing
12functionality to the wxAui dock manager. This allows the dock
13manager to have a plugable look-and-feel.
14
15By default, a \helpref{wxAuiManager}{wxauimanager} uses an
16instance of this class called {\bf wxAuiDefaultDockArt} which
17provides bitmap art and a colour scheme that is adapted to
18the major platforms' look. You can either derive from that
19class to alter its behaviour or write a completely new dock
20art class. Call \helpref{wxAuiManager::SetArtProvider}{wxauimanagersetartprovider}
21to make use this new dock art.
22
23\wxheading{Derived from}
24
25No base class
26
27\wxheading{Include files}
28
29<wx/aui/dockart.h>
30
31\wxheading{See also}
32
33\helpref{wxAuiManager}{wxauimanager}, 
34\helpref{wxAuiPaneInfo}{wxauipaneinfo}
35
36\wxheading{Data structures}
37
38\begin{verbatim}
39enum wxAuiPaneDockArtSetting
40{
41    wxAUI_DOCKART_SASH_SIZE = 0,
42    wxAUI_DOCKART_CAPTION_SIZE = 1,
43    wxAUI_DOCKART_GRIPPER_SIZE = 2,
44    wxAUI_DOCKART_PANE_BORDER_SIZE = 3,
45    wxAUI_DOCKART_PANE_BUTTON_SIZE = 4,
46    wxAUI_DOCKART_BACKGROUND_COLOUR = 5,
47    wxAUI_DOCKART_SASH_COLOUR = 6,
48    wxAUI_DOCKART_ACTIVE_CAPTION_COLOUR = 7,
49    wxAUI_DOCKART_ACTIVE_CAPTION_GRADIENT_COLOUR = 8,
50    wxAUI_DOCKART_INACTIVE_CAPTION_COLOUR = 9,
51    wxAUI_DOCKART_INACTIVE_CAPTION_GRADIENT_COLOUR = 10,
52    wxAUI_DOCKART_ACTIVE_CAPTION_TEXT_COLOUR = 11,
53    wxAUI_DOCKART_INACTIVE_CAPTION_TEXT_COLOUR = 12,
54    wxAUI_DOCKART_BORDER_COLOUR = 13,
55    wxAUI_DOCKART_GRIPPER_COLOUR = 14,
56    wxAUI_DOCKART_CAPTION_FONT = 15,
57    wxAUI_DOCKART_GRADIENT_TYPE = 16
58}
59\end{verbatim}
60
61\begin{verbatim}
62enum wxAuiPaneDockArtGradients
63{
64    wxAUI_GRADIENT_NONE = 0,
65    wxAUI_GRADIENT_VERTICAL = 1,
66    wxAUI_GRADIENT_HORIZONTAL = 2
67}
68\end{verbatim}
69
70\begin{verbatim}
71enum wxAuiPaneButtonState
72{
73    wxAUI_BUTTON_STATE_NORMAL = 0,
74    wxAUI_BUTTON_STATE_HOVER = 1,
75    wxAUI_BUTTON_STATE_PRESSED = 2
76}
77\end{verbatim}
78
79\begin{verbatim}
80enum wxAuiButtonId
81{
82    wxAUI_BUTTON_CLOSE = 101,
83    wxAUI_BUTTON_MAXIMIZE_RESTORE = 102,
84    wxAUI_BUTTON_MINIMIZE = 103,
85    wxAUI_BUTTON_PIN = 104,
86    wxAUI_BUTTON_OPTIONS = 105,
87    wxAUI_BUTTON_WINDOWLIST = 106,
88    wxAUI_BUTTON_LEFT = 107,
89    wxAUI_BUTTON_RIGHT = 108,
90    wxAUI_BUTTON_UP = 109,
91    wxAUI_BUTTON_DOWN = 110,
92    wxAUI_BUTTON_CUSTOM1 = 201,
93    wxAUI_BUTTON_CUSTOM2 = 202,
94    wxAUI_BUTTON_CUSTOM3 = 203
95};
96\end{verbatim}
97
98
99
100\membersection{wxAuiDockArt::wxAuiDockArt}\label{wxauidockartwxauidockart}
101
102\func{}{wxAuiDockArt}{\void}
103
104Constructor.
105
106\membersection{wxAuiDockArt::\destruct{wxAuiDockArt}}\label{wxauidockartdtor}
107
108\func{}{\destruct{wxAuiDockArt}}{\void}
109
110Destructor.
111
112\membersection{wxAuiDockArt::DrawBackground}\label{wxauidockartdrawbackground}
113
114\func{virtual void}{DrawBackground}{\param{wxDC\& }{dc}, \param{wxWindow* }{window}, \param{int }{orientation}, \param{const wxRect\& }{rect}}
115
116Draws a background.
117
118\membersection{wxAuiDockArt::DrawBorder}\label{wxauidockartdrawborder}
119
120\func{virtual void}{DrawBorder}{\param{wxDC\& }{dc}, \param{wxWindow* }{window}, \param{const wxRect\& }{rect}, \param{wxAuiPaneInfo\& }{pane}}
121
122Draws a border.
123
124\membersection{wxAuiDockArt::DrawCaption}\label{wxauidockartdrawcaption}
125
126\func{virtual void}{DrawCaption}{\param{wxDC\& }{dc}, \param{wxWindow* }{window}, \param{const wxString\& }{text}, \param{const wxRect\& }{rect}, \param{wxAuiPaneInfo\& }{pane}}
127
128Draws a caption.
129
130\membersection{wxAuiDockArt::DrawGripper}\label{wxauidockartdrawgripper}
131
132\func{virtual void}{DrawGripper}{\param{wxDC\& }{dc}, \param{wxWindow* }{window}, \param{const wxRect\& }{rect}, \param{wxAuiPaneInfo\& }{pane}}
133
134Draws a gripper.
135
136\membersection{wxAuiDockArt::DrawPaneButton}\label{wxauidockartdrawpanebutton}
137
138\func{virtual void}{DrawPaneButton}{\param{wxDC\& }{dc}, \param{wxWindow* }{window}, \param{int }{button}, \param{int }{button\_state}, \param{const wxRect\& }{rect}, \param{wxAuiPaneInfo\& }{pane}}
139
140Draws a button in the pane's title bar.
141
142{\it button} can be one of the values of {\bf wxAuiButtonId}.
143
144{\it button\_state} can be one of the values of {\bf wxAuiPaneButtonState}.
145
146\membersection{wxAuiDockArt::DrawSash}\label{wxauidockartdrawsash}
147
148\func{virtual void}{DrawSash}{\param{wxDC\& }{dc}, \param{wxWindow* }{window}, \param{int }{orientation}, \param{const wxRect\& }{rect}}
149
150Draws a sash between two windows.
151
152\membersection{wxAuiDockArt::GetColor}\label{wxauidockartgetcolor}
153
154\func{virtual wxColour}{GetColor}{\param{int }{id}}
155
156The same as \helpref{GetColour}{wxauidockartgetcolour}.
157
158\membersection{wxAuiDockArt::GetColour}\label{wxauidockartgetcolour}
159
160\func{virtual wxColour}{GetColour}{\param{int }{id}}
161
162Get the colour of a certain setting.
163
164{\it id} can be one of the colour values of {\bf wxAuiPaneDockArtSetting}.
165
166
167\membersection{wxAuiDockArt::GetFont}\label{wxauidockartgetfont}
168
169\func{virtual wxFont}{GetFont}{\param{int }{id}}
170
171Get a font setting.
172
173\membersection{wxAuiDockArt::GetMetric}\label{wxauidockartgetmetric}
174
175\func{virtual int}{GetMetric}{\param{int }{id}}
176
177Get the value of a certain setting.
178
179{\it id} can be one of the size values of {\bf wxAuiPaneDockArtSetting}.
180
181
182\membersection{wxAuiDockArt::SetColor}\label{wxauidockartsetcolor}
183
184\func{virtual void}{SetColor}{\param{int }{id}, \param{const wxColour\& }{color}}
185
186The same as \helpref{SetColour}{wxauidockartsetcolour}.
187
188\membersection{wxAuiDockArt::SetColour}\label{wxauidockartsetcolour}
189
190\func{virtual void}{SetColour}{\param{int }{id}, \param{const wxColor\& }{colour}}
191
192Set a certain setting with the value {\it colour}.
193
194{\it id} can be one of the colour values of {\bf wxAuiPaneDockArtSetting}.
195
196\membersection{wxAuiDockArt::SetFont}\label{wxauidockartsetfont}
197
198\func{virtual void}{SetFont}{\param{int }{id}, \param{const wxFont\& }{font}}
199
200Set a font setting.
201
202\membersection{wxAuiDockArt::SetMetric}\label{wxauidockartsetmetric}
203
204\func{virtual void}{SetMetric}{\param{int }{id}, \param{int }{new\_val}}
205
206Set a certain setting with the value {\it new\_val}.
207
208{\it id} can be one of the size values of {\bf wxAuiPaneDockArtSetting}.
209
210