added wxAuiNotebook::Split() documentation

[wxWidgets.git] / src / common / toplvcmn.cpp

diff --git a/src/common/toplvcmn.cpp b/src/common/toplvcmn.cpp
index b1af3fdd14ece11311c8a76ec6b20c08d2bf198e..45ad2fc6fb5a7d9328eb7a149f46060b234f1ddd 100644 (file)
--- a/src/common/toplvcmn.cpp
+++ b/src/common/toplvcmn.cpp
@@ -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$
 // 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
 /////////////////////////////////////////////////////////////////////////////
 
 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 


@@ -16,10 +16,6 @@
 // headers
 // ----------------------------------------------------------------------------
 
 // headers
 // ----------------------------------------------------------------------------
 

-#ifdef __GNUG__
-    #pragma implementation "toplevelbase.h"
-#endif
-

 // For compilers that support precompilation, includes "wx.h".
 #include "wx/wxprec.h"
 
 // For compilers that support precompilation, includes "wx.h".
 #include "wx/wxprec.h"
 


@@ -27,12 +23,15 @@
     #pragma hdrstop
 #endif
 
     #pragma hdrstop
 #endif
 

+#include "wx/toplevel.h"
+

 #ifndef WX_PRECOMP
 #ifndef WX_PRECOMP

-    #include "wx/toplevel.h"

     #include "wx/dcclient.h"
     #include "wx/app.h"
 #endif // WX_PRECOMP
 
     #include "wx/dcclient.h"
     #include "wx/app.h"
 #endif // WX_PRECOMP
 

+#include "wx/display.h"
+

 // ----------------------------------------------------------------------------
 // event table
 // ----------------------------------------------------------------------------
 // ----------------------------------------------------------------------------
 // event table
 // ----------------------------------------------------------------------------


@@ -46,10 +45,7 @@ END_EVENT_TABLE()
 // implementation
 // ============================================================================
 
 // implementation
 // ============================================================================
 

-// FIXME: some platforms don't have wxTopLevelWindow yet
-#ifdef wxTopLevelWindowNative
-    IMPLEMENT_DYNAMIC_CLASS(wxTopLevelWindow, wxWindow)
-#endif
+IMPLEMENT_ABSTRACT_CLASS(wxTopLevelWindow, wxWindow)

 
 // ----------------------------------------------------------------------------
 // construction/destruction
 
 // ----------------------------------------------------------------------------
 // construction/destruction


@@ -57,6 +53,10 @@ END_EVENT_TABLE()
 
 wxTopLevelWindowBase::wxTopLevelWindowBase()
 {
 
 wxTopLevelWindowBase::wxTopLevelWindowBase()
 {

+    // Unlike windows, top level windows are created hidden by default.
+    m_isShown = false;
+    m_winDefault = NULL;
+    m_winTmpDefault = NULL;

 }
 
 wxTopLevelWindowBase::~wxTopLevelWindowBase()
 }
 
 wxTopLevelWindowBase::~wxTopLevelWindowBase()


@@ -65,13 +65,11 @@ wxTopLevelWindowBase::~wxTopLevelWindowBase()
     if ( wxTheApp && wxTheApp->GetTopWindow() == this )
         wxTheApp->SetTopWindow(NULL);
 
     if ( wxTheApp && wxTheApp->GetTopWindow() == this )
         wxTheApp->SetTopWindow(NULL);
 

-    bool shouldExit = IsLastBeforeExit();
-

     wxTopLevelWindows.DeleteObject(this);
 
     wxTopLevelWindows.DeleteObject(this);
 

-    if ( shouldExit )
+    if ( IsLastBeforeExit() )

     {
     {

-        // then do it
+        // no other (important) windows left, quit the app

         wxTheApp->ExitMainLoop();
     }
 }
         wxTheApp->ExitMainLoop();
     }
 }


@@ -83,38 +81,199 @@ bool wxTopLevelWindowBase::Destroy()
     if ( !wxPendingDelete.Member(this) )
         wxPendingDelete.Append(this);
 
     if ( !wxPendingDelete.Member(this) )
         wxPendingDelete.Append(this);
 

-    return TRUE;
+    if (wxTopLevelWindows.GetCount() > 1)
+    {
+        // Hide it immediately. This should
+        // not be done if this TLW is the
+        // only one left since we then would
+        // risk not to get any idle events
+        // at all anymore during which we
+        // could delete any pending events.
+        Hide();
+    }
+
+    return true;

 }
 
 bool wxTopLevelWindowBase::IsLastBeforeExit() const
 {
 }
 
 bool wxTopLevelWindowBase::IsLastBeforeExit() const
 {

-    // we exit the application if there are no more top level windows left
-    // normally but wxApp can prevent this from happening
-    return wxTopLevelWindows.GetCount() == 1 &&
-            wxTopLevelWindows.GetFirst()->GetData() == (wxWindow *)this &&
-            wxTheApp && wxTheApp->GetExitOnFrameDelete();
+    // 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 = wx_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 = wx_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
 // ----------------------------------------------------------------------------
 
 }
 
 // ----------------------------------------------------------------------------
 // wxTopLevelWindow geometry
 // ----------------------------------------------------------------------------
 

-wxSize wxTopLevelWindowBase::GetMaxSize() const
+void wxTopLevelWindowBase::SetMinSize(const wxSize& minSize)

 {
 {

-    wxSize  size( GetMaxWidth(), GetMaxHeight() );
-    int     w, h;
+    SetSizeHints( minSize.x, minSize.y, GetMaxWidth(), GetMaxHeight() );    
+}

 
 

-    wxClientDisplayRect( 0, 0, &w, &h );
+void wxTopLevelWindowBase::SetMaxSize(const wxSize& maxSize)
+{
+    SetSizeHints( GetMinWidth(), GetMinHeight(), maxSize.x, maxSize.y );
+}

 
 

-    if( size.GetWidth() == -1 )
-        size.SetWidth( w );
+// set the min/max size of the window
+void wxTopLevelWindowBase::DoSetSizeHints(int minW, int minH,
+                                  int maxW, int maxH,
+                                  int WXUNUSED(incW), int WXUNUSED(incH))
+{
+    // setting min width greater than max width leads to infinite loops under
+    // X11 and generally doesn't make any sense, so don't allow it
+    wxCHECK_RET( (minW == wxDefaultCoord || maxW == wxDefaultCoord || minW <= maxW) &&
+                    (minH == wxDefaultCoord || maxH == wxDefaultCoord || minH <= maxH),
+                 _T("min width/height must be less than max width/height!") );
+
+    m_minWidth = minW;
+    m_maxWidth = maxW;
+    m_minHeight = minH;
+    m_maxHeight = maxH;
+}

 
 

-    if( size.GetHeight() == -1 )
-        size.SetHeight( h );
+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();
+
+    // 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;
+    }

 
     return size;
 }
 
 
     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
+    if(IsAlwaysMaximized())
+        return;
+
+    // we need the display rect anyhow so store it first
+    int nDisplay = wxDisplay::GetFromWindow(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 ( !rectDisplay.Contains(rectParent.GetTopLeft()) &&
+                !rectParent.Contains(rectParent.GetBottomRight()) )
+        {
+            // this is enough to make IsEmpty() test below pass
+            rectParent.width = 0;
+        }
+    }
+
+    if ( rectParent.IsEmpty() )
+    {
+        // we were explicitely 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;
+    }
+
+    // centering maximized window on screen is no-op
+    if((rectParent == rectDisplay) && IsMaximized())
+        return;
+
+    // the new window rect candidate
+    wxRect rect = GetRect().CentreIn(rectParent, dir);
+
+    // 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()) )
+    {
+        if ( !rectDisplay.Contains(rect.GetBottomRight()) )
+        {
+            // check if we can move the window so that the bottom right corner
+            // is visible without hiding the top left one
+            int dx = rectDisplay.GetRight() - rect.GetRight();
+            int dy = rectDisplay.GetBottom() - rect.GetBottom();
+            rect.Offset(dx, dy);
+        }
+        //else: the window top left and bottom right corner are both visible,
+        //      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 just leave it as is
+    }
+    else // make top left corner visible
+    {
+        if ( rect.x < rectDisplay.x )
+            rect.x = rectDisplay.x;
+
+        if ( rect.y < rectDisplay.y )
+            rect.y = rectDisplay.y;
+    }
+
+    // -1 could be valid coordinate here if there are several displays
+    SetSize(rect, wxSIZE_ALLOW_MINUS_ONE);
+}
+

 // ----------------------------------------------------------------------------
 // wxTopLevelWindow size management: we exclude the areas taken by
 // menu/status/toolbars from the client area, so the client area is what's
 // ----------------------------------------------------------------------------
 // wxTopLevelWindow size management: we exclude the areas taken by
 // menu/status/toolbars from the client area, so the client area is what's


@@ -146,6 +305,14 @@ void wxTopLevelWindowBase::DoClientToScreen(int *x, int *y) const
     wxWindow::DoClientToScreen(x, y);
 }
 
     wxWindow::DoClientToScreen(x, y);
 }
 

+bool wxTopLevelWindowBase::IsAlwaysMaximized() const
+{
+#if defined(__SMARTPHONE__) || defined(__POCKETPC__)
+    return true;
+#else
+    return false;
+#endif
+}

 
 // ----------------------------------------------------------------------------
 // event handlers
 
 // ----------------------------------------------------------------------------
 // event handlers


@@ -153,7 +320,7 @@ void wxTopLevelWindowBase::DoClientToScreen(int *x, int *y) const
 
 // default resizing behaviour - if only ONE subwindow, resize to fill the
 // whole client area
 
 // 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 or sizers - do use them
     if ( GetAutoLayout() )
 {
     // if we're using constraints or sizers - do use them
     if ( GetAutoLayout() )


@@ -164,7 +331,7 @@ void wxTopLevelWindowBase::OnSize(wxSizeEvent& WXUNUSED(event))
     {
         // do we have _exactly_ one child?
         wxWindow *child = (wxWindow *)NULL;
     {
         // do we have _exactly_ one child?
         wxWindow *child = (wxWindow *)NULL;

-        for ( wxWindowList::Node *node = GetChildren().GetFirst();
+        for ( wxWindowList::compatibility_iterator node = GetChildren().GetFirst();

               node;
               node = node->GetNext() )
         {
               node;
               node = node->GetNext() )
         {


@@ -185,7 +352,7 @@ void wxTopLevelWindowBase::OnSize(wxSizeEvent& WXUNUSED(event))
         }
 
         // do we have any children at all?
         }
 
         // 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;
         {
             // exactly one child - set it's size to fill the whole frame
             int clientW, clientH;


@@ -194,12 +361,18 @@ void wxTopLevelWindowBase::OnSize(wxSizeEvent& WXUNUSED(event))
             // for whatever reasons, wxGTK wants to have a small offset - it
             // probably looks better with it?
 #ifdef __WXGTK__
             // for whatever reasons, wxGTK wants to have a small offset - it
             // probably looks better with it?
 #ifdef __WXGTK__

-            static const int ofs = 1;
+            const int ofs = 1;
+            clientW -= 2 * ofs;
+            clientH -= 2 * ofs;
+            if (clientW < 0)
+                clientW = 0;
+            if (clientH < 0)
+                clientH = 0;

 #else
 #else

-            static const int ofs = 0;
+            const int ofs = 0;

 #endif
 
 #endif
 

-            child->SetSize(ofs, ofs, clientW - 2*ofs, clientH - 2*ofs);
+            child->SetSize(ofs, ofs, clientW, clientH);

         }
     }
 }
         }
     }
 }


@@ -218,4 +391,35 @@ bool wxTopLevelWindowBase::SendIconizeEvent(bool iconized)
     return GetEventHandler()->ProcessEvent(event);
 }
 
     return GetEventHandler()->ProcessEvent(event);
 }
 

-// vi:sts=4:sw=4:et
+// do the window-specific processing after processing the update event
+void wxTopLevelWindowBase::DoUpdateWindowUI(wxUpdateUIEvent& event)
+{
+    // 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);
+
+    // update title
+    if ( event.GetSetText() )
+    {
+        if ( event.GetText() != GetTitle() )
+            SetTitle(event.GetText());
+    }
+}
+
+void wxTopLevelWindowBase::RequestUserAttention(int WXUNUSED(flags))
+{
+    // it's probably better than do nothing, isn't it?
+    Raise();
+}
+
+void wxTopLevelWindowBase::RemoveChild(wxWindowBase *child)
+{
+    if ( child == m_winDefault )
+        m_winDefault = NULL;
+
+    if ( child == m_winTmpDefault )
+        m_winTmpDefault = NULL;
+
+    wxWindow::RemoveChild(child);
+}