1%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
2%% Name:        pickerbase.tex
3%% Purpose:     wxPickerBase documentation
4%% Author:      Francesco Montorsi
5%% Created:     2006-04-18
6%% RCS-ID:      $Id: pickerbase.tex 48887 2007-09-21 17:53:07Z JS $
7%% Copyright:   (c) 2006 Francesco Montorsi
8%% License:     wxWindows license
9%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
10
11\section{\class{wxPickerBase}}\label{wxpickerbase}
12
13Base abstract class for all pickers which support an auxiliary text control.
14This class handles all positioning and sizing of the text control like a
15an horizontal \helpref{wxBoxSizer}{wxboxsizer} would do, with the text control on
16the left of the picker button.
17The proportion (see \helpref{wxSizer}{wxsizer} documentation for more info about
18proportion values) of the picker control defaults to $1$ when there isn't a text control
19associated (see {\tt wxPB\_USE\_TEXTCTRL} style) and to $0$ otherwise.
20
21\wxheading{Derived from}
22
23\helpref{wxControl}{wxcontrol}\\
24\helpref{wxWindow}{wxwindow}\\
25\helpref{wxEvtHandler}{wxevthandler}\\
26\helpref{wxObject}{wxobject}
27
28\wxheading{Include files}
29
30<wx/pickerbase.h>
31
32\wxheading{Window styles}
33
34\twocolwidtha{5cm}%
35\begin{twocollist}\itemsep=0pt
36\twocolitem{\windowstyle{wxPB\_USE\_TEXTCTRL}}{Creates a text control to the left of the
37picker which is completely managed by this \helpref{wxPickerBase}{wxpickerbase}
38class.}
39\end{twocollist}
40
41\wxheading{See also}
42
43\helpref{wxColourPickerCtrl}{wxcolourpickerctrl}
44
45
46\latexignore{\rtfignore{\wxheading{Members}}}
47
48\membersection{wxPickerBase::SetInternalMargin}\label{wxpickerbasesetinternalmargin}
49
50\func{void}{SetInternalMargin}{\param{int}{margin}}
51
52Sets the margin (in pixel) between the picker and the text control.
53This function can be used only when \helpref{HasTextCtrl}{wxpickerbasehastextctrl} returns \true.
54
55
56\membersection{wxPickerBase::GetInternalMargin}\label{wxpickerbasegetinternalmargin}
57
58\constfunc{int}{GetInternalMargin}{}
59
60Returns the margin (in pixel) between the picker and the text control.
61This function can be used only when \helpref{HasTextCtrl}{wxpickerbasehastextctrl} returns \true.
62
63
64\membersection{wxPickerBase::SetTextCtrlProportion}\label{wxpickerbasesettextctrlproportion}
65
66\func{void}{SetTextCtrlProportion}{\param{int}{prop}}
67
68Sets the proportion value of the text control.
69Look at the overview of wxPickerBase for more details about this.
70This function can be used only when \helpref{HasTextCtrl}{wxpickerbasehastextctrl} returns \true.
71
72
73\membersection{wxPickerBase::SetPickerCtrlProportion}\label{wxpickerbasesetpickerctrlproportion}
74
75\func{void}{SetPickerCtrlProportion}{\param{int}{prop}}
76
77Sets the proportion value of the picker.
78Look at the overview of wxPickerBase for more details about this.
79
80
81\membersection{wxPickerBase::GetTextCtrlProportion}\label{wxpickerbasegettextctrlproportion}
82
83\constfunc{int}{GetTextCtrlProportion}{}
84
85Returns the proportion value of the text control.
86This function can be used only when \helpref{HasTextCtrl}{wxpickerbasehastextctrl} returns \true.
87
88
89\membersection{wxPickerBase::GetPickerCtrlProportion}\label{wxpickerbasegetpickerctrlproportion}
90
91\constfunc{int}{GetPickerCtrlProportion}{}
92
93Returns the proportion value of the picker.
94
95
96\membersection{wxPickerBase::HasTextCtrl}\label{wxpickerbasehastextctrl}
97
98\constfunc{bool}{HasTextCtrl}{}
99
100Returns true if this window has a valid text control (i.e. if the \windowstyle{wxPB\_USE\_TEXTCTRL} style was
101given when creating this control).
102
103
104\membersection{wxPickerBase::GetTextCtrl}\label{wxpickerbasegetextctrl}
105
106\func{wxTextCtrl *}{GetTextCtrl}{}
107
108Returns a pointer to the text control handled by this window or \texttt{NULL} if the \windowstyle{wxPB\_USE\_TEXTCTRL} style was not specified when this control was created.
109Very 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).
110
111
112\membersection{wxPickerBase::IsTextCtrlGrowable}\label{wxpickerbaseistextctrlgrowable}
113
114\constfunc{bool}{IsTextCtrlGrowable}{}
115
116Returns \true if the text control is growable.
117This function can be used only when \helpref{HasTextCtrl}{wxpickerbasehastextctrl} returns \true.
118
119
120\membersection{wxPickerBase::SetPickerCtrlGrowable}\label{wxpickerbasesetpickerctrlgrowable}
121
122\func{void}{SetPickerCtrlGrowable}{\param{bool}{ grow = true}}
123
124Sets the picker control as growable when {\tt grow} is \true.
125
126
127\membersection{wxPickerBase::SetTextCtrlGrowable}\label{wxpickerbasesettextctrlgrowable}
128
129\func{void}{SetTextCtrlGrowable}{\param{bool}{ grow = true}}
130
131Sets the text control as growable when {\tt grow} is \true.
132This function can be used only when \helpref{HasTextCtrl}{wxpickerbasehastextctrl} returns \true.
133
134
135
136\membersection{wxPickerBase::IsPickerCtrlGrowable}\label{wxpickerbaseispickerctrlgrowable}
137
138\constfunc{bool}{IsPickerCtrlGrowable}{}
139
140Returns \true if the picker control is growable.
141
142