Correct wxDatePickerCtrl::GetValue() documentation and other minor fixes.

The documentation for this method seems to have been copy-and-pasted from
somewhere else and didn't make any sense.

Also don't say that this control doesn't have any control-specific styles when
it does.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@69223 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Vadim Zeitlin
2011-09-29 13:43:05 +00:00
parent 8957e55ed3
commit 1319b2684f

View File

@@ -67,6 +67,11 @@ public:
const wxString& name = "datectrl"); const wxString& name = "datectrl");
/** /**
Create the control window.
This method should only be used for objects created using default
constructor.
@param parent @param parent
Parent window, must not be non-@NULL. Parent window, must not be non-@NULL.
@param id @param id
@@ -81,8 +86,8 @@ public:
best size by using the height approximately equal to a text control best size by using the height approximately equal to a text control
and width large enough to show the date string fully. and width large enough to show the date string fully.
@param style @param style
The window style, should be left at 0 as there are no special The window style, see the description of the styles in the class
styles for this control in this version. documentation.
@param validator @param validator
Validator which can be used for additional date checks. Validator which can be used for additional date checks.
@param name @param name
@@ -123,9 +128,10 @@ public:
virtual bool GetRange(wxDateTime* dt1, wxDateTime* dt2) const = 0; virtual bool GetRange(wxDateTime* dt1, wxDateTime* dt2) const = 0;
/** /**
Returns the currently selected. If there is no selection or the Returns the currently entered date.
selection is outside of the current range, an invalid object is
returned. For a control with @c wxDP_ALLOWNONE style the returned value may be
invalid if no date is entered, otherwise it is always valid.
*/ */
virtual wxDateTime GetValue() const = 0; virtual wxDateTime GetValue() const = 0;