X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/9111db680241332df07dd22db32973e20f77fb1a..af01f1ba0d697c07173f436ab661b4c833258a91:/include/wx/generic/progdlgg.h diff --git a/include/wx/generic/progdlgg.h b/include/wx/generic/progdlgg.h index 27b5fffe4f..11437238a0 100644 --- a/include/wx/generic/progdlgg.h +++ b/include/wx/generic/progdlgg.h @@ -1,4 +1,4 @@ -///////////////////////////////////////////////////////////////////////////// +//////////////////////////////////////////////////// // Name: progdlgg.h // Purpose: wxProgressDialog class // Author: Karsten Ballüder @@ -6,8 +6,8 @@ // Created: 09.05.1999 // RCS-ID: $Id$ // Copyright: (c) Karsten Ballüder -// Licence: wxWindows license -///////////////////////////////////////////////////////////////////////////// +// Licence: wxWindows license +//////////////////////////////////////////////////// #ifndef __PROGDLGH_G__ #define __PROGDLGH_G__ @@ -17,74 +17,110 @@ #endif #include "wx/setup.h" -#include "wx/frame.h" +#if wxUSE_PROGRESSDLG +#include "wx/dialog.h" -/** Progress dialog which shows a moving progress bar. +class WXDLLEXPORT wxButton; +class WXDLLEXPORT wxGauge; +class WXDLLEXPORT wxStaticText; + +/* Progress dialog which shows a moving progress bar. Taken from the Mahogany project.*/ -class WXDLLEXPORT wxProgressDialog : public wxFrame +class WXDLLEXPORT wxProgressDialog : public wxDialog { DECLARE_DYNAMIC_CLASS(wxProgressDialog) public: - /** Creates and displays dialog, disables event handling for other + /* Creates and displays dialog, disables event handling for other frames or parent frame to avoid recursion problems. @param title title for window @param message message to display in window - @param maximum maximum value for status bar, if <= 0, no bar is shown + @param maximum value for status bar, if <= 0, no bar is shown @param parent window or NULL - @param disableParentOnly if true, only disable parent window's - event handling - @param abortButton if true, dialog will show an abort button + @param style is the bit mask of wxPD_XXX constants from wx/defs.h */ wxProgressDialog(const wxString &title, wxString const &message, - int maximum = 100, - wxWindow *parent = NULL, - bool disableParentOnly = FALSE, - bool abortButton = FALSE); - /** Destructor. + int maximum = 100, + wxWindow *parent = NULL, + int style = wxPD_APP_MODAL | wxPD_AUTO_HIDE); + /* Destructor. Re-enables event handling for other windows. */ ~wxProgressDialog(); - /** Update the status bar to the new value. + /* Update the status bar to the new value. @param value new value @param newmsg if used, new message to display @returns true if ABORT button has not been pressed */ - bool Update(int value = -1, const wxString& newmsg = ""); + bool Update(int value, const wxString& newmsg = wxT("")); - /** Can be called to continue after the cancel button has been pressed, but + /* Can be called to continue after the cancel button has been pressed, but the program decided to continue the operation (e.g., user didn't - configrm it) + confirm it) */ void Resume() { m_state = Continue; } - /// Callback for optional abort button - void OnCancel(wxEvent& WXUNUSED(event)) { m_state = Canceled; } +protected: + // callback for optional abort button + void OnCancel(wxCommandEvent& event); - /// callback to disable "hard" window closing + // callback to disable "hard" window closing void OnClose(wxCloseEvent& event); + // callback to detect when the dialog is closed + void OnShow(wxShowEvent& event); + + // must be called to reenable the other windows temporarily disabled while + // the dialog was shown + void ReenableOtherWindows(); + private: - /// the status bar - class wxGauge *m_gauge; - /// the message displayed - class wxStaticText *m_msg; - /// disable all or parent window only - bool m_disableParentOnly; - /// parent window - class wxWindow *m_parent; - /// continue processing or not (return value for Update()) + // create the label with given text and another one to show the time nearby + // under the lastWindow and modify it to be the same as the control created + // (which is returned) + wxStaticText *CreateLabel(const wxString& text, wxWindow **lastWindow); + + // the status bar + wxGauge *m_gauge; + // the message displayed + wxStaticText *m_msg; + // displayed elapsed, estimated, remaining time + class wxStaticText *m_elapsed, + *m_estimated, + *m_remaining; + // time when the dialog was created + unsigned long m_timeStart; + + // parent top level window (may be NULL) + wxWindow *m_parentTop; + + // continue processing or not (return value for Update()) enum { Uncancelable = -1, // dialog can't be canceled Canceled, // can be cancelled and, in fact, was - Continue // can be cancelled but wasn't + Continue, // can be cancelled but wasn't + Finished // finished, waiting to be removed from screen } m_state; + // the abort button (or NULL if none) + wxButton *m_btnAbort; + + // the maximum value + int m_maximum; + + // for wxPD_APP_MODAL case + class WXDLLEXPORT wxWindowDisabler *m_winDisabler; + DECLARE_EVENT_TABLE() +private: + // Virtual function hiding supression + virtual void Update() { wxDialog::Update(); } }; +#endif + #endif // __PROGDLGH_G__