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