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

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%% Name:        pickerbase.tex
%% Purpose:     wxPickerBase documentation
%% Author:      Francesco Montorsi
%% Created:     2006-04-18
%% RCS-ID:      $Id$
%% Copyright:   (c) 2006 Francesco Montorsi
%% License:     wxWindows license
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

\section{\class{wxPickerBase}}\label{wxpickerbase}

Base abstract class for all pickers which support an auxiliary text control.
This class handles all positioning and sizing of the text control like a
an horizontal \helpref{wxBoxSizer}{wxboxsizer} would do, with the text control on
the left of the picker button and the proportion of the picker fixed to value 1.

\wxheading{Derived from}

\helpref{wxControl}{wxcontrol}\\
\helpref{wxWindow}{wxwindow}\\
\helpref{wxEvtHandler}{wxevthandler}\\
\helpref{wxObject}{wxobject}

\wxheading{Include files}

<wx/pickerbase.h>

\wxheading{Window styles}

\twocolwidtha{5cm}%
\begin{twocollist}\itemsep=0pt
\twocolitem{\windowstyle{wxPB\_USE\_TEXTCTRL}}{Creates a text control to the left of the
picker which is completely managed by this \helpref{wxPickerBase}{wxpickerbase}
class.}
\end{twocollist}

\wxheading{See also}

\helpref{wxColourPickerCtrl}{wxcolourpickerctrl}


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

\membersection{wxPickerBase::SetInternalMargin}\label{wxpickerbasesetinternalmargin}

\func{void}{SetInternalMargin}{\param{int}{margin}}

Sets the margin (in pixel) between the picker and the text control.


\membersection{wxPickerBase::GetInternalMargin}\label{wxpickerbasegetinternalmargin}

\constfunc{int}{GetInternalMargin}{}

Returns the margin (in pixel) between the picker and the text control.


\membersection{wxPickerBase::SetTextCtrlProportion}\label{wxpickerbasesettextctrlproportion}

\func{void}{SetTextCtrlProportion}{\param{int}{prop}}

Sets the proportion between the text control and the picker.
Look at the overview of wxPickerBase for more details about this.


\membersection{wxPickerBase::GetTextCtrlProportion}\label{wxpickerbasesgettextctrlproportion}

\constfunc{int}{GetTextCtrlProportion}{}

Returns the proportion between the text control and the picker.


\membersection{wxPickerBase::HasTextCtrl}\label{wxpickerbaseshastextctrl}

\constfunc{bool}{HasTextCtrl}{}

Returns true if this class has a valid text control (i.e. if the \windowstyle{wxPB\_USE\_TEXTCTRL} style was
given when creating this control).


\membersection{wxPickerBase::GetTextCtrl}\label{wxpickerbasesgetextctrl}

\func{wxTextCtrl *}{GetTextCtrl}{}

Returns a pointer to the text control handled by this class or \texttt{NULL} if the \windowstyle{wxPB\_USE\_TEXTCTRL} style was not specified when this control was created.
Very important: the contents of the text control could be containing an invalid representation of the entity which can be chosen through the picker (e.g. the user entered an invalid colour syntax because of a typo). Thus you should never parse the content of the textctrl to get the user's input; rather use the derived-class getter (e.g. \helpref{wxColourPickerCtrl::GetColour}{wxcolourpickerctrlgetcolour}, \helpref{wxFilePickerCtrl::GetPath}{wxfilepickerctrlgetpath}, etc).
Commit	Line	Data
ec376c8f VZ	1	%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
	2	%% Name: pickerbase.tex
	3	%% Purpose: wxPickerBase documentation
	4	%% Author: Francesco Montorsi
	5	%% Created: 2006-04-18
	6	%% RCS-ID: $Id$
	7	%% Copyright: (c) 2006 Francesco Montorsi
	8	%% License: wxWindows license
	9	%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
	10
	11	\section{\class{wxPickerBase}}\label{wxpickerbase}
	12
	13	Base abstract class for all pickers which support an auxiliary text control.
	14	This class handles all positioning and sizing of the text control like a
	15	an horizontal \helpref{wxBoxSizer}{wxboxsizer} would do, with the text control on
	16	the left of the picker button and the proportion of the picker fixed to value 1.
	17
	18	\wxheading{Derived from}
	19
	20	\helpref{wxControl}{wxcontrol}\\
	21	\helpref{wxWindow}{wxwindow}\\
	22	\helpref{wxEvtHandler}{wxevthandler}\\
	23	\helpref{wxObject}{wxobject}
	24
	25	\wxheading{Include files}
	26
	27	<wx/pickerbase.h>
	28
	29	\wxheading{Window styles}
	30
	31	\twocolwidtha{5cm}%
	32	\begin{twocollist}\itemsep=0pt
	33	\twocolitem{\windowstyle{wxPB\_USE\_TEXTCTRL}}{Creates a text control to the left of the
	34	picker which is completely managed by this \helpref{wxPickerBase}{wxpickerbase}
	35	class.}
	36	\end{twocollist}
	37
	38	\wxheading{See also}
	39
	40	\helpref{wxColourPickerCtrl}{wxcolourpickerctrl}
	41
	42
	43	\latexignore{\rtfignore{\wxheading{Members}}}
	44
	45	\membersection{wxPickerBase::SetInternalMargin}\label{wxpickerbasesetinternalmargin}
	46
	47	\func{void}{SetInternalMargin}{\param{int}{margin}}
	48
	49	Sets the margin (in pixel) between the picker and the text control.
	50
	51
	52	\membersection{wxPickerBase::GetInternalMargin}\label{wxpickerbasegetinternalmargin}
	53
	54	\constfunc{int}{GetInternalMargin}{}
	55
	56	Returns the margin (in pixel) between the picker and the text control.
	57
	58
	59	\membersection{wxPickerBase::SetTextCtrlProportion}\label{wxpickerbasesettextctrlproportion}
	60
	61	\func{void}{SetTextCtrlProportion}{\param{int}{prop}}
	62
	63	Sets the proportion between the text control and the picker.
	64	Look at the overview of wxPickerBase for more details about this.
65
66
67	\membersection{wxPickerBase::GetTextCtrlProportion}\label{wxpickerbasesgettextctrlproportion}
68
69	\constfunc{int}{GetTextCtrlProportion}{}
70
71	Returns the proportion between the text control and the picker.
72
73
74	\membersection{wxPickerBase::HasTextCtrl}\label{wxpickerbaseshastextctrl}
75
76	\constfunc{bool}{HasTextCtrl}{}
77
78	Returns true if this class has a valid text control (i.e. if the \windowstyle{wxPB\_USE\_TEXTCTRL} style was
79	given when creating this control).
80
81
82	\membersection{wxPickerBase::GetTextCtrl}\label{wxpickerbasesgetextctrl}
83
84	\func{wxTextCtrl *}{GetTextCtrl}{}
85
86	Returns a pointer to the text control handled by this class or \texttt{NULL} if the \windowstyle{wxPB\_USE\_TEXTCTRL} style was not specified when this control was created.
87	Very important: the contents of the text control could be containing an invalid representation of the entity which can be chosen through the picker (e.g. the user entered an invalid colour syntax because of a typo). Thus you should never parse the content of the textctrl to get the user's input; rather use the derived-class getter (e.g. \helpref{wxColourPickerCtrl::GetColour}{wxcolourpickerctrlgetcolour}, \helpref{wxFilePickerCtrl::GetPath}{wxfilepickerctrlgetpath}, etc).