// Created: 09.05.1999
// RCS-ID: $Id$
// Copyright: (c) Karsten Ballüder
-// Licence: wxWindows license
+// Licence: wxWindows licence
/////////////////////////////////////////////////////////////////////////////
// ============================================================================
// headers
// ----------------------------------------------------------------------------
-#ifdef __GNUG__
+#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
#pragma implementation "progdlgg.h"
#endif
#include "wx/frame.h"
#include "wx/button.h"
#include "wx/stattext.h"
- #include "wx/layout.h"
+ #include "wx/sizer.h"
#include "wx/event.h"
#include "wx/gauge.h"
#include "wx/intl.h"
#include "wx/generic/progdlgg.h"
+// ---------------------------------------------------------------------------
+// macros
+// ---------------------------------------------------------------------------
+
+/* Macro for avoiding #ifdefs when value have to be different depending on size of
+ device we display on - take it from something like wxDesktopPolicy in the future
+ */
+
+#if defined(__SMARTPHONE__)
+ #define wxLARGESMALL(large,small) small
+#else
+ #define wxLARGESMALL(large,small) large
+#endif
+
// ----------------------------------------------------------------------------
// constants
// ----------------------------------------------------------------------------
-#define LAYOUT_X_MARGIN 8
-#define LAYOUT_Y_MARGIN 8
+#define LAYOUT_MARGIN wxLARGESMALL(8,2)
// ----------------------------------------------------------------------------
// private functions
// ----------------------------------------------------------------------------
BEGIN_EVENT_TABLE(wxProgressDialog, wxDialog)
- EVT_BUTTON(wxID_CANCEL, wxProgressDialog::OnCancel)
- EVT_CLOSE(wxProgressDialog::OnClose)
+ EVT_BUTTON(wxID_CANCEL, wxProgressDialog::OnCancel)
+
+ EVT_CLOSE(wxProgressDialog::OnClose)
END_EVENT_TABLE()
IMPLEMENT_CLASS(wxProgressDialog, wxDialog)
// ============================================================================
-// implementation
+// wxProgressDialog implementation
// ============================================================================
// ----------------------------------------------------------------------------
-// wxProgressDialog
+// wxProgressDialog creation
// ----------------------------------------------------------------------------
wxProgressDialog::wxProgressDialog(wxString const &title,
int maximum,
wxWindow *parent,
int style)
- : wxDialog(parent, -1, title)
+ : wxDialog(parent, wxID_ANY, title),
+ m_delay(3)
{
+ // we may disappear at any moment, let the others know about it
+ SetExtraStyle(GetExtraStyle() | wxWS_EX_TRANSIENT);
+
+ m_windowStyle |= style;
+
bool hasAbortButton = (style & wxPD_CAN_ABORT) != 0;
- m_state = hasAbortButton ? Continue : Uncancelable;
- m_maximum = maximum;
- m_parentTop = parent;
- while ( m_parentTop && m_parentTop->GetParent() )
+#if defined(__WXMSW__) && !defined(__WXUNIVERSAL__)
+ // we have to remove the "Close" button from the title bar then as it is
+ // confusing to have it - it doesn't work anyhow
+ //
+ // FIXME: should probably have a (extended?) window style for this
+ if ( !hasAbortButton )
{
- m_parentTop = m_parentTop->GetParent();
+ EnableCloseButton(false);
}
+#endif // wxMSW
+
+#if defined(__SMARTPHONE__)
+ SetLeftMenu();
+#endif
+
+ m_state = hasAbortButton ? Continue : Uncancelable;
+ m_maximum = maximum;
+
+#if defined(__WXMSW__) || defined(__WXPM__)
+ // we can't have values > 65,536 in the progress control under Windows, so
+ // scale everything down
+ m_factor = m_maximum / 65536 + 1;
+ m_maximum /= m_factor;
+#endif // __WXMSW__
- wxLayoutConstraints *c;
+ m_parentTop = wxGetTopLevelParent(parent);
wxClientDC dc(this);
- dc.SetFont(wxSystemSettings::GetSystemFont(wxSYS_DEFAULT_GUI_FONT));
+ dc.SetFont(wxSystemSettings::GetFont(wxSYS_DEFAULT_GUI_FONT));
long widthText;
-#if defined(__VISAGECPP__)
-// have two versions of this in wxWindowDC tp avoid function hiding
-// since there are two of these in wxDCBase, and in turn in wxDC.
-// VA cannot resolve this so:
dc.GetTextExtent(message, &widthText, NULL, NULL, NULL, NULL);
-#else
- dc.GetTextExtent(message, &widthText, (long*)NULL);
-#endif
- m_msg = new wxStaticText(this, -1, message);
- c = new wxLayoutConstraints;
- c->left.SameAs(this, wxLeft, 2*LAYOUT_X_MARGIN);
- c->top.SameAs(this, wxTop, 2*LAYOUT_Y_MARGIN);
- c->width.AsIs();
- c->height.AsIs();
- m_msg->SetConstraints(c);
+ wxBoxSizer *sizer = new wxBoxSizer(wxVERTICAL);
- wxSize sizeDlg, sizeLabel = m_msg->GetSize();
- sizeDlg.y = 2*LAYOUT_Y_MARGIN + sizeLabel.y;
+ m_msg = new wxStaticText(this, wxID_ANY, message);
+ sizer->Add(m_msg, 0, wxLEFT | wxTOP, 2*LAYOUT_MARGIN);
- wxWindow *lastWindow = m_msg;
+ wxSize sizeDlg,
+ sizeLabel = m_msg->GetSize();
+ sizeDlg.y = 2*LAYOUT_MARGIN + sizeLabel.y;
if ( maximum > 0 )
{
- m_gauge = new wxGauge(this, -1, maximum,
- wxDefaultPosition, wxDefaultSize,
- wxGA_HORIZONTAL | wxRAISED_BORDER | (style & wxGA_SMOOTH));
- c = new wxLayoutConstraints;
- c->left.SameAs(this, wxLeft, 2*LAYOUT_X_MARGIN);
- c->top.Below(m_msg, 2*LAYOUT_Y_MARGIN);
- c->right.SameAs(this, wxRight, 2*LAYOUT_X_MARGIN);
- c->height.AsIs();
- m_gauge->SetConstraints(c);
+ // note that we can't use wxGA_SMOOTH because it happens to
+ // cause the dialog to be modal. Have an extra
+ // style argument to wxProgressDialog, perhaps.
+ m_gauge = new wxGauge(this, wxID_ANY, m_maximum,
+ wxDefaultPosition, wxDefaultSize,
+ wxGA_HORIZONTAL);
+
+ sizer->Add(m_gauge, 0, wxLEFT | wxRIGHT | wxTOP | wxEXPAND, 2*LAYOUT_MARGIN);
m_gauge->SetValue(0);
- lastWindow = m_gauge;
wxSize sizeGauge = m_gauge->GetSize();
- sizeDlg.y += 2*LAYOUT_Y_MARGIN + sizeGauge.y;
+ sizeDlg.y += 2*LAYOUT_MARGIN + sizeGauge.y;
}
else
m_gauge = (wxGauge *)NULL;
// create the estimated/remaining/total time zones if requested
m_elapsed = m_estimated = m_remaining = (wxStaticText*)NULL;
+ m_display_estimated = m_last_timeupdate = m_break = 0;
+ m_ctdelay = 0;
+
+ // if we are going to have at least one label, remmeber it in this var
+ wxStaticText *label = NULL;
+
+ // also count how many labels we really have
+ size_t nTimeLabels = 0;
- int nTimeLabels = 0;
if ( style & wxPD_ELAPSED_TIME )
{
nTimeLabels++;
- m_elapsed = CreateLabel(_("Elapsed time : "), &lastWindow);
+ label =
+ m_elapsed = CreateLabel(_("Elapsed time : "), sizer);
}
if ( style & wxPD_ESTIMATED_TIME )
{
nTimeLabels++;
- m_estimated = CreateLabel(_("Estimated time : "), &lastWindow);
+ label =
+ m_estimated = CreateLabel(_("Estimated time : "), sizer);
}
if ( style & wxPD_REMAINING_TIME )
{
nTimeLabels++;
- m_remaining = CreateLabel(_("Remaining time : "), &lastWindow);
+ label =
+ m_remaining = CreateLabel(_("Remaining time : "), sizer);
}
if ( nTimeLabels > 0 )
{
// set it to the current time
m_timeStart = wxGetCurrentTime();
- sizeDlg.y += nTimeLabels * (sizeLabel.y + LAYOUT_Y_MARGIN);
+ sizeDlg.y += nTimeLabels * (label->GetSize().y + LAYOUT_MARGIN);
}
if ( hasAbortButton )
{
- m_btnAbort = new wxButton(this, wxID_CANCEL, _("Cancel"));
- c = new wxLayoutConstraints;
+#if defined(__SMARTPHONE__)
+ SetLeftMenu(wxID_CANCEL, _("Cancel"));
+ }
+#else
+ m_btnAbort = new wxButton(this, wxID_CANCEL);
// Windows dialogs usually have buttons in the lower right corner
-#ifdef __WXMSW__
- c->right.SameAs(this, wxRight, 2*LAYOUT_X_MARGIN);
+#if defined(__WXMSW__) || defined(__WXPM__)
+ sizer->Add(m_btnAbort, 0, wxALIGN_RIGHT | wxALL, 2*LAYOUT_MARGIN);
#else // !MSW
- c->centreX.SameAs(this, wxCentreX);
+ sizer->Add(m_btnAbort, 0, wxALIGN_CENTER_HORIZONTAL | wxBOTTOM | wxTOP, 2*LAYOUT_MARGIN);
#endif // MSW/!MSW
- c->bottom.SameAs(this, wxBottom, 2*LAYOUT_Y_MARGIN);
-
- wxSize sizeBtn = wxButton::GetDefaultSize();
- c->width.Absolute(sizeBtn.x);
- c->height.Absolute(sizeBtn.y);
-
- m_btnAbort->SetConstraints(c);
-
- sizeDlg.y += 2*LAYOUT_Y_MARGIN + sizeBtn.y;
+ sizeDlg.y += 2*LAYOUT_MARGIN + wxButton::GetDefaultSize().y;
}
- else
+ else // no "Cancel" button
+#endif // __SMARTPHONE__/!__SMARTPHONE__
+ {
m_btnAbort = (wxButton *)NULL;
+ }
- SetAutoLayout(TRUE);
- Layout();
+ SetSizerAndFit(sizer);
- sizeDlg.y += 2*LAYOUT_Y_MARGIN;
+ sizeDlg.y += 2*LAYOUT_MARGIN;
// try to make the dialog not square but rectangular of reasonabel width
sizeDlg.x = (wxCoord)wxMax(widthText, 4*sizeDlg.y/3);
Centre(wxCENTER_FRAME | wxBOTH);
- if ( !(style & wxPD_APP_MODAL) )
+ if ( style & wxPD_APP_MODAL )
{
- if ( m_parentTop )
- m_parentTop->Enable(FALSE);
+ m_winDisabler = new wxWindowDisabler(this);
}
else
{
- wxEnableTopLevelWindows(FALSE);
+ if ( m_parentTop )
+ m_parentTop->Disable();
+ m_winDisabler = NULL;
}
- Show(TRUE);
- Enable(TRUE); // enable this window
+ Show();
+ Enable();
- // Update the display (especially on X, GTK)
- wxYield();
+ // this one can be initialized even if the others are unknown for now
+ //
+ // NB: do it after calling Layout() to keep the labels correctly aligned
+ if ( m_elapsed )
+ {
+ SetTimeLabel(0, m_elapsed);
+ }
-#ifdef __WXMAC__
- MacUpdateImmediately();
-#endif
+ Update();
}
wxStaticText *wxProgressDialog::CreateLabel(const wxString& text,
- wxWindow **lastWindow)
+ wxSizer *sizer)
{
- wxLayoutConstraints *c;
-
- wxStaticText *label = new wxStaticText(this, -1, _("unknown"));
- c = new wxLayoutConstraints;
-
- // VZ: I like the labels be centered - if the others don't mind, you may
- // remove "#ifdef __WXMSW__" and use it for all ports
-#ifdef __WXMSW__
- c->left.SameAs(this, wxCentreX, LAYOUT_X_MARGIN);
-#else // !MSW
- c->right.SameAs(this, wxRight, 2*LAYOUT_X_MARGIN);
-#endif // MSW/!MSW
- c->top.Below(*lastWindow, LAYOUT_Y_MARGIN);
- c->width.AsIs();
- c->height.AsIs();
- label->SetConstraints(c);
-
- wxStaticText *dummy = new wxStaticText(this, -1, text);
- c = new wxLayoutConstraints;
- c->right.LeftOf(label);
- c->top.SameAs(label, wxTop, 0);
- c->width.AsIs();
- c->height.AsIs();
- dummy->SetConstraints(c);
-
- *lastWindow = label;
+ wxBoxSizer *locsizer = new wxBoxSizer(wxLARGESMALL(wxHORIZONTAL,wxVERTICAL));
+
+ wxStaticText *dummy = new wxStaticText(this, wxID_ANY, text);
+ wxStaticText *label = new wxStaticText(this, wxID_ANY, _("unknown"));
+
+ // select placement most native or nice on target GUI
+#if defined(__SMARTPHONE__)
+ // label and time to the left in two rows
+ locsizer->Add(dummy, 1, wxALIGN_LEFT);
+ locsizer->Add(label, 1, wxALIGN_LEFT);
+ sizer->Add(locsizer, 0, wxALIGN_LEFT | wxTOP | wxLEFT, LAYOUT_MARGIN);
+#elif defined(__WXMSW__) || defined(__WXPM__) || defined(__WXMAC__)
+ // label and time centered in one row
+ locsizer->Add(dummy, 1, wxLARGESMALL(wxALIGN_RIGHT,wxALIGN_LEFT));
+ locsizer->Add(label, 1, wxALIGN_LEFT | wxLEFT, LAYOUT_MARGIN);
+ sizer->Add(locsizer, 0, wxALIGN_CENTER_HORIZONTAL | wxTOP, LAYOUT_MARGIN);
+#else
+ // label and time to the right in one row
+ sizer->Add(locsizer, 0, wxALIGN_RIGHT | wxRIGHT | wxTOP, LAYOUT_MARGIN);
+ locsizer->Add(dummy);
+ locsizer->Add(label, 0, wxLEFT, LAYOUT_MARGIN);
+#endif
return label;
}
+// ----------------------------------------------------------------------------
+// wxProgressDialog operations
+// ----------------------------------------------------------------------------
+
bool
wxProgressDialog::Update(int value, const wxString& newmsg)
{
wxASSERT_MSG( value == -1 || m_gauge, wxT("cannot update non existent dialog") );
+
+#ifdef __WXMSW__
+ value /= m_factor;
+#endif // __WXMSW__
+
wxASSERT_MSG( value <= m_maximum, wxT("invalid progress value") );
- if ( m_gauge )
- m_gauge->SetValue(value + 1);
+ // fill up the gauge if value == maximum because this means that the dialog
+ // is going to close and the gauge shouldn't be partly empty in this case
+ if ( m_gauge && value <= m_maximum )
+ {
+ m_gauge->SetValue(value == m_maximum ? value : value + 1);
+ }
if ( !newmsg.IsEmpty() )
{
-#ifdef __WXMSW__
- // this seems to be necessary or garbage is left when the new label is
- // longer than the old one
- m_msg->SetLabel(wxEmptyString);
-#endif // MSW
-
m_msg->SetLabel(newmsg);
- wxYield();
+ wxYieldIfNeeded() ;
}
if ( (m_elapsed || m_remaining || m_estimated) && (value != 0) )
{
unsigned long elapsed = wxGetCurrentTime() - m_timeStart;
- unsigned long estimated = elapsed * m_maximum / value;
- unsigned long remaining = estimated - elapsed;
+ if ( m_last_timeupdate < elapsed
+ || value == m_maximum
+ )
+ {
+ m_last_timeupdate = elapsed;
+ unsigned long estimated = m_break +
+ (unsigned long)(( (double) (elapsed-m_break) * m_maximum ) / ((double)value)) ;
+ if ( estimated > m_display_estimated
+ && m_ctdelay >= 0
+ )
+ {
+ ++m_ctdelay;
+ }
+ else if ( estimated < m_display_estimated
+ && m_ctdelay <= 0
+ )
+ {
+ --m_ctdelay;
+ }
+ else
+ {
+ m_ctdelay = 0;
+ }
+ if ( m_ctdelay >= m_delay // enough confirmations for a higher value
+ || m_ctdelay <= (m_delay*-1) // enough confirmations for a lower value
+ || value == m_maximum // to stay consistent
+ || elapsed > m_display_estimated // to stay consistent
+ || ( elapsed > 0 && elapsed < 4 ) // additional updates in the beginning
+ )
+ {
+ m_display_estimated = estimated;
+ m_ctdelay = 0;
+ }
+ }
+
+ long display_remaining = m_display_estimated - elapsed;
+ if ( display_remaining < 0 )
+ {
+ display_remaining = 0;
+ }
SetTimeLabel(elapsed, m_elapsed);
- SetTimeLabel(estimated, m_estimated);
- SetTimeLabel(remaining, m_remaining);
+ SetTimeLabel(m_display_estimated, m_estimated);
+ SetTimeLabel(display_remaining, m_remaining);
}
- if ( (value == m_maximum ) && !(GetWindowStyle() & wxPD_AUTO_HIDE) )
+ if ( value == m_maximum )
{
- if ( m_btnAbort )
- {
- // tell the user what he should do...
- m_btnAbort->SetLabel(_("Close"));
- }
-
- if ( !newmsg )
+ if ( m_state == Finished )
{
- // also provide the finishing message if the application didn't
- m_msg->SetLabel(_("Done."));
+ // ignore multiple calls to Update(m_maximum): it may sometimes be
+ // troublesome to ensure that Update() is not called twice with the
+ // same value (e.g. because of the rounding errors) and if we don't
+ // return now we're going to generate asserts below
+ return true;
}
- // so that we return TRUE below and that out [Cancel] handler knew what
+ // so that we return true below and that out [Cancel] handler knew what
// to do
m_state = Finished;
+ if( !(GetWindowStyle() & wxPD_AUTO_HIDE) )
+ {
+#if defined(__SMARTPHONE__)
+ SetLeftMenu(wxID_CANCEL, _("Close"));
+#endif
+ if ( m_btnAbort )
+ {
+ // tell the user what he should do...
+ m_btnAbort->SetLabel(_("Close"));
+ }
+#if defined(__WXMSW__) && !defined(__WXUNIVERSAL__)
+ else // enable the button to give the user a way to close the dlg
+ {
+ EnableCloseButton();
+ }
+#endif // __WXMSW__
+
+ if ( !newmsg )
+ {
+ // also provide the finishing message if the application didn't
+ m_msg->SetLabel(_("Done."));
+ }
+
+ wxYieldIfNeeded() ;
+
+ (void)ShowModal();
+ }
+ else // auto hide
+ {
+ // reenable other windows before hiding this one because otherwise
+ // Windows wouldn't give the focus back to the window which had
+ // been previously focused because it would still be disabled
+ ReenableOtherWindows();
- wxYield();
-
- (void)ShowModal();
+ Hide();
+ }
}
else
{
- // update the display
- wxYield();
+ // we have to yield because not only we want to update the display but
+ // also to process the clicks on the cancel button
+ wxYieldIfNeeded() ;
}
-#ifdef __WXMAC__
- MacUpdateImmediately();
-#endif
+ // update the display in case yielding above didn't do it
+ Update();
return m_state != Canceled;
}
+void wxProgressDialog::Resume()
+{
+ m_state = Continue;
+ m_ctdelay = m_delay; // force an update of the elapsed/estimated/remaining time
+ m_break += wxGetCurrentTime()-m_timeStop;
+
+ // it may have been disabled by OnCancel(), so enable it back to let the
+ // user interrupt us again if needed
+ if(m_btnAbort)
+ m_btnAbort->Enable();
+#if defined(__SMARTPHONE__)
+ SetLeftMenu(wxID_CANCEL, _("Cancel"));
+#endif
+}
+
+bool wxProgressDialog::Show( bool show )
+{
+ // reenable other windows before hiding this one because otherwise
+ // Windows wouldn't give the focus back to the window which had
+ // been previously focused because it would still be disabled
+ if(!show)
+ ReenableOtherWindows();
+
+ return wxDialog::Show(show);
+}
+
// ----------------------------------------------------------------------------
// event handlers
// ----------------------------------------------------------------------------
// update the button state immediately so that the user knows that the
// request has been noticed
- m_btnAbort->Disable();
+ if(m_btnAbort)
+ m_btnAbort->Disable();
+
+#if defined(__SMARTPHONE__)
+ SetLeftMenu();
+#endif
+
+ // save the time when the dialog was stopped
+ m_timeStop = wxGetCurrentTime();
}
}
if ( m_state == Uncancelable )
{
// can't close this dialog
- event.Veto(TRUE);
+ event.Veto();
}
else if ( m_state == Finished )
{
{
// next Update() will notice it
m_state = Canceled;
+ if(m_btnAbort)
+ m_btnAbort->Disable();
+#if defined(__SMARTPHONE__)
+ SetLeftMenu();
+#endif
+ m_timeStop = wxGetCurrentTime();
}
}
wxProgressDialog::~wxProgressDialog()
{
- if ( !(GetWindowStyle() & wxPD_APP_MODAL) )
+ // normally this should have been already done, but just in case
+ ReenableOtherWindows();
+}
+
+void wxProgressDialog::ReenableOtherWindows()
+{
+ if ( GetWindowStyle() & wxPD_APP_MODAL )
{
- if ( m_parentTop )
- m_parentTop->Enable(TRUE);
+ delete m_winDisabler;
+ m_winDisabler = (wxWindowDisabler *)NULL;
}
else
{
- wxEnableTopLevelWindows(TRUE);
+ if ( m_parentTop )
+ m_parentTop->Enable();
}
}
projects / wxWidgets.git / blobdiff