updated SetFont() documentation: it returns bool, not void (bug 1705330)

[wxWidgets.git] / docs / latex / wx / auidockart.tex

%
% automatically generated by HelpGen $Revision$ from
% dockart.h at 04/Nov/06 21:54:42
%

\section{\class{wxAuiDockArt}}\label{wxauidockart}

wxAuiDockArt is part of the wxAUI class framework.
See also \helpref{wxAUI overview}{wxauioverview}.

Dock art provider code - a dock provider provides all drawing
functionality to the wxAui dock manager. This allows the dock
manager to have a plugable look-and-feel.

By default, a \helpref{wxAuiManager}{wxauimanager} uses an
instance of this class called {\bf wxAuiDefaultDockArt} which
provides bitmap art and a colour scheme that is adapted to
the major platforms' look. You can either derive from that
class to alter its behaviour or write a completely new dock
art class. Call \helpref{wxAuiManager::SetArtProvider}{wxauimanagersetartprovider}
to make use this new dock art.

\wxheading{Derived from}

No base class

\wxheading{Include files}

<wx/aui/dockart.h>

\wxheading{See also}

\helpref{wxAuiManager}{wxauimanager}, 
\helpref{wxAuiPaneInfo}{wxauipaneinfo}

\wxheading{Data structures}

\begin{verbatim}
enum wxAuiPaneDockArtSetting
{
    wxAUI_DOCKART_SASH_SIZE = 0,
    wxAUI_DOCKART_CAPTION_SIZE = 1,
    wxAUI_DOCKART_GRIPPER_SIZE = 2,
    wxAUI_DOCKART_PANE_BORDER_SIZE = 3,
    wxAUI_DOCKART_PANE_BUTTON_SIZE = 4,
    wxAUI_DOCKART_BACKGROUND_COLOUR = 5,
    wxAUI_DOCKART_SASH_COLOUR = 6,
    wxAUI_DOCKART_ACTIVE_CAPTION_COLOUR = 7,
    wxAUI_DOCKART_ACTIVE_CAPTION_GRADIENT_COLOUR = 8,
    wxAUI_DOCKART_INACTIVE_CAPTION_COLOUR = 9,
    wxAUI_DOCKART_INACTIVE_CAPTION_GRADIENT_COLOUR = 10,
    wxAUI_DOCKART_ACTIVE_CAPTION_TEXT_COLOUR = 11,
    wxAUI_DOCKART_INACTIVE_CAPTION_TEXT_COLOUR = 12,
    wxAUI_DOCKART_BORDER_COLOUR = 13,
    wxAUI_DOCKART_GRIPPER_COLOUR = 14,
    wxAUI_DOCKART_CAPTION_FONT = 15,
    wxAUI_DOCKART_GRADIENT_TYPE = 16
}
\end{verbatim}

\begin{verbatim}
enum wxAuiPaneDockArtGradients
{
    wxAUI_GRADIENT_NONE = 0,
    wxAUI_GRADIENT_VERTICAL = 1,
    wxAUI_GRADIENT_HORIZONTAL = 2
}
\end{verbatim}

\begin{verbatim}
enum wxAuiPaneButtonState
{
    wxAUI_BUTTON_STATE_NORMAL = 0,
    wxAUI_BUTTON_STATE_HOVER = 1,
    wxAUI_BUTTON_STATE_PRESSED = 2
}
\end{verbatim}

\begin{verbatim}
enum wxAuiButtonId
{
    wxAUI_BUTTON_CLOSE = 101,
    wxAUI_BUTTON_MAXIMIZE_RESTORE = 102,
    wxAUI_BUTTON_MINIMIZE = 103,
    wxAUI_BUTTON_PIN = 104,
    wxAUI_BUTTON_OPTIONS = 105,
    wxAUI_BUTTON_WINDOWLIST = 106,
    wxAUI_BUTTON_LEFT = 107,
    wxAUI_BUTTON_RIGHT = 108,
    wxAUI_BUTTON_UP = 109,
    wxAUI_BUTTON_DOWN = 110,
    wxAUI_BUTTON_CUSTOM1 = 201,
    wxAUI_BUTTON_CUSTOM2 = 202,
    wxAUI_BUTTON_CUSTOM3 = 203
};
\end{verbatim}



\membersection{wxAuiDockArt::wxAuiDockArt}\label{wxauidockartwxauidockart}

\func{}{wxAuiDockArt}{\void}

Constructor.

\membersection{wxAuiDockArt::\destruct{wxAuiDockArt}}\label{wxauidockartdtor}

\func{}{\destruct{wxAuiDockArt}}{\void}

Destructor.

\membersection{wxAuiDockArt::DrawBackground}\label{wxauidockartdrawbackground}

\func{virtual void}{DrawBackground}{\param{wxDC\& }{dc}, \param{wxWindow* }{window}, \param{int }{orientation}, \param{const wxRect\& }{rect}}

Draws a background.

\membersection{wxAuiDockArt::DrawBorder}\label{wxauidockartdrawborder}

\func{virtual void}{DrawBorder}{\param{wxDC\& }{dc}, \param{wxWindow* }{window}, \param{const wxRect\& }{rect}, \param{wxAuiPaneInfo\& }{pane}}

Draws a border.

\membersection{wxAuiDockArt::DrawCaption}\label{wxauidockartdrawcaption}

\func{virtual void}{DrawCaption}{\param{wxDC\& }{dc}, \param{wxWindow* }{window}, \param{const wxString\& }{text}, \param{const wxRect\& }{rect}, \param{wxAuiPaneInfo\& }{pane}}

Draws a caption.

\membersection{wxAuiDockArt::DrawGripper}\label{wxauidockartdrawgripper}

\func{virtual void}{DrawGripper}{\param{wxDC\& }{dc}, \param{wxWindow* }{window}, \param{const wxRect\& }{rect}, \param{wxAuiPaneInfo\& }{pane}}

Draws a gripper.

\membersection{wxAuiDockArt::DrawPaneButton}\label{wxauidockartdrawpanebutton}

\func{virtual void}{DrawPaneButton}{\param{wxDC\& }{dc}, \param{wxWindow* }{window}, \param{int }{button}, \param{int }{button\_state}, \param{const wxRect\& }{rect}, \param{wxAuiPaneInfo\& }{pane}}

Draws a button in the pane's title bar.

{\it button} can be one of the values of {\bf wxAuiButtonId}.

{\it button\_state} can be one of the values of {\bf wxAuiPaneButtonState}.

\membersection{wxAuiDockArt::DrawSash}\label{wxauidockartdrawsash}

\func{virtual void}{DrawSash}{\param{wxDC\& }{dc}, \param{wxWindow* }{window}, \param{int }{orientation}, \param{const wxRect\& }{rect}}

Draws a sash between two windows.

\membersection{wxAuiDockArt::GetColor}\label{wxauidockartgetcolor}

\func{virtual wxColour}{GetColor}{\param{int }{id}}

The same as \helpref{GetColour}{wxauidockartgetcolour}.

\membersection{wxAuiDockArt::GetColour}\label{wxauidockartgetcolour}

\func{virtual wxColour}{GetColour}{\param{int }{id}}

Get the colour of a certain setting.

{\it id} can be one of the colour values of {\bf wxAuiPaneDockArtSetting}.


\membersection{wxAuiDockArt::GetFont}\label{wxauidockartgetfont}

\func{virtual wxFont}{GetFont}{\param{int }{id}}

Get a font setting.

\membersection{wxAuiDockArt::GetMetric}\label{wxauidockartgetmetric}

\func{virtual int}{GetMetric}{\param{int }{id}}

Get the value of a certain setting.

{\it id} can be one of the size values of {\bf wxAuiPaneDockArtSetting}.


\membersection{wxAuiDockArt::SetColor}\label{wxauidockartsetcolor}

\func{virtual void}{SetColor}{\param{int }{id}, \param{const wxColour\& }{color}}

The same as \helpref{SetColour}{wxauidockartsetcolour}.

\membersection{wxAuiDockArt::SetColour}\label{wxauidockartsetcolour}

\func{virtual void}{SetColour}{\param{int }{id}, \param{const wxColor\& }{colour}}

Set a certain setting with the value {\it colour}.

{\it id} can be one of the colour values of {\bf wxAuiPaneDockArtSetting}.

\membersection{wxAuiDockArt::SetFont}\label{wxauidockartsetfont}

\func{virtual void}{SetFont}{\param{int }{id}, \param{const wxFont\& }{font}}

Set a font setting.

\membersection{wxAuiDockArt::SetMetric}\label{wxauidockartsetmetric}

\func{virtual void}{SetMetric}{\param{int }{id}, \param{int }{new\_val}}

Set a certain setting with the value {\it new\_val}.

{\it id} can be one of the size values of {\bf wxAuiPaneDockArtSetting}.