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

38
interface/progdlg.h
View File

@@ -53,23 +53,19 @@ public:
window only.
@param title
Dialog title to show in titlebar.
Dialog title to show in titlebar.
@param message
Message displayed above the progress bar.
Message displayed above the progress bar.
@param maximum
Maximum value for the progress bar.
Maximum value for the progress bar.
@param parent
Parent window.
Parent window.
@param style
The dialog style. See wxProgressDialog.
The dialog style. See wxProgressDialog.
*/
wxProgressDialog(const wxString& title, const wxString& message,
int maximum = 100,
wxWindow * parent = @NULL,
wxWindow* parent = NULL,
int style = wxPD_AUTO_HIDE | wxPD_APP_MODAL);
/**
@@ -85,7 +81,7 @@ public:
the progress bar a bit to indicate that some progress was done.
*/
virtual bool Pulse(const wxString& newmsg = "",
bool * skip = @NULL);
bool* skip = NULL);
/**
Can be used to continue with the dialog, after the user had chosen
@@ -97,25 +93,23 @@ public:
Updates the dialog, setting the progress bar to the new value and, if
given changes the message above it. Returns @true unless the Cancel button
has been pressed.
If @false is returned, the application can either immediately destroy the
dialog
or ask the user for the confirmation and if the abort is not confirmed the
dialog may be resumed with Resume() function.
@param value
The new value of the progress meter. It should be less than or
equal to the maximum value given to the constructor and the dialog is closed if
it is equal to the maximum.
The new value of the progress meter. It should be less than or
equal to the maximum value given to the constructor and the dialog is
closed if
it is equal to the maximum.
@param newmsg
The new messages for the progress dialog text, if it is
empty (which is the default) the message is not changed.
The new messages for the progress dialog text, if it is
empty (which is the default) the message is not changed.
@param skip
If "Skip" button was pressed since last
Update call, this is set to @true.
If "Skip" button was pressed since last
Update call, this is set to @true.
*/
virtual bool Update(int value, const wxString& newmsg = "",
bool * skip = @NULL);
bool* skip = NULL);
};