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

%
% automatically generated by HelpGen $Revision$ from
% auibook.h at 11/Nov/06 22:56:01
%

\section{\class{wxAuiTabArt}}\label{wxauitabart}

Tab art class.

\wxheading{Derived from}

No base class

\wxheading{Include files}

<wx/aui/auibook.h>

\wxheading{Data structures}

\latexignore{\rtfignore{\wxheading{Members}}}

\membersection{wxAuiTabArt::wxAuiTabArt}\label{wxauitabartwxauitabart}

\func{}{wxAuiTabArt}{\void}

Constructor.

\membersection{wxAuiTabArt::Clone}\label{wxauitabartclone}

\func{wxAuiTabArt*}{Clone}{\void}

Clones the art object.

\membersection{wxAuiTabArt::DrawBackground}\label{wxauitabartdrawbackground}

\func{void}{DrawBackground}{\param{wxDC\& }{dc}, \param{wxWindow* }{wnd}, \param{const wxRect\& }{rect}}

Draws a background on the given area.

\membersection{wxAuiTabArt::DrawButton}\label{wxauitabartdrawbutton}

\func{void}{DrawButton}{\param{wxDC\& }{dc}, \param{wxWindow* }{wnd}, \param{const wxRect\& }{in\_rect}, \param{int }{bitmap\_id}, \param{int }{button\_state}, \param{int }{orientation}, \param{const wxBitmap\& }{bitmap\_override}, \param{wxRect* }{out\_rect}}

Draws a button.

\membersection{wxAuiTabArt::DrawTab}\label{wxauitabartdrawtab}

\func{void}{DrawTab}{\param{wxDC\& }{dc}, \param{wxWindow* }{wnd}, \param{const wxRect\& }{in\_rect}, \param{const wxString\& }{caption}, \param{const wxBitmap\& }{bitmap}, \param{bool }{active}, \param{int }{close\_button\_state}, \param{wxRect* }{out\_tab\_rect}, \param{wxRect* }{out\_button\_rect}, \param{int* }{x\_extent}}

Draws a tab.

\membersection{wxAuiTabArt::GetBestTabCtrlSize}\label{wxauitabartgetbesttabctrlsize}

\func{int}{GetBestTabCtrlSize}{\param{wxWindow* }{wnd}, \param{wxAuiNotebookPageArray\& }{pages}}

Returns the tab control size.

\membersection{wxAuiTabArt::GetIndentSize}\label{wxauitabartgetindentsize}

\func{int}{GetIndentSize}{\void}

Returns the indent size.

\membersection{wxAuiTabArt::GetTabSize}\label{wxauitabartgettabsize}

\func{wxSize}{GetTabSize}{\param{wxDC\& }{dc}, \param{wxWindow* }{wnd}, \param{const wxString\& }{caption}, \param{const wxBitmap\& }{bitmap}, \param{bool }{active}, \param{int }{close\_button\_state}, \param{int* }{x\_extent}}

Returns the tab size for the given caption, bitmap and state.

\membersection{wxAuiTabArt::SetFlags}\label{wxauitabartsetflags}

\func{void}{SetFlags}{\param{unsigned int }{flags}}

Sets flags.

\membersection{wxAuiTabArt::SetMeasuringFont}\label{wxauitabartsetmeasuringfont}

\func{void}{SetMeasuringFont}{\param{const wxFont\& }{font}}

Sets the font used for calculating measurements.

\membersection{wxAuiTabArt::SetNormalFont}\label{wxauitabartsetnormalfont}

\func{void}{SetNormalFont}{\param{const wxFont\& }{font}}

Sets the normal font for drawing labels.

\membersection{wxAuiTabArt::SetSelectedFont}\label{wxauitabartsetselectedfont}

\func{void}{SetSelectedFont}{\param{const wxFont\& }{font}}

Sets the font for drawing text for selected UI elements.

\membersection{wxAuiTabArt::SetSizingInfo}\label{wxauitabartsetsizinginfo}

\func{void}{SetSizingInfo}{\param{const wxSize\& }{tab\_ctrl\_size}, \param{size\_t }{tab\_count}}

Sets sizing information.

\membersection{wxAuiTabArt::ShowWindowList}\label{wxauitabartshowwindowlist}

\func{int}{ShowWindowList}{\param{wxWindow* }{wnd}, \param{const wxArrayString\& }{items}, \param{int }{active\_idx}}

Pops up a menu to show the list of windows managed by wxAui.
Commit	Line	Data
c0d9896a BW	1	%
	2	% automatically generated by HelpGen $Revision$ from
	3	% auibook.h at 11/Nov/06 22:56:01
	4	%
	5
c0d9896a BW	6	\section{\class{wxAuiTabArt}}\label{wxauitabart}
c0d9896a BW	7
8ffbb0f8	8	Tab art class.
c0d9896a BW	9
	10	\wxheading{Derived from}
	11
	12	No base class
	13
	14	\wxheading{Include files}
	15
8ffbb0f8	16	<wx/aui/auibook.h>
c0d9896a BW	17
	18	\wxheading{Data structures}
	19
	20	\latexignore{\rtfignore{\wxheading{Members}}}
	21
c0d9896a BW	22	\membersection{wxAuiTabArt::wxAuiTabArt}\label{wxauitabartwxauitabart}
	23
	24	\func{}{wxAuiTabArt}{\void}
	25
8ffbb0f8	26	Constructor.
c0d9896a BW	27
	28	\membersection{wxAuiTabArt::Clone}\label{wxauitabartclone}
	29
	30	\func{wxAuiTabArt*}{Clone}{\void}
	31
8ffbb0f8	32	Clones the art object.
c0d9896a BW	33
	34	\membersection{wxAuiTabArt::DrawBackground}\label{wxauitabartdrawbackground}
	35
	36	\func{void}{DrawBackground}{\param{wxDC\& }{dc}, \param{wxWindow* }{wnd}, \param{const wxRect\& }{rect}}
	37
8ffbb0f8	38	Draws a background on the given area.
c0d9896a BW	39
	40	\membersection{wxAuiTabArt::DrawButton}\label{wxauitabartdrawbutton}
	41
	42	\func{void}{DrawButton}{\param{wxDC\& }{dc}, \param{wxWindow* }{wnd}, \param{const wxRect\& }{in\_rect}, \param{int }{bitmap\_id}, \param{int }{button\_state}, \param{int }{orientation}, \param{const wxBitmap\& }{bitmap\_override}, \param{wxRect* }{out\_rect}}
	43
8ffbb0f8	44	Draws a button.
c0d9896a BW	45
	46	\membersection{wxAuiTabArt::DrawTab}\label{wxauitabartdrawtab}
	47
	48	\func{void}{DrawTab}{\param{wxDC\& }{dc}, \param{wxWindow* }{wnd}, \param{const wxRect\& }{in\_rect}, \param{const wxString\& }{caption}, \param{const wxBitmap\& }{bitmap}, \param{bool }{active}, \param{int }{close\_button\_state}, \param{wxRect* }{out\_tab\_rect}, \param{wxRect* }{out\_button\_rect}, \param{int* }{x\_extent}}
	49
8ffbb0f8	50	Draws a tab.
c0d9896a BW	51
	52	\membersection{wxAuiTabArt::GetBestTabCtrlSize}\label{wxauitabartgetbesttabctrlsize}
	53
	54	\func{int}{GetBestTabCtrlSize}{\param{wxWindow* }{wnd}, \param{wxAuiNotebookPageArray\& }{pages}}
	55
8ffbb0f8	56	Returns the tab control size.
c0d9896a BW	57
	58	\membersection{wxAuiTabArt::GetIndentSize}\label{wxauitabartgetindentsize}
	59
	60	\func{int}{GetIndentSize}{\void}
	61
8ffbb0f8	62	Returns the indent size.
c0d9896a BW	63
	64	\membersection{wxAuiTabArt::GetTabSize}\label{wxauitabartgettabsize}
	65
	66	\func{wxSize}{GetTabSize}{\param{wxDC\& }{dc}, \param{wxWindow* }{wnd}, \param{const wxString\& }{caption}, \param{const wxBitmap\& }{bitmap}, \param{bool }{active}, \param{int }{close\_button\_state}, \param{int* }{x\_extent}}
	67
8ffbb0f8	68	Returns the tab size for the given caption, bitmap and state.
c0d9896a BW	69
	70	\membersection{wxAuiTabArt::SetFlags}\label{wxauitabartsetflags}
	71
	72	\func{void}{SetFlags}{\param{unsigned int }{flags}}
	73
8ffbb0f8	74	Sets flags.
c0d9896a BW	75
	76	\membersection{wxAuiTabArt::SetMeasuringFont}\label{wxauitabartsetmeasuringfont}
	77
	78	\func{void}{SetMeasuringFont}{\param{const wxFont\& }{font}}
	79
8ffbb0f8	80	Sets the font used for calculating measurements.
c0d9896a BW	81
	82	\membersection{wxAuiTabArt::SetNormalFont}\label{wxauitabartsetnormalfont}
	83
	84	\func{void}{SetNormalFont}{\param{const wxFont\& }{font}}
	85
8ffbb0f8	86	Sets the normal font for drawing labels.
c0d9896a BW	87
	88	\membersection{wxAuiTabArt::SetSelectedFont}\label{wxauitabartsetselectedfont}
	89
	90	\func{void}{SetSelectedFont}{\param{const wxFont\& }{font}}
	91
8ffbb0f8	92	Sets the font for drawing text for selected UI elements.
c0d9896a BW	93
	94	\membersection{wxAuiTabArt::SetSizingInfo}\label{wxauitabartsetsizinginfo}
	95
	96	\func{void}{SetSizingInfo}{\param{const wxSize\& }{tab\_ctrl\_size}, \param{size\_t }{tab\_count}}
	97
8ffbb0f8	98	Sets sizing information.
c0d9896a BW	99
	100	\membersection{wxAuiTabArt::ShowWindowList}\label{wxauitabartshowwindowlist}
	101
	102	\func{int}{ShowWindowList}{\param{wxWindow* }{wnd}, \param{const wxArrayString\& }{items}, \param{int }{active\_idx}}
	103
8ffbb0f8 JS	104	Pops up a menu to show the list of windows managed by wxAui.
8ffbb0f8 JS	105