src/generic/progdlgg.cpp

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        src/generic/progdlgg.cpp
   3 // Purpose:     wxProgressDialog class
   4 // Author:      Karsten Ballüder
   5 // Modified by:
   6 // Created:     09.05.1999
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) Karsten Ballüder
   9 // Licence:     wxWindows licence
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 // ============================================================================
  13 // declarations
  14 // ============================================================================
  15
  16 // ----------------------------------------------------------------------------
  17 // headers
  18 // ----------------------------------------------------------------------------
  19
  20 // For compilers that support precompilation, includes "wx.h".
  21 #include "wx/wxprec.h"
  22
  23 #ifdef __BORLANDC__
  24     #pragma hdrstop
  25 #endif
  26
  27 #if wxUSE_PROGRESSDLG
  28
  29 #ifndef WX_PRECOMP
  30     #include "wx/utils.h"
  31     #include "wx/frame.h"
  32     #include "wx/button.h"
  33     #include "wx/stattext.h"
  34     #include "wx/sizer.h"
  35     #include "wx/event.h"
  36     #include "wx/gauge.h"
  37     #include "wx/intl.h"
  38     #include "wx/dcclient.h"
  39     #include "wx/timer.h"
  40     #include "wx/settings.h"
  41 #endif
  42
  43 #include "wx/progdlg.h"
  44
  45 // ---------------------------------------------------------------------------
  46 // macros
  47 // ---------------------------------------------------------------------------
  48
  49 /* Macro for avoiding #ifdefs when value have to be different depending on size of
  50    device we display on - take it from something like wxDesktopPolicy in the future
  51  */
  52
  53 #if defined(__SMARTPHONE__)
  54     #define wxLARGESMALL(large,small) small
  55 #else
  56     #define wxLARGESMALL(large,small) large
  57 #endif
  58
  59 // ----------------------------------------------------------------------------
  60 // constants
  61 // ----------------------------------------------------------------------------
  62
  63 #define LAYOUT_MARGIN wxLARGESMALL(8,2)
  64
  65 static const int wxID_SKIP = 32000;  // whatever
  66
  67 // ----------------------------------------------------------------------------
  68 // private functions
  69 // ----------------------------------------------------------------------------
  70
  71 // update the label to show the given time (in seconds)
  72 static void SetTimeLabel(unsigned long val, wxStaticText *label);
  73
  74 // ----------------------------------------------------------------------------
  75 // event tables
  76 // ----------------------------------------------------------------------------
  77
  78 BEGIN_EVENT_TABLE(wxProgressDialog, wxDialog)
  79     EVT_BUTTON(wxID_CANCEL, wxProgressDialog::OnCancel)
  80     EVT_BUTTON(wxID_SKIP, wxProgressDialog::OnSkip)
  81
  82     EVT_CLOSE(wxProgressDialog::OnClose)
  83 END_EVENT_TABLE()
  84
  85 IMPLEMENT_CLASS(wxProgressDialog, wxDialog)
  86
  87 // ============================================================================
  88 // wxProgressDialog implementation
  89 // ============================================================================
  90
  91 // ----------------------------------------------------------------------------
  92 // wxProgressDialog creation
  93 // ----------------------------------------------------------------------------
  94
  95 wxProgressDialog::wxProgressDialog(wxString const &title,
  96                                    wxString const &message,
  97                                    int maximum,
  98                                    wxWindow *parent,
  99                                    int style)
 100                 : wxDialog(GetParentForModalDialog(parent), wxID_ANY, title),
 101                   m_skip(false),
 102                   m_delay(3),
 103                   m_hasAbortButton(false),
 104                   m_hasSkipButton(false)
 105 {
 106     // we may disappear at any moment, let the others know about it
 107     SetExtraStyle(GetExtraStyle() | wxWS_EX_TRANSIENT);
 108     m_windowStyle |= style;
 109
 110     m_hasAbortButton = (style & wxPD_CAN_ABORT) != 0;
 111     m_hasSkipButton = (style & wxPD_CAN_SKIP) != 0;
 112
 113     bool isPda = (wxSystemSettings::GetScreenType() <= wxSYS_SCREEN_PDA);
 114
 115 #if defined(__WXMSW__) && !defined(__WXUNIVERSAL__)
 116     // we have to remove the "Close" button from the title bar then as it is
 117     // confusing to have it - it doesn't work anyhow
 118     //
 119     // FIXME: should probably have a (extended?) window style for this
 120     if ( !m_hasAbortButton )
 121     {
 122         EnableCloseButton(false);
 123     }
 124 #endif // wxMSW
 125
 126 #if defined(__SMARTPHONE__)
 127     SetLeftMenu();
 128 #endif
 129
 130     m_state = m_hasAbortButton ? Continue : Uncancelable;
 131     m_maximum = maximum;
 132
 133 #if defined(__WXMSW__) || defined(__WXPM__)
 134     // we can't have values > 65,536 in the progress control under Windows, so
 135     // scale everything down
 136     m_factor = m_maximum / 65536 + 1;
 137     m_maximum /= m_factor;
 138 #endif // __WXMSW__
 139
 140     m_parentTop = wxGetTopLevelParent(parent);
 141
 142     wxClientDC dc(this);
 143     dc.SetFont(wxSystemSettings::GetFont(wxSYS_DEFAULT_GUI_FONT));
 144     wxCoord widthText = 0;
 145     dc.GetTextExtent(message, &widthText, NULL, NULL, NULL, NULL);
 146
 147     wxBoxSizer *sizer = new wxBoxSizer(wxVERTICAL);
 148
 149     m_msg = new wxStaticText(this, wxID_ANY, message);
 150     sizer->Add(m_msg, 0, wxLEFT | wxTOP, 2*LAYOUT_MARGIN);
 151
 152     wxSize sizeDlg,
 153            sizeLabel = m_msg->GetSize();
 154     sizeDlg.y = 2*LAYOUT_MARGIN + sizeLabel.y;
 155
 156     if ( maximum > 0 )
 157     {
 158         int gauge_style = wxGA_HORIZONTAL;
 159         if ( ( style & wxPD_SMOOTH ) == wxPD_SMOOTH )
 160             gauge_style |= wxGA_SMOOTH;
 161         m_gauge = new wxGauge(this, wxID_ANY, m_maximum,
 162                               wxDefaultPosition, wxDefaultSize,
 163                               gauge_style );
 164
 165         sizer->Add(m_gauge, 0, wxLEFT | wxRIGHT | wxTOP | wxEXPAND, 2*LAYOUT_MARGIN);
 166         m_gauge->SetValue(0);
 167
 168         wxSize sizeGauge = m_gauge->GetSize();
 169         sizeDlg.y += 2*LAYOUT_MARGIN + sizeGauge.y;
 170     }
 171     else
 172         m_gauge = (wxGauge *)NULL;
 173
 174     // create the estimated/remaining/total time zones if requested
 175     m_elapsed = m_estimated = m_remaining = (wxStaticText*)NULL;
 176     m_display_estimated = m_last_timeupdate = m_break = 0;
 177     m_ctdelay = 0;
 178
 179     // if we are going to have at least one label, remember it in this var
 180     wxStaticText *label = NULL;
 181
 182     // also count how many labels we really have
 183     size_t nTimeLabels = 0;
 184
 185     if ( style & wxPD_ELAPSED_TIME )
 186     {
 187         nTimeLabels++;
 188
 189         label =
 190         m_elapsed = CreateLabel(_("Elapsed time : "), sizer);
 191     }
 192
 193     if ( style & wxPD_ESTIMATED_TIME )
 194     {
 195         nTimeLabels++;
 196
 197         label =
 198         m_estimated = CreateLabel(_("Estimated time : "), sizer);
 199     }
 200
 201     if ( style & wxPD_REMAINING_TIME )
 202     {
 203         nTimeLabels++;
 204
 205         label =
 206         m_remaining = CreateLabel(_("Remaining time : "), sizer);
 207     }
 208
 209     if ( nTimeLabels > 0 )
 210     {
 211         // set it to the current time
 212         m_timeStart = wxGetCurrentTime();
 213         sizeDlg.y += nTimeLabels * (label->GetSize().y + LAYOUT_MARGIN);
 214     }
 215
 216 #if defined(__SMARTPHONE__)
 217     if ( m_hasSkipButton )
 218         SetRightMenu(wxID_SKIP, _("Skip"));
 219     if ( m_hasAbortButton )
 220         SetLeftMenu(wxID_CANCEL);
 221 #else
 222     m_btnAbort = m_btnSkip = (wxButton *)NULL;
 223     bool sizeDlgModified = false;
 224     wxBoxSizer *buttonSizer = new wxBoxSizer(wxHORIZONTAL);
 225
 226     const int sizerFlags =
 227 #if defined(__WXMSW__) || defined(__WXPM__)
 228                            wxALIGN_RIGHT | wxALL
 229 #else // !MSW
 230                            wxALIGN_CENTER_HORIZONTAL | wxBOTTOM | wxTOP
 231 #endif // MSW/!MSW
 232                            ;
 233
 234     if ( m_hasSkipButton )
 235     {
 236         m_btnSkip = new wxButton(this, wxID_SKIP, _("Skip"));
 237
 238         // Windows dialogs usually have buttons in the lower right corner
 239         buttonSizer->Add(m_btnSkip, 0, sizerFlags, LAYOUT_MARGIN);
 240         sizeDlg.y += 2*LAYOUT_MARGIN + wxButton::GetDefaultSize().y;
 241         sizeDlgModified = true;
 242     }
 243
 244     if ( m_hasAbortButton )
 245     {
 246         m_btnAbort = new wxButton(this, wxID_CANCEL);
 247
 248         // Windows dialogs usually have buttons in the lower right corner
 249         buttonSizer->Add(m_btnAbort, 0, sizerFlags, LAYOUT_MARGIN);
 250         if(!sizeDlgModified)
 251             sizeDlg.y += 2*LAYOUT_MARGIN + wxButton::GetDefaultSize().y;
 252     }
 253
 254     sizer->Add(buttonSizer, 0, sizerFlags, LAYOUT_MARGIN );
 255 #endif // __SMARTPHONE__/!__SMARTPHONE__
 256
 257     SetSizerAndFit(sizer);
 258
 259     if (!isPda)
 260     {
 261         sizeDlg.y += 2*LAYOUT_MARGIN;
 262
 263         // try to make the dialog not square but rectangular of reasonable width
 264         sizeDlg.x = (wxCoord)wxMax(3*widthText/2, 4*sizeDlg.y/3);
 265         SetClientSize(sizeDlg);
 266     }
 267
 268     Centre(wxCENTER_FRAME | wxBOTH);
 269
 270     if ( style & wxPD_APP_MODAL )
 271     {
 272         m_winDisabler = new wxWindowDisabler(this);
 273     }
 274     else
 275     {
 276         if ( m_parentTop )
 277             m_parentTop->Disable();
 278         m_winDisabler = NULL;
 279     }
 280
 281     Show();
 282     Enable();
 283
 284     // this one can be initialized even if the others are unknown for now
 285     //
 286     // NB: do it after calling Layout() to keep the labels correctly aligned
 287     if ( m_elapsed )
 288     {
 289         SetTimeLabel(0, m_elapsed);
 290     }
 291
 292     Update();
 293 }
 294
 295 wxStaticText *wxProgressDialog::CreateLabel(const wxString& text,
 296                                             wxSizer *sizer)
 297 {
 298     wxBoxSizer *locsizer = new wxBoxSizer(wxLARGESMALL(wxHORIZONTAL,wxVERTICAL));
 299
 300     wxStaticText *dummy = new wxStaticText(this, wxID_ANY, text);
 301     wxStaticText *label = new wxStaticText(this, wxID_ANY, _("unknown"));
 302
 303     // select placement most native or nice on target GUI
 304 #if defined(__SMARTPHONE__)
 305     // label and time to the left in two rows
 306     locsizer->Add(dummy, 1, wxALIGN_LEFT);
 307     locsizer->Add(label, 1, wxALIGN_LEFT);
 308     sizer->Add(locsizer, 0, wxALIGN_LEFT | wxTOP | wxLEFT, LAYOUT_MARGIN);
 309 #elif defined(__WXMSW__) || defined(__WXPM__) || defined(__WXMAC__) || defined(__WXGTK20__)
 310     // label and time centered in one row
 311     locsizer->Add(dummy, 1, wxLARGESMALL(wxALIGN_RIGHT,wxALIGN_LEFT));
 312     locsizer->Add(label, 1, wxALIGN_LEFT | wxLEFT, LAYOUT_MARGIN);
 313     sizer->Add(locsizer, 0, wxALIGN_CENTER_HORIZONTAL | wxTOP, LAYOUT_MARGIN);
 314 #else
 315     // label and time to the right in one row
 316     sizer->Add(locsizer, 0, wxALIGN_RIGHT | wxRIGHT | wxTOP, LAYOUT_MARGIN);
 317     locsizer->Add(dummy);
 318     locsizer->Add(label, 0, wxLEFT, LAYOUT_MARGIN);
 319 #endif
 320
 321     return label;
 322 }
 323
 324 // ----------------------------------------------------------------------------
 325 // wxProgressDialog operations
 326 // ----------------------------------------------------------------------------
 327
 328 bool
 329 wxProgressDialog::Update(int value, const wxString& newmsg, bool *skip)
 330 {
 331     wxASSERT_MSG( value == -1 || m_gauge, wxT("cannot update non existent dialog") );
 332
 333 #ifdef __WXMSW__
 334     value /= m_factor;
 335 #endif // __WXMSW__
 336
 337     wxASSERT_MSG( value <= m_maximum, wxT("invalid progress value") );
 338
 339     if ( m_gauge )
 340         m_gauge->SetValue(value);
 341
 342     UpdateMessage(newmsg);
 343
 344     if ( (m_elapsed || m_remaining || m_estimated) && (value != 0) )
 345     {
 346         unsigned long elapsed = wxGetCurrentTime() - m_timeStart;
 347         if (    m_last_timeupdate < elapsed
 348              || value == m_maximum
 349            )
 350         {
 351             m_last_timeupdate = elapsed;
 352             unsigned long estimated = m_break +
 353                   (unsigned long)(( (double) (elapsed-m_break) * m_maximum ) / ((double)value)) ;
 354             if (    estimated > m_display_estimated
 355                  && m_ctdelay >= 0
 356                )
 357             {
 358                 ++m_ctdelay;
 359             }
 360             else if (    estimated < m_display_estimated
 361                       && m_ctdelay <= 0
 362                     )
 363             {
 364                 --m_ctdelay;
 365             }
 366             else
 367             {
 368                 m_ctdelay = 0;
 369             }
 370             if (    m_ctdelay >= m_delay          // enough confirmations for a higher value
 371                  || m_ctdelay <= (m_delay*-1)     // enough confirmations for a lower value
 372                  || value == m_maximum            // to stay consistent
 373                  || elapsed > m_display_estimated // to stay consistent
 374                  || ( elapsed > 0 && elapsed < 4 ) // additional updates in the beginning
 375                )
 376             {
 377                 m_display_estimated = estimated;
 378                 m_ctdelay = 0;
 379             }
 380         }
 381
 382         long display_remaining = m_display_estimated - elapsed;
 383         if ( display_remaining < 0 )
 384         {
 385             display_remaining = 0;
 386         }
 387
 388         SetTimeLabel(elapsed, m_elapsed);
 389         SetTimeLabel(m_display_estimated, m_estimated);
 390         SetTimeLabel(display_remaining, m_remaining);
 391     }
 392
 393     if ( value == m_maximum )
 394     {
 395         if ( m_state == Finished )
 396         {
 397             // ignore multiple calls to Update(m_maximum): it may sometimes be
 398             // troublesome to ensure that Update() is not called twice with the
 399             // same value (e.g. because of the rounding errors) and if we don't
 400             // return now we're going to generate asserts below
 401             return true;
 402         }
 403
 404         // so that we return true below and that out [Cancel] handler knew what
 405         // to do
 406         m_state = Finished;
 407         if( !(GetWindowStyle() & wxPD_AUTO_HIDE) )
 408         {
 409             EnableClose();
 410             DisableSkip();
 411 #if defined(__WXMSW__) && !defined(__WXUNIVERSAL__)
 412             EnableCloseButton();
 413 #endif // __WXMSW__
 414
 415             if ( newmsg.empty() )
 416             {
 417                 // also provide the finishing message if the application didn't
 418                 m_msg->SetLabel(_("Done."));
 419             }
 420
 421             wxYieldIfNeeded() ;
 422
 423             (void)ShowModal();
 424         }
 425         else // auto hide
 426         {
 427             // reenable other windows before hiding this one because otherwise
 428             // Windows wouldn't give the focus back to the window which had
 429             // been previously focused because it would still be disabled
 430             ReenableOtherWindows();
 431
 432             Hide();
 433         }
 434     }
 435     else // not at maximum yet
 436     {
 437         return DoAfterUpdate(skip);
 438     }
 439
 440     // update the display in case yielding above didn't do it
 441     Update();
 442
 443     return m_state != Canceled;
 444 }
 445
 446 bool wxProgressDialog::Pulse(const wxString& newmsg, bool *skip)
 447 {
 448     wxASSERT_MSG( m_gauge, wxT("cannot update non existent dialog") );
 449
 450     // show a bit of progress
 451     m_gauge->Pulse();
 452
 453     UpdateMessage(newmsg);
 454
 455     if (m_elapsed || m_remaining || m_estimated)
 456     {
 457         unsigned long elapsed = wxGetCurrentTime() - m_timeStart;
 458
 459         SetTimeLabel(elapsed, m_elapsed);
 460         SetTimeLabel((unsigned long)-1, m_estimated);
 461         SetTimeLabel((unsigned long)-1, m_remaining);
 462     }
 463
 464     return DoAfterUpdate(skip);
 465 }
 466
 467 bool wxProgressDialog::DoAfterUpdate(bool *skip)
 468 {
 469     // we have to yield because not only we want to update the display but
 470     // also to process the clicks on the cancel and skip buttons
 471     wxYieldIfNeeded();
 472
 473     Update();
 474
 475     if ( m_skip && skip && !*skip )
 476     {
 477         *skip = true;
 478         m_skip = false;
 479         EnableSkip();
 480     }
 481
 482     return m_state != Canceled;
 483 }
 484
 485 void wxProgressDialog::Resume()
 486 {
 487     m_state = Continue;
 488     m_ctdelay = m_delay; // force an update of the elapsed/estimated/remaining time
 489     m_break += wxGetCurrentTime()-m_timeStop;
 490
 491     EnableAbort();
 492     EnableSkip();
 493     m_skip = false;
 494 }
 495
 496 bool wxProgressDialog::Show( bool show )
 497 {
 498     // reenable other windows before hiding this one because otherwise
 499     // Windows wouldn't give the focus back to the window which had
 500     // been previously focused because it would still be disabled
 501     if(!show)
 502         ReenableOtherWindows();
 503
 504     return wxDialog::Show(show);
 505 }
 506
 507 // ----------------------------------------------------------------------------
 508 // event handlers
 509 // ----------------------------------------------------------------------------
 510
 511 void wxProgressDialog::OnCancel(wxCommandEvent& event)
 512 {
 513     if ( m_state == Finished )
 514     {
 515         // this means that the count down is already finished and we're being
 516         // shown as a modal dialog - so just let the default handler do the job
 517         event.Skip();
 518     }
 519     else
 520     {
 521         // request to cancel was received, the next time Update() is called we
 522         // will handle it
 523         m_state = Canceled;
 524
 525         // update the buttons state immediately so that the user knows that the
 526         // request has been noticed
 527         DisableAbort();
 528         DisableSkip();
 529
 530         // save the time when the dialog was stopped
 531         m_timeStop = wxGetCurrentTime();
 532     }
 533 }
 534
 535 void wxProgressDialog::OnSkip(wxCommandEvent& WXUNUSED(event))
 536 {
 537     DisableSkip();
 538     m_skip = true;
 539 }
 540
 541 void wxProgressDialog::OnClose(wxCloseEvent& event)
 542 {
 543     if ( m_state == Uncancelable )
 544     {
 545         // can't close this dialog
 546         event.Veto();
 547     }
 548     else if ( m_state == Finished )
 549     {
 550         // let the default handler close the window as we already terminated
 551         event.Skip();
 552     }
 553     else
 554     {
 555         // next Update() will notice it
 556         m_state = Canceled;
 557         DisableAbort();
 558         DisableSkip();
 559
 560         m_timeStop = wxGetCurrentTime();
 561     }
 562 }
 563
 564 // ----------------------------------------------------------------------------
 565 // destruction
 566 // ----------------------------------------------------------------------------
 567
 568 wxProgressDialog::~wxProgressDialog()
 569 {
 570     // normally this should have been already done, but just in case
 571     ReenableOtherWindows();
 572 }
 573
 574 void wxProgressDialog::ReenableOtherWindows()
 575 {
 576     if ( GetWindowStyle() & wxPD_APP_MODAL )
 577     {
 578         delete m_winDisabler;
 579         m_winDisabler = (wxWindowDisabler *)NULL;
 580     }
 581     else
 582     {
 583         if ( m_parentTop )
 584             m_parentTop->Enable();
 585     }
 586 }
 587
 588 // ----------------------------------------------------------------------------
 589 // private functions
 590 // ----------------------------------------------------------------------------
 591
 592 static void SetTimeLabel(unsigned long val, wxStaticText *label)
 593 {
 594     if ( label )
 595     {
 596         wxString s;
 597
 598         if (val != (unsigned long)-1)
 599         {
 600         unsigned long hours = val / 3600;
 601         unsigned long minutes = (val % 3600) / 60;
 602         unsigned long seconds = val % 60;
 603         s.Printf(wxT("%lu:%02lu:%02lu"), hours, minutes, seconds);
 604         }
 605         else
 606         {
 607             s = _("Unknown");
 608         }
 609
 610         if ( s != label->GetLabel() )
 611             label->SetLabel(s);
 612     }
 613 }
 614
 615 void wxProgressDialog::EnableSkip(bool enable)
 616 {
 617     if(m_hasSkipButton)
 618     {
 619 #ifdef __SMARTPHONE__
 620         if(enable)
 621             SetRightMenu(wxID_SKIP, _("Skip"));
 622         else
 623             SetRightMenu();
 624 #else
 625         if(m_btnSkip)
 626             m_btnSkip->Enable(enable);
 627 #endif
 628     }
 629 }
 630
 631 void wxProgressDialog::EnableAbort(bool enable)
 632 {
 633     if(m_hasAbortButton)
 634     {
 635 #ifdef __SMARTPHONE__
 636         if(enable)
 637             SetLeftMenu(wxID_CANCEL); // stock buttons makes Cancel label
 638         else
 639             SetLeftMenu();
 640 #else
 641         if(m_btnAbort)
 642             m_btnAbort->Enable(enable);
 643 #endif
 644     }
 645 }
 646
 647 void wxProgressDialog::EnableClose()
 648 {
 649     if(m_hasAbortButton)
 650     {
 651 #ifdef __SMARTPHONE__
 652         SetLeftMenu(wxID_CANCEL, _("Close"));
 653 #else
 654         if(m_btnAbort)
 655         {
 656             m_btnAbort->Enable();
 657             m_btnAbort->SetLabel(_("Close"));
 658         }
 659 #endif
 660     }
 661 }
 662
 663 void wxProgressDialog::UpdateMessage(const wxString &newmsg)
 664 {
 665     if ( !newmsg.empty() && newmsg != m_msg->GetLabel() )
 666     {
 667         m_msg->SetLabel(newmsg);
 668
 669         wxYieldIfNeeded() ;
 670     }
 671 }
 672
 673 #endif // wxUSE_PROGRESSDLG