src/generic/progdlgg.cpp

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