Amebis/wxWidgets
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

removed @NULL,@true,@false tags from the function prototypes; fixed * and & displacing in the prototypes; changed @param as discussed on wx-dev; use @see instead of @sa; better indentation for @returns,@remarks,@see paragraphs; other misc fixes

Browse Source 
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@52407 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Francesco Montorsi
2008-03-09 12:33:59 +00:00
parent 0aaf0255e4
commit 4cc4bfafe5
256 changed files with 8880 additions and 10701 deletions
Download Patch File Download Diff File Expand all files Collapse all files

31
interface/textdlg.h
View File

@@ -48,26 +48,22 @@ public:
Constructor. Use ShowModal() to show the dialog.
@param parent
Parent window.
Parent window.
@param message
Message to show on the dialog.
Message to show on the dialog.
@param defaultValue
The default value, which may be the empty string.
The default value, which may be the empty string.
@param style
A dialog style, specifying the buttons (wxOK, wxCANCEL)
and an optional wxCENTRE style. Additionally, wxTextCtrl styles (such as
wxTE_PASSWORD) may be specified here.
A dialog style, specifying the buttons (wxOK, wxCANCEL)
and an optional wxCENTRE style. Additionally, wxTextCtrl styles (such as
wxTE_PASSWORD) may be specified here.
@param pos
Dialog position.
Dialog position.
*/
wxTextEntryDialog(wxWindow* parent, const wxString& message,
const wxString& caption = "Please enter text",
const wxString& defaultValue = "",
long style = wxOK | wxCANCEL | wxCENTRE,
long style = wxOK | wxCANCEL | wxCENTRE,
const wxPoint& pos = wxDefaultPosition);
/**
@@ -103,17 +99,16 @@ public:
Pop up a dialog box with title set to @e caption, @e message, and a
@e default_value. The user may type in text and press OK to return this text,
or press Cancel to return the empty string.
If @e centre is @true, the message text (which may include new line characters)
If @a centre is @true, the message text (which may include new line characters)
is centred; if @false, the message is left-justified.
*/
wxString wxGetTextFromUser(const wxString& message,
const wxString& caption = "Input text",
const wxString& default_value = "",
wxWindow * parent = @NULL,
wxWindow* parent = NULL,
int x = wxDefaultCoord,
int y = wxDefaultCoord,
bool centre = @true);
bool centre = true);
/**
Similar to wxGetTextFromUser but the text entered
@@ -123,8 +118,8 @@ wxString wxGetTextFromUser(const wxString& message,
wxString wxGetPasswordFromUser(const wxString& message,
const wxString& caption = "Input text",
const wxString& default_value = "",
wxWindow * parent = @NULL,
wxWindow* parent = NULL,
int x = wxDefaultCoord,
int y = wxDefaultCoord,
bool centre = @true);
bool centre = true);