docs/latex/wx/auidockart.tex

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