Better documentation for the default parameters values.

Use symbolic names for them and document them separately.

Closes #14051.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@70791 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Vadim Zeitlin
2012-03-04 00:29:07 +00:00
parent 3285e9a347
commit 0b59366faa
6 changed files with 104 additions and 43 deletions

View File

@@ -6,6 +6,18 @@
// Licence: wxWindows licence
/////////////////////////////////////////////////////////////////////////////
/**
Default text dialog style.
*/
#define wxTextEntryDialogStyle (wxOK | wxCANCEL | wxCENTRE | wxWS_EX_VALIDATE_RECURSIVELY)
/// Default text dialog caption.
const char wxGetTextFromUserPromptStr[] = "Input Text";
/// Default password dialog caption.
const char wxGetPasswordFromUserPromptStr[] = "Enter Password";
/**
@class wxPasswordEntryDialog
@@ -45,7 +57,7 @@ public:
wxPasswordEntryDialog(wxWindow* parent, const wxString& message,
const wxString& caption = wxGetPasswordFromUserPromptStr,
const wxString& defaultValue = wxEmptyString,
long style = wxOK | wxCANCEL | wxCENTRE,
long style = wxTextEntryDialogStyle,
const wxPoint& pos = wxDefaultPosition);
};
@@ -87,7 +99,7 @@ public:
wxTextEntryDialog(wxWindow* parent, const wxString& message,
const wxString& caption = wxGetTextFromUserPromptStr,
const wxString& value = wxEmptyString,
long style = wxOK | wxCANCEL | wxCENTRE,
long style = wxTextEntryDialogStyle,
const wxPoint& pos = wxDefaultPosition);
/**
@@ -139,7 +151,7 @@ public:
@header{wx/textdlg.h}
*/
wxString wxGetTextFromUser(const wxString& message,
const wxString& caption = "Input text",
const wxString& caption = wxGetTextFromUserPromptStr,
const wxString& default_value = wxEmptyString,
wxWindow* parent = NULL,
int x = wxDefaultCoord,
@@ -154,7 +166,7 @@ wxString wxGetTextFromUser(const wxString& message,
@header{wx/textdlg.h}
*/
wxString wxGetPasswordFromUser(const wxString& message,
const wxString& caption = "Input text",
const wxString& caption = wxGetPasswordFromUserPromptStr,
const wxString& default_value = wxEmptyString,
wxWindow* parent = NULL,
int x = wxDefaultCoord,