docs/latex/wx/datectrl.tex

   1 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
   2 %% Name:        datectrl.tex
   3 %% Purpose:     wxDatePickerCtrl documentation
   4 %% Author:      Vadim Zeitlin
   5 %% Created:     2005-01-15
   6 %% RCS-ID:      $Id$
   7 %% Copyright:   (c) 2005 Vadim Zeitlin
   8 %% License:     wxWindows license
   9 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  10
  11 \section{\class{wxDatePickerCtrl}}\label{wxdatepickerctrl}
  12
  13 This control allows the user to select a date. Unlike
  14 \helpref{wxCalendarCtrl}{wxcalendarctrl}, which is a relatively big control,
  15 wxDatePickerCtrl is implemented as a small window showing the currently selected date.
  16 The control can be edited using the keyboard, and can also display a popup
  17 window for more user-friendly date selection, depending on the styles used and
  18 the platform, except PalmOS where date is selected using native dialog.
  19
  20 It is only available if \texttt{wxUSE\_DATEPICKCTRL} is set to $1$.
  21
  22 \wxheading{Derived from}
  23
  24 \helpref{wxControl}{wxcontrol}\\
  25 \helpref{wxWindow}{wxwindow}\\
  26 \helpref{wxEvtHandler}{wxevthandler}\\
  27 \helpref{wxObject}{wxobject}
  28
  29 \wxheading{Include files}
  30
  31 <wx/datectrl.h>
  32
  33 (only available if \texttt{wxUSE\_DATEPICKCTRL} is set to $1$)
  34
  35 \wxheading{Window styles}
  36
  37 \twocolwidtha{5cm}%
  38 \begin{twocollist}\itemsep=0pt
  39 \twocolitem{\windowstyle{wxDP\_SPIN}}{Creates a control without month calendar
  40 drop down but with spin control-like arrows to change individual date
  41 components. This style is not supported by the generic version.}
  42 \twocolitem{\windowstyle{wxDP\_DROPDOWN}}{Creates a control with a month
  43 calendar drop down part from which the user can select a date.}
  44 \twocolitem{\windowstyle{wxDP\_DEFAULT}}{Creates a control with default style
  45 which is the best supported for the current platform (currently wxDP\_SPIN
  46 under Windows and wxDP\_DROPDOWN elsewhere).}
  47 \twocolitem{\windowstyle{wxDP\_ALLOWNONE}}{With this style, the control allows
  48 the user to not enter any valid date at all. Without it -- which is by default
  49 -- the control always has some valid date.}
  50 \twocolitem{\windowstyle{wxDP\_SHOWCENTURY}}{Forces display of the century in
  51 the default date format. Without this flas the century could be displayed or
  52 not depending on the default date representation in the system.}
  53 \end{twocollist}
  54
  55 \wxheading{Event handling}
  56
  57 \twocolwidtha{7cm}%
  58 \begin{twocollist}\itemsep=0pt
  59 \twocolitem{{\bf EVT\_DATE\_CHANGED(id, func)}}{This event fires when the user
  60 changes the current selection in the control.}
  61 \end{twocollist}
  62
  63 \wxheading{See also}
  64
  65 \helpref{wxCalendarCtrl}{wxcalendarctrl},\\
  66 \helpref{wxDateEvent}{wxdateevent}
  67
  68
  69 \latexignore{\rtfignore{\wxheading{Members}}}
  70
  71 \membersection{wxDatePickerCtrl::wxDatePickerCtrl}\label{wxdatepickerctrlctor}
  72
  73 \func{}{wxDatePickerCtrl}{\param{wxWindow *}{parent},\rtfsp
  74 \param{wxWindowID}{ id},\rtfsp
  75 \param{const wxDateTime\& }{dt = wxDefaultDateTime},\rtfsp
  76 \param{const wxPoint\& }{pos = wxDefaultPosition},\rtfsp
  77 \param{const wxSize\& }{size = wxDefaultSize},\rtfsp
  78 \param{long}{ style = wxDP\_DEFAULT | wxDP\_SHOWCENTURY},\rtfsp
  79 \param{const wxValidator\& }{validator = wxDefaultValidator},
  80 \param{const wxString\& }{name = ``datectrl"}}
  81
  82 Initializes the object and calls \helpref{Create}{wxdatepickerctrlcreate} with
  83 all the parameters.
  84
  85
  86 \membersection{wxDatePickerCtrl::Create}\label{wxdatepickerctrlcreate}
  87
  88 \func{bool}{Create}{\param{wxWindow *}{parent},\rtfsp
  89 \param{wxWindowID}{ id},\rtfsp
  90 \param{const wxDateTime\& }{dt = wxDefaultDateTime},\rtfsp
  91 \param{const wxPoint\& }{pos = wxDefaultPosition},\rtfsp
  92 \param{const wxSize\& }{size = wxDefaultSize},\rtfsp
  93 \param{long}{ style = wxDP\_DEFAULT | wxDP\_SHOWCENTURY},\rtfsp
  94 \param{const wxValidator\& }{validator = wxDefaultValidator},
  95 \param{const wxString\& }{name = ``datectrl"}}
  96
  97 \wxheading{Parameters}
  98
  99 \docparam{parent}{Parent window, must not be non-\texttt{NULL}.}
 100
 101 \docparam{id}{The identifier for the control.}
 102
 103 \docparam{dt}{The initial value of the control, if an invalid date (such as the
 104 default value) is used, the control is set to today.}
 105
 106 \docparam{pos}{Initial position.}
 107
 108 \docparam{size}{Initial size. If left at default value, the control chooses its
 109 own best size by using the height approximately equal to a text control and
 110 width large enough to show the date string fully.}
 111
 112 \docparam{style}{The window style, should be left at $0$ as there are no
 113 special styles for this control in this version.}
 114
 115 \docparam{validator}{Validator which can be used for additional date checks.}
 116
 117 \docparam{name}{Control name.}
 118
 119 \wxheading{Return value}
 120
 121 \true if the control was successfully created or \false if creation failed.
 122
 123
 124 \membersection{wxDatePickerCtrl::GetRange}\label{wxdatepickerctrlgetrange}
 125
 126 \constfunc{bool}{GetRange}{\param{wxDateTime *}{dt1}, \param{wxDateTime }{*dt2}}
 127
 128 If the control had been previously limited to a range of dates using
 129 \helpref{SetRange()}{wxdatepickerctrlsetrange}, returns the lower and upper
 130 bounds of this range. If no range is set (or only one of the bounds is set),
 131 the \arg{dt1} and/or \arg{dt2} are set to be invalid.
 132
 133 \wxheading{Parameters}
 134
 135 \docparam{dt1}{Pointer to the object which receives the lower range limit or
 136 becomes invalid if it is not set. May be \texttt{NULLL} if the caller is not
 137 interested in lower limit}
 138
 139 \docparam{dt2}{Same as above but for the upper limit}
 140
 141 \wxheading{Return value}
 142
 143 \false if no range limits are currently set, \true if at least one bound is
 144 set.
 145
 146
 147 \membersection{wxDatePickerCtrl::GetValue}\label{wxdatepickerctrlgetvalue}
 148
 149 \constfunc{wxDateTime}{GetValue}{\void}
 150
 151 Returns the currently selected. If there is no selection or the selection is
 152 outside of the current range, an invalid object is returned.
 153
 154
 155 \membersection{wxDatePickerCtrl::SetRange}\label{wxdatepickerctrlsetrange}
 156
 157 \func{void}{SetRange}{\param{const wxDateTime\&}{ dt1}, \param{const wxDateTime\&}{ dt2}}
 158
 159 Sets the valid range for the date selection. If \arg{dt1} is valid, it becomes
 160 the earliest date (inclusive) accepted by the control. If \arg{dt2} is valid,
 161 it becomes the latest possible date.
 162
 163 \wxheading{Remarks}
 164
 165 If the current value of the control is outside of the newly set range bounds,
 166 the behaviour is undefined.
 167
 168
 169 \membersection{wxDatePickerCtrl::SetValue}\label{wxdatepickerctrlsetvalue}
 170
 171 \func{void}{SetValue}{\param{const wxDateTime\&}{ dt}}
 172
 173 Changes the current value of the control. The date should be valid and included
 174 in the currently selected range, if any.
 175
 176 Calling this method does not result in a date change event.
 177