wxWidgets/include/wx/generic/progdlgg.h

/////////////////////////////////////////////////////////////////////////////
// Name:        progdlgg.h
// Purpose:     wxProgressDialog class
// Author:      Karsten Ball<6C>der
// Modified by:
// Created:     09.05.1999
// RCS-ID:      $Id$
// Copyright:   (c) Karsten Ball<6C>der
// Licence:   	wxWindows license
/////////////////////////////////////////////////////////////////////////////

#ifndef __PROGDLGH_G__
#define __PROGDLGH_G__

#ifdef __GNUG__
#pragma interface "progdlgg.h"
#endif

#include "wx/setup.h"
#include "wx/frame.h"



/** Progress dialog which shows a moving progress bar.
    Taken from the Mahogany project.*/

class WXDLLEXPORT wxProgressDialog : public wxFrame
{
DECLARE_DYNAMIC_CLASS(wxProgressDialog)
public:
   /** 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 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
   */
   wxProgressDialog(const wxString &title, wxString const &message,
                   int maximum = 100,
                   wxWindow *parent = NULL,
                   bool disableParentOnly = FALSE,
                   bool abortButton = FALSE);
   /** Destructor.
       Re-enables event handling for other windows.
   */
   ~wxProgressDialog();

   /** 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 = "");

   /** 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)
   */
   void Resume() { m_state = Continue; }

   /// Callback for optional abort button
   void OnCancel(wxEvent& WXUNUSED(event)) { m_state = Canceled; }

   /// callback to disable "hard" window closing
   void OnClose(wxCloseEvent& event);

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())
   enum
   {
      Uncancelable = -1,   // dialog can't be canceled
      Canceled,            // can be cancelled and, in fact, was
      Continue             // can be cancelled but wasn't
   } m_state;

   DECLARE_EVENT_TABLE()
};
#endif
    // __PROGDLGH_G__