Make code reading BMP files more robust.
[wxWidgets.git] / src / common / toplvcmn.cpp
index c4f43c5a6003802866d0c3e2f476e2f0abbc60d8..e93cdc024f329c6186c16be7993f1f81c1065d0b 100644 (file)
@@ -1,10 +1,10 @@
 /////////////////////////////////////////////////////////////////////////////
-// Name:        common/toplvcmn.cpp
+// Name:        src/common/toplvcmn.cpp
 // Purpose:     common (for all platforms) wxTopLevelWindow functions
 // Author:      Julian Smart, Vadim Zeitlin
 // Created:     01/02/97
 // Id:          $Id$
-// Copyright:   (c) 1998 Robert Roebling, Julian Smart and Markus Holzem
+// Copyright:   (c) 1998 Robert Roebling and Julian Smart
 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 // headers
 // ----------------------------------------------------------------------------
 
-#ifdef __GNUG__
-    #pragma implementation "toplevelbase.h"
-#endif
-
 // For compilers that support precompilation, includes "wx.h".
 #include "wx/wxprec.h"
 
     #pragma hdrstop
 #endif
 
+#include "wx/toplevel.h"
+
 #ifndef WX_PRECOMP
-    #include "wx/toplevel.h"
     #include "wx/dcclient.h"
+    #include "wx/app.h"
 #endif // WX_PRECOMP
 
-#include "wx/evtloop.h"
+#include "wx/display.h"
 
 // ----------------------------------------------------------------------------
 // event table
@@ -47,10 +45,7 @@ END_EVENT_TABLE()
 // implementation
 // ============================================================================
 
-// FIXME: some platforms don't have wxTopLevelWindow yet
-#ifdef wxTopLevelWindowNative
-    IMPLEMENT_DYNAMIC_CLASS(wxTopLevelWindow, wxWindow)
-#endif
+IMPLEMENT_ABSTRACT_CLASS(wxTopLevelWindow, wxWindow)
 
 // ----------------------------------------------------------------------------
 // construction/destruction
@@ -58,6 +53,51 @@ END_EVENT_TABLE()
 
 wxTopLevelWindowBase::wxTopLevelWindowBase()
 {
+    // Unlike windows, top level windows are created hidden by default.
+    m_isShown = false;
+}
+
+wxTopLevelWindowBase::~wxTopLevelWindowBase()
+{
+    // don't let wxTheApp keep any stale pointers to us
+    if ( wxTheApp && wxTheApp->GetTopWindow() == this )
+        wxTheApp->SetTopWindow(NULL);
+
+    wxTopLevelWindows.DeleteObject(this);
+
+    // delete any our top level children which are still pending for deletion
+    // immediately: this could happen if a child (e.g. a temporary dialog
+    // created with this window as parent) was Destroy()'d) while this window
+    // was deleted directly (with delete, or maybe just because it was created
+    // on the stack) immediately afterwards and before the child TLW was really
+    // destroyed -- not destroying it now would leave it alive with a dangling
+    // parent pointer and result in a crash later
+    for ( wxObjectList::iterator i = wxPendingDelete.begin();
+          i != wxPendingDelete.end();
+          )
+    {
+        wxWindow * const win = wxDynamicCast(*i, wxWindow);
+        if ( win && win->GetParent() == this )
+        {
+            wxPendingDelete.erase(i);
+
+            delete win;
+
+            // deleting it invalidated the list (and not only one node because
+            // it could have resulted in deletion of other objects to)
+            i = wxPendingDelete.begin();
+        }
+        else
+        {
+            ++i;
+        }
+    }
+
+    if ( IsLastBeforeExit() )
+    {
+        // no other (important) windows left, quit the app
+        wxTheApp->ExitMainLoop();
+    }
 }
 
 bool wxTopLevelWindowBase::Destroy()
@@ -67,7 +107,190 @@ bool wxTopLevelWindowBase::Destroy()
     if ( !wxPendingDelete.Member(this) )
         wxPendingDelete.Append(this);
 
-    return TRUE;
+    // normally we want to hide the window immediately so that it doesn't get
+    // stuck on the screen while it's being destroyed, however we shouldn't
+    // hide the last visible window as then we might not get any idle events
+    // any more as no events will be sent to the hidden window and without idle
+    // events we won't prune wxPendingDelete list and the application won't
+    // terminate
+    for ( wxWindowList::const_iterator i = wxTopLevelWindows.begin(),
+                                     end = wxTopLevelWindows.end();
+          i != end;
+          ++i )
+    {
+        wxTopLevelWindow * const win = static_cast<wxTopLevelWindow *>(*i);
+        if ( win != this && win->IsShown() )
+        {
+            // there remains at least one other visible TLW, we can hide this
+            // one
+            Hide();
+
+            break;
+        }
+    }
+
+    return true;
+}
+
+bool wxTopLevelWindowBase::IsLastBeforeExit() const
+{
+    // first of all, automatically exiting the app on last window close can be
+    // completely disabled at wxTheApp level
+    if ( !wxTheApp || !wxTheApp->GetExitOnFrameDelete() )
+        return false;
+
+    wxWindowList::const_iterator i;
+    const wxWindowList::const_iterator end = wxTopLevelWindows.end();
+
+    // then decide whether we should exit at all
+    for ( i = wxTopLevelWindows.begin(); i != end; ++i )
+    {
+        wxTopLevelWindow * const win = static_cast<wxTopLevelWindow *>(*i);
+        if ( win->ShouldPreventAppExit() )
+        {
+            // there remains at least one important TLW, don't exit
+            return false;
+        }
+    }
+
+    // if yes, close all the other windows: this could still fail
+    for ( i = wxTopLevelWindows.begin(); i != end; ++i )
+    {
+        // don't close twice the windows which are already marked for deletion
+        wxTopLevelWindow * const win = static_cast<wxTopLevelWindow *>(*i);
+        if ( !wxPendingDelete.Member(win) && !win->Close() )
+        {
+            // one of the windows refused to close, don't exit
+            //
+            // NB: of course, by now some other windows could have been already
+            //     closed but there is really nothing we can do about it as we
+            //     have no way just to ask the window if it can close without
+            //     forcing it to do it
+            return false;
+        }
+    }
+
+    return true;
+}
+
+// ----------------------------------------------------------------------------
+// wxTopLevelWindow geometry
+// ----------------------------------------------------------------------------
+
+void wxTopLevelWindowBase::SetMinSize(const wxSize& minSize)
+{
+    SetSizeHints(minSize, GetMaxSize());
+}
+
+void wxTopLevelWindowBase::SetMaxSize(const wxSize& maxSize)
+{
+    SetSizeHints(GetMinSize(), maxSize);
+}
+
+void wxTopLevelWindowBase::GetRectForTopLevelChildren(int *x, int *y, int *w, int *h)
+{
+    GetPosition(x,y);
+    GetSize(w,h);
+}
+
+/* static */
+wxSize wxTopLevelWindowBase::GetDefaultSize()
+{
+    wxSize size = wxGetClientDisplayRect().GetSize();
+#ifndef __WXOSX_IPHONE__
+    // create proportionally bigger windows on small screens
+    if ( size.x >= 1024 )
+        size.x = 400;
+    else if ( size.x >= 800 )
+        size.x = 300;
+    else if ( size.x >= 320 )
+        size.x = 240;
+
+    if ( size.y >= 768 )
+        size.y = 250;
+    else if ( size.y > 200 )
+    {
+        size.y *= 2;
+        size.y /= 3;
+    }
+#endif
+    return size;
+}
+
+void wxTopLevelWindowBase::DoCentre(int dir)
+{
+    // on some platforms centering top level windows is impossible
+    // because they are always maximized by guidelines or limitations
+    //
+    // and centering a maximized window doesn't make sense as its position
+    // can't change
+    if ( IsAlwaysMaximized() || IsMaximized() )
+        return;
+
+    // we need the display rect anyhow so store it first: notice that we should
+    // be centered on the same display as our parent window, the display of
+    // this window itself is not really defined yet
+    int nDisplay = wxDisplay::GetFromWindow(GetParent() ? GetParent() : this);
+    wxDisplay dpy(nDisplay == wxNOT_FOUND ? 0 : nDisplay);
+    const wxRect rectDisplay(dpy.GetClientArea());
+
+    // what should we centre this window on?
+    wxRect rectParent;
+    if ( !(dir & wxCENTRE_ON_SCREEN) && GetParent() )
+    {
+        // centre on parent window: notice that we need screen coordinates for
+        // positioning this TLW
+        rectParent = GetParent()->GetScreenRect();
+
+        // if the parent is entirely off screen (happens at least with MDI
+        // parent frame under Mac but could happen elsewhere too if the frame
+        // was hidden/moved away for some reason), don't use it as otherwise
+        // this window wouldn't be visible at all
+        if ( !rectParent.Intersects(rectDisplay) )
+        {
+            // just centre on screen then
+            rectParent = rectDisplay;
+        }
+    }
+    else
+    {
+        // we were explicitly asked to centre this window on the entire screen
+        // or if we have no parent anyhow and so can't centre on it
+        rectParent = rectDisplay;
+    }
+
+    if ( !(dir & wxBOTH) )
+        dir |= wxBOTH; // if neither is specified, center in both directions
+
+    // the new window rect candidate
+    wxRect rect = GetRect().CentreIn(rectParent, dir & ~wxCENTRE_ON_SCREEN);
+
+    // we don't want to place the window off screen if Centre() is called as
+    // this is (almost?) never wanted and it would be very difficult to prevent
+    // it from happening from the user code if we didn't check for it here
+    if ( !rectDisplay.Contains(rect.GetTopLeft()) )
+    {
+        // move the window just enough to make the corner visible
+        int dx = rectDisplay.GetLeft() - rect.GetLeft();
+        int dy = rectDisplay.GetTop() - rect.GetTop();
+        rect.Offset(dx > 0 ? dx : 0, dy > 0 ? dy : 0);
+    }
+
+    if ( !rectDisplay.Contains(rect.GetBottomRight()) )
+    {
+        // do the same for this corner too
+        int dx = rectDisplay.GetRight() - rect.GetRight();
+        int dy = rectDisplay.GetBottom() - rect.GetBottom();
+        rect.Offset(dx < 0 ? dx : 0, dy < 0 ? dy : 0);
+    }
+
+    // the window top left and bottom right corner are both visible now and
+    // although the window might still be not entirely on screen (with 2
+    // staggered displays for example) we wouldn't be able to improve the
+    // layout much in such case, so we stop here
+
+    // -1 could be valid coordinate here if there are several displays
+    SetSize(rect, wxSIZE_ALLOW_MINUS_ONE);
 }
 
 // ----------------------------------------------------------------------------
@@ -101,6 +324,34 @@ void wxTopLevelWindowBase::DoClientToScreen(int *x, int *y) const
     wxWindow::DoClientToScreen(x, y);
 }
 
+bool wxTopLevelWindowBase::IsAlwaysMaximized() const
+{
+#if defined(__SMARTPHONE__) || defined(__POCKETPC__)
+    return true;
+#else
+    return false;
+#endif
+}
+
+// ----------------------------------------------------------------------------
+// icons
+// ----------------------------------------------------------------------------
+
+wxIcon wxTopLevelWindowBase::GetIcon() const
+{
+    return m_icons.IsEmpty() ? wxIcon() : m_icons.GetIcon( -1 );
+}
+
+void wxTopLevelWindowBase::SetIcon(const wxIcon& icon)
+{
+    // passing wxNullIcon to SetIcon() is possible (it means that we shouldn't
+    // have any icon), but adding an invalid icon to wxIconBundle is not
+    wxIconBundle icons;
+    if ( icon.IsOk() )
+        icons.AddIcon(icon);
+
+    SetIcons(icons);
+}
 
 // ----------------------------------------------------------------------------
 // event handlers
@@ -108,20 +359,26 @@ void wxTopLevelWindowBase::DoClientToScreen(int *x, int *y) const
 
 // default resizing behaviour - if only ONE subwindow, resize to fill the
 // whole client area
-void wxTopLevelWindowBase::OnSize(wxSizeEvent& WXUNUSED(event))
+void wxTopLevelWindowBase::DoLayout()
 {
-    // if we're using constraints - do use them
-#if wxUSE_CONSTRAINTS
+    // We are called during the window destruction several times, e.g. as
+    // wxFrame tries to adjust to its tool/status bars disappearing. But
+    // actually doing the layout is pretty useless in this case as the window
+    // will disappear anyhow -- so just don't bother.
+    if ( IsBeingDeleted() )
+        return;
+
+
+    // if we're using constraints or sizers - do use them
     if ( GetAutoLayout() )
     {
         Layout();
     }
     else
-#endif // wxUSE_CONSTRAINTS
     {
         // do we have _exactly_ one child?
-        wxWindow *child = (wxWindow *)NULL;
-        for ( wxWindowList::Node *node = GetChildren().GetFirst();
+        wxWindow *child = NULL;
+        for ( wxWindowList::compatibility_iterator node = GetChildren().GetFirst();
               node;
               node = node->GetNext() )
         {
@@ -142,21 +399,13 @@ void wxTopLevelWindowBase::OnSize(wxSizeEvent& WXUNUSED(event))
         }
 
         // do we have any children at all?
-        if ( child )
+        if ( child && child->IsShown() )
         {
             // exactly one child - set it's size to fill the whole frame
             int clientW, clientH;
             DoGetClientSize(&clientW, &clientH);
 
-            // for whatever reasons, wxGTK wants to have a small offset - it
-            // probably looks better with it?
-#ifdef __WXGTK__
-            static const int ofs = 1;
-#else
-            static const int ofs = 0;
-#endif
-
-            child->SetSize(ofs, ofs, clientW - 2*ofs, clientH - 2*ofs);
+            child->SetSize(0, 0, clientW, clientH);
         }
     }
 }
@@ -175,223 +424,24 @@ bool wxTopLevelWindowBase::SendIconizeEvent(bool iconized)
     return GetEventHandler()->ProcessEvent(event);
 }
 
-
-// ----------------------------------------------------------------------------
-// interactive manipulation
-// ----------------------------------------------------------------------------
-
-#ifdef __WXUNIVERSAL__
-
-#define wxINTERACTIVE_RESIZE_DIR \
-          (wxINTERACTIVE_RESIZE_W | wxINTERACTIVE_RESIZE_E | \
-           wxINTERACTIVE_RESIZE_S | wxINTERACTIVE_RESIZE_N)
-
-struct wxInteractiveMoveData
-{
-    wxTopLevelWindowBase *m_window;
-    wxEventLoop          *m_evtLoop;
-    int                   m_flags;
-    wxRect                m_rect;
-    wxRect                m_rectOrig;
-    wxPoint               m_pos;
-    wxSize                m_minSize, m_maxSize;
-};
-
-class wxInteractiveMoveHandler : public wxEvtHandler
+// do the window-specific processing after processing the update event
+void wxTopLevelWindowBase::DoUpdateWindowUI(wxUpdateUIEvent& event)
 {
-public:
-    wxInteractiveMoveHandler(wxInteractiveMoveData& data) : m_data(data) {}
-    
-private:
-    DECLARE_EVENT_TABLE()
-    void OnMouseMove(wxMouseEvent& event);
-    void OnMouseDown(wxMouseEvent& event);
-    void OnMouseUp(wxMouseEvent& event);
-    void OnKeyDown(wxKeyEvent& event);
-
-    wxInteractiveMoveData& m_data;
-};
-
-BEGIN_EVENT_TABLE(wxInteractiveMoveHandler, wxEvtHandler)
-    EVT_MOTION(wxInteractiveMoveHandler::OnMouseMove)
-    EVT_LEFT_DOWN(wxInteractiveMoveHandler::OnMouseDown)
-    EVT_LEFT_UP(wxInteractiveMoveHandler::OnMouseUp)
-    EVT_KEY_DOWN(wxInteractiveMoveHandler::OnKeyDown)
-END_EVENT_TABLE()
-
+    // call inherited, but skip the wxControl's version, and call directly the
+    // wxWindow's one instead, because the only reason why we are overriding this
+    // function is that we want to use SetTitle() instead of wxControl::SetLabel()
+    wxWindowBase::DoUpdateWindowUI(event);
 
-static inline LINKAGEMODE 
-void wxApplyResize(wxInteractiveMoveData& data, const wxPoint& diff)
-{
-    if ( data.m_flags & wxINTERACTIVE_RESIZE_W )
-    {
-        data.m_rect.x += diff.x;
-        data.m_rect.width -= diff.x;
-    }
-    else if ( data.m_flags & wxINTERACTIVE_RESIZE_E )
+    // update title
+    if ( event.GetSetText() )
     {
-        data.m_rect.width += diff.x;
-    }
-    if ( data.m_flags & wxINTERACTIVE_RESIZE_N )
-    {
-        data.m_rect.y += diff.y;
-        data.m_rect.height -= diff.y;
-    }
-    else if ( data.m_flags & wxINTERACTIVE_RESIZE_S )
-    {
-        data.m_rect.height += diff.y;
-    }
-    
-    if ( data.m_minSize.x != -1 && data.m_rect.width < data.m_minSize.x )
-    {
-        if ( data.m_flags & wxINTERACTIVE_RESIZE_W )
-            data.m_rect.x -= data.m_minSize.x - data.m_rect.width;
-        data.m_rect.width = data.m_minSize.x;
-    }
-    if ( data.m_maxSize.x != -1 && data.m_rect.width > data.m_maxSize.x )
-    {
-        if ( data.m_flags & wxINTERACTIVE_RESIZE_W )
-            data.m_rect.x -= data.m_minSize.x - data.m_rect.width;
-        data.m_rect.width = data.m_maxSize.x;
-    }
-    if ( data.m_minSize.y != -1 && data.m_rect.height < data.m_minSize.y )
-    {
-        if ( data.m_flags & wxINTERACTIVE_RESIZE_N )
-            data.m_rect.y -= data.m_minSize.y - data.m_rect.height;
-        data.m_rect.height = data.m_minSize.y;
-    }
-    if ( data.m_maxSize.y != -1 && data.m_rect.height > data.m_maxSize.y )
-    {
-        if ( data.m_flags & wxINTERACTIVE_RESIZE_N )
-            data.m_rect.y -= data.m_minSize.y - data.m_rect.height;
-        data.m_rect.height = data.m_maxSize.y;
-    }
-}
-
-void wxInteractiveMoveHandler::OnMouseMove(wxMouseEvent& event)
-{
-    if ( m_data.m_flags & wxINTERACTIVE_WAIT_FOR_INPUT )
-        event.Skip();
-
-    else if ( m_data.m_flags & wxINTERACTIVE_MOVE )
-    {
-        wxPoint diff = wxGetMousePosition() - m_data.m_pos;
-        m_data.m_rect = m_data.m_rectOrig;
-        m_data.m_rect.Offset(diff);
-        m_data.m_window->Move(m_data.m_rect.GetPosition());
-    }
-
-    else if ( m_data.m_flags & wxINTERACTIVE_RESIZE )
-    {
-        wxPoint diff = wxGetMousePosition() - m_data.m_pos;
-        m_data.m_rect = m_data.m_rectOrig;
-        wxApplyResize(m_data, diff);
-        m_data.m_window->SetSize(m_data.m_rect);
-    }
-}
-
-void wxInteractiveMoveHandler::OnMouseDown(wxMouseEvent& event)
-{
-    if ( m_data.m_flags & wxINTERACTIVE_WAIT_FOR_INPUT )
-    {
-        m_data.m_flags &= ~wxINTERACTIVE_WAIT_FOR_INPUT;
-        m_data.m_pos = wxGetMousePosition();
-    }
-}
-
-void wxInteractiveMoveHandler::OnKeyDown(wxKeyEvent& event)
-{
-    if ( m_data.m_flags & wxINTERACTIVE_WAIT_FOR_INPUT )
-    {
-        m_data.m_flags &= ~wxINTERACTIVE_WAIT_FOR_INPUT;
-        m_data.m_pos = wxGetMousePosition();
-    }
-    
-    wxPoint diff(-1,-1);
-    
-    switch ( event.GetKeyCode() )
-    {
-        case WXK_UP:    diff = wxPoint(0, -16); break;
-        case WXK_DOWN:  diff = wxPoint(0, 16);  break;
-        case WXK_LEFT:  diff = wxPoint(-16, 0); break;
-        case WXK_RIGHT: diff = wxPoint(16, 0);  break;
-        case WXK_ESCAPE:
-            m_data.m_window->SetSize(m_data.m_rectOrig);
-            m_data.m_evtLoop->Exit();
-            return;
-        case WXK_RETURN:
-            m_data.m_evtLoop->Exit();
-            return;
-    }
-    
-    if ( diff.x != -1 )
-    {
-        if ( m_data.m_flags & wxINTERACTIVE_MOVE )
-        {
-            m_data.m_rect.Offset(diff);
-            m_data.m_window->Move(m_data.m_rect.GetPosition());
-        }
-        else /* wxINTERACTIVE_RESIZE */
-        {
-            if ( !(m_data.m_flags & wxINTERACTIVE_RESIZE_DIR) )
-            {
-                if ( diff.y < 0 )
-                    m_data.m_flags |= wxINTERACTIVE_RESIZE_N;
-                else if ( diff.y > 0 )
-                    m_data.m_flags |= wxINTERACTIVE_RESIZE_S;
-                if ( diff.x < 0 )
-                    m_data.m_flags |= wxINTERACTIVE_RESIZE_W;
-                else if ( diff.x > 0 )
-                    m_data.m_flags |= wxINTERACTIVE_RESIZE_E;
-            }
-
-            wxApplyResize(m_data, diff);
-            m_data.m_window->SetSize(m_data.m_rect);
-        }
+        if ( event.GetText() != GetTitle() )
+            SetTitle(event.GetText());
     }
 }
 
-void wxInteractiveMoveHandler::OnMouseUp(wxMouseEvent& event)
+void wxTopLevelWindowBase::RequestUserAttention(int WXUNUSED(flags))
 {
-    m_data.m_evtLoop->Exit();
+    // it's probably better than do nothing, isn't it?
+    Raise();
 }
-
-
-void wxTopLevelWindowBase::InteractiveMove(int flags)
-{
-    wxASSERT_MSG( !((flags & wxINTERACTIVE_MOVE) && (flags & wxINTERACTIVE_RESIZE)),
-                  wxT("can't move and resize window at the same time") );
-
-    wxASSERT_MSG( !(flags & wxINTERACTIVE_RESIZE) || 
-                  (flags & wxINTERACTIVE_WAIT_FOR_INPUT) || 
-                  (flags & wxINTERACTIVE_RESIZE_DIR),
-                  wxT("direction of resizing not specified") );
-
-    wxInteractiveMoveData data;
-    wxEventLoop loop;
-    wxWindow *focus = FindFocus();
-    
-    // FIXME - display resize cursor if waiting for initial input
-
-    data.m_window = this;
-    data.m_evtLoop = &loop;
-    data.m_flags = flags;
-    data.m_rect = data.m_rectOrig = GetRect();
-    data.m_pos = wxGetMousePosition();
-    data.m_minSize = wxSize(GetMinWidth(), GetMinHeight());
-    data.m_maxSize = wxSize(GetMaxWidth(), GetMaxHeight());
-
-    this->PushEventHandler(new wxInteractiveMoveHandler(data));
-    if ( focus )
-        focus->PushEventHandler(new wxInteractiveMoveHandler(data));
-
-    CaptureMouse();
-    loop.Run();
-    ReleaseMouse();
-
-    this->PopEventHandler(TRUE/*delete*/);
-    if ( focus )
-        focus->PopEventHandler(TRUE/*delete*/);
-}
-
-#endif // __WXUNIVERSAL__