]> git.saurik.com Git - wxWidgets.git/blob - src/generic/progdlgg.cpp
cleanup - reformat
[wxWidgets.git] / 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 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 #endif
41
42 #include "wx/generic/progdlgg.h"
43 #include "wx/settings.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(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 long widthText;
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, 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__)
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 // fill up the gauge if value == maximum because this means that the dialog
342 // is going to close and the gauge shouldn't be partly empty in this case
343 if ( m_gauge && value <= m_maximum )
344 {
345 m_gauge->SetValue(value == m_maximum ? value : value + 1);
346 }
347
348 if ( !newmsg.empty() && newmsg != m_msg->GetLabel() )
349 {
350 m_msg->SetLabel(newmsg);
351
352 wxYieldIfNeeded() ;
353 }
354
355 if ( (m_elapsed || m_remaining || m_estimated) && (value != 0) )
356 {
357 unsigned long elapsed = wxGetCurrentTime() - m_timeStart;
358 if ( m_last_timeupdate < elapsed
359 || value == m_maximum
360 )
361 {
362 m_last_timeupdate = elapsed;
363 unsigned long estimated = m_break +
364 (unsigned long)(( (double) (elapsed-m_break) * m_maximum ) / ((double)value)) ;
365 if ( estimated > m_display_estimated
366 && m_ctdelay >= 0
367 )
368 {
369 ++m_ctdelay;
370 }
371 else if ( estimated < m_display_estimated
372 && m_ctdelay <= 0
373 )
374 {
375 --m_ctdelay;
376 }
377 else
378 {
379 m_ctdelay = 0;
380 }
381 if ( m_ctdelay >= m_delay // enough confirmations for a higher value
382 || m_ctdelay <= (m_delay*-1) // enough confirmations for a lower value
383 || value == m_maximum // to stay consistent
384 || elapsed > m_display_estimated // to stay consistent
385 || ( elapsed > 0 && elapsed < 4 ) // additional updates in the beginning
386 )
387 {
388 m_display_estimated = estimated;
389 m_ctdelay = 0;
390 }
391 }
392
393 long display_remaining = m_display_estimated - elapsed;
394 if ( display_remaining < 0 )
395 {
396 display_remaining = 0;
397 }
398
399 SetTimeLabel(elapsed, m_elapsed);
400 SetTimeLabel(m_display_estimated, m_estimated);
401 SetTimeLabel(display_remaining, m_remaining);
402 }
403
404 if ( value == m_maximum )
405 {
406 if ( m_state == Finished )
407 {
408 // ignore multiple calls to Update(m_maximum): it may sometimes be
409 // troublesome to ensure that Update() is not called twice with the
410 // same value (e.g. because of the rounding errors) and if we don't
411 // return now we're going to generate asserts below
412 return true;
413 }
414
415 // so that we return true below and that out [Cancel] handler knew what
416 // to do
417 m_state = Finished;
418 if( !(GetWindowStyle() & wxPD_AUTO_HIDE) )
419 {
420 EnableClose();
421 DisableSkip();
422 #if defined(__WXMSW__) && !defined(__WXUNIVERSAL__)
423 EnableCloseButton();
424 #endif // __WXMSW__
425
426 if ( newmsg.empty() )
427 {
428 // also provide the finishing message if the application didn't
429 m_msg->SetLabel(_("Done."));
430 }
431
432 wxYieldIfNeeded() ;
433
434 (void)ShowModal();
435 }
436 else // auto hide
437 {
438 // reenable other windows before hiding this one because otherwise
439 // Windows wouldn't give the focus back to the window which had
440 // been previously focused because it would still be disabled
441 ReenableOtherWindows();
442
443 Hide();
444 }
445 }
446 else
447 {
448 // we have to yield because not only we want to update the display but
449 // also to process the clicks on the cancel and skip buttons
450 wxYieldIfNeeded() ;
451
452 if ( (m_skip) && (skip != NULL) && (*skip == false) )
453 {
454 *skip = true;
455 m_skip = false;
456 EnableSkip();
457 }
458 }
459
460 // update the display in case yielding above didn't do it
461 Update();
462
463 return m_state != Canceled;
464 }
465
466 void wxProgressDialog::Resume()
467 {
468 m_state = Continue;
469 m_ctdelay = m_delay; // force an update of the elapsed/estimated/remaining time
470 m_break += wxGetCurrentTime()-m_timeStop;
471
472 EnableAbort();
473 EnableSkip();
474 m_skip = false;
475 }
476
477 bool wxProgressDialog::Show( bool show )
478 {
479 // reenable other windows before hiding this one because otherwise
480 // Windows wouldn't give the focus back to the window which had
481 // been previously focused because it would still be disabled
482 if(!show)
483 ReenableOtherWindows();
484
485 return wxDialog::Show(show);
486 }
487
488 // ----------------------------------------------------------------------------
489 // event handlers
490 // ----------------------------------------------------------------------------
491
492 void wxProgressDialog::OnCancel(wxCommandEvent& event)
493 {
494 if ( m_state == Finished )
495 {
496 // this means that the count down is already finished and we're being
497 // shown as a modal dialog - so just let the default handler do the job
498 event.Skip();
499 }
500 else
501 {
502 // request to cancel was received, the next time Update() is called we
503 // will handle it
504 m_state = Canceled;
505
506 // update the buttons state immediately so that the user knows that the
507 // request has been noticed
508 DisableAbort();
509 DisableSkip();
510
511 // save the time when the dialog was stopped
512 m_timeStop = wxGetCurrentTime();
513 }
514 }
515
516 void wxProgressDialog::OnSkip(wxCommandEvent& WXUNUSED(event))
517 {
518 DisableSkip();
519 m_skip = true;
520 }
521
522 void wxProgressDialog::OnClose(wxCloseEvent& event)
523 {
524 if ( m_state == Uncancelable )
525 {
526 // can't close this dialog
527 event.Veto();
528 }
529 else if ( m_state == Finished )
530 {
531 // let the default handler close the window as we already terminated
532 event.Skip();
533 }
534 else
535 {
536 // next Update() will notice it
537 m_state = Canceled;
538 DisableAbort();
539 DisableSkip();
540
541 m_timeStop = wxGetCurrentTime();
542 }
543 }
544
545 // ----------------------------------------------------------------------------
546 // destruction
547 // ----------------------------------------------------------------------------
548
549 wxProgressDialog::~wxProgressDialog()
550 {
551 // normally this should have been already done, but just in case
552 ReenableOtherWindows();
553 }
554
555 void wxProgressDialog::ReenableOtherWindows()
556 {
557 if ( GetWindowStyle() & wxPD_APP_MODAL )
558 {
559 delete m_winDisabler;
560 m_winDisabler = (wxWindowDisabler *)NULL;
561 }
562 else
563 {
564 if ( m_parentTop )
565 m_parentTop->Enable();
566 }
567 }
568
569 // ----------------------------------------------------------------------------
570 // private functions
571 // ----------------------------------------------------------------------------
572
573 static void SetTimeLabel(unsigned long val, wxStaticText *label)
574 {
575 if ( label )
576 {
577 wxString s;
578 unsigned long hours = val / 3600;
579 unsigned long minutes = (val % 3600) / 60;
580 unsigned long seconds = val % 60;
581 s.Printf(wxT("%lu:%02lu:%02lu"), hours, minutes, seconds);
582
583 if ( s != label->GetLabel() )
584 label->SetLabel(s);
585 }
586 }
587
588 void wxProgressDialog::EnableSkip(bool enable)
589 {
590 if(m_hasSkipButton)
591 {
592 #ifdef __SMARTPHONE__
593 if(enable)
594 SetRightMenu(wxID_SKIP, _("Skip"));
595 else
596 SetRightMenu();
597 #else
598 if(m_btnSkip)
599 m_btnSkip->Enable(enable);
600 #endif
601 }
602 }
603
604 void wxProgressDialog::EnableAbort(bool enable)
605 {
606 if(m_hasAbortButton)
607 {
608 #ifdef __SMARTPHONE__
609 if(enable)
610 SetLeftMenu(wxID_CANCEL); // stock buttons makes Cancel label
611 else
612 SetLeftMenu();
613 #else
614 if(m_btnAbort)
615 m_btnAbort->Enable(enable);
616 #endif
617 }
618 }
619
620 void wxProgressDialog::EnableClose()
621 {
622 if(m_hasAbortButton)
623 {
624 #ifdef __SMARTPHONE__
625 SetLeftMenu(wxID_CANCEL, _("Close"));
626 #else
627 if(m_btnAbort)
628 {
629 m_btnAbort->Enable();
630 m_btnAbort->SetLabel(_("Close"));
631 }
632 #endif
633 }
634 }
635
636 #endif // wxUSE_PROGRESSDLG