no changes, just come cleanup and more comments

[wxWidgets.git] / docs / latex / wx / datectrl.tex

diff --git a/docs/latex/wx/datectrl.tex b/docs/latex/wx/datectrl.tex
index 2bb24c87d2c3cc323b6475bb9235d6eb372dabc8..09c2f933aab67f4009d40e299bb31df3e5e1b70a 100644 (file)
--- a/docs/latex/wx/datectrl.tex
+++ b/docs/latex/wx/datectrl.tex
@@ -5,7 +5,7 @@
 %% Created:     2005-01-15
 %% RCS-ID:      $Id$
 %% Copyright:   (c) 2005 Vadim Zeitlin
-%% License:     wxWidgets license
+%% License:     wxWindows license
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
 \section{\class{wxDatePickerCtrl}}\label{wxdatepickerctrl}
@@ -15,7 +15,7 @@ This control allows the user to select a date. Unlike
 wxDatePickerCtrl is implemented as a small window showing the currently selected date.
 The control can be edited using the keyboard, and can also display a popup
 window for more user-friendly date selection, depending on the styles used and
-the platform.
+the platform, except PalmOS where date is selected using native dialog.
 
 It is only available if \texttt{wxUSE\_DATEPICKCTRL} is set to $1$.
 
@@ -30,23 +30,29 @@ It is only available if \texttt{wxUSE\_DATEPICKCTRL} is set to $1$.
 
 <wx/datectrl.h>
 
+\wxheading{Library}
+
+\helpref{wxAdv}{librarieslist}
+
 (only available if \texttt{wxUSE\_DATEPICKCTRL} is set to $1$)
 
 \wxheading{Window styles}
 
 \twocolwidtha{5cm}%
 \begin{twocollist}\itemsep=0pt
-\twocolitem{\windowstyle{wxDP\_SPIN}}{Creates a control without month calendar
-drop down but with spin control-like arrows to change individual date
+\twocolitem{\windowstyle{wxDP\_SPIN}}{Creates a control without a month calendar
+drop down but with spin-control-like arrows to change individual date
 components. This style is not supported by the generic version.}
 \twocolitem{\windowstyle{wxDP\_DROPDOWN}}{Creates a control with a month
-calendar drop down part from which the user can select a date.}
-\twocolitem{\windowstyle{wxDP\_DEFAULT}}{Creates a control with default style
-which is the best supported for the current platform (currently wxDP\_SPIN
+calendar drop-down part from which the user can select a date.}
+\twocolitem{\windowstyle{wxDP\_DEFAULT}}{Creates a control with the style
+that is best supported for the current platform (currently wxDP\_SPIN
 under Windows and wxDP\_DROPDOWN elsewhere).}
+\twocolitem{\windowstyle{wxDP\_ALLOWNONE}}{With this style, the control allows
+the user to not enter any valid date at all. Without it - the default - the control always has some valid date.}
 \twocolitem{\windowstyle{wxDP\_SHOWCENTURY}}{Forces display of the century in
-the default date format. Without this flas the century could be displayed or
-not depending on the default date representation in the system.}
+the default date format. Without this style the century could be displayed, or
+not, depending on the default date representation in the system.}
 \end{twocollist}
 
 \wxheading{Event handling}
@@ -125,12 +131,12 @@ special styles for this control in this version.}
 If the control had been previously limited to a range of dates using 
 \helpref{SetRange()}{wxdatepickerctrlsetrange}, returns the lower and upper
 bounds of this range. If no range is set (or only one of the bounds is set),
-the \arg{dt1} and/or \arg{dt2} are set to be invalid.
+ \arg{dt1} and/or \arg{dt2} are set to be invalid.
 
 \wxheading{Parameters}
 
 \docparam{dt1}{Pointer to the object which receives the lower range limit or
-becomes invalid if it is not set. May be \texttt{NULLL} if the caller is not
+becomes invalid if it is not set. May be \texttt{NULL} if the caller is not
 interested in lower limit}
 
 \docparam{dt2}{Same as above but for the upper limit}
@@ -148,6 +154,21 @@ set.
 Returns the currently selected. If there is no selection or the selection is
 outside of the current range, an invalid object is returned.
 
+\membersection{wxDatePickerCtrl::SetFormat}\label{wxdatepickerctrlsetformat}
+
+\func{void}{SetFormat}{\param{const wxChar*}{ format}}
+
+Please note that this function is only available in the generic version of this
+control. The native version always uses the current system locale.
+
+Sets the display format for the date in the control. See wxDateTime for the
+meaning of format strings.
+
+\wxheading{Remarks}
+
+If the format parameter is invalid,
+the behaviour is undefined.
+
 
 \membersection{wxDatePickerCtrl::SetRange}\label{wxdatepickerctrlsetrange}