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 #if !USE_SHARED_LIBRARY
  68     BEGIN_EVENT_TABLE(wxProgressDialog, wxDialog)
  69        EVT_BUTTON(wxID_CANCEL, wxProgressDialog::OnCancel)
  70        EVT_CLOSE(wxProgressDialog::OnClose)
  71     END_EVENT_TABLE()
  72
  73     IMPLEMENT_CLASS(wxProgressDialog, wxDialog)
  74 #endif
  75
  76 // ============================================================================
  77 // implementation
  78 // ============================================================================
  79
  80 // ----------------------------------------------------------------------------
  81 // wxProgressDialog
  82 // ----------------------------------------------------------------------------
  83
  84 wxProgressDialog::wxProgressDialog(wxString const &title,
  85                                    wxString const &message,
  86                                    int maximum,
  87                                    wxWindow *parent,
  88                                    int style)
  89                 : wxDialog(parent, -1, title)
  90 {
  91     bool hasAbortButton = (style & wxPD_CAN_ABORT) != 0;
  92     m_state = hasAbortButton ? Continue : Uncancelable;
  93     m_disableParentOnly = (style & wxPD_APP_MODAL) == 0;
  94     m_AutoHide = (style & wxPD_AUTO_HIDE) != 0;
  95     m_parent = parent;
  96     m_maximum = maximum;
  97
  98     wxLayoutConstraints *c;
  99
 100     wxClientDC dc(this);
 101     dc.SetFont(wxSystemSettings::GetSystemFont(wxSYS_DEFAULT_GUI_FONT));
 102     long widthText;
 103 #if defined(__VISAGECPP__)
 104 // have two versions of this in wxWindowDC tp avoid function hiding
 105 // since there are two of these in wxDCBase, and in turn in wxDC.
 106 // VA cannot resolve this so:
 107     dc.GetTextExtent(message, &widthText, NULL, NULL, NULL, NULL);
 108 #else
 109     dc.GetTextExtent(message, &widthText, (long*)NULL);
 110 #endif
 111
 112     m_msg = new wxStaticText(this, -1, message);
 113     c = new wxLayoutConstraints;
 114     c->left.SameAs(this, wxLeft, 2*LAYOUT_X_MARGIN);
 115     c->top.SameAs(this, wxTop, 2*LAYOUT_Y_MARGIN);
 116     c->width.AsIs();
 117     c->height.AsIs();
 118     m_msg->SetConstraints(c);
 119
 120     wxSize sizeDlg, sizeLabel = m_msg->GetSize();
 121     sizeDlg.y = 2*LAYOUT_Y_MARGIN + sizeLabel.y;
 122
 123     wxWindow *lastWindow = m_msg;
 124
 125     if ( maximum > 0 )
 126     {
 127         m_gauge = new wxGauge(this, -1, maximum,
 128                 wxDefaultPosition, wxDefaultSize,
 129                 wxGA_HORIZONTAL | wxRAISED_BORDER);
 130         c = new wxLayoutConstraints;
 131         c->left.SameAs(this, wxLeft, 2*LAYOUT_X_MARGIN);
 132         c->top.Below(m_msg, 2*LAYOUT_Y_MARGIN);
 133         c->right.SameAs(this, wxRight, 2*LAYOUT_X_MARGIN);
 134         c->height.AsIs();
 135         m_gauge->SetConstraints(c);
 136         m_gauge->SetValue(0);
 137         lastWindow = m_gauge;
 138
 139         wxSize sizeGauge = m_gauge->GetSize();
 140         sizeDlg.y += 2*LAYOUT_Y_MARGIN + sizeGauge.y;
 141     }
 142     else
 143         m_gauge = (wxGauge *)NULL;
 144
 145     // create the estimated/remaining/total time zones if requested
 146     m_elapsed = m_estimated = m_remaining = (wxStaticText*)NULL;
 147
 148     int nTimeLabels = 0;
 149     if ( style & wxPD_ELAPSED_TIME )
 150     {
 151         nTimeLabels++;
 152
 153         m_elapsed = CreateLabel(wxT("Elapsed time : "), &lastWindow);
 154     }
 155
 156     if ( style & wxPD_ESTIMATED_TIME )
 157     {
 158         nTimeLabels++;
 159
 160         m_estimated = CreateLabel(wxT("Estimated time : "), &lastWindow);
 161     }
 162
 163     if ( style & wxPD_REMAINING_TIME )
 164     {
 165         nTimeLabels++;
 166
 167         m_remaining = CreateLabel(wxT("Remaining time : "), &lastWindow);
 168     }
 169
 170     if ( nTimeLabels > 0 )
 171     {
 172         // set it to the current time
 173         m_timeStart = wxGetCurrentTime();
 174
 175         sizeDlg.y += nTimeLabels * (sizeLabel.y + LAYOUT_Y_MARGIN);
 176     }
 177
 178     if ( hasAbortButton )
 179     {
 180         m_btnAbort = new wxButton(this, wxID_CANCEL, _("Cancel"));
 181         c = new wxLayoutConstraints;
 182
 183         // Windows dialogs usually have buttons in the lower right corner
 184 #ifdef __WXMSW__
 185         c->right.SameAs(this, wxRight, 2*LAYOUT_X_MARGIN);
 186 #else // !MSW
 187         c->centreX.SameAs(this, wxCentreX);
 188 #endif // MSW/!MSW
 189         c->bottom.SameAs(this, wxBottom, 2*LAYOUT_Y_MARGIN);
 190
 191         wxSize sizeBtn = wxButton::GetDefaultSize();
 192         c->width.Absolute(sizeBtn.x);
 193         c->height.Absolute(sizeBtn.y);
 194
 195         m_btnAbort->SetConstraints(c);
 196
 197         sizeDlg.y += 2*LAYOUT_Y_MARGIN + sizeBtn.y;
 198     }
 199     else
 200         m_btnAbort = (wxButton *)NULL;
 201
 202     SetAutoLayout(TRUE);
 203     Layout();
 204
 205     sizeDlg.y += 2*LAYOUT_Y_MARGIN;
 206
 207     // try to make the dialog not square but rectangular of reasonabel width
 208     sizeDlg.x = wxMax(widthText, 4*sizeDlg.y/3);
 209     sizeDlg.x *= 3;
 210     sizeDlg.x /= 2;
 211     SetClientSize(sizeDlg);
 212
 213     Centre(wxCENTER_FRAME | wxBOTH);
 214
 215     if (m_disableParentOnly )
 216     {
 217         if ( m_parent )
 218             m_parent->Enable(FALSE);
 219     }
 220     else
 221     {
 222         wxEnableTopLevelWindows(FALSE);
 223     }
 224
 225     Show(TRUE);
 226     Enable(TRUE); // enable this window
 227
 228     // Update the display (especially on X, GTK)
 229     wxYield();
 230 }
 231
 232 wxStaticText *wxProgressDialog::CreateLabel(const wxString& text,
 233                                             wxWindow **lastWindow)
 234 {
 235     wxLayoutConstraints *c;
 236
 237     wxStaticText *label = new wxStaticText(this, -1, wxT("unknown"));
 238     c = new wxLayoutConstraints;
 239
 240     // VZ: I like the labels be centered - if the others don't mind, you may
 241     //     remove "#ifdef __WXMSW__" and use it for all ports
 242 #ifdef __WXMSW__
 243     c->left.SameAs(this, wxCentreX, LAYOUT_X_MARGIN);
 244 #else // !MSW
 245     c->right.SameAs(this, wxRight, 2*LAYOUT_X_MARGIN);
 246 #endif // MSW/!MSW
 247     c->top.Below(*lastWindow, LAYOUT_Y_MARGIN);
 248     c->width.AsIs();
 249     c->height.AsIs();
 250     label->SetConstraints(c);
 251
 252     wxStaticText *dummy = new wxStaticText(this, -1, text);
 253     c = new wxLayoutConstraints;
 254     c->right.LeftOf(label);
 255     c->top.SameAs(label, wxTop, 0);
 256     c->width.AsIs();
 257     c->height.AsIs();
 258     dummy->SetConstraints(c);
 259
 260     *lastWindow = label;
 261
 262     return label;
 263 }
 264
 265 bool
 266 wxProgressDialog::Update(int value, const wxString& newmsg)
 267 {
 268    wxASSERT_MSG( value == -1 || m_gauge, wxT("cannot update non existent dialog") );
 269    wxASSERT_MSG( value <= m_maximum, wxT("invalid progress value") );
 270
 271
 272    if( m_gauge )
 273       m_gauge->SetValue(value + 1);
 274
 275    if( !newmsg.IsEmpty() )
 276       m_msg->SetLabel(newmsg);
 277
 278    if ( (m_elapsed || m_remaining || m_estimated) && (value != 0) )
 279    {
 280       unsigned long elapsed = wxGetCurrentTime() - m_timeStart;
 281       unsigned long estimated = elapsed * m_maximum / value;
 282       unsigned long remaining = estimated - elapsed;
 283
 284       SetTimeLabel(elapsed, m_elapsed);
 285       SetTimeLabel(estimated, m_estimated);
 286       SetTimeLabel(remaining, m_remaining);
 287    }
 288
 289    if ( (value == m_maximum ) && !m_AutoHide )
 290    {
 291        if ( m_btnAbort )
 292        {
 293            // tell the user what he should do...
 294            m_btnAbort->SetLabel(_("Close"));
 295        }
 296
 297        if ( !newmsg )
 298        {
 299            // also provide the finishing message if the application didn't
 300            m_msg->SetLabel(_("Done."));
 301        }
 302
 303        // so that we return TRUE below and that out [Cancel] handler knew what
 304        // to do
 305        m_state = Finished;
 306
 307        wxYield();
 308
 309        (void)ShowModal();
 310    }
 311    else
 312    {
 313        // update the display
 314        wxYield();
 315    }
 316
 317    return m_state != Canceled;
 318 }
 319
 320 // ----------------------------------------------------------------------------
 321 // event handlers
 322 // ----------------------------------------------------------------------------
 323
 324 void wxProgressDialog::OnCancel(wxCommandEvent& event)
 325 {
 326     if ( m_state == Finished )
 327     {
 328         // this means that the count down is already finished and we're being
 329         // shown as a modal dialog - so just let the default handler do the job
 330         event.Skip();
 331     }
 332     else
 333     {
 334         // request to cancel was received, the next time Update() is called we
 335         // will handle it
 336         m_state = Canceled;
 337     }
 338 }
 339
 340 void wxProgressDialog::OnClose(wxCloseEvent& event)
 341 {
 342     if ( m_state == Uncancelable )
 343         event.Veto(TRUE);
 344     else
 345         m_state = Canceled;
 346 }
 347
 348 // ----------------------------------------------------------------------------
 349 // destruction
 350 // ----------------------------------------------------------------------------
 351
 352 wxProgressDialog::~wxProgressDialog()
 353 {
 354     if ( m_disableParentOnly )
 355     {
 356         if ( m_parent )
 357             m_parent->Enable(TRUE);
 358     }
 359     else
 360     {
 361         wxEnableTopLevelWindows(TRUE);
 362     }
 363 }
 364
 365 // ----------------------------------------------------------------------------
 366 // private functions
 367 // ----------------------------------------------------------------------------
 368
 369 static void SetTimeLabel(unsigned long val, wxStaticText *label)
 370 {
 371     if ( label )
 372     {
 373         wxString s;
 374         unsigned long hours = val / 3600;
 375         unsigned long minutes = (val % 3600) / 60;
 376         unsigned long seconds = val % 60;
 377         s.Printf(wxT("%lu:%02lu:%02lu"), hours, minutes, seconds);
 378
 379         if ( s != label->GetLabel() )
 380             label->SetLabel(s);
 381     }
 382 }
 383
 384 #endif // wxUSE_PROGRESSDLG