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, remmeber 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(widthText*2, 4*sizeDlg.y/3);
 265         sizeDlg.x *= 3;
 266         sizeDlg.x /= 2;
 267         SetClientSize(sizeDlg);
 268     }
 269
 270     Centre(wxCENTER_FRAME | wxBOTH);
 271
 272     if ( style & wxPD_APP_MODAL )
 273     {
 274         m_winDisabler = new wxWindowDisabler(this);
 275     }
 276     else
 277     {
 278         if ( m_parentTop )
 279             m_parentTop->Disable();
 280         m_winDisabler = NULL;
 281     }
 282
 283     Show();
 284     Enable();
 285
 286     // this one can be initialized even if the others are unknown for now
 287     //
 288     // NB: do it after calling Layout() to keep the labels correctly aligned
 289     if ( m_elapsed )
 290     {
 291         SetTimeLabel(0, m_elapsed);
 292     }
 293
 294     Update();
 295 }
 296
 297 wxStaticText *wxProgressDialog::CreateLabel(const wxString& text,
 298                                             wxSizer *sizer)
 299 {
 300     wxBoxSizer *locsizer = new wxBoxSizer(wxLARGESMALL(wxHORIZONTAL,wxVERTICAL));
 301
 302     wxStaticText *dummy = new wxStaticText(this, wxID_ANY, text);
 303     wxStaticText *label = new wxStaticText(this, wxID_ANY, _("unknown"));
 304
 305     // select placement most native or nice on target GUI
 306 #if defined(__SMARTPHONE__)
 307     // label and time to the left in two rows
 308     locsizer->Add(dummy, 1, wxALIGN_LEFT);
 309     locsizer->Add(label, 1, wxALIGN_LEFT);
 310     sizer->Add(locsizer, 0, wxALIGN_LEFT | wxTOP | wxLEFT, LAYOUT_MARGIN);
 311 #elif defined(__WXMSW__) || defined(__WXPM__) || defined(__WXMAC__) || defined(__WXGTK20__)
 312     // label and time centered in one row
 313     locsizer->Add(dummy, 1, wxLARGESMALL(wxALIGN_RIGHT,wxALIGN_LEFT));
 314     locsizer->Add(label, 1, wxALIGN_LEFT | wxLEFT, LAYOUT_MARGIN);
 315     sizer->Add(locsizer, 0, wxALIGN_CENTER_HORIZONTAL | wxTOP, LAYOUT_MARGIN);
 316 #else
 317     // label and time to the right in one row
 318     sizer->Add(locsizer, 0, wxALIGN_RIGHT | wxRIGHT | wxTOP, LAYOUT_MARGIN);
 319     locsizer->Add(dummy);
 320     locsizer->Add(label, 0, wxLEFT, LAYOUT_MARGIN);
 321 #endif
 322
 323     return label;
 324 }
 325
 326 // ----------------------------------------------------------------------------
 327 // wxProgressDialog operations
 328 // ----------------------------------------------------------------------------
 329
 330 bool
 331 wxProgressDialog::Update(int value, const wxString& newmsg, bool *skip)
 332 {
 333     wxASSERT_MSG( value == -1 || m_gauge, wxT("cannot update non existent dialog") );
 334
 335 #ifdef __WXMSW__
 336     value /= m_factor;
 337 #endif // __WXMSW__
 338
 339     wxASSERT_MSG( value <= m_maximum, wxT("invalid progress value") );
 340
 341     if ( m_gauge )
 342         m_gauge->SetValue(value);
 343
 344     UpdateMessage(newmsg);
 345
 346     if ( (m_elapsed || m_remaining || m_estimated) && (value != 0) )
 347     {
 348         unsigned long elapsed = wxGetCurrentTime() - m_timeStart;
 349         if (    m_last_timeupdate < elapsed
 350              || value == m_maximum
 351            )
 352         {
 353             m_last_timeupdate = elapsed;
 354             unsigned long estimated = m_break +
 355                   (unsigned long)(( (double) (elapsed-m_break) * m_maximum ) / ((double)value)) ;
 356             if (    estimated > m_display_estimated
 357                  && m_ctdelay >= 0
 358                )
 359             {
 360                 ++m_ctdelay;
 361             }
 362             else if (    estimated < m_display_estimated
 363                       && m_ctdelay <= 0
 364                     )
 365             {
 366                 --m_ctdelay;
 367             }
 368             else
 369             {
 370                 m_ctdelay = 0;
 371             }
 372             if (    m_ctdelay >= m_delay          // enough confirmations for a higher value
 373                  || m_ctdelay <= (m_delay*-1)     // enough confirmations for a lower value
 374                  || value == m_maximum            // to stay consistent
 375                  || elapsed > m_display_estimated // to stay consistent
 376                  || ( elapsed > 0 && elapsed < 4 ) // additional updates in the beginning
 377                )
 378             {
 379                 m_display_estimated = estimated;
 380                 m_ctdelay = 0;
 381             }
 382         }
 383
 384         long display_remaining = m_display_estimated - elapsed;
 385         if ( display_remaining < 0 )
 386         {
 387             display_remaining = 0;
 388         }
 389
 390         SetTimeLabel(elapsed, m_elapsed);
 391         SetTimeLabel(m_display_estimated, m_estimated);
 392         SetTimeLabel(display_remaining, m_remaining);
 393     }
 394
 395     if ( value == m_maximum )
 396     {
 397         if ( m_state == Finished )
 398         {
 399             // ignore multiple calls to Update(m_maximum): it may sometimes be
 400             // troublesome to ensure that Update() is not called twice with the
 401             // same value (e.g. because of the rounding errors) and if we don't
 402             // return now we're going to generate asserts below
 403             return true;
 404         }
 405
 406         // so that we return true below and that out [Cancel] handler knew what
 407         // to do
 408         m_state = Finished;
 409         if( !(GetWindowStyle() & wxPD_AUTO_HIDE) )
 410         {
 411             EnableClose();
 412             DisableSkip();
 413 #if defined(__WXMSW__) && !defined(__WXUNIVERSAL__)
 414             EnableCloseButton();
 415 #endif // __WXMSW__
 416
 417             if ( newmsg.empty() )
 418             {
 419                 // also provide the finishing message if the application didn't
 420                 m_msg->SetLabel(_("Done."));
 421             }
 422
 423             wxYieldIfNeeded() ;
 424
 425             (void)ShowModal();
 426         }
 427         else // auto hide
 428         {
 429             // reenable other windows before hiding this one because otherwise
 430             // Windows wouldn't give the focus back to the window which had
 431             // been previously focused because it would still be disabled
 432             ReenableOtherWindows();
 433
 434             Hide();
 435         }
 436     }
 437     else // not at maximum yet
 438     {
 439         return DoAfterUpdate(skip);
 440     }
 441
 442     // update the display in case yielding above didn't do it
 443     Update();
 444
 445     return m_state != Canceled;
 446 }
 447
 448 bool wxProgressDialog::Pulse(const wxString& newmsg, bool *skip)
 449 {
 450     wxASSERT_MSG( m_gauge, wxT("cannot update non existent dialog") );
 451
 452     // show a bit of progress
 453     m_gauge->Pulse();
 454
 455     UpdateMessage(newmsg);
 456
 457     if (m_elapsed || m_remaining || m_estimated)
 458     {
 459         unsigned long elapsed = wxGetCurrentTime() - m_timeStart;
 460
 461         SetTimeLabel(elapsed, m_elapsed);
 462         SetTimeLabel((unsigned long)-1, m_estimated);
 463         SetTimeLabel((unsigned long)-1, m_remaining);
 464     }
 465
 466     return DoAfterUpdate(skip);
 467 }
 468
 469 bool wxProgressDialog::DoAfterUpdate(bool *skip)
 470 {
 471     // we have to yield because not only we want to update the display but
 472     // also to process the clicks on the cancel and skip buttons
 473     wxYieldIfNeeded();
 474
 475     Update();
 476
 477     if ( m_skip && skip && !*skip )
 478     {
 479         *skip = true;
 480         m_skip = false;
 481         EnableSkip();
 482     }
 483
 484     return m_state != Canceled;
 485 }
 486
 487 void wxProgressDialog::Resume()
 488 {
 489     m_state = Continue;
 490     m_ctdelay = m_delay; // force an update of the elapsed/estimated/remaining time
 491     m_break += wxGetCurrentTime()-m_timeStop;
 492
 493     EnableAbort();
 494     EnableSkip();
 495     m_skip = false;
 496 }
 497
 498 bool wxProgressDialog::Show( bool show )
 499 {
 500     // reenable other windows before hiding this one because otherwise
 501     // Windows wouldn't give the focus back to the window which had
 502     // been previously focused because it would still be disabled
 503     if(!show)
 504         ReenableOtherWindows();
 505
 506     return wxDialog::Show(show);
 507 }
 508
 509 // ----------------------------------------------------------------------------
 510 // event handlers
 511 // ----------------------------------------------------------------------------
 512
 513 void wxProgressDialog::OnCancel(wxCommandEvent& event)
 514 {
 515     if ( m_state == Finished )
 516     {
 517         // this means that the count down is already finished and we're being
 518         // shown as a modal dialog - so just let the default handler do the job
 519         event.Skip();
 520     }
 521     else
 522     {
 523         // request to cancel was received, the next time Update() is called we
 524         // will handle it
 525         m_state = Canceled;
 526
 527         // update the buttons state immediately so that the user knows that the
 528         // request has been noticed
 529         DisableAbort();
 530         DisableSkip();
 531
 532         // save the time when the dialog was stopped
 533         m_timeStop = wxGetCurrentTime();
 534     }
 535 }
 536
 537 void wxProgressDialog::OnSkip(wxCommandEvent& WXUNUSED(event))
 538 {
 539     DisableSkip();
 540     m_skip = true;
 541 }
 542
 543 void wxProgressDialog::OnClose(wxCloseEvent& event)
 544 {
 545     if ( m_state == Uncancelable )
 546     {
 547         // can't close this dialog
 548         event.Veto();
 549     }
 550     else if ( m_state == Finished )
 551     {
 552         // let the default handler close the window as we already terminated
 553         event.Skip();
 554     }
 555     else
 556     {
 557         // next Update() will notice it
 558         m_state = Canceled;
 559         DisableAbort();
 560         DisableSkip();
 561
 562         m_timeStop = wxGetCurrentTime();
 563     }
 564 }
 565
 566 // ----------------------------------------------------------------------------
 567 // destruction
 568 // ----------------------------------------------------------------------------
 569
 570 wxProgressDialog::~wxProgressDialog()
 571 {
 572     // normally this should have been already done, but just in case
 573     ReenableOtherWindows();
 574 }
 575
 576 void wxProgressDialog::ReenableOtherWindows()
 577 {
 578     if ( GetWindowStyle() & wxPD_APP_MODAL )
 579     {
 580         delete m_winDisabler;
 581         m_winDisabler = (wxWindowDisabler *)NULL;
 582     }
 583     else
 584     {
 585         if ( m_parentTop )
 586             m_parentTop->Enable();
 587     }
 588 }
 589
 590 // ----------------------------------------------------------------------------
 591 // private functions
 592 // ----------------------------------------------------------------------------
 593
 594 static void SetTimeLabel(unsigned long val, wxStaticText *label)
 595 {
 596     if ( label )
 597     {
 598         wxString s;
 599
 600         if (val != (unsigned long)-1)
 601         {
 602         unsigned long hours = val / 3600;
 603         unsigned long minutes = (val % 3600) / 60;
 604         unsigned long seconds = val % 60;
 605         s.Printf(wxT("%lu:%02lu:%02lu"), hours, minutes, seconds);
 606         }
 607         else
 608         {
 609             s = _("Unknown");
 610         }
 611
 612         if ( s != label->GetLabel() )
 613             label->SetLabel(s);
 614     }
 615 }
 616
 617 void wxProgressDialog::EnableSkip(bool enable)
 618 {
 619     if(m_hasSkipButton)
 620     {
 621 #ifdef __SMARTPHONE__
 622         if(enable)
 623             SetRightMenu(wxID_SKIP, _("Skip"));
 624         else
 625             SetRightMenu();
 626 #else
 627         if(m_btnSkip)
 628             m_btnSkip->Enable(enable);
 629 #endif
 630     }
 631 }
 632
 633 void wxProgressDialog::EnableAbort(bool enable)
 634 {
 635     if(m_hasAbortButton)
 636     {
 637 #ifdef __SMARTPHONE__
 638         if(enable)
 639             SetLeftMenu(wxID_CANCEL); // stock buttons makes Cancel label
 640         else
 641             SetLeftMenu();
 642 #else
 643         if(m_btnAbort)
 644             m_btnAbort->Enable(enable);
 645 #endif
 646     }
 647 }
 648
 649 void wxProgressDialog::EnableClose()
 650 {
 651     if(m_hasAbortButton)
 652     {
 653 #ifdef __SMARTPHONE__
 654         SetLeftMenu(wxID_CANCEL, _("Close"));
 655 #else
 656         if(m_btnAbort)
 657         {
 658             m_btnAbort->Enable();
 659             m_btnAbort->SetLabel(_("Close"));
 660         }
 661 #endif
 662     }
 663 }
 664
 665 void wxProgressDialog::UpdateMessage(const wxString &newmsg)
 666 {
 667     if ( !newmsg.empty() && newmsg != m_msg->GetLabel() )
 668     {
 669         m_msg->SetLabel(newmsg);
 670
 671         wxYieldIfNeeded() ;
 672     }
 673 }
 674
 675 #endif // wxUSE_PROGRESSDLG