docs/latex/wx/pickerbase.tex

   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 This function can be used only when \helpref{HasTextCtrl}{wxpickerbasehastextctrl} returns \true.
  51
  52
  53 \membersection{wxPickerBase::GetInternalMargin}\label{wxpickerbasegetinternalmargin}
  54
  55 \constfunc{int}{GetInternalMargin}{}
  56
  57 Returns the margin (in pixel) between the picker and the text control.
  58 This function can be used only when \helpref{HasTextCtrl}{wxpickerbasehastextctrl} returns \true.
  59
  60
  61 \membersection{wxPickerBase::SetTextCtrlProportion}\label{wxpickerbasesettextctrlproportion}
  62
  63 \func{void}{SetTextCtrlProportion}{\param{int}{prop}}
  64
  65 Sets the proportion between the text control and the picker.
  66 Look at the overview of wxPickerBase for more details about this.
  67 This function can be used only when \helpref{HasTextCtrl}{wxpickerbasehastextctrl} returns \true.
  68
  69
  70 \membersection{wxPickerBase::GetTextCtrlProportion}\label{wxpickerbasegettextctrlproportion}
  71
  72 \constfunc{int}{GetTextCtrlProportion}{}
  73
  74 Returns the proportion between the text control and the picker.
  75 This function can be used only when \helpref{HasTextCtrl}{wxpickerbasehastextctrl} returns \true.
  76
  77
  78
  79 \membersection{wxPickerBase::HasTextCtrl}\label{wxpickerbasehastextctrl}
  80
  81 \constfunc{bool}{HasTextCtrl}{}
  82
  83 Returns true if this window has a valid text control (i.e. if the \windowstyle{wxPB\_USE\_TEXTCTRL} style was
  84 given when creating this control).
  85
  86
  87 \membersection{wxPickerBase::GetTextCtrl}\label{wxpickerbasegetextctrl}
  88
  89 \func{wxTextCtrl *}{GetTextCtrl}{}
  90
  91 Returns 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.
  92 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).
  93
  94
  95 \membersection{wxPickerBase::IsTextCtrlGrowable}\label{wxpickerbaseistextctrlgrowable}
  96
  97 \constfunc{bool}{IsTextCtrlGrowable}{}
  98
  99 Returns \true if the text control is growable.
 100 This function can be used only when \helpref{HasTextCtrl}{wxpickerbasehastextctrl} returns \true.
 101
 102
 103 \membersection{wxPickerBase::SetTextCtrlGrowable}\label{wxpickerbasesettextctrlgrowable}
 104
 105 \func{void}{SetTextCtrlGrowable}{\param{bool}{ grow = true}}
 106
 107 Sets the text control as growable when {\tt grow} is \true.
 108 This function can be used only when \helpref{HasTextCtrl}{wxpickerbasehastextctrl} returns \true.
 109
 110
 111
 112 \membersection{wxPickerBase::IsPickerCtrlGrowable}\label{wxpickerbaseispickerctrlgrowable}
 113
 114 \constfunc{bool}{IsPickerCtrlGrowable}{}
 115
 116 Returns \true if the picker control is growable.
 117
 118
 119 \membersection{wxPickerBase::SetPickerCtrlGrowable}\label{wxpickerbasesetpickerctrlgrowable}
 120
 121 \func{void}{SetPickerCtrlGrowable}{\param{bool}{ grow = true}}
 122
 123 Sets the picker control as growable when {\tt grow} is \true.
 124 This function has effects only when \helpref{HasTextCtrl}{wxpickerbasehastextctrl} returns \true.
 125