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