Some doc corrections; Watcom C++ corrections; VC++ 4 corrections

[wxWidgets.git] / src / generic / progdlgg.cpp

diff --git a/src/generic/progdlgg.cpp b/src/generic/progdlgg.cpp
index f987808944002996ab054abece5762b78186ac23..34890e763ce17c70c987bc942ca7a9976f70470a 100644 (file)
--- a/src/generic/progdlgg.cpp
+++ b/src/generic/progdlgg.cpp
@@ -9,8 +9,16 @@
 // Licence:     wxWindows license
 /////////////////////////////////////////////////////////////////////////////
 
 // Licence:     wxWindows license
 /////////////////////////////////////////////////////////////////////////////
 

+// ============================================================================
+// declarations
+// ============================================================================
+
+// ----------------------------------------------------------------------------
+// headers
+// ----------------------------------------------------------------------------
+

 #ifdef __GNUG__
 #ifdef __GNUG__

-#pragma implementation "progdlgg.h"
+    #pragma implementation "progdlgg.h"

 #endif
 
 // For compilers that support precompilation, includes "wx.h".
 #endif
 
 // For compilers that support precompilation, includes "wx.h".


@@ -20,6 +28,8 @@
     #pragma hdrstop
 #endif
 
     #pragma hdrstop
 #endif
 

+#if wxUSE_PROGRESSDLG
+

 #ifndef WX_PRECOMP
     #include "wx/utils.h"
     #include "wx/frame.h"
 #ifndef WX_PRECOMP
     #include "wx/utils.h"
     #include "wx/frame.h"


@@ -31,187 +41,233 @@
     #include "wx/intl.h"
     #include "wx/settings.h"
     #include "wx/dcclient.h"
     #include "wx/intl.h"
     #include "wx/settings.h"
     #include "wx/dcclient.h"

+    #include "wx/timer.h"

 #endif
 
 #endif
 

-#if wxUSE_PROGRESSDLG
-

 #include "wx/generic/progdlgg.h"
 
 #include "wx/generic/progdlgg.h"
 

+// ----------------------------------------------------------------------------
+// constants
+// ----------------------------------------------------------------------------
+

 #define LAYOUT_X_MARGIN 8
 #define LAYOUT_Y_MARGIN 8
 
 #define LAYOUT_X_MARGIN 8
 #define LAYOUT_Y_MARGIN 8
 

-// wxTextEntryDialog
+// ----------------------------------------------------------------------------
+// private functions
+// ----------------------------------------------------------------------------

 
 

-#if !USE_SHARED_LIBRARY
-    BEGIN_EVENT_TABLE(wxProgressDialog, wxFrame)
-       EVT_BUTTON(-1, wxProgressDialog::OnCancel)
-       EVT_CLOSE(wxProgressDialog::OnClose)
-    END_EVENT_TABLE()
+// update the label to show the given time (in seconds)
+static void SetTimeLabel(unsigned long val, wxStaticText *label);

 
 

-    IMPLEMENT_CLASS(wxProgressDialog, wxFrame)
-#endif
+// ----------------------------------------------------------------------------
+// event tables
+// ----------------------------------------------------------------------------

 
 

-wxProgressDialog::wxProgressDialog(wxString const &title,
-                                 wxString const &message,
-                                 int maximum,
-                                 wxWindow *parent,
-                                 int style)
-{
-   wxWindow *lastWindow = NULL;
-   bool hasAbortButton = (style & wxPD_CAN_ABORT) != 0;
-   m_state = hasAbortButton ? Continue : Uncancelable;
-   m_disableParentOnly = (style & wxPD_APP_MODAL) == 0;
-   m_parent = parent;
-   m_maximum = maximum;
-
-   m_elapsed = m_estimated = m_remaining = NULL;
-   if ((style & (wxPD_ELAPSED_TIME | wxPD_ESTIMATED_TIME | wxPD_REMAINING_TIME)) != 0) m_time = new wxTime;
-   else m_time = NULL;
-
-   wxFrame::Create(m_parent, -1, title, wxDefaultPosition,
-                   wxDefaultSize, wxDEFAULT_DIALOG_STYLE);
-   SetBackgroundColour(wxSystemSettings::GetSystemColour(wxSYS_COLOUR_3DFACE));
-
-   wxLayoutConstraints *c;
-
-   wxClientDC dc(this);
-   dc.SetFont(wxSystemSettings::GetSystemFont(wxSYS_DEFAULT_GUI_FONT));
-   long widthText;
-   dc.GetTextExtent(message, &widthText, NULL);
-
-   m_msg = new wxStaticText(this, -1, message);
-   c = new wxLayoutConstraints;
-   c->left.SameAs(this, wxLeft, 10);
-   c->top.SameAs(this, wxTop, 10);
-   c->width.AsIs();
-   c->height.AsIs();
-   m_msg->SetConstraints(c);
-   lastWindow = m_msg;
-
-   if ( maximum > 0 )
-   {
-      m_gauge = new wxGauge(this, -1, maximum,
-                            wxDefaultPosition, wxDefaultSize,
-                            wxGA_HORIZONTAL | wxRAISED_BORDER);
-      c = new wxLayoutConstraints;
-      c->left.SameAs(this, wxLeft, 2*LAYOUT_X_MARGIN);
-      c->top.Below(m_msg, 2*LAYOUT_Y_MARGIN);
-      c->right.SameAs(this, wxRight, 2*LAYOUT_X_MARGIN);
-      c->height.AsIs();
-      m_gauge->SetConstraints(c);
-      m_gauge->SetValue(0);
-      lastWindow = m_gauge;
-   }
-   else
-      m_gauge = (wxGauge *)NULL;
+BEGIN_EVENT_TABLE(wxProgressDialog, wxDialog)
+   EVT_BUTTON(wxID_CANCEL, wxProgressDialog::OnCancel)
+   EVT_CLOSE(wxProgressDialog::OnClose)
+END_EVENT_TABLE()

 
 

-   
-   if ( style & wxPD_ELAPSED_TIME )
-   {
-      m_elapsed = new wxStaticText(this, -1, "");
-      c = new wxLayoutConstraints;
-      c->right.SameAs(this, wxRight, 2*LAYOUT_X_MARGIN);
-      c->top.Below(lastWindow, LAYOUT_Y_MARGIN);
-      c->width.Absolute(60);
-      c->height.AsIs();
-      m_elapsed->SetConstraints(c);
-
-      wxStaticText *dummy = new wxStaticText(this, -1, _T("Elapsed time : "));
-      c = new wxLayoutConstraints;
-      c->right.LeftOf(m_elapsed);
-      c->top.SameAs(m_elapsed, wxTop, 0);
-      c->width.AsIs();
-      c->height.AsIs();
-      dummy->SetConstraints(c);      
-
-      lastWindow = m_elapsed;
-   }
+IMPLEMENT_CLASS(wxProgressDialog, wxDialog)

 
 

-   if ( style & wxPD_ESTIMATED_TIME )
-   {
-      m_estimated = new wxStaticText(this, -1, "");
-      c = new wxLayoutConstraints;
-      c->right.SameAs(this, wxRight, 2*LAYOUT_X_MARGIN);
-      c->top.Below(lastWindow, 0);
-      c->width.Absolute(60);
-      c->height.AsIs();
-      m_estimated->SetConstraints(c);
-
-      wxStaticText *dummy = new wxStaticText(this, -1, _T("Estimated time : "));
-      c = new wxLayoutConstraints;
-      c->right.LeftOf(m_estimated);
-      c->top.SameAs(m_estimated, wxTop, 0);
-      c->width.AsIs();
-      c->height.AsIs();
-      dummy->SetConstraints(c);      
-
-      lastWindow = m_estimated;
-   }
+// ============================================================================
+// implementation
+// ============================================================================

 
 

-   if ( style & wxPD_REMAINING_TIME )
-   {
-      m_remaining = new wxStaticText(this, -1, "");
-      c = new wxLayoutConstraints;
-      c->right.SameAs(this, wxRight, 2*LAYOUT_X_MARGIN);
-      c->top.Below(lastWindow, 0);
-      c->width.Absolute(60);
-      c->height.AsIs();
-      m_remaining->SetConstraints(c);
-
-      wxStaticText *dummy = new wxStaticText(this, -1, _T("Remaining time : "));
-      c = new wxLayoutConstraints;
-      c->right.LeftOf(m_remaining);
-      c->top.SameAs(m_remaining, wxTop, 0);
-      c->width.AsIs();
-      c->height.AsIs();
-      dummy->SetConstraints(c);      
-
-      lastWindow = m_remaining;
-   }
+// ----------------------------------------------------------------------------
+// wxProgressDialog
+// ----------------------------------------------------------------------------

 
 

-   if ( hasAbortButton )
-   {
-      m_btnAbort = new wxButton(this, -1, _("Cancel"));
-      c = new wxLayoutConstraints;
-      c->centreX.SameAs(this, wxCentreX);
-      c->top.Below(lastWindow, 2*LAYOUT_Y_MARGIN);
-      c->width.AsIs();
-      c->height.AsIs();
-      m_btnAbort->SetConstraints(c);
-   }
-   else
-      m_btnAbort = (wxButton *)NULL;
-
-   SetAutoLayout(TRUE);
-   Layout();
-
-   // calc the height of the dialog
-   Fit();
-   // and set the width from it - unfortunately, Fit() makes the dialog way too
-   // wide under Windows, so try to find a reasonable value for the width, not
-   // too big and not too small
-   wxSize size = GetClientSize();
-   size.x = wxMax(3*widthText/2, 2*size.y);
-   SetClientSize(size);
-
-   Show(TRUE);
-   Centre(wxCENTER_FRAME | wxBOTH);
-
-   if(m_disableParentOnly)
-      m_parent->Enable(FALSE);
-   else
-      wxEnableTopLevelWindows(FALSE);
+wxProgressDialog::wxProgressDialog(wxString const &title,
+                                   wxString const &message,
+                                   int maximum,
+                                   wxWindow *parent,
+                                   int style)
+                : wxDialog(parent, -1, title)
+{
+    bool hasAbortButton = (style & wxPD_CAN_ABORT) != 0;
+    m_state = hasAbortButton ? Continue : Uncancelable;
+    m_disableParentOnly = (style & wxPD_APP_MODAL) == 0;
+    m_AutoHide = (style & wxPD_AUTO_HIDE) != 0;
+    m_parent = parent;
+    m_maximum = maximum;
+
+    wxLayoutConstraints *c;
+
+    wxClientDC dc(this);
+    dc.SetFont(wxSystemSettings::GetSystemFont(wxSYS_DEFAULT_GUI_FONT));
+    long widthText;
+#if defined(__VISAGECPP__)
+// have two versions of this in wxWindowDC tp avoid function hiding
+// since there are two of these in wxDCBase, and in turn in wxDC.
+// VA cannot resolve this so:
+    dc.GetTextExtent(message, &widthText, NULL, NULL, NULL, NULL);
+#else
+    dc.GetTextExtent(message, &widthText, (long*)NULL);
+#endif

 
 

-   Enable(TRUE); // enable this window
-   wxYield();
+    m_msg = new wxStaticText(this, -1, message);
+    c = new wxLayoutConstraints;
+    c->left.SameAs(this, wxLeft, 2*LAYOUT_X_MARGIN);
+    c->top.SameAs(this, wxTop, 2*LAYOUT_Y_MARGIN);
+    c->width.AsIs();
+    c->height.AsIs();
+    m_msg->SetConstraints(c);
+
+    wxSize sizeDlg, sizeLabel = m_msg->GetSize();
+    sizeDlg.y = 2*LAYOUT_Y_MARGIN + sizeLabel.y;
+
+    wxWindow *lastWindow = m_msg;
+
+    if ( maximum > 0 )
+    {
+        m_gauge = new wxGauge(this, -1, maximum,
+                wxDefaultPosition, wxDefaultSize,
+                wxGA_HORIZONTAL | wxRAISED_BORDER | (style & wxGA_SMOOTH));
+        c = new wxLayoutConstraints;
+        c->left.SameAs(this, wxLeft, 2*LAYOUT_X_MARGIN);
+        c->top.Below(m_msg, 2*LAYOUT_Y_MARGIN);
+        c->right.SameAs(this, wxRight, 2*LAYOUT_X_MARGIN);
+        c->height.AsIs();
+        m_gauge->SetConstraints(c);
+        m_gauge->SetValue(0);
+        lastWindow = m_gauge;
+
+        wxSize sizeGauge = m_gauge->GetSize();
+        sizeDlg.y += 2*LAYOUT_Y_MARGIN + sizeGauge.y;
+    }
+    else
+        m_gauge = (wxGauge *)NULL;
+
+    // create the estimated/remaining/total time zones if requested
+    m_elapsed = m_estimated = m_remaining = (wxStaticText*)NULL;
+
+    int nTimeLabels = 0;
+    if ( style & wxPD_ELAPSED_TIME )
+    {
+        nTimeLabels++;
+
+        m_elapsed = CreateLabel(_("Elapsed time : "), &lastWindow);
+    }
+
+    if ( style & wxPD_ESTIMATED_TIME )
+    {
+        nTimeLabels++;
+
+        m_estimated = CreateLabel(_("Estimated time : "), &lastWindow);
+    }
+
+    if ( style & wxPD_REMAINING_TIME )
+    {
+        nTimeLabels++;
+
+        m_remaining = CreateLabel(_("Remaining time : "), &lastWindow);
+    }
+
+    if ( nTimeLabels > 0 )
+    {
+        // set it to the current time
+        m_timeStart = wxGetCurrentTime();
+        sizeDlg.y += nTimeLabels * (sizeLabel.y + LAYOUT_Y_MARGIN);
+    }
+
+    if ( hasAbortButton )
+    {
+        m_btnAbort = new wxButton(this, wxID_CANCEL, _("Cancel"));
+        c = new wxLayoutConstraints;
+
+        // Windows dialogs usually have buttons in the lower right corner
+#ifdef __WXMSW__
+        c->right.SameAs(this, wxRight, 2*LAYOUT_X_MARGIN);
+#else // !MSW
+        c->centreX.SameAs(this, wxCentreX);
+#endif // MSW/!MSW
+        c->bottom.SameAs(this, wxBottom, 2*LAYOUT_Y_MARGIN);
+
+        wxSize sizeBtn = wxButton::GetDefaultSize();
+        c->width.Absolute(sizeBtn.x);
+        c->height.Absolute(sizeBtn.y);
+
+        m_btnAbort->SetConstraints(c);
+
+        sizeDlg.y += 2*LAYOUT_Y_MARGIN + sizeBtn.y;
+    }
+    else
+        m_btnAbort = (wxButton *)NULL;
+
+    SetAutoLayout(TRUE);
+    Layout();
+
+    sizeDlg.y += 2*LAYOUT_Y_MARGIN;
+
+    // try to make the dialog not square but rectangular of reasonabel width
+    sizeDlg.x = (wxCoord)wxMax(widthText, 4*sizeDlg.y/3);
+    sizeDlg.x *= 3;
+    sizeDlg.x /= 2;
+    SetClientSize(sizeDlg);
+
+    Centre(wxCENTER_FRAME | wxBOTH);
+
+    if ( m_disableParentOnly )
+    {
+        if ( m_parent )
+            m_parent->Enable(FALSE);
+    }
+    else
+    {
+        wxEnableTopLevelWindows(FALSE);
+    }
+
+    Show(TRUE);
+    Enable(TRUE); // enable this window
+
+    // Update the display (especially on X, GTK)
+    wxYield();
+
+#ifdef __WXMAC__
+    MacUpdateImmediately();
+#endif

 }
 
 }
 

+wxStaticText *wxProgressDialog::CreateLabel(const wxString& text,
+                                            wxWindow **lastWindow)
+{
+    wxLayoutConstraints *c;
+
+    wxStaticText *label = new wxStaticText(this, -1, _("unknown"));
+    c = new wxLayoutConstraints;
+
+    // VZ: I like the labels be centered - if the others don't mind, you may
+    //     remove "#ifdef __WXMSW__" and use it for all ports
+#ifdef __WXMSW__
+    c->left.SameAs(this, wxCentreX, LAYOUT_X_MARGIN);
+#else // !MSW
+    c->right.SameAs(this, wxRight, 2*LAYOUT_X_MARGIN);
+#endif // MSW/!MSW
+    c->top.Below(*lastWindow, LAYOUT_Y_MARGIN);
+    c->width.AsIs();
+    c->height.AsIs();
+    label->SetConstraints(c);
+
+    wxStaticText *dummy = new wxStaticText(this, -1, text);
+    c = new wxLayoutConstraints;
+    c->right.LeftOf(label);
+    c->top.SameAs(label, wxTop, 0);
+    c->width.AsIs();
+    c->height.AsIs();
+    dummy->SetConstraints(c);
+
+    *lastWindow = label;
+
+    return label;
+}

 
 bool
 wxProgressDialog::Update(int value, const wxString& newmsg)
 {
 
 bool
 wxProgressDialog::Update(int value, const wxString& newmsg)
 {

-   wxASSERT_MSG( value == -1 || m_gauge, _T("cannot update non existent dialog") );
-   wxASSERT_MSG( value <= m_maximum, _T("invalid progress value") );
+   wxASSERT_MSG( value == -1 || m_gauge, wxT("cannot update non existent dialog") );
+   wxASSERT_MSG( value <= m_maximum, wxT("invalid progress value") );

 
 
    if( m_gauge )
 
 
    if( m_gauge )


@@ -222,31 +278,16 @@ wxProgressDialog::Update(int value, const wxString& newmsg)
 
    if ( (m_elapsed || m_remaining || m_estimated) && (value != 0) )
    {
 
    if ( (m_elapsed || m_remaining || m_estimated) && (value != 0) )
    {

-      wxTime timenow;
-      wxTime diff = timenow -  *m_time;
-      unsigned long secs = diff.GetSecond() + 60 * diff.GetMinute() + 60 * 60 * diff.GetHour();
-      unsigned long estim = secs * m_maximum / value; 
-      unsigned long remai = estim - secs; 
-      wxString s;
-
-      if (m_elapsed) 
-      {
-         s.Printf("%i:%02i:%02i", diff.GetHour(), diff.GetMinute(), diff.GetSecond());
-         if (s != m_elapsed->GetLabel()) m_elapsed->SetLabel(s);
-      }
-      if (m_estimated) 
-      {
-         s.Printf("%i:%02i:%02i", estim / (60 * 60), (estim / 60) % 60, estim % 60);
-         if (s != m_estimated->GetLabel()) m_estimated->SetLabel(s);
-      }
-      if (m_remaining) 
-      {
-         s.Printf("%i:%02i:%02i", remai / (60 * 60), (remai / 60) % 60, remai % 60);
-         if (s != m_remaining->GetLabel()) m_remaining->SetLabel(s);
-      }
+      unsigned long elapsed = wxGetCurrentTime() - m_timeStart;
+      unsigned long estimated = elapsed * m_maximum / value;
+      unsigned long remaining = estimated - elapsed;
+
+      SetTimeLabel(elapsed, m_elapsed);
+      SetTimeLabel(estimated, m_estimated);
+      SetTimeLabel(remaining, m_remaining);

    }
 
    }
 

-   if ( (value == m_maximum - 1) && !(GetWindowStyleFlag() & wxPD_AUTO_HIDE) )
+   if ( (value == m_maximum ) && !m_AutoHide )

    {
        if ( m_btnAbort )
        {
    {
        if ( m_btnAbort )
        {


@@ -260,31 +301,93 @@ wxProgressDialog::Update(int value, const wxString& newmsg)
            m_msg->SetLabel(_("Done."));
        }
 
            m_msg->SetLabel(_("Done."));
        }
 

+       // so that we return TRUE below and that out [Cancel] handler knew what
+       // to do

        m_state = Finished;
 
        m_state = Finished;
 

-       // so that we return TRUE below
-       m_state = Finished;
+       wxYield();
+
+       (void)ShowModal();
+   }
+   else
+   {
+       // update the display
+       wxYield();

    }
    }

-   wxYield();
+
+#ifdef __WXMAC__
+    MacUpdateImmediately();
+#endif
+

    return m_state != Canceled;
 }
 
    return m_state != Canceled;
 }
 

+// ----------------------------------------------------------------------------
+// event handlers
+// ----------------------------------------------------------------------------
+
+void wxProgressDialog::OnCancel(wxCommandEvent& event)
+{
+    if ( m_state == Finished )
+    {
+        // this means that the count down is already finished and we're being
+        // shown as a modal dialog - so just let the default handler do the job
+        event.Skip();
+    }
+    else
+    {
+        // request to cancel was received, the next time Update() is called we
+        // will handle it
+        m_state = Canceled;
+
+        // update the button state immediately so that the user knows that the
+        // request has been noticed
+        m_btnAbort->Disable();
+    }
+}
+

 void wxProgressDialog::OnClose(wxCloseEvent& event)
 {
 void wxProgressDialog::OnClose(wxCloseEvent& event)
 {

-   if ( m_state == Uncancelable )
-      event.Veto(TRUE);
-   else
-      m_state = Canceled;
+    if ( m_state == Uncancelable )
+        event.Veto(TRUE);
+    else
+        m_state = Canceled;

 }
 
 }
 

+// ----------------------------------------------------------------------------
+// destruction
+// ----------------------------------------------------------------------------

 
 wxProgressDialog::~wxProgressDialog()
 {
 
 wxProgressDialog::~wxProgressDialog()
 {

-   if ( m_disableParentOnly )
-      m_parent->Enable(TRUE);
-   else
-      wxEnableTopLevelWindows(TRUE);
-   if (m_time) delete m_time;
+    if ( m_disableParentOnly )
+    {
+        if ( m_parent )
+            m_parent->Enable(TRUE);
+    }
+    else
+    {
+        wxEnableTopLevelWindows(TRUE);
+    }

 }
 
 }
 

-#endif
+// ----------------------------------------------------------------------------
+// private functions
+// ----------------------------------------------------------------------------
+
+static void SetTimeLabel(unsigned long val, wxStaticText *label)
+{
+    if ( label )
+    {
+        wxString s;
+        unsigned long hours = val / 3600;
+        unsigned long minutes = (val % 3600) / 60;
+        unsigned long seconds = val % 60;
+        s.Printf(wxT("%lu:%02lu:%02lu"), hours, minutes, seconds);
+
+        if ( s != label->GetLabel() )
+            label->SetLabel(s);
+    }
+}
+
+#endif // wxUSE_PROGRESSDLG