]> git.saurik.com Git - wxWidgets.git/blame - docs/latex/wx/auidockart.tex
typo fix
[wxWidgets.git] / docs / latex / wx / auidockart.tex
CommitLineData
e67635d4
RR
1%
2% automatically generated by HelpGen $Revision$ from
3% dockart.h at 04/Nov/06 21:54:42
4%
5
6\section{\class{wxAuiDockArt}}\label{wxauidockart}
7
683b60e9
BW
8wxAuiDockArt is part of the wxAUI class framework.
9See also \helpref{wxAUI overview}{wxauioverview}.
10
e67635d4
RR
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
a7af285d
VZ
31\wxheading{Library}
32
33\helpref{wxAui}{librarieslist}
34
e67635d4
RR
35\wxheading{See also}
36
2207fd21 37\helpref{wxAuiManager}{wxauimanager},
e67635d4
RR
38\helpref{wxAuiPaneInfo}{wxauipaneinfo}
39
40\wxheading{Data structures}
41
42\begin{verbatim}
43enum wxAuiPaneDockArtSetting
44{
a95dd1d8
BW
45 wxAUI_DOCKART_SASH_SIZE = 0,
46 wxAUI_DOCKART_CAPTION_SIZE = 1,
47 wxAUI_DOCKART_GRIPPER_SIZE = 2,
48 wxAUI_DOCKART_PANE_BORDER_SIZE = 3,
49 wxAUI_DOCKART_PANE_BUTTON_SIZE = 4,
50 wxAUI_DOCKART_BACKGROUND_COLOUR = 5,
51 wxAUI_DOCKART_SASH_COLOUR = 6,
52 wxAUI_DOCKART_ACTIVE_CAPTION_COLOUR = 7,
53 wxAUI_DOCKART_ACTIVE_CAPTION_GRADIENT_COLOUR = 8,
54 wxAUI_DOCKART_INACTIVE_CAPTION_COLOUR = 9,
55 wxAUI_DOCKART_INACTIVE_CAPTION_GRADIENT_COLOUR = 10,
56 wxAUI_DOCKART_ACTIVE_CAPTION_TEXT_COLOUR = 11,
57 wxAUI_DOCKART_INACTIVE_CAPTION_TEXT_COLOUR = 12,
58 wxAUI_DOCKART_BORDER_COLOUR = 13,
59 wxAUI_DOCKART_GRIPPER_COLOUR = 14,
60 wxAUI_DOCKART_CAPTION_FONT = 15,
61 wxAUI_DOCKART_GRADIENT_TYPE = 16
e67635d4
RR
62}
63\end{verbatim}
64
65\begin{verbatim}
66enum wxAuiPaneDockArtGradients
67{
68 wxAUI_GRADIENT_NONE = 0,
69 wxAUI_GRADIENT_VERTICAL = 1,
70 wxAUI_GRADIENT_HORIZONTAL = 2
71}
72\end{verbatim}
73
74\begin{verbatim}
75enum wxAuiPaneButtonState
76{
77 wxAUI_BUTTON_STATE_NORMAL = 0,
78 wxAUI_BUTTON_STATE_HOVER = 1,
79 wxAUI_BUTTON_STATE_PRESSED = 2
80}
81\end{verbatim}
82
83\begin{verbatim}
84enum wxAuiButtonId
85{
86 wxAUI_BUTTON_CLOSE = 101,
87 wxAUI_BUTTON_MAXIMIZE_RESTORE = 102,
88 wxAUI_BUTTON_MINIMIZE = 103,
89 wxAUI_BUTTON_PIN = 104,
90 wxAUI_BUTTON_OPTIONS = 105,
91 wxAUI_BUTTON_WINDOWLIST = 106,
92 wxAUI_BUTTON_LEFT = 107,
93 wxAUI_BUTTON_RIGHT = 108,
94 wxAUI_BUTTON_UP = 109,
95 wxAUI_BUTTON_DOWN = 110,
96 wxAUI_BUTTON_CUSTOM1 = 201,
97 wxAUI_BUTTON_CUSTOM2 = 202,
98 wxAUI_BUTTON_CUSTOM3 = 203
99};
100\end{verbatim}
101
102
103
104\membersection{wxAuiDockArt::wxAuiDockArt}\label{wxauidockartwxauidockart}
105
106\func{}{wxAuiDockArt}{\void}
107
108Constructor.
109
110\membersection{wxAuiDockArt::\destruct{wxAuiDockArt}}\label{wxauidockartdtor}
111
112\func{}{\destruct{wxAuiDockArt}}{\void}
113
114Destructor.
115
116\membersection{wxAuiDockArt::DrawBackground}\label{wxauidockartdrawbackground}
117
118\func{virtual void}{DrawBackground}{\param{wxDC\& }{dc}, \param{wxWindow* }{window}, \param{int }{orientation}, \param{const wxRect\& }{rect}}
119
120Draws a background.
121
122\membersection{wxAuiDockArt::DrawBorder}\label{wxauidockartdrawborder}
123
124\func{virtual void}{DrawBorder}{\param{wxDC\& }{dc}, \param{wxWindow* }{window}, \param{const wxRect\& }{rect}, \param{wxAuiPaneInfo\& }{pane}}
125
126Draws a border.
127
128\membersection{wxAuiDockArt::DrawCaption}\label{wxauidockartdrawcaption}
129
130\func{virtual void}{DrawCaption}{\param{wxDC\& }{dc}, \param{wxWindow* }{window}, \param{const wxString\& }{text}, \param{const wxRect\& }{rect}, \param{wxAuiPaneInfo\& }{pane}}
131
132Draws a caption.
133
134\membersection{wxAuiDockArt::DrawGripper}\label{wxauidockartdrawgripper}
135
136\func{virtual void}{DrawGripper}{\param{wxDC\& }{dc}, \param{wxWindow* }{window}, \param{const wxRect\& }{rect}, \param{wxAuiPaneInfo\& }{pane}}
137
138Draws a gripper.
139
140\membersection{wxAuiDockArt::DrawPaneButton}\label{wxauidockartdrawpanebutton}
141
142\func{virtual void}{DrawPaneButton}{\param{wxDC\& }{dc}, \param{wxWindow* }{window}, \param{int }{button}, \param{int }{button\_state}, \param{const wxRect\& }{rect}, \param{wxAuiPaneInfo\& }{pane}}
143
144Draws a button in the pane's title bar.
145
146{\it button} can be one of the values of {\bf wxAuiButtonId}.
147
148{\it button\_state} can be one of the values of {\bf wxAuiPaneButtonState}.
149
150\membersection{wxAuiDockArt::DrawSash}\label{wxauidockartdrawsash}
151
152\func{virtual void}{DrawSash}{\param{wxDC\& }{dc}, \param{wxWindow* }{window}, \param{int }{orientation}, \param{const wxRect\& }{rect}}
153
154Draws a sash between two windows.
155
156\membersection{wxAuiDockArt::GetColor}\label{wxauidockartgetcolor}
157
158\func{virtual wxColour}{GetColor}{\param{int }{id}}
159
160The same as \helpref{GetColour}{wxauidockartgetcolour}.
161
162\membersection{wxAuiDockArt::GetColour}\label{wxauidockartgetcolour}
163
164\func{virtual wxColour}{GetColour}{\param{int }{id}}
165
166Get the colour of a certain setting.
167
168{\it id} can be one of the colour values of {\bf wxAuiPaneDockArtSetting}.
169
170
171\membersection{wxAuiDockArt::GetFont}\label{wxauidockartgetfont}
172
173\func{virtual wxFont}{GetFont}{\param{int }{id}}
174
175Get a font setting.
176
177\membersection{wxAuiDockArt::GetMetric}\label{wxauidockartgetmetric}
178
179\func{virtual int}{GetMetric}{\param{int }{id}}
180
181Get the value of a certain setting.
182
183{\it id} can be one of the size values of {\bf wxAuiPaneDockArtSetting}.
184
185
186\membersection{wxAuiDockArt::SetColor}\label{wxauidockartsetcolor}
187
188\func{virtual void}{SetColor}{\param{int }{id}, \param{const wxColour\& }{color}}
189
190The same as \helpref{SetColour}{wxauidockartsetcolour}.
191
192\membersection{wxAuiDockArt::SetColour}\label{wxauidockartsetcolour}
193
194\func{virtual void}{SetColour}{\param{int }{id}, \param{const wxColor\& }{colour}}
195
196Set a certain setting with the value {\it colour}.
197
198{\it id} can be one of the colour values of {\bf wxAuiPaneDockArtSetting}.
199
200\membersection{wxAuiDockArt::SetFont}\label{wxauidockartsetfont}
201
202\func{virtual void}{SetFont}{\param{int }{id}, \param{const wxFont\& }{font}}
203
204Set a font setting.
205
206\membersection{wxAuiDockArt::SetMetric}\label{wxauidockartsetmetric}
207
208\func{virtual void}{SetMetric}{\param{int }{id}, \param{int }{new\_val}}
209
210Set a certain setting with the value {\it new\_val}.
211
212{\it id} can be one of the size values of {\bf wxAuiPaneDockArtSetting}.
213