src/generic/progdlgg.cpp

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        progdlgg.h
   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 license
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 // ============================================================================
  13 // declarations
  14 // ============================================================================
  15
  16 // ----------------------------------------------------------------------------
  17 // headers
  18 // ----------------------------------------------------------------------------
  19
  20 #ifdef __GNUG__
  21     #pragma implementation "progdlgg.h"
  22 #endif
  23
  24 // For compilers that support precompilation, includes "wx.h".
  25 #include "wx/wxprec.h"
  26
  27 #ifdef __BORLANDC__
  28     #pragma hdrstop
  29 #endif
  30
  31 #if wxUSE_PROGRESSDLG
  32
  33 #ifndef WX_PRECOMP
  34     #include "wx/utils.h"
  35     #include "wx/frame.h"
  36     #include "wx/button.h"
  37     #include "wx/stattext.h"
  38     #include "wx/layout.h"
  39     #include "wx/event.h"
  40     #include "wx/gauge.h"
  41     #include "wx/intl.h"
  42     #include "wx/settings.h"
  43     #include "wx/dcclient.h"
  44     #include "wx/timer.h"
  45 #endif
  46
  47 #include "wx/generic/progdlgg.h"
  48
  49 // ----------------------------------------------------------------------------
  50 // constants
  51 // ----------------------------------------------------------------------------
  52
  53 #define LAYOUT_X_MARGIN 8
  54 #define LAYOUT_Y_MARGIN 8
  55
  56 // ----------------------------------------------------------------------------
  57 // private functions
  58 // ----------------------------------------------------------------------------
  59
  60 // update the label to show the given time (in seconds)
  61 static void SetTimeLabel(unsigned long val, wxStaticText *label);
  62
  63 // ----------------------------------------------------------------------------
  64 // event tables
  65 // ----------------------------------------------------------------------------
  66
  67 BEGIN_EVENT_TABLE(wxProgressDialog, wxDialog)
  68     EVT_BUTTON(wxID_CANCEL, wxProgressDialog::OnCancel)
  69
  70     EVT_SHOW(wxProgressDialog::OnShow)
  71
  72     EVT_CLOSE(wxProgressDialog::OnClose)
  73 END_EVENT_TABLE()
  74
  75 IMPLEMENT_CLASS(wxProgressDialog, wxDialog)
  76
  77 // ============================================================================
  78 // implementation
  79 // ============================================================================
  80
  81 // ----------------------------------------------------------------------------
  82 // wxProgressDialog
  83 // ----------------------------------------------------------------------------
  84
  85 wxProgressDialog::wxProgressDialog(wxString const &title,
  86                                    wxString const &message,
  87                                    int maximum,
  88                                    wxWindow *parent,
  89                                    int style)
  90                 : wxDialog(parent, -1, title)
  91 {
  92     // we may disappear at any moment, let the others know about it
  93     SetExtraStyle(GetExtraStyle() | wxWS_EX_TRANSIENT);
  94
  95     m_windowStyle |= style;
  96
  97     bool hasAbortButton = (style & wxPD_CAN_ABORT) != 0;
  98
  99 #if defined(__WXMSW__) && !defined(__WXUNIVERSAL__)
 100     // we have to remove the "Close" button from the title bar then as it is
 101     // confusing to have it - it doesn't work anyhow
 102     //
 103     // FIXME: should probably have a (extended?) window style for this
 104     if ( !hasAbortButton )
 105     {
 106         EnableCloseButton(FALSE);
 107     }
 108 #endif // wxMSW
 109
 110     m_state = hasAbortButton ? Continue : Uncancelable;
 111     m_maximum = maximum;
 112
 113 #ifdef __WXMSW__
 114     // we can't have values > 65,536 in the progress control under Windows, so
 115     // scale everything down
 116     m_factor = m_maximum / 65536 + 1;
 117     m_maximum /= m_factor;
 118 #endif // __WXMSW__
 119
 120     m_parentTop = parent;
 121     while ( m_parentTop && m_parentTop->GetParent() )
 122     {
 123         m_parentTop = m_parentTop->GetParent();
 124     }
 125
 126     wxLayoutConstraints *c;
 127
 128     wxClientDC dc(this);
 129     dc.SetFont(wxSystemSettings::GetFont(wxSYS_DEFAULT_GUI_FONT));
 130     long widthText;
 131     dc.GetTextExtent(message, &widthText, NULL, NULL, NULL, NULL);
 132
 133     m_msg = new wxStaticText(this, -1, message);
 134     c = new wxLayoutConstraints;
 135     c->left.SameAs(this, wxLeft, 2*LAYOUT_X_MARGIN);
 136     c->top.SameAs(this, wxTop, 2*LAYOUT_Y_MARGIN);
 137     c->width.AsIs();
 138     c->height.AsIs();
 139     m_msg->SetConstraints(c);
 140
 141     wxSize sizeDlg,
 142            sizeLabel = m_msg->GetSize();
 143     sizeDlg.y = 2*LAYOUT_Y_MARGIN + sizeLabel.y;
 144
 145     wxWindow *lastWindow = m_msg;
 146
 147     if ( maximum > 0 )
 148     {
 149         // note that we can't use wxGA_SMOOTH because it happens to also mean
 150         // wxDIALOG_MODAL and will cause the dialog to be modal. Have an extra
 151         // style argument to wxProgressDialog, perhaps.
 152         m_gauge = new wxGauge(this, -1, m_maximum,
 153                               wxDefaultPosition, wxDefaultSize,
 154                               wxGA_HORIZONTAL);
 155
 156         c = new wxLayoutConstraints;
 157         c->left.SameAs(this, wxLeft, 2*LAYOUT_X_MARGIN);
 158         c->top.Below(m_msg, 2*LAYOUT_Y_MARGIN);
 159         c->right.SameAs(this, wxRight, 2*LAYOUT_X_MARGIN);
 160         c->height.AsIs();
 161         m_gauge->SetConstraints(c);
 162         m_gauge->SetValue(0);
 163         lastWindow = m_gauge;
 164
 165         wxSize sizeGauge = m_gauge->GetSize();
 166         sizeDlg.y += 2*LAYOUT_Y_MARGIN + sizeGauge.y;
 167     }
 168     else
 169         m_gauge = (wxGauge *)NULL;
 170
 171     // create the estimated/remaining/total time zones if requested
 172     m_elapsed = m_estimated = m_remaining = (wxStaticText*)NULL;
 173
 174     // if we are going to have at least one label, remmeber it in this var
 175     wxStaticText *label = NULL;
 176
 177     // also count how many labels we really have
 178     size_t nTimeLabels = 0;
 179
 180     if ( style & wxPD_ELAPSED_TIME )
 181     {
 182         nTimeLabels++;
 183
 184         label =
 185         m_elapsed = CreateLabel(_("Elapsed time : "), &lastWindow);
 186     }
 187
 188     if ( style & wxPD_ESTIMATED_TIME )
 189     {
 190         nTimeLabels++;
 191
 192         label =
 193         m_estimated = CreateLabel(_("Estimated time : "), &lastWindow);
 194     }
 195
 196     if ( style & wxPD_REMAINING_TIME )
 197     {
 198         nTimeLabels++;
 199
 200         label =
 201         m_remaining = CreateLabel(_("Remaining time : "), &lastWindow);
 202     }
 203
 204     if ( nTimeLabels > 0 )
 205     {
 206         // set it to the current time
 207         m_timeStart = wxGetCurrentTime();
 208         sizeDlg.y += nTimeLabels * (label->GetSize().y + LAYOUT_Y_MARGIN);
 209     }
 210
 211     if ( hasAbortButton )
 212     {
 213         m_btnAbort = new wxButton(this, wxID_CANCEL, _("Cancel"));
 214         c = new wxLayoutConstraints;
 215
 216         // Windows dialogs usually have buttons in the lower right corner
 217 #ifdef __WXMSW__
 218         c->right.SameAs(this, wxRight, 2*LAYOUT_X_MARGIN);
 219 #else // !MSW
 220         c->centreX.SameAs(this, wxCentreX);
 221 #endif // MSW/!MSW
 222         c->bottom.SameAs(this, wxBottom, 2*LAYOUT_Y_MARGIN);
 223
 224         wxSize sizeBtn = wxButton::GetDefaultSize();
 225         c->width.Absolute(sizeBtn.x);
 226         c->height.Absolute(sizeBtn.y);
 227
 228         m_btnAbort->SetConstraints(c);
 229
 230         sizeDlg.y += 2*LAYOUT_Y_MARGIN + sizeBtn.y;
 231     }
 232     else
 233         m_btnAbort = (wxButton *)NULL;
 234
 235     SetAutoLayout(TRUE);
 236     Layout();
 237
 238     sizeDlg.y += 2*LAYOUT_Y_MARGIN;
 239
 240     // try to make the dialog not square but rectangular of reasonabel width
 241     sizeDlg.x = (wxCoord)wxMax(widthText, 4*sizeDlg.y/3);
 242     sizeDlg.x *= 3;
 243     sizeDlg.x /= 2;
 244     SetClientSize(sizeDlg);
 245
 246     Centre(wxCENTER_FRAME | wxBOTH);
 247
 248     if ( style & wxPD_APP_MODAL )
 249     {
 250         m_winDisabler = new wxWindowDisabler(this);
 251     }
 252     else
 253     {
 254         if ( m_parentTop )
 255             m_parentTop->Enable(FALSE);
 256         m_winDisabler = NULL;
 257     }
 258
 259     Show(TRUE);
 260     Enable(TRUE); // enable this window
 261
 262     // this one can be initialized even if the others are unknown for now
 263     //
 264     // NB: do it after calling Layout() to keep the labels correctly aligned
 265     if ( m_elapsed )
 266     {
 267         SetTimeLabel(0, m_elapsed);
 268     }
 269
 270     // Update the display (especially on X, GTK)
 271     wxYield();
 272
 273 #ifdef __WXMAC__
 274     MacUpdateImmediately();
 275 #endif
 276 }
 277
 278 wxStaticText *wxProgressDialog::CreateLabel(const wxString& text,
 279                                             wxWindow **lastWindow)
 280 {
 281     wxLayoutConstraints *c;
 282
 283     wxStaticText *label = new wxStaticText(this, -1, _("unknown"));
 284     c = new wxLayoutConstraints;
 285
 286     // VZ: I like the labels be centered - if the others don't mind, you may
 287     //     remove "#ifdef __WXMSW__" and use it for all ports
 288 #ifdef __WXMSW__
 289     c->left.SameAs(this, wxCentreX, LAYOUT_X_MARGIN);
 290 #else // !MSW
 291     c->right.SameAs(this, wxRight, 2*LAYOUT_X_MARGIN);
 292 #endif // MSW/!MSW
 293     c->top.Below(*lastWindow, LAYOUT_Y_MARGIN);
 294     c->width.AsIs();
 295     c->height.AsIs();
 296     label->SetConstraints(c);
 297
 298     wxStaticText *dummy = new wxStaticText(this, -1, text);
 299     c = new wxLayoutConstraints;
 300     c->right.LeftOf(label);
 301     c->top.SameAs(label, wxTop, 0);
 302     c->width.AsIs();
 303     c->height.AsIs();
 304     dummy->SetConstraints(c);
 305
 306     *lastWindow = label;
 307
 308     return label;
 309 }
 310
 311 bool
 312 wxProgressDialog::Update(int value, const wxString& newmsg)
 313 {
 314     wxASSERT_MSG( value == -1 || m_gauge, wxT("cannot update non existent dialog") );
 315
 316 #ifdef __WXMSW__
 317     value /= m_factor;
 318 #endif // __WXMSW__
 319
 320     wxASSERT_MSG( value <= m_maximum, wxT("invalid progress value") );
 321
 322     if ( m_gauge )
 323     {
 324         m_gauge->SetValue(value + 1);
 325     }
 326
 327     if ( !newmsg.IsEmpty() )
 328     {
 329         m_msg->SetLabel(newmsg);
 330
 331         wxYield();
 332     }
 333
 334     if ( (m_elapsed || m_remaining || m_estimated) && (value != 0) )
 335     {
 336         unsigned long elapsed = wxGetCurrentTime() - m_timeStart;
 337         unsigned long estimated = elapsed * m_maximum / value;
 338         unsigned long remaining = estimated - elapsed;
 339
 340         SetTimeLabel(elapsed, m_elapsed);
 341         SetTimeLabel(estimated, m_estimated);
 342         SetTimeLabel(remaining, m_remaining);
 343     }
 344
 345     if ( (value == m_maximum ) )
 346     {
 347         // so that we return TRUE below and that out [Cancel] handler knew what
 348         // to do
 349         m_state = Finished;
 350         if( !(GetWindowStyle() & wxPD_AUTO_HIDE) )
 351         {
 352             if ( m_btnAbort )
 353             {
 354                 // tell the user what he should do...
 355                 m_btnAbort->SetLabel(_("Close"));
 356             }
 357 #if defined(__WXMSW__) && !defined(__WXUNIVERSAL__)
 358             else // enable the close button to give the user a way to close the dlg
 359             {
 360                 EnableCloseButton(TRUE);
 361             }
 362 #endif // __WXMSW__
 363
 364             if ( !newmsg )
 365             {
 366                 // also provide the finishing message if the application didn't
 367                 m_msg->SetLabel(_("Done."));
 368             }
 369
 370             wxYield();
 371
 372             (void)ShowModal();
 373         }
 374         else
 375         {
 376             Hide();
 377             ReenableOtherWindows();
 378         }
 379     }
 380     else
 381     {
 382         // update the display
 383         wxYield();
 384     }
 385
 386 #ifdef __WXMAC__
 387     MacUpdateImmediately();
 388 #endif
 389
 390     return m_state != Canceled;
 391 }
 392
 393 // ----------------------------------------------------------------------------
 394 // event handlers
 395 // ----------------------------------------------------------------------------
 396
 397 void wxProgressDialog::OnCancel(wxCommandEvent& event)
 398 {
 399     if ( m_state == Finished )
 400     {
 401         // this means that the count down is already finished and we're being
 402         // shown as a modal dialog - so just let the default handler do the job
 403         event.Skip();
 404     }
 405     else
 406     {
 407         // request to cancel was received, the next time Update() is called we
 408         // will handle it
 409         m_state = Canceled;
 410
 411         // update the button state immediately so that the user knows that the
 412         // request has been noticed
 413         m_btnAbort->Disable();
 414     }
 415 }
 416
 417 void wxProgressDialog::OnClose(wxCloseEvent& event)
 418 {
 419     if ( m_state == Uncancelable )
 420     {
 421         // can't close this dialog
 422         event.Veto(TRUE);
 423     }
 424     else if ( m_state == Finished )
 425     {
 426         // let the default handler close the window as we already terminated
 427         event.Skip();
 428     }
 429     else
 430     {
 431         // next Update() will notice it
 432         m_state = Canceled;
 433     }
 434 }
 435
 436 void wxProgressDialog::OnShow(wxShowEvent& event)
 437 {
 438     // if the dialog is being hidden, it was closed, so reenable other windows
 439     // now
 440     if ( event.GetShow() )
 441     {
 442         ReenableOtherWindows();
 443     }
 444 }
 445
 446 // ----------------------------------------------------------------------------
 447 // destruction
 448 // ----------------------------------------------------------------------------
 449
 450 wxProgressDialog::~wxProgressDialog()
 451 {
 452     // normally this should have been already done, but just in case
 453     ReenableOtherWindows();
 454 }
 455
 456 void wxProgressDialog::ReenableOtherWindows()
 457 {
 458     if ( GetWindowStyle() & wxPD_APP_MODAL )
 459     {
 460         delete m_winDisabler;
 461         m_winDisabler = (wxWindowDisabler *)NULL;
 462     }
 463     else
 464     {
 465         if ( m_parentTop )
 466             m_parentTop->Enable(TRUE);
 467     }
 468 }
 469
 470 // ----------------------------------------------------------------------------
 471 // private functions
 472 // ----------------------------------------------------------------------------
 473
 474 static void SetTimeLabel(unsigned long val, wxStaticText *label)
 475 {
 476     if ( label )
 477     {
 478         wxString s;
 479         unsigned long hours = val / 3600;
 480         unsigned long minutes = (val % 3600) / 60;
 481         unsigned long seconds = val % 60;
 482         s.Printf(wxT("%lu:%02lu:%02lu"), hours, minutes, seconds);
 483
 484         if ( s != label->GetLabel() )
 485             label->SetLabel(s);
 486     }
 487 }
 488
 489 #endif // wxUSE_PROGRESSDLG