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, style), 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     if ( !DoBeforeUpdate(skip) )
 317         return false;
 318
 319     wxASSERT_MSG( value == -1 || m_gauge, wxT("cannot update non existent dialog") );
 320
 321 #ifdef __WXMSW__
 322     value /= m_factor;
 323 #endif // __WXMSW__
 324
 325     wxASSERT_MSG( value <= m_maximum, wxT("invalid progress value") );
 326
 327     if ( m_gauge )
 328         m_gauge->SetValue(value);
 329
 330     UpdateMessage(newmsg);
 331
 332     if ( (m_elapsed || m_remaining || m_estimated) && (value != 0) )
 333     {
 334         unsigned long elapsed = wxGetCurrentTime() - m_timeStart;
 335         if (    m_last_timeupdate < elapsed
 336              || value == m_maximum
 337            )
 338         {
 339             m_last_timeupdate = elapsed;
 340             unsigned long estimated = m_break +
 341                   (unsigned long)(( (double) (elapsed-m_break) * m_maximum ) / ((double)value)) ;
 342             if (    estimated > m_display_estimated
 343                  && m_ctdelay >= 0
 344                )
 345             {
 346                 ++m_ctdelay;
 347             }
 348             else if (    estimated < m_display_estimated
 349                       && m_ctdelay <= 0
 350                     )
 351             {
 352                 --m_ctdelay;
 353             }
 354             else
 355             {
 356                 m_ctdelay = 0;
 357             }
 358             if (    m_ctdelay >= m_delay          // enough confirmations for a higher value
 359                  || m_ctdelay <= (m_delay*-1)     // enough confirmations for a lower value
 360                  || value == m_maximum            // to stay consistent
 361                  || elapsed > m_display_estimated // to stay consistent
 362                  || ( elapsed > 0 && elapsed < 4 ) // additional updates in the beginning
 363                )
 364             {
 365                 m_display_estimated = estimated;
 366                 m_ctdelay = 0;
 367             }
 368         }
 369
 370         long display_remaining = m_display_estimated - elapsed;
 371         if ( display_remaining < 0 )
 372         {
 373             display_remaining = 0;
 374         }
 375
 376         SetTimeLabel(elapsed, m_elapsed);
 377         SetTimeLabel(m_display_estimated, m_estimated);
 378         SetTimeLabel(display_remaining, m_remaining);
 379     }
 380
 381     if ( value == m_maximum )
 382     {
 383         if ( m_state == Finished )
 384         {
 385             // ignore multiple calls to Update(m_maximum): it may sometimes be
 386             // troublesome to ensure that Update() is not called twice with the
 387             // same value (e.g. because of the rounding errors) and if we don't
 388             // return now we're going to generate asserts below
 389             return true;
 390         }
 391
 392         // so that we return true below and that out [Cancel] handler knew what
 393         // to do
 394         m_state = Finished;
 395         if( !HasFlag(wxPD_AUTO_HIDE) )
 396         {
 397             EnableClose();
 398             DisableSkip();
 399 #if defined(__WXMSW__) && !defined(__WXUNIVERSAL__)
 400             EnableCloseButton();
 401 #endif // __WXMSW__
 402
 403             if ( newmsg.empty() )
 404             {
 405                 // also provide the finishing message if the application didn't
 406                 m_msg->SetLabel(_("Done."));
 407             }
 408
 409             wxCHECK_MSG(wxEventLoopBase::GetActive(), false,
 410                         "wxProgressDialog::Update needs a running event loop");
 411
 412             // allow the window to repaint:
 413             // NOTE: since we yield only for UI events with this call, there
 414             //       should be no side-effects
 415             wxEventLoopBase::GetActive()->YieldFor(wxEVT_CATEGORY_UI);
 416
 417             // NOTE: this call results in a new event loop being created
 418             //       and to a call to ProcessPendingEvents() (which may generate
 419             //       unwanted re-entrancies).
 420             (void)ShowModal();
 421         }
 422         else // auto hide
 423         {
 424             // reenable other windows before hiding this one because otherwise
 425             // Windows wouldn't give the focus back to the window which had
 426             // been previously focused because it would still be disabled
 427             ReenableOtherWindows();
 428
 429             Hide();
 430         }
 431     }
 432     else // not at maximum yet
 433     {
 434         DoAfterUpdate();
 435     }
 436
 437     // update the display in case yielding above didn't do it
 438     Update();
 439
 440     return m_state != Canceled;
 441 }
 442
 443 bool wxProgressDialog::Pulse(const wxString& newmsg, bool *skip)
 444 {
 445     if ( !DoBeforeUpdate(skip) )
 446         return false;
 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     DoAfterUpdate();
 465
 466     return m_state != Canceled;
 467 }
 468
 469 bool wxProgressDialog::DoBeforeUpdate(bool *skip)
 470 {
 471     wxCHECK_MSG(wxEventLoopBase::GetActive(), false,
 472                 "wxProgressDialog::DoBeforeUpdate needs a running event loop");
 473
 474     // we have to yield because not only we want to update the display but
 475     // also to process the clicks on the cancel and skip buttons
 476     // NOTE: using YieldFor() this call shouldn't give re-entrancy problems
 477     //       for event handlers not interested to UI/user-input events.
 478     wxEventLoopBase::GetActive()->YieldFor(wxEVT_CATEGORY_UI|wxEVT_CATEGORY_USER_INPUT);
 479
 480     Update();
 481
 482     if ( m_skip && skip && !*skip )
 483     {
 484         *skip = true;
 485         m_skip = false;
 486         EnableSkip();
 487     }
 488
 489     return m_state != Canceled;
 490 }
 491
 492 void wxProgressDialog::DoAfterUpdate()
 493 {
 494     wxCHECK_RET(wxEventLoopBase::GetActive(),
 495                 "wxProgressDialog::DoAfterUpdate needs a running event loop");
 496
 497     // allow the window to repaint:
 498     // NOTE: since we yield only for UI events with this call, there
 499     //       should be no side-effects
 500     wxEventLoopBase::GetActive()->YieldFor(wxEVT_CATEGORY_UI);
 501 }
 502
 503 void wxProgressDialog::Resume()
 504 {
 505     m_state = Continue;
 506     m_ctdelay = m_delay; // force an update of the elapsed/estimated/remaining time
 507     m_break += wxGetCurrentTime()-m_timeStop;
 508
 509     EnableAbort();
 510     EnableSkip();
 511     m_skip = false;
 512 }
 513
 514 bool wxProgressDialog::Show( bool show )
 515 {
 516     // reenable other windows before hiding this one because otherwise
 517     // Windows wouldn't give the focus back to the window which had
 518     // been previously focused because it would still be disabled
 519     if(!show)
 520         ReenableOtherWindows();
 521
 522     return wxDialog::Show(show);
 523 }
 524
 525 int wxProgressDialog::GetValue() const
 526 {
 527     if (m_gauge)
 528         return m_gauge->GetValue();
 529     return wxNOT_FOUND;
 530 }
 531
 532 int wxProgressDialog::GetRange() const
 533 {
 534     if (m_gauge)
 535         return m_gauge->GetRange();
 536     return wxNOT_FOUND;
 537 }
 538
 539 wxString wxProgressDialog::GetMessage() const
 540 {
 541     return m_msg->GetLabel();
 542 }
 543
 544 void wxProgressDialog::SetRange(int maximum)
 545 {
 546     wxASSERT_MSG(m_gauge, "The dialog should have been constructed with a range > 0");
 547     wxASSERT_MSG(maximum > 0, "Invalid range");
 548
 549     m_gauge->SetRange(maximum);
 550     m_maximum = maximum;
 551
 552 #if defined(__WXMSW__) || defined(__WXPM__)
 553     // we can't have values > 65,536 in the progress control under Windows, so
 554     // scale everything down
 555     m_factor = m_maximum / 65536 + 1;
 556     m_maximum /= m_factor;
 557 #endif // __WXMSW__
 558 }
 559
 560
 561 bool wxProgressDialog::WasCancelled() const
 562 {
 563     return m_hasAbortButton && m_state == Canceled;
 564 }
 565
 566 bool wxProgressDialog::WasSkipped() const
 567 {
 568     return m_hasSkipButton && m_skip;
 569 }
 570
 571
 572 // ----------------------------------------------------------------------------
 573 // event handlers
 574 // ----------------------------------------------------------------------------
 575
 576 void wxProgressDialog::OnCancel(wxCommandEvent& event)
 577 {
 578     if ( m_state == Finished )
 579     {
 580         // this means that the count down is already finished and we're being
 581         // shown as a modal dialog - so just let the default handler do the job
 582         event.Skip();
 583     }
 584     else
 585     {
 586         // request to cancel was received, the next time Update() is called we
 587         // will handle it
 588         m_state = Canceled;
 589
 590         // update the buttons state immediately so that the user knows that the
 591         // request has been noticed
 592         DisableAbort();
 593         DisableSkip();
 594
 595         // save the time when the dialog was stopped
 596         m_timeStop = wxGetCurrentTime();
 597     }
 598 }
 599
 600 void wxProgressDialog::OnSkip(wxCommandEvent& WXUNUSED(event))
 601 {
 602     DisableSkip();
 603     m_skip = true;
 604 }
 605
 606 void wxProgressDialog::OnClose(wxCloseEvent& event)
 607 {
 608     if ( m_state == Uncancelable )
 609     {
 610         // can't close this dialog
 611         event.Veto();
 612     }
 613     else if ( m_state == Finished )
 614     {
 615         // let the default handler close the window as we already terminated
 616         event.Skip();
 617     }
 618     else
 619     {
 620         // next Update() will notice it
 621         m_state = Canceled;
 622         DisableAbort();
 623         DisableSkip();
 624
 625         m_timeStop = wxGetCurrentTime();
 626     }
 627 }
 628
 629 // ----------------------------------------------------------------------------
 630 // destruction
 631 // ----------------------------------------------------------------------------
 632
 633 wxProgressDialog::~wxProgressDialog()
 634 {
 635     // normally this should have been already done, but just in case
 636     ReenableOtherWindows();
 637 }
 638
 639 void wxProgressDialog::ReenableOtherWindows()
 640 {
 641     if ( HasFlag(wxPD_APP_MODAL) )
 642     {
 643         delete m_winDisabler;
 644         m_winDisabler = NULL;
 645     }
 646     else
 647     {
 648         if ( m_parentTop )
 649             m_parentTop->Enable();
 650     }
 651 }
 652
 653 // ----------------------------------------------------------------------------
 654 // private functions
 655 // ----------------------------------------------------------------------------
 656
 657 static void SetTimeLabel(unsigned long val, wxStaticText *label)
 658 {
 659     if ( label )
 660     {
 661         wxString s;
 662
 663         if (val != (unsigned long)-1)
 664         {
 665             unsigned long hours = val / 3600;
 666             unsigned long minutes = (val % 3600) / 60;
 667             unsigned long seconds = val % 60;
 668             s.Printf(wxT("%lu:%02lu:%02lu"), hours, minutes, seconds);
 669         }
 670         else
 671         {
 672             s = _("Unknown");
 673         }
 674
 675         if ( s != label->GetLabel() )
 676             label->SetLabel(s);
 677     }
 678 }
 679
 680 void wxProgressDialog::EnableSkip(bool enable)
 681 {
 682     if(m_hasSkipButton)
 683     {
 684 #ifdef __SMARTPHONE__
 685         if(enable)
 686             SetRightMenu(wxID_SKIP, _("Skip"));
 687         else
 688             SetRightMenu();
 689 #else
 690         if(m_btnSkip)
 691             m_btnSkip->Enable(enable);
 692 #endif
 693     }
 694 }
 695
 696 void wxProgressDialog::EnableAbort(bool enable)
 697 {
 698     if(m_hasAbortButton)
 699     {
 700 #ifdef __SMARTPHONE__
 701         if(enable)
 702             SetLeftMenu(wxID_CANCEL); // stock buttons makes Cancel label
 703         else
 704             SetLeftMenu();
 705 #else
 706         if(m_btnAbort)
 707             m_btnAbort->Enable(enable);
 708 #endif
 709     }
 710 }
 711
 712 void wxProgressDialog::EnableClose()
 713 {
 714     if(m_hasAbortButton)
 715     {
 716 #ifdef __SMARTPHONE__
 717         SetLeftMenu(wxID_CANCEL, _("Close"));
 718 #else
 719         if(m_btnAbort)
 720         {
 721             m_btnAbort->Enable();
 722             m_btnAbort->SetLabel(_("Close"));
 723         }
 724 #endif
 725     }
 726 }
 727
 728 void wxProgressDialog::UpdateMessage(const wxString &newmsg)
 729 {
 730     wxCHECK_RET(wxEventLoopBase::GetActive(),
 731                 "wxProgressDialog::UpdateMessage needs a running event loop");
 732
 733     if ( !newmsg.empty() && newmsg != m_msg->GetLabel() )
 734     {
 735         m_msg->SetLabel(newmsg);
 736
 737         // allow the window to repaint:
 738         // NOTE: since we yield only for UI events with this call, there
 739         //       should be no side-effects
 740         wxEventLoopBase::GetActive()->YieldFor(wxEVT_CATEGORY_UI);
 741     }
 742 }
 743
 744 #endif // wxUSE_PROGRESSDLG