added wxAuiNotebook::Split() documentation

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

diff --git a/src/common/docview.cpp b/src/common/docview.cpp
index 64ea2a86273a038b3f8596e0d5d67b1ca567d43e..0e26b04b6b6428b15126f750cff26c30aeaedb04 100644 (file)
--- a/src/common/docview.cpp
+++ b/src/common/docview.cpp
@@ -17,30 +17,31 @@
 // headers
 // ----------------------------------------------------------------------------
 
 // headers
 // ----------------------------------------------------------------------------
 

-#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
-    #pragma implementation "docview.h"
-#endif
-

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

-  #pragma hdrstop
+    #pragma hdrstop

 #endif
 
 #if wxUSE_DOC_VIEW_ARCHITECTURE
 
 #endif
 
 #if wxUSE_DOC_VIEW_ARCHITECTURE
 

+#include "wx/docview.h"
+

 #ifndef WX_PRECOMP
 #ifndef WX_PRECOMP

+    #include "wx/list.h"

     #include "wx/string.h"
     #include "wx/utils.h"
     #include "wx/app.h"
     #include "wx/dc.h"
     #include "wx/dialog.h"
     #include "wx/menu.h"
     #include "wx/string.h"
     #include "wx/utils.h"
     #include "wx/app.h"
     #include "wx/dc.h"
     #include "wx/dialog.h"
     #include "wx/menu.h"

-    #include "wx/list.h"

     #include "wx/filedlg.h"
     #include "wx/intl.h"
     #include "wx/log.h"
     #include "wx/filedlg.h"
     #include "wx/intl.h"
     #include "wx/log.h"

+    #include "wx/msgdlg.h"
+    #include "wx/mdi.h"
+    #include "wx/choicdlg.h"

 #endif
 
 #include "wx/ffile.h"
 #endif
 
 #include "wx/ffile.h"


@@ -49,34 +50,28 @@
     #include "wx/filename.h"
 #endif
 
     #include "wx/filename.h"
 #endif
 

-#ifdef __WXGTK__
-    #include "wx/mdi.h"
-#endif
-

 #if wxUSE_PRINTING_ARCHITECTURE
 #if wxUSE_PRINTING_ARCHITECTURE

-  #include "wx/prntbase.h"
-  #include "wx/printdlg.h"
+    #include "wx/prntbase.h"
+    #include "wx/printdlg.h"

 #endif
 
 #endif
 

-#include "wx/msgdlg.h"
-#include "wx/choicdlg.h"
-#include "wx/docview.h"

 #include "wx/confbase.h"
 #include "wx/file.h"
 #include "wx/cmdproc.h"
 #include "wx/confbase.h"
 #include "wx/file.h"
 #include "wx/cmdproc.h"

+#include "wx/tokenzr.h"

 
 #include <stdio.h>
 #include <string.h>
 
 #if wxUSE_STD_IOSTREAM
 
 #include <stdio.h>
 #include <string.h>
 
 #if wxUSE_STD_IOSTREAM

-  #include "wx/ioswrap.h"
-  #if wxUSE_IOSTREAMH
-    #include <fstream.h>
-  #else
-    #include <fstream>
-  #endif
+    #include "wx/ioswrap.h"
+    #if wxUSE_IOSTREAMH
+        #include <fstream.h>
+    #else
+        #include <fstream>
+    #endif

 #else
 #else

-  #include "wx/wfstream.h"
+    #include "wx/wfstream.h"

 #endif
 
 // ----------------------------------------------------------------------------
 #endif
 
 // ----------------------------------------------------------------------------


@@ -183,23 +178,43 @@ bool wxDocument::OnCloseDocument()
 bool wxDocument::DeleteAllViews()
 {
     wxDocManager* manager = GetDocumentManager();
 bool wxDocument::DeleteAllViews()
 {
     wxDocManager* manager = GetDocumentManager();

-    wxList::iterator it, en;

 
 

-    for ( it = m_documentViews.begin(), en = m_documentViews.end();
-          it != en;
-          ++it )
+    // first check if all views agree to be closed
+    const wxList::iterator end = m_documentViews.end();
+    for ( wxList::iterator i = m_documentViews.begin(); i != end; ++i )

     {
     {

-        wxView *view = (wxView *)*it;
-        if (!view->Close())
+        wxView *view = (wxView *)*i;
+        if ( !view->Close() )

             return false;
             return false;

+    }

 
 

-        delete view; // Deletes node implicitly
+    // all views agreed to close, now do close them
+    if ( m_documentViews.empty() )
+    {
+        // normally the document would be implicitly deleted when the last view
+        // is, but if don't have any views, do it here instead
+        if ( manager && manager->GetDocuments().Member(this) )
+            delete this;

     }
     }

+    else // have views
+    {
+        // as we delete elements we iterate over, don't use the usual "from
+        // begin to end" loop
+        for ( ;; )
+        {
+            wxView *view = (wxView *)*m_documentViews.begin();

 
 

-    // If we haven't yet deleted the document (for example
-    // if there were no views) then delete it.
-    if (manager && manager->GetDocuments().Member(this))
-        delete this;
+            bool isLastOne = m_documentViews.size() == 1;
+
+            // this always deletes the node implicitly and if this is the last
+            // view also deletes this object itself (also implicitly, great),
+            // so we can't test for m_documentViews.empty() after calling this!
+            delete view;
+
+            if ( isLastOne )
+                break;
+        }
+    }

 
     return true;
 }
 
     return true;
 }


@@ -287,7 +302,7 @@ bool wxDocument::SaveAs()
             wxFileNameFromPath(GetFilename()),
             docTemplate->GetDefaultExtension(),
             filter,
             wxFileNameFromPath(GetFilename()),
             docTemplate->GetDefaultExtension(),
             filter,

-            wxSAVE | wxOVERWRITE_PROMPT,
+            wxFD_SAVE | wxFD_OVERWRITE_PROMPT,

             GetDocumentWindow());
 
     if (tmp.empty())
             GetDocumentWindow());
 
     if (tmp.empty())


@@ -551,7 +566,7 @@ bool wxDocument::DoSaveDocument(const wxString& file)
         msgTitle = wxString(_("File error"));
 
 #if wxUSE_STD_IOSTREAM
         msgTitle = wxString(_("File error"));
 
 #if wxUSE_STD_IOSTREAM

-    wxSTD ofstream store(file.mb_str());
+    wxSTD ofstream store(file.mb_str(), wxSTD ios::binary);

     if (store.fail() || store.bad())
 #else
     wxFileOutputStream store(file);
     if (store.fail() || store.bad())
 #else
     wxFileOutputStream store(file);


@@ -576,39 +591,26 @@ bool wxDocument::DoSaveDocument(const wxString& file)
 
 bool wxDocument::DoOpenDocument(const wxString& file)
 {
 
 bool wxDocument::DoOpenDocument(const wxString& file)
 {

-    wxString msgTitle;
-    if (!wxTheApp->GetAppName().empty())
-        msgTitle = wxTheApp->GetAppName();
-    else
-        msgTitle = wxString(_("File error"));
-

 #if wxUSE_STD_IOSTREAM
 #if wxUSE_STD_IOSTREAM

-    wxSTD ifstream store(file.mb_str());
-    if (store.fail() || store.bad())
+    wxSTD ifstream store(file.mb_str(), wxSTD ios::binary);
+    if (!store.fail() && !store.bad())

 #else
     wxFileInputStream store(file);
 #else
     wxFileInputStream store(file);

-    if (store.GetLastError() != wxSTREAM_NO_ERROR)
+    if (store.GetLastError() == wxSTREAM_NO_ERROR)

 #endif
     {
 #endif
     {

-        (void)wxMessageBox(_("Sorry, could not open this file."), msgTitle, wxOK|wxICON_EXCLAMATION,
-                           GetDocumentWindow());
-        return false;
-    }

 #if wxUSE_STD_IOSTREAM
 #if wxUSE_STD_IOSTREAM

-    LoadObject(store);
-    if ( !store && !store.eof() )
+        LoadObject(store);
+        if ( !!store || store.eof() )

 #else
 #else

-    int res = LoadObject(store).GetLastError();
-    if ((res != wxSTREAM_NO_ERROR) &&
-        (res != wxSTREAM_EOF))
+        int res = LoadObject(store).GetLastError();
+        if ( res == wxSTREAM_NO_ERROR || res == wxSTREAM_EOF )

 #endif
 #endif

-    {
-        (void)wxMessageBox(_("Sorry, could not open this file."), msgTitle, wxOK|wxICON_EXCLAMATION,
-                           GetDocumentWindow());
-        return false;
+            return true;

     }
 
     }
 

-    return true;
+    wxLogError(_("Sorry, could not open this file."));
+    return false;

 }
 
 
 }
 
 


@@ -653,14 +655,18 @@ void wxView::OnUpdate(wxView *WXUNUSED(sender), wxObject *WXUNUSED(hint))
 
 void wxView::OnChangeFilename()
 {
 
 void wxView::OnChangeFilename()
 {

-    if (GetFrame() && GetDocument())
-    {
-        wxString title;
+    // GetFrame can return wxWindow rather than wxTopLevelWindow due to
+    // generic MDI implementation so use SetLabel rather than SetTitle.
+    // It should cause SetTitle() for top level windows.
+    wxWindow *win = GetFrame();
+    if (!win) return;

 
 

-        GetDocument()->GetPrintableName(title);
+    wxDocument *doc = GetDocument();
+    if (!doc) return;

 
 

-        GetFrame()->SetTitle(title);
-    }
+    wxString name;
+    doc->GetPrintableName(name);
+    win->SetLabel(name);

 }
 
 void wxView::SetDocument(wxDocument *doc)
 }
 
 void wxView::SetDocument(wxDocument *doc)


@@ -789,6 +795,17 @@ wxView *wxDocTemplate::CreateView(wxDocument *doc, long flags)
 // that of the template
 bool wxDocTemplate::FileMatchesTemplate(const wxString& path)
 {
 // that of the template
 bool wxDocTemplate::FileMatchesTemplate(const wxString& path)
 {

+    wxStringTokenizer parser (GetFileFilter(), wxT(";"));
+    wxString anything = wxT ("*");
+    while (parser.HasMoreTokens())
+    {
+        wxString filter = parser.GetNextToken();
+        wxString filterExt = FindExtension (filter);
+        if ( filter.IsSameAs (anything)    ||
+             filterExt.IsSameAs (anything) ||
+             filterExt.IsSameAs (FindExtension (path)) )
+            return true;
+    }

     return GetDefaultExtension().IsSameAs(FindExtension(path));
 }
 
     return GetDefaultExtension().IsSameAs(FindExtension(path));
 }
 


@@ -1205,7 +1222,12 @@ wxDocument *wxDocManager::CreateDocument(const wxString& path, long flags)
             {
                 newDoc->SetDocumentName(temp->GetDocumentName());
                 newDoc->SetDocumentTemplate(temp);
             {
                 newDoc->SetDocumentName(temp->GetDocumentName());
                 newDoc->SetDocumentTemplate(temp);

-                newDoc->OnNewDocument();
+                if (!newDoc->OnNewDocument() )
+                {
+                     // Document is implicitly deleted by DeleteAllViews
+                     newDoc->DeleteAllViews();
+                     return NULL;
+                }

             }
             return newDoc;
         }
             }
             return newDoc;
         }


@@ -1228,7 +1250,12 @@ wxDocument *wxDocManager::CreateDocument(const wxString& path, long flags)
             {
                 newDoc->SetDocumentName(temp->GetDocumentName());
                 newDoc->SetDocumentTemplate(temp);
             {
                 newDoc->SetDocumentName(temp->GetDocumentName());
                 newDoc->SetDocumentTemplate(temp);

-                newDoc->OnNewDocument();
+                if (!newDoc->OnNewDocument() )
+                {
+                     // Document is implicitly deleted by DeleteAllViews
+                     newDoc->DeleteAllViews();
+                     return NULL;
+                }

             }
             return newDoc;
         }
             }
             return newDoc;
         }


@@ -1268,6 +1295,28 @@ wxDocument *wxDocManager::CreateDocument(const wxString& path, long flags)
             }
         }
 
             }
         }
 

+        //see if this file is already open
+        for (size_t i = 0; i < GetDocuments().GetCount(); ++i)
+        {
+            wxDocument* currentDoc = (wxDocument*)(GetDocuments().Item(i)->GetData());
+#ifdef __WXMSW__
+            //file paths are case-insensitive on Windows
+            if (path2.CmpNoCase(currentDoc->GetFilename()) == 0)
+#else
+            if (path2.Cmp(currentDoc->GetFilename()) == 0)
+#endif
+            {
+                //file already open. Just activate it and return
+                if (currentDoc->GetFirstView())
+                {
+                    ActivateView(currentDoc->GetFirstView(), true);
+                    if (currentDoc->GetDocumentWindow())
+                        currentDoc->GetDocumentWindow()->SetFocus();
+                    return currentDoc;
+                }
+            }
+        }
+

         wxDocument *newDoc = temp->CreateDocument(path2, flags);
         if (newDoc)
         {
         wxDocument *newDoc = temp->CreateDocument(path2, flags);
         if (newDoc)
         {


@@ -1874,6 +1923,11 @@ BEGIN_EVENT_TABLE(wxDocParentFrame, wxFrame)
     EVT_CLOSE(wxDocParentFrame::OnCloseWindow)
 END_EVENT_TABLE()
 
     EVT_CLOSE(wxDocParentFrame::OnCloseWindow)
 END_EVENT_TABLE()
 

+wxDocParentFrame::wxDocParentFrame()
+{
+    m_docManager = NULL;
+}
+

 wxDocParentFrame::wxDocParentFrame(wxDocManager *manager,
                                    wxFrame *frame,
                                    wxWindowID id,
 wxDocParentFrame::wxDocParentFrame(wxDocManager *manager,
                                    wxFrame *frame,
                                    wxWindowID id,


@@ -1887,6 +1941,19 @@ wxDocParentFrame::wxDocParentFrame(wxDocManager *manager,
     m_docManager = manager;
 }
 
     m_docManager = manager;
 }
 

+bool wxDocParentFrame::Create(wxDocManager *manager,
+                              wxFrame *frame,
+                              wxWindowID id,
+                              const wxString& title,
+                              const wxPoint& pos,
+                              const wxSize& size,
+                              long style,
+                              const wxString& name)
+{
+    m_docManager = manager;
+    return base_type::Create(frame, id, title, pos, size, style, name);
+}
+

 void wxDocParentFrame::OnExit(wxCommandEvent& WXUNUSED(event))
 {
     Close();
 void wxDocParentFrame::OnExit(wxCommandEvent& WXUNUSED(event))
 {
     Close();


@@ -2126,6 +2193,8 @@ void wxFileHistory::AddFileToHistory(const wxString& file)
                 pathInMenu = m_fileHistory[i];
             }
 
                 pathInMenu = m_fileHistory[i];
             }
 

+            // we need to quote '&' characters which are used for mnemonics
+            pathInMenu.Replace(_T("&"), _T("&&"));

             wxString buf;
             buf.Printf(s_MRUEntryFormat, i + 1, pathInMenu.c_str());
             wxList::compatibility_iterator node = m_fileMenus.GetFirst();
             wxString buf;
             buf.Printf(s_MRUEntryFormat, i + 1, pathInMenu.c_str());
             wxList::compatibility_iterator node = m_fileMenus.GetFirst();


@@ -2156,20 +2225,20 @@ void wxFileHistory::RemoveFileFromHistory(size_t i)
     wxList::compatibility_iterator node = m_fileMenus.GetFirst();
     while ( node )
     {
     wxList::compatibility_iterator node = m_fileMenus.GetFirst();
     while ( node )
     {

-         wxMenu* menu = (wxMenu*) node->GetData();
+        wxMenu* menu = (wxMenu*) node->GetData();

 
 

-         // shuffle filenames up
-         wxString buf;
-         for ( j = i; j < m_fileHistoryN - 1; j++ )
-         {
-             buf.Printf(s_MRUEntryFormat, j + 1, m_fileHistory[j]);
-             menu->SetLabel(m_idBase + j, buf);
-         }
+        // shuffle filenames up
+        wxString buf;
+        for ( j = i; j < m_fileHistoryN - 1; j++ )
+        {
+            buf.Printf(s_MRUEntryFormat, j + 1, m_fileHistory[j]);
+            menu->SetLabel(m_idBase + j, buf);
+        }

 
 

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

 
         // delete the last menu item which is unused now
 
         // delete the last menu item which is unused now

-        wxWindowID lastItemId = m_idBase + m_fileHistoryN - 1;
+        wxWindowID lastItemId = m_idBase + wx_truncate_cast(wxWindowID, m_fileHistoryN) - 1;

         if (menu->FindItem(lastItemId))
         {
             menu->Delete(lastItemId);
         if (menu->FindItem(lastItemId))
         {
             menu->Delete(lastItemId);


@@ -2178,10 +2247,10 @@ void wxFileHistory::RemoveFileFromHistory(size_t i)
         // delete the last separator too if no more files are left
         if ( m_fileHistoryN == 1 )
         {
         // delete the last separator too if no more files are left
         if ( m_fileHistoryN == 1 )
         {

-            wxMenuItemList::compatibility_iterator node = menu->GetMenuItems().GetLast();
-            if ( node )
+            wxMenuItemList::compatibility_iterator nodeLast = menu->GetMenuItems().GetLast();
+            if ( nodeLast )

             {
             {

-                wxMenuItem *menuItem = node->GetData();
+                wxMenuItem *menuItem = nodeLast->GetData();

                 if ( menuItem->IsSeparator() )
                 {
                     menu->Delete(menuItem);
                 if ( menuItem->IsSeparator() )
                 {
                     menu->Delete(menuItem);


@@ -2404,4 +2473,3 @@ bool wxTransferStreamToFile(wxInputStream& stream, const wxString& filename)
 #endif // wxUSE_STD_IOSTREAM/!wxUSE_STD_IOSTREAM
 
 #endif // wxUSE_DOC_VIEW_ARCHITECTURE
 #endif // wxUSE_STD_IOSTREAM/!wxUSE_STD_IOSTREAM
 
 #endif // wxUSE_DOC_VIEW_ARCHITECTURE

-