1 /////////////////////////////////////////////////////////////////////////////
2 // Name: src/common/docview.cpp
3 // Purpose: Document/view classes
4 // Author: Julian Smart
5 // Modified by: Vadim Zeitlin
7 // Copyright: (c) Julian Smart
8 // Licence: wxWindows licence
9 /////////////////////////////////////////////////////////////////////////////
11 // ============================================================================
13 // ============================================================================
15 // ----------------------------------------------------------------------------
17 // ----------------------------------------------------------------------------
19 // For compilers that support precompilation, includes "wx.h".
20 #include "wx/wxprec.h"
26 #if wxUSE_DOC_VIEW_ARCHITECTURE
28 #include "wx/docview.h"
32 #include "wx/string.h"
36 #include "wx/dialog.h"
38 #include "wx/filedlg.h"
41 #include "wx/msgdlg.h"
43 #include "wx/choicdlg.h"
46 #if wxUSE_PRINTING_ARCHITECTURE
47 #include "wx/prntbase.h"
48 #include "wx/printdlg.h"
51 #include "wx/confbase.h"
52 #include "wx/filename.h"
55 #include "wx/cmdproc.h"
56 #include "wx/tokenzr.h"
57 #include "wx/filename.h"
58 #include "wx/stdpaths.h"
59 #include "wx/vector.h"
60 #include "wx/scopedarray.h"
61 #include "wx/scopedptr.h"
62 #include "wx/scopeguard.h"
63 #include "wx/except.h"
65 #if wxUSE_STD_IOSTREAM
66 #include "wx/ioswrap.h"
67 #include "wx/beforestd.h"
73 #include "wx/afterstd.h"
75 #include "wx/wfstream.h"
78 // ----------------------------------------------------------------------------
80 // ----------------------------------------------------------------------------
82 IMPLEMENT_ABSTRACT_CLASS(wxDocument, wxEvtHandler)
83 IMPLEMENT_ABSTRACT_CLASS(wxView, wxEvtHandler)
84 IMPLEMENT_ABSTRACT_CLASS(wxDocTemplate, wxObject)
85 IMPLEMENT_DYNAMIC_CLASS(wxDocManager, wxEvtHandler)
86 IMPLEMENT_CLASS(wxDocChildFrame, wxFrame)
87 IMPLEMENT_CLASS(wxDocParentFrame, wxFrame)
89 #if wxUSE_PRINTING_ARCHITECTURE
90 IMPLEMENT_DYNAMIC_CLASS(wxDocPrintout, wxPrintout)
93 // ============================================================================
95 // ============================================================================
97 // ----------------------------------------------------------------------------
99 // ----------------------------------------------------------------------------
104 wxString FindExtension(const wxString& path)
107 wxFileName::SplitPath(path, NULL, NULL, &ext);
109 // VZ: extensions are considered not case sensitive - is this really a good
111 return ext.MakeLower();
114 } // anonymous namespace
116 // ----------------------------------------------------------------------------
117 // Definition of wxDocument
118 // ----------------------------------------------------------------------------
120 wxDocument::wxDocument(wxDocument *parent)
122 m_documentModified = false;
123 m_documentTemplate = NULL;
125 m_documentParent = parent;
127 parent->m_childDocuments.push_back(this);
129 m_commandProcessor = NULL;
133 bool wxDocument::DeleteContents()
138 wxDocument::~wxDocument()
140 delete m_commandProcessor;
142 if (GetDocumentManager())
143 GetDocumentManager()->RemoveDocument(this);
145 if ( m_documentParent )
146 m_documentParent->m_childDocuments.remove(this);
148 // Not safe to do here, since it'll invoke virtual view functions
149 // expecting to see valid derived objects: and by the time we get here,
150 // we've called destructors higher up.
154 bool wxDocument::Close()
156 if ( !OnSaveModified() )
159 // When the parent document closes, its children must be closed as well as
160 // they can't exist without the parent.
162 // As usual, first check if all children can be closed.
163 DocsList::const_iterator it = m_childDocuments.begin();
164 for ( DocsList::const_iterator end = m_childDocuments.end(); it != end; ++it )
166 if ( !(*it)->OnSaveModified() )
168 // Leave the parent document opened if a child can't close.
173 // Now that they all did, do close them: as m_childDocuments is modified as
174 // we iterate over it, don't use the usual for-style iteration here.
175 while ( !m_childDocuments.empty() )
177 wxDocument * const childDoc = m_childDocuments.front();
179 // This will call OnSaveModified() once again but it shouldn't do
180 // anything as the document was just saved or marked as not needing to
181 // be saved by the call to OnSaveModified() that returned true above.
182 if ( !childDoc->Close() )
184 wxFAIL_MSG( "Closing the child document unexpectedly failed "
185 "after its OnSaveModified() returned true" );
188 // Delete the child document by deleting all its views.
189 childDoc->DeleteAllViews();
193 return OnCloseDocument();
196 bool wxDocument::OnCloseDocument()
198 // Tell all views that we're about to close
205 // Note that this implicitly deletes the document when the last view is
207 bool wxDocument::DeleteAllViews()
209 wxDocManager* manager = GetDocumentManager();
211 // first check if all views agree to be closed
212 const wxList::iterator end = m_documentViews.end();
213 for ( wxList::iterator i = m_documentViews.begin(); i != end; ++i )
215 wxView *view = (wxView *)*i;
216 if ( !view->Close() )
220 // all views agreed to close, now do close them
221 if ( m_documentViews.empty() )
223 // normally the document would be implicitly deleted when the last view
224 // is, but if don't have any views, do it here instead
225 if ( manager && manager->GetDocuments().Member(this) )
230 // as we delete elements we iterate over, don't use the usual "from
231 // begin to end" loop
234 wxView *view = (wxView *)*m_documentViews.begin();
236 bool isLastOne = m_documentViews.size() == 1;
238 // this always deletes the node implicitly and if this is the last
239 // view also deletes this object itself (also implicitly, great),
240 // so we can't test for m_documentViews.empty() after calling this!
251 wxView *wxDocument::GetFirstView() const
253 if ( m_documentViews.empty() )
256 return static_cast<wxView *>(m_documentViews.GetFirst()->GetData());
259 void wxDocument::Modify(bool mod)
261 if (mod != m_documentModified)
263 m_documentModified = mod;
265 // Allow views to append asterix to the title
266 wxView* view = GetFirstView();
267 if (view) view->OnChangeFilename();
271 wxDocManager *wxDocument::GetDocumentManager() const
273 // For child documents we use the same document manager as the parent, even
274 // though we don't have our own template (as children are not opened/saved
276 if ( m_documentParent )
277 return m_documentParent->GetDocumentManager();
279 return m_documentTemplate ? m_documentTemplate->GetDocumentManager() : NULL;
282 bool wxDocument::OnNewDocument()
284 // notice that there is no need to neither reset nor even check the
285 // modified flag here as the document itself is a new object (this is only
286 // called from CreateDocument()) and so it shouldn't be saved anyhow even
287 // if it is modified -- this could happen if the user code creates
288 // documents pre-filled with some user-entered (and which hence must not be
291 SetDocumentSaved(false);
293 const wxString name = GetDocumentManager()->MakeNewDocumentName();
295 SetFilename(name, true);
300 bool wxDocument::Save()
302 if ( AlreadySaved() )
305 if ( m_documentFile.empty() || !m_savedYet )
308 return OnSaveDocument(m_documentFile);
311 bool wxDocument::SaveAs()
313 wxDocTemplate *docTemplate = GetDocumentTemplate();
317 #ifdef wxHAS_MULTIPLE_FILEDLG_FILTERS
318 wxString filter = docTemplate->GetDescription() + wxT(" (") +
319 docTemplate->GetFileFilter() + wxT(")|") +
320 docTemplate->GetFileFilter();
322 // Now see if there are some other template with identical view and document
323 // classes, whose filters may also be used.
324 if (docTemplate->GetViewClassInfo() && docTemplate->GetDocClassInfo())
326 wxList::compatibility_iterator
327 node = docTemplate->GetDocumentManager()->GetTemplates().GetFirst();
330 wxDocTemplate *t = (wxDocTemplate*) node->GetData();
332 if (t->IsVisible() && t != docTemplate &&
333 t->GetViewClassInfo() == docTemplate->GetViewClassInfo() &&
334 t->GetDocClassInfo() == docTemplate->GetDocClassInfo())
336 // add a '|' to separate this filter from the previous one
337 if ( !filter.empty() )
340 filter << t->GetDescription()
341 << wxT(" (") << t->GetFileFilter() << wxT(") |")
342 << t->GetFileFilter();
345 node = node->GetNext();
349 wxString filter = docTemplate->GetFileFilter() ;
352 wxString defaultDir = docTemplate->GetDirectory();
353 if ( defaultDir.empty() )
355 defaultDir = wxPathOnly(GetFilename());
356 if ( defaultDir.empty() )
357 defaultDir = GetDocumentManager()->GetLastDirectory();
360 wxString fileName = wxFileSelector(_("Save As"),
362 wxFileNameFromPath(GetFilename()),
363 docTemplate->GetDefaultExtension(),
365 wxFD_SAVE | wxFD_OVERWRITE_PROMPT,
366 GetDocumentWindow());
368 if (fileName.empty())
369 return false; // cancelled by user
371 // Files that were not saved correctly are not added to the FileHistory.
372 if (!OnSaveDocument(fileName))
375 SetTitle(wxFileNameFromPath(fileName));
376 SetFilename(fileName, true); // will call OnChangeFileName automatically
378 // A file that doesn't use the default extension of its document template
379 // cannot be opened via the FileHistory, so we do not add it.
380 if (docTemplate->FileMatchesTemplate(fileName))
382 GetDocumentManager()->AddFileToHistory(fileName);
384 //else: the user will probably not be able to open the file again, so we
385 // could warn about the wrong file-extension here
390 bool wxDocument::OnSaveDocument(const wxString& file)
395 if ( !DoSaveDocument(file) )
398 if ( m_commandProcessor )
399 m_commandProcessor->MarkAsSaved();
403 SetDocumentSaved(true);
404 #if defined( __WXOSX_MAC__ ) && wxOSX_USE_CARBON
405 wxFileName fn(file) ;
406 fn.MacSetDefaultTypeAndCreator() ;
411 bool wxDocument::OnOpenDocument(const wxString& file)
413 // notice that there is no need to check the modified flag here for the
414 // reasons explained in OnNewDocument()
416 if ( !DoOpenDocument(file) )
419 SetFilename(file, true);
421 // stretching the logic a little this does make sense because the document
422 // had been saved into the file we just loaded it from, it just could have
423 // happened during a previous program execution, it's just that the name of
424 // this method is a bit unfortunate, it should probably have been called
425 // HasAssociatedFileName()
426 SetDocumentSaved(true);
433 #if wxUSE_STD_IOSTREAM
434 wxSTD istream& wxDocument::LoadObject(wxSTD istream& stream)
436 wxInputStream& wxDocument::LoadObject(wxInputStream& stream)
442 #if wxUSE_STD_IOSTREAM
443 wxSTD ostream& wxDocument::SaveObject(wxSTD ostream& stream)
445 wxOutputStream& wxDocument::SaveObject(wxOutputStream& stream)
451 bool wxDocument::Revert()
455 _("Discard changes and reload the last saved version?"),
456 wxTheApp->GetAppDisplayName(),
457 wxYES_NO | wxCANCEL | wxICON_QUESTION,
462 if ( !DoOpenDocument(GetFilename()) )
472 // Get title, or filename if no title, else unnamed
473 #if WXWIN_COMPATIBILITY_2_8
474 bool wxDocument::GetPrintableName(wxString& buf) const
476 // this function cannot only be overridden by the user code but also
477 // called by it so we need to ensure that we return the same thing as
478 // GetUserReadableName() but we can't call it because this would result in
479 // an infinite recursion, hence we use the helper DoGetUserReadableName()
480 buf = DoGetUserReadableName();
484 #endif // WXWIN_COMPATIBILITY_2_8
486 wxString wxDocument::GetUserReadableName() const
488 #if WXWIN_COMPATIBILITY_2_8
489 // we need to call the old virtual function to ensure that the overridden
490 // version of it is still called
492 if ( GetPrintableName(name) )
494 #endif // WXWIN_COMPATIBILITY_2_8
496 return DoGetUserReadableName();
499 wxString wxDocument::DoGetUserReadableName() const
501 if ( !m_documentTitle.empty() )
502 return m_documentTitle;
504 if ( !m_documentFile.empty() )
505 return wxFileNameFromPath(m_documentFile);
510 wxWindow *wxDocument::GetDocumentWindow() const
512 wxView * const view = GetFirstView();
514 return view ? view->GetFrame() : wxTheApp->GetTopWindow();
517 wxCommandProcessor *wxDocument::OnCreateCommandProcessor()
519 return new wxCommandProcessor;
522 // true if safe to close
523 bool wxDocument::OnSaveModified()
527 switch ( wxMessageBox
531 _("Do you want to save changes to %s?"),
532 GetUserReadableName()
534 wxTheApp->GetAppDisplayName(),
535 wxYES_NO | wxCANCEL | wxICON_QUESTION | wxCENTRE
553 bool wxDocument::Draw(wxDC& WXUNUSED(context))
558 bool wxDocument::AddView(wxView *view)
560 if ( !m_documentViews.Member(view) )
562 m_documentViews.Append(view);
568 bool wxDocument::RemoveView(wxView *view)
570 (void)m_documentViews.DeleteObject(view);
575 bool wxDocument::OnCreate(const wxString& WXUNUSED(path), long flags)
577 return GetDocumentTemplate()->CreateView(this, flags) != NULL;
580 // Called after a view is added or removed.
581 // The default implementation deletes the document if
582 // there are no more views.
583 void wxDocument::OnChangedViewList()
585 if ( m_documentViews.empty() && OnSaveModified() )
589 void wxDocument::UpdateAllViews(wxView *sender, wxObject *hint)
591 wxList::compatibility_iterator node = m_documentViews.GetFirst();
594 wxView *view = (wxView *)node->GetData();
596 view->OnUpdate(sender, hint);
597 node = node->GetNext();
601 void wxDocument::NotifyClosing()
603 wxList::compatibility_iterator node = m_documentViews.GetFirst();
606 wxView *view = (wxView *)node->GetData();
607 view->OnClosingDocument();
608 node = node->GetNext();
612 void wxDocument::SetFilename(const wxString& filename, bool notifyViews)
614 m_documentFile = filename;
615 OnChangeFilename(notifyViews);
618 void wxDocument::OnChangeFilename(bool notifyViews)
622 // Notify the views that the filename has changed
623 wxList::compatibility_iterator node = m_documentViews.GetFirst();
626 wxView *view = (wxView *)node->GetData();
627 view->OnChangeFilename();
628 node = node->GetNext();
633 bool wxDocument::DoSaveDocument(const wxString& file)
635 #if wxUSE_STD_IOSTREAM
636 wxSTD ofstream store(file.mb_str(), wxSTD ios::binary);
639 wxFileOutputStream store(file);
640 if ( store.GetLastError() != wxSTREAM_NO_ERROR )
643 wxLogError(_("File \"%s\" could not be opened for writing."), file);
647 if (!SaveObject(store))
649 wxLogError(_("Failed to save document to the file \"%s\"."), file);
656 bool wxDocument::DoOpenDocument(const wxString& file)
658 #if wxUSE_STD_IOSTREAM
659 wxSTD ifstream store(file.mb_str(), wxSTD ios::binary);
662 wxFileInputStream store(file);
663 if (store.GetLastError() != wxSTREAM_NO_ERROR || !store.IsOk())
666 wxLogError(_("File \"%s\" could not be opened for reading."), file);
670 #if wxUSE_STD_IOSTREAM
674 int res = LoadObject(store).GetLastError();
675 if ( res != wxSTREAM_NO_ERROR && res != wxSTREAM_EOF )
678 wxLogError(_("Failed to read document from the file \"%s\"."), file);
686 // ----------------------------------------------------------------------------
688 // ----------------------------------------------------------------------------
692 m_viewDocument = NULL;
696 m_docChildFrame = NULL;
701 if (m_viewDocument && GetDocumentManager())
702 GetDocumentManager()->ActivateView(this, false);
704 // reset our frame view first, before removing it from the document as
705 // SetView(NULL) is a simple call while RemoveView() may result in user
706 // code being executed and this user code can, for example, show a message
707 // box which would result in an activation event for m_docChildFrame and so
708 // could reactivate the view being destroyed -- unless we reset it first
709 if ( m_docChildFrame && m_docChildFrame->GetView() == this )
711 // prevent it from doing anything with us
712 m_docChildFrame->SetView(NULL);
714 // it doesn't make sense to leave the frame alive if its associated
715 // view doesn't exist any more so unconditionally close it as well
717 // notice that we only get here if m_docChildFrame is non-NULL in the
718 // first place and it will be always NULL if we're deleted because our
719 // frame was closed, so this only catches the case of directly deleting
720 // the view, as it happens if its creation fails in wxDocTemplate::
721 // CreateView() for example
722 m_docChildFrame->GetWindow()->Destroy();
725 if ( m_viewDocument )
726 m_viewDocument->RemoveView(this);
729 void wxView::SetDocChildFrame(wxDocChildFrameAnyBase *docChildFrame)
731 SetFrame(docChildFrame ? docChildFrame->GetWindow() : NULL);
732 m_docChildFrame = docChildFrame;
735 bool wxView::TryBefore(wxEvent& event)
737 wxDocument * const doc = GetDocument();
738 return doc && doc->ProcessEventLocally(event);
741 void wxView::OnActivateView(bool WXUNUSED(activate),
742 wxView *WXUNUSED(activeView),
743 wxView *WXUNUSED(deactiveView))
747 void wxView::OnPrint(wxDC *dc, wxObject *WXUNUSED(info))
752 void wxView::OnUpdate(wxView *WXUNUSED(sender), wxObject *WXUNUSED(hint))
756 void wxView::OnChangeFilename()
758 // GetFrame can return wxWindow rather than wxTopLevelWindow due to
759 // generic MDI implementation so use SetLabel rather than SetTitle.
760 // It should cause SetTitle() for top level windows.
761 wxWindow *win = GetFrame();
764 wxDocument *doc = GetDocument();
767 wxString label = doc->GetUserReadableName();
768 if (doc->IsModified())
772 win->SetLabel(label);
775 void wxView::SetDocument(wxDocument *doc)
777 m_viewDocument = doc;
782 bool wxView::Close(bool deleteWindow)
784 return OnClose(deleteWindow);
787 void wxView::Activate(bool activate)
789 if (GetDocument() && GetDocumentManager())
791 OnActivateView(activate, this, GetDocumentManager()->GetCurrentView());
792 GetDocumentManager()->ActivateView(this, activate);
796 bool wxView::OnClose(bool WXUNUSED(deleteWindow))
798 return GetDocument() ? GetDocument()->Close() : true;
801 #if wxUSE_PRINTING_ARCHITECTURE
802 wxPrintout *wxView::OnCreatePrintout()
804 return new wxDocPrintout(this);
806 #endif // wxUSE_PRINTING_ARCHITECTURE
808 // ----------------------------------------------------------------------------
810 // ----------------------------------------------------------------------------
812 wxDocTemplate::wxDocTemplate(wxDocManager *manager,
813 const wxString& descr,
814 const wxString& filter,
817 const wxString& docTypeName,
818 const wxString& viewTypeName,
819 wxClassInfo *docClassInfo,
820 wxClassInfo *viewClassInfo,
823 m_documentManager = manager;
824 m_description = descr;
827 m_fileFilter = filter;
829 m_docTypeName = docTypeName;
830 m_viewTypeName = viewTypeName;
831 m_documentManager->AssociateTemplate(this);
833 m_docClassInfo = docClassInfo;
834 m_viewClassInfo = viewClassInfo;
837 wxDocTemplate::~wxDocTemplate()
839 m_documentManager->DisassociateTemplate(this);
842 // Tries to dynamically construct an object of the right class.
843 wxDocument *wxDocTemplate::CreateDocument(const wxString& path, long flags)
845 // InitDocument() is supposed to delete the document object if its
846 // initialization fails so don't use wxScopedPtr<> here: this is fragile
847 // but unavoidable because the default implementation uses CreateView()
848 // which may -- or not -- create a wxView and if it does create it and its
849 // initialization fails then the view destructor will delete the document
850 // (via RemoveView()) and as we can't distinguish between the two cases we
851 // just have to assume that it always deletes it in case of failure
852 wxDocument * const doc = DoCreateDocument();
854 return doc && InitDocument(doc, path, flags) ? doc : NULL;
858 wxDocTemplate::InitDocument(wxDocument* doc, const wxString& path, long flags)
860 // Normally, if wxDocument::OnCreate() fails, it happens because the view
861 // initialization fails and then the document is destroyed due to the
862 // destruction of its last view. But take into account the (currently
863 // unrealized, AFAICS) possibility of other failures as well and ensure
864 // that the document is always destroyed if it can't be initialized.
867 doc->SetFilename(path);
868 doc->SetDocumentTemplate(this);
869 GetDocumentManager()->AddDocument(doc);
870 doc->SetCommandProcessor(doc->OnCreateCommandProcessor());
872 return doc->OnCreate(path, flags);
875 if ( GetDocumentManager()->GetDocuments().Member(doc) )
876 doc->DeleteAllViews();
881 wxView *wxDocTemplate::CreateView(wxDocument *doc, long flags)
883 wxScopedPtr<wxView> view(DoCreateView());
887 view->SetDocument(doc);
888 if ( !view->OnCreate(doc, flags) )
891 return view.release();
894 // The default (very primitive) format detection: check is the extension is
895 // that of the template
896 bool wxDocTemplate::FileMatchesTemplate(const wxString& path)
898 wxStringTokenizer parser (GetFileFilter(), wxT(";"));
899 wxString anything = wxT ("*");
900 while (parser.HasMoreTokens())
902 wxString filter = parser.GetNextToken();
903 wxString filterExt = FindExtension (filter);
904 if ( filter.IsSameAs (anything) ||
905 filterExt.IsSameAs (anything) ||
906 filterExt.IsSameAs (FindExtension (path)) )
909 return GetDefaultExtension().IsSameAs(FindExtension(path));
912 wxDocument *wxDocTemplate::DoCreateDocument()
917 return static_cast<wxDocument *>(m_docClassInfo->CreateObject());
920 wxView *wxDocTemplate::DoCreateView()
922 if (!m_viewClassInfo)
925 return static_cast<wxView *>(m_viewClassInfo->CreateObject());
928 // ----------------------------------------------------------------------------
930 // ----------------------------------------------------------------------------
932 BEGIN_EVENT_TABLE(wxDocManager, wxEvtHandler)
933 EVT_MENU(wxID_OPEN, wxDocManager::OnFileOpen)
934 EVT_MENU(wxID_CLOSE, wxDocManager::OnFileClose)
935 EVT_MENU(wxID_CLOSE_ALL, wxDocManager::OnFileCloseAll)
936 EVT_MENU(wxID_REVERT, wxDocManager::OnFileRevert)
937 EVT_MENU(wxID_NEW, wxDocManager::OnFileNew)
938 EVT_MENU(wxID_SAVE, wxDocManager::OnFileSave)
939 EVT_MENU(wxID_SAVEAS, wxDocManager::OnFileSaveAs)
940 EVT_MENU(wxID_UNDO, wxDocManager::OnUndo)
941 EVT_MENU(wxID_REDO, wxDocManager::OnRedo)
943 // We don't know in advance how many items can there be in the MRU files
944 // list so set up OnMRUFile() as a handler for all menu events and do the
945 // check for the id of the menu item clicked inside it.
946 EVT_MENU(wxID_ANY, wxDocManager::OnMRUFile)
948 EVT_UPDATE_UI(wxID_OPEN, wxDocManager::OnUpdateFileOpen)
949 EVT_UPDATE_UI(wxID_CLOSE, wxDocManager::OnUpdateDisableIfNoDoc)
950 EVT_UPDATE_UI(wxID_CLOSE_ALL, wxDocManager::OnUpdateDisableIfNoDoc)
951 EVT_UPDATE_UI(wxID_REVERT, wxDocManager::OnUpdateFileRevert)
952 EVT_UPDATE_UI(wxID_NEW, wxDocManager::OnUpdateFileNew)
953 EVT_UPDATE_UI(wxID_SAVE, wxDocManager::OnUpdateFileSave)
954 EVT_UPDATE_UI(wxID_SAVEAS, wxDocManager::OnUpdateFileSaveAs)
955 EVT_UPDATE_UI(wxID_UNDO, wxDocManager::OnUpdateUndo)
956 EVT_UPDATE_UI(wxID_REDO, wxDocManager::OnUpdateRedo)
958 #if wxUSE_PRINTING_ARCHITECTURE
959 EVT_MENU(wxID_PRINT, wxDocManager::OnPrint)
960 EVT_MENU(wxID_PREVIEW, wxDocManager::OnPreview)
961 EVT_MENU(wxID_PRINT_SETUP, wxDocManager::OnPageSetup)
963 EVT_UPDATE_UI(wxID_PRINT, wxDocManager::OnUpdateDisableIfNoDoc)
964 EVT_UPDATE_UI(wxID_PREVIEW, wxDocManager::OnUpdateDisableIfNoDoc)
965 // NB: we keep "Print setup" menu item always enabled as it can be used
966 // even without an active document
967 #endif // wxUSE_PRINTING_ARCHITECTURE
970 wxDocManager* wxDocManager::sm_docManager = NULL;
972 wxDocManager::wxDocManager(long WXUNUSED(flags), bool initialize)
974 sm_docManager = this;
976 m_defaultDocumentNameCounter = 1;
977 m_currentView = NULL;
978 m_maxDocsOpen = INT_MAX;
979 m_fileHistory = NULL;
984 wxDocManager::~wxDocManager()
987 delete m_fileHistory;
988 sm_docManager = NULL;
991 // closes the specified document
992 bool wxDocManager::CloseDocument(wxDocument* doc, bool force)
994 if ( !doc->Close() && !force )
997 // Implicitly deletes the document when
998 // the last view is deleted
999 doc->DeleteAllViews();
1001 // Check we're really deleted
1002 if (m_docs.Member(doc))
1008 bool wxDocManager::CloseDocuments(bool force)
1010 wxList::compatibility_iterator node = m_docs.GetFirst();
1013 wxDocument *doc = (wxDocument *)node->GetData();
1014 wxList::compatibility_iterator next = node->GetNext();
1016 if (!CloseDocument(doc, force))
1019 // This assumes that documents are not connected in
1020 // any way, i.e. deleting one document does NOT
1027 bool wxDocManager::Clear(bool force)
1029 if (!CloseDocuments(force))
1032 m_currentView = NULL;
1034 wxList::compatibility_iterator node = m_templates.GetFirst();
1037 wxDocTemplate *templ = (wxDocTemplate*) node->GetData();
1038 wxList::compatibility_iterator next = node->GetNext();
1045 bool wxDocManager::Initialize()
1047 m_fileHistory = OnCreateFileHistory();
1051 wxString wxDocManager::GetLastDirectory() const
1053 // if we haven't determined the last used directory yet, do it now
1054 if ( m_lastDirectory.empty() )
1056 // we're going to modify m_lastDirectory in this const method, so do it
1057 // via non-const self pointer instead of const this one
1058 wxDocManager * const self = const_cast<wxDocManager *>(this);
1060 // first try to reuse the directory of the most recently opened file:
1061 // this ensures that if the user opens a file, closes the program and
1062 // runs it again the "Open file" dialog will open in the directory of
1063 // the last file he used
1064 if ( m_fileHistory && m_fileHistory->GetCount() )
1066 const wxString lastOpened = m_fileHistory->GetHistoryFile(0);
1067 const wxFileName fn(lastOpened);
1068 if ( fn.DirExists() )
1070 self->m_lastDirectory = fn.GetPath();
1072 //else: should we try the next one?
1074 //else: no history yet
1076 // if we don't have any files in the history (yet?), use the
1077 // system-dependent default location for the document files
1078 if ( m_lastDirectory.empty() )
1080 self->m_lastDirectory = wxStandardPaths::Get().GetAppDocumentsDir();
1084 return m_lastDirectory;
1087 wxFileHistory *wxDocManager::OnCreateFileHistory()
1089 return new wxFileHistory;
1092 void wxDocManager::OnFileClose(wxCommandEvent& WXUNUSED(event))
1094 wxDocument *doc = GetCurrentDocument();
1099 void wxDocManager::OnFileCloseAll(wxCommandEvent& WXUNUSED(event))
1101 CloseDocuments(false);
1104 void wxDocManager::OnFileNew(wxCommandEvent& WXUNUSED(event))
1106 CreateNewDocument();
1109 void wxDocManager::OnFileOpen(wxCommandEvent& WXUNUSED(event))
1111 if ( !CreateDocument("") )
1113 OnOpenFileFailure();
1117 void wxDocManager::OnFileRevert(wxCommandEvent& WXUNUSED(event))
1119 wxDocument *doc = GetCurrentDocument();
1125 void wxDocManager::OnFileSave(wxCommandEvent& WXUNUSED(event))
1127 wxDocument *doc = GetCurrentDocument();
1133 void wxDocManager::OnFileSaveAs(wxCommandEvent& WXUNUSED(event))
1135 wxDocument *doc = GetCurrentDocument();
1141 void wxDocManager::OnMRUFile(wxCommandEvent& event)
1143 // Check if the id is in the range assigned to MRU list entries.
1144 const int id = event.GetId();
1145 if ( id >= wxID_FILE1 &&
1146 id < wxID_FILE1 + static_cast<int>(m_fileHistory->GetCount()) )
1148 DoOpenMRUFile(id - wxID_FILE1);
1156 void wxDocManager::DoOpenMRUFile(unsigned n)
1158 wxString filename(GetHistoryFile(n));
1159 if ( filename.empty() )
1162 wxString errMsg; // must contain exactly one "%s" if non-empty
1163 if ( wxFile::Exists(filename) )
1165 // Try to open it but don't give an error if it failed: this could be
1166 // normal, e.g. because the user cancelled opening it, and we don't
1167 // have any useful information to put in the error message anyhow, so
1168 // we assume that in case of an error the appropriate message had been
1170 (void)CreateDocument(filename, wxDOC_SILENT);
1172 else // file doesn't exist
1174 OnMRUFileNotExist(n, filename);
1178 void wxDocManager::OnMRUFileNotExist(unsigned n, const wxString& filename)
1180 // remove the file which we can't open from the MRU list
1181 RemoveFileFromHistory(n);
1183 // and tell the user about it
1184 wxLogError(_("The file '%s' doesn't exist and couldn't be opened.\n"
1185 "It has been removed from the most recently used files list."),
1189 #if wxUSE_PRINTING_ARCHITECTURE
1191 void wxDocManager::OnPrint(wxCommandEvent& WXUNUSED(event))
1193 wxView *view = GetAnyUsableView();
1197 wxPrintout *printout = view->OnCreatePrintout();
1200 wxPrintDialogData printDialogData(m_pageSetupDialogData.GetPrintData());
1201 wxPrinter printer(&printDialogData);
1202 printer.Print(view->GetFrame(), printout, true);
1208 void wxDocManager::OnPageSetup(wxCommandEvent& WXUNUSED(event))
1210 wxPageSetupDialog dlg(wxTheApp->GetTopWindow(), &m_pageSetupDialogData);
1211 if ( dlg.ShowModal() == wxID_OK )
1213 m_pageSetupDialogData = dlg.GetPageSetupData();
1217 wxPreviewFrame* wxDocManager::CreatePreviewFrame(wxPrintPreviewBase* preview,
1219 const wxString& title)
1221 return new wxPreviewFrame(preview, parent, title);
1224 void wxDocManager::OnPreview(wxCommandEvent& WXUNUSED(event))
1227 wxView *view = GetAnyUsableView();
1231 wxPrintout *printout = view->OnCreatePrintout();
1234 wxPrintDialogData printDialogData(m_pageSetupDialogData.GetPrintData());
1236 // Pass two printout objects: for preview, and possible printing.
1237 wxPrintPreviewBase *
1238 preview = new wxPrintPreview(printout,
1239 view->OnCreatePrintout(),
1241 if ( !preview->IsOk() )
1244 wxLogError(_("Print preview creation failed."));
1248 wxPreviewFrame* frame = CreatePreviewFrame(preview,
1249 wxTheApp->GetTopWindow(),
1250 _("Print Preview"));
1251 wxCHECK_RET( frame, "should create a print preview frame" );
1253 frame->Centre(wxBOTH);
1254 frame->Initialize();
1258 #endif // wxUSE_PRINTING_ARCHITECTURE
1260 void wxDocManager::OnUndo(wxCommandEvent& event)
1262 wxCommandProcessor * const cmdproc = GetCurrentCommandProcessor();
1272 void wxDocManager::OnRedo(wxCommandEvent& event)
1274 wxCommandProcessor * const cmdproc = GetCurrentCommandProcessor();
1284 // Handlers for UI update commands
1286 void wxDocManager::OnUpdateFileOpen(wxUpdateUIEvent& event)
1288 // CreateDocument() (which is called from OnFileOpen) may succeed
1289 // only when there is at least a template:
1290 event.Enable( GetTemplates().GetCount()>0 );
1293 void wxDocManager::OnUpdateDisableIfNoDoc(wxUpdateUIEvent& event)
1295 event.Enable( GetCurrentDocument() != NULL );
1298 void wxDocManager::OnUpdateFileRevert(wxUpdateUIEvent& event)
1300 wxDocument* doc = GetCurrentDocument();
1301 event.Enable(doc && doc->IsModified() && doc->GetDocumentSaved());
1304 void wxDocManager::OnUpdateFileNew(wxUpdateUIEvent& event)
1306 // CreateDocument() (which is called from OnFileNew) may succeed
1307 // only when there is at least a template:
1308 event.Enable( GetTemplates().GetCount()>0 );
1311 void wxDocManager::OnUpdateFileSave(wxUpdateUIEvent& event)
1313 wxDocument * const doc = GetCurrentDocument();
1314 event.Enable( doc && !doc->IsChildDocument() && !doc->AlreadySaved() );
1317 void wxDocManager::OnUpdateFileSaveAs(wxUpdateUIEvent& event)
1319 wxDocument * const doc = GetCurrentDocument();
1320 event.Enable( doc && !doc->IsChildDocument() );
1323 void wxDocManager::OnUpdateUndo(wxUpdateUIEvent& event)
1325 wxCommandProcessor * const cmdproc = GetCurrentCommandProcessor();
1328 // If we don't have any document at all, the menu item should really be
1330 if ( !GetCurrentDocument() )
1331 event.Enable(false);
1332 else // But if we do have it, it might handle wxID_UNDO on its own
1336 event.Enable(cmdproc->CanUndo());
1337 cmdproc->SetMenuStrings();
1340 void wxDocManager::OnUpdateRedo(wxUpdateUIEvent& event)
1342 wxCommandProcessor * const cmdproc = GetCurrentCommandProcessor();
1345 // Use same logic as in OnUpdateUndo() above.
1346 if ( !GetCurrentDocument() )
1347 event.Enable(false);
1352 event.Enable(cmdproc->CanRedo());
1353 cmdproc->SetMenuStrings();
1356 wxView *wxDocManager::GetAnyUsableView() const
1358 wxView *view = GetCurrentView();
1360 if ( !view && !m_docs.empty() )
1362 // if we have exactly one document, consider its view to be the current
1365 // VZ: I'm not exactly sure why is this needed but this is how this
1366 // code used to behave before the bug #9518 was fixed and it seems
1367 // safer to preserve the old logic
1368 wxList::compatibility_iterator node = m_docs.GetFirst();
1369 if ( !node->GetNext() )
1371 wxDocument *doc = static_cast<wxDocument *>(node->GetData());
1372 view = doc->GetFirstView();
1374 //else: we have more than one document
1380 bool wxDocManager::TryBefore(wxEvent& event)
1382 wxView * const view = GetAnyUsableView();
1383 return view && view->ProcessEventLocally(event);
1389 // helper function: return only the visible templates
1390 wxDocTemplateVector GetVisibleTemplates(const wxList& allTemplates)
1392 // select only the visible templates
1393 const size_t totalNumTemplates = allTemplates.GetCount();
1394 wxDocTemplateVector templates;
1395 if ( totalNumTemplates )
1397 templates.reserve(totalNumTemplates);
1399 for ( wxList::const_iterator i = allTemplates.begin(),
1400 end = allTemplates.end();
1404 wxDocTemplate * const temp = (wxDocTemplate *)*i;
1405 if ( temp->IsVisible() )
1406 templates.push_back(temp);
1413 } // anonymous namespace
1415 void wxDocument::Activate()
1417 wxView * const view = GetFirstView();
1421 view->Activate(true);
1422 if ( wxWindow *win = view->GetFrame() )
1426 wxDocument* wxDocManager::FindDocumentByPath(const wxString& path) const
1428 const wxFileName fileName(path);
1429 for ( wxList::const_iterator i = m_docs.begin(); i != m_docs.end(); ++i )
1431 wxDocument * const doc = wxStaticCast(*i, wxDocument);
1433 if ( fileName == wxFileName(doc->GetFilename()) )
1439 wxDocument *wxDocManager::CreateDocument(const wxString& pathOrig, long flags)
1441 // this ought to be const but SelectDocumentType/Path() are not
1442 // const-correct and can't be changed as, being virtual, this risks
1443 // breaking user code overriding them
1444 wxDocTemplateVector templates(GetVisibleTemplates(m_templates));
1445 const size_t numTemplates = templates.size();
1446 if ( !numTemplates )
1448 // no templates can be used, can't create document
1453 // normally user should select the template to use but wxDOC_SILENT flag we
1454 // choose one ourselves
1455 wxString path = pathOrig; // may be modified below
1456 wxDocTemplate *temp;
1457 if ( flags & wxDOC_SILENT )
1459 wxASSERT_MSG( !path.empty(),
1460 "using empty path with wxDOC_SILENT doesn't make sense" );
1462 temp = FindTemplateForPath(path);
1465 wxLogWarning(_("The format of file '%s' couldn't be determined."),
1469 else // not silent, ask the user
1471 // for the new file we need just the template, for an existing one we
1472 // need the template and the path, unless it's already specified
1473 if ( (flags & wxDOC_NEW) || !path.empty() )
1474 temp = SelectDocumentType(&templates[0], numTemplates);
1476 temp = SelectDocumentPath(&templates[0], numTemplates, path, flags);
1482 // check whether the document with this path is already opened
1483 if ( !path.empty() )
1485 wxDocument * const doc = FindDocumentByPath(path);
1488 // file already open, just activate it and return
1494 // no, we need to create a new document
1497 // if we've reached the max number of docs, close the first one.
1498 if ( (int)GetDocuments().GetCount() >= m_maxDocsOpen )
1500 if ( !CloseDocument((wxDocument *)GetDocuments().GetFirst()->GetData()) )
1502 // can't open the new document if closing the old one failed
1508 // do create and initialize the new document finally
1509 wxDocument * const docNew = temp->CreateDocument(path, flags);
1513 docNew->SetDocumentName(temp->GetDocumentName());
1517 // call the appropriate function depending on whether we're creating a
1518 // new file or opening an existing one
1519 if ( !(flags & wxDOC_NEW ? docNew->OnNewDocument()
1520 : docNew->OnOpenDocument(path)) )
1522 docNew->DeleteAllViews();
1526 wxCATCH_ALL( docNew->DeleteAllViews(); throw; )
1528 // add the successfully opened file to MRU, but only if we're going to be
1529 // able to reopen it successfully later which requires the template for
1530 // this document to be retrievable from the file extension
1531 if ( !(flags & wxDOC_NEW) && temp->FileMatchesTemplate(path) )
1532 AddFileToHistory(path);
1534 // at least under Mac (where views are top level windows) it seems to be
1535 // necessary to manually activate the new document to bring it to the
1536 // forefront -- and it shouldn't hurt doing this under the other platforms
1542 wxView *wxDocManager::CreateView(wxDocument *doc, long flags)
1544 wxDocTemplateVector templates(GetVisibleTemplates(m_templates));
1545 const size_t numTemplates = templates.size();
1547 if ( numTemplates == 0 )
1550 wxDocTemplate * const
1551 temp = numTemplates == 1 ? templates[0]
1552 : SelectViewType(&templates[0], numTemplates);
1557 wxView *view = temp->CreateView(doc, flags);
1559 view->SetViewName(temp->GetViewName());
1563 // Not yet implemented
1565 wxDocManager::DeleteTemplate(wxDocTemplate *WXUNUSED(temp), long WXUNUSED(flags))
1569 // Not yet implemented
1570 bool wxDocManager::FlushDoc(wxDocument *WXUNUSED(doc))
1575 wxDocument *wxDocManager::GetCurrentDocument() const
1577 wxView * const view = GetAnyUsableView();
1578 return view ? view->GetDocument() : NULL;
1581 wxCommandProcessor *wxDocManager::GetCurrentCommandProcessor() const
1583 wxDocument * const doc = GetCurrentDocument();
1584 return doc ? doc->GetCommandProcessor() : NULL;
1587 // Make a default name for a new document
1588 #if WXWIN_COMPATIBILITY_2_8
1589 bool wxDocManager::MakeDefaultName(wxString& WXUNUSED(name))
1591 // we consider that this function can only be overridden by the user code,
1592 // not called by it as it only makes sense to call it internally, so we
1593 // don't bother to return anything from here
1596 #endif // WXWIN_COMPATIBILITY_2_8
1598 wxString wxDocManager::MakeNewDocumentName()
1602 #if WXWIN_COMPATIBILITY_2_8
1603 if ( !MakeDefaultName(name) )
1604 #endif // WXWIN_COMPATIBILITY_2_8
1606 name.Printf(_("unnamed%d"), m_defaultDocumentNameCounter);
1607 m_defaultDocumentNameCounter++;
1613 // Make a frame title (override this to do something different)
1614 // If docName is empty, a document is not currently active.
1615 wxString wxDocManager::MakeFrameTitle(wxDocument* doc)
1617 wxString appName = wxTheApp->GetAppDisplayName();
1623 wxString docName = doc->GetUserReadableName();
1624 title = docName + wxString(_(" - ")) + appName;
1630 // Not yet implemented
1631 wxDocTemplate *wxDocManager::MatchTemplate(const wxString& WXUNUSED(path))
1636 // File history management
1637 void wxDocManager::AddFileToHistory(const wxString& file)
1640 m_fileHistory->AddFileToHistory(file);
1643 void wxDocManager::RemoveFileFromHistory(size_t i)
1646 m_fileHistory->RemoveFileFromHistory(i);
1649 wxString wxDocManager::GetHistoryFile(size_t i) const
1654 histFile = m_fileHistory->GetHistoryFile(i);
1659 void wxDocManager::FileHistoryUseMenu(wxMenu *menu)
1662 m_fileHistory->UseMenu(menu);
1665 void wxDocManager::FileHistoryRemoveMenu(wxMenu *menu)
1668 m_fileHistory->RemoveMenu(menu);
1672 void wxDocManager::FileHistoryLoad(const wxConfigBase& config)
1675 m_fileHistory->Load(config);
1678 void wxDocManager::FileHistorySave(wxConfigBase& config)
1681 m_fileHistory->Save(config);
1685 void wxDocManager::FileHistoryAddFilesToMenu(wxMenu* menu)
1688 m_fileHistory->AddFilesToMenu(menu);
1691 void wxDocManager::FileHistoryAddFilesToMenu()
1694 m_fileHistory->AddFilesToMenu();
1697 size_t wxDocManager::GetHistoryFilesCount() const
1699 return m_fileHistory ? m_fileHistory->GetCount() : 0;
1703 // Find out the document template via matching in the document file format
1704 // against that of the template
1705 wxDocTemplate *wxDocManager::FindTemplateForPath(const wxString& path)
1707 wxDocTemplate *theTemplate = NULL;
1709 // Find the template which this extension corresponds to
1710 for (size_t i = 0; i < m_templates.GetCount(); i++)
1712 wxDocTemplate *temp = (wxDocTemplate *)m_templates.Item(i)->GetData();
1713 if ( temp->FileMatchesTemplate(path) )
1722 // Prompts user to open a file, using file specs in templates.
1723 // Must extend the file selector dialog or implement own; OR
1724 // match the extension to the template extension.
1726 wxDocTemplate *wxDocManager::SelectDocumentPath(wxDocTemplate **templates,
1729 long WXUNUSED(flags),
1730 bool WXUNUSED(save))
1732 #ifdef wxHAS_MULTIPLE_FILEDLG_FILTERS
1735 for (int i = 0; i < noTemplates; i++)
1737 if (templates[i]->IsVisible())
1739 // add a '|' to separate this filter from the previous one
1740 if ( !descrBuf.empty() )
1741 descrBuf << wxT('|');
1743 descrBuf << templates[i]->GetDescription()
1744 << wxT(" (") << templates[i]->GetFileFilter() << wxT(") |")
1745 << templates[i]->GetFileFilter();
1749 wxString descrBuf = wxT("*.*");
1750 wxUnusedVar(noTemplates);
1753 int FilterIndex = -1;
1755 wxString pathTmp = wxFileSelectorEx(_("Open File"),
1760 wxFD_OPEN | wxFD_FILE_MUST_EXIST);
1762 wxDocTemplate *theTemplate = NULL;
1763 if (!pathTmp.empty())
1765 if (!wxFileExists(pathTmp))
1768 if (!wxTheApp->GetAppDisplayName().empty())
1769 msgTitle = wxTheApp->GetAppDisplayName();
1771 msgTitle = wxString(_("File error"));
1773 wxMessageBox(_("Sorry, could not open this file."),
1775 wxOK | wxICON_EXCLAMATION | wxCENTRE);
1777 path = wxEmptyString;
1781 SetLastDirectory(wxPathOnly(pathTmp));
1785 // first choose the template using the extension, if this fails (i.e.
1786 // wxFileSelectorEx() didn't fill it), then use the path
1787 if ( FilterIndex != -1 )
1788 theTemplate = templates[FilterIndex];
1790 theTemplate = FindTemplateForPath(path);
1793 // Since we do not add files with non-default extensions to the
1794 // file history this can only happen if the application changes the
1795 // allowed templates in runtime.
1796 wxMessageBox(_("Sorry, the format for this file is unknown."),
1798 wxOK | wxICON_EXCLAMATION | wxCENTRE);
1809 wxDocTemplate *wxDocManager::SelectDocumentType(wxDocTemplate **templates,
1810 int noTemplates, bool sort)
1812 wxArrayString strings;
1813 wxScopedArray<wxDocTemplate *> data(new wxDocTemplate *[noTemplates]);
1817 for (i = 0; i < noTemplates; i++)
1819 if (templates[i]->IsVisible())
1823 for (j = 0; j < n; j++)
1825 //filter out NOT unique documents + view combinations
1826 if ( templates[i]->m_docTypeName == data[j]->m_docTypeName &&
1827 templates[i]->m_viewTypeName == data[j]->m_viewTypeName
1834 strings.Add(templates[i]->m_description);
1836 data[n] = templates[i];
1844 strings.Sort(); // ascending sort
1845 // Yes, this will be slow, but template lists
1846 // are typically short.
1848 n = strings.Count();
1849 for (i = 0; i < n; i++)
1851 for (j = 0; j < noTemplates; j++)
1853 if (strings[i] == templates[j]->m_description)
1854 data[i] = templates[j];
1859 wxDocTemplate *theTemplate;
1864 // no visible templates, hence nothing to choose from
1869 // don't propose the user to choose if he has no choice
1870 theTemplate = data[0];
1874 // propose the user to choose one of several
1875 theTemplate = (wxDocTemplate *)wxGetSingleChoiceData
1877 _("Select a document template"),
1887 wxDocTemplate *wxDocManager::SelectViewType(wxDocTemplate **templates,
1888 int noTemplates, bool sort)
1890 wxArrayString strings;
1891 wxScopedArray<wxDocTemplate *> data(new wxDocTemplate *[noTemplates]);
1895 for (i = 0; i < noTemplates; i++)
1897 wxDocTemplate *templ = templates[i];
1898 if ( templ->IsVisible() && !templ->GetViewName().empty() )
1902 for (j = 0; j < n; j++)
1904 //filter out NOT unique views
1905 if ( templates[i]->m_viewTypeName == data[j]->m_viewTypeName )
1911 strings.Add(templ->m_viewTypeName);
1920 strings.Sort(); // ascending sort
1921 // Yes, this will be slow, but template lists
1922 // are typically short.
1924 n = strings.Count();
1925 for (i = 0; i < n; i++)
1927 for (j = 0; j < noTemplates; j++)
1929 if (strings[i] == templates[j]->m_viewTypeName)
1930 data[i] = templates[j];
1935 wxDocTemplate *theTemplate;
1937 // the same logic as above
1945 theTemplate = data[0];
1949 theTemplate = (wxDocTemplate *)wxGetSingleChoiceData
1951 _("Select a document view"),
1962 void wxDocManager::AssociateTemplate(wxDocTemplate *temp)
1964 if (!m_templates.Member(temp))
1965 m_templates.Append(temp);
1968 void wxDocManager::DisassociateTemplate(wxDocTemplate *temp)
1970 m_templates.DeleteObject(temp);
1973 wxDocTemplate* wxDocManager::FindTemplate(const wxClassInfo* classinfo)
1975 for ( wxList::compatibility_iterator node = m_templates.GetFirst();
1977 node = node->GetNext() )
1979 wxDocTemplate* t = wxStaticCast(node->GetData(), wxDocTemplate);
1980 if ( t->GetDocClassInfo() == classinfo )
1987 // Add and remove a document from the manager's list
1988 void wxDocManager::AddDocument(wxDocument *doc)
1990 if (!m_docs.Member(doc))
1994 void wxDocManager::RemoveDocument(wxDocument *doc)
1996 m_docs.DeleteObject(doc);
1999 // Views or windows should inform the document manager
2000 // when a view is going in or out of focus
2001 void wxDocManager::ActivateView(wxView *view, bool activate)
2005 m_currentView = view;
2009 if ( m_currentView == view )
2011 // don't keep stale pointer
2012 m_currentView = NULL;
2017 // ----------------------------------------------------------------------------
2018 // wxDocChildFrameAnyBase
2019 // ----------------------------------------------------------------------------
2021 bool wxDocChildFrameAnyBase::TryProcessEvent(wxEvent& event)
2025 // We must be being destroyed, don't forward events anywhere as
2026 // m_childDocument could be invalid by now.
2030 // Store a (non-owning) pointer to the last processed event here to be able
2031 // to recognize this event again if it bubbles up to the parent frame, see
2032 // the code in wxDocParentFrameAnyBase::TryProcessEvent().
2033 m_lastEvent = &event;
2035 // Forward the event to the document manager which will, in turn, forward
2036 // it to its active view which must be our m_childView.
2038 // Notice that we do things in this roundabout way to guarantee the correct
2039 // event handlers call order: first the document, then the view and then the
2040 // document manager itself. And if we forwarded the event directly to the
2041 // view, then the document manager would do it once again when we forwarded
2043 return m_childDocument->GetDocumentManager()->ProcessEventLocally(event);
2046 bool wxDocChildFrameAnyBase::CloseView(wxCloseEvent& event)
2050 // notice that we must call wxView::Close() and OnClose() called from
2051 // it in any case, even if we know that we are going to close anyhow
2052 if ( !m_childView->Close(false) && event.CanVeto() )
2058 m_childView->Activate(false);
2060 // it is important to reset m_childView frame pointer to NULL before
2061 // deleting it because while normally it is the frame which deletes the
2062 // view when it's closed, the view also closes the frame if it is
2063 // deleted directly not by us as indicated by its doc child frame
2064 // pointer still being set
2065 m_childView->SetDocChildFrame(NULL);
2067 // 2014.11.15. Toshi Nagata
2068 // m_childView should be set to NULL _really_ before deleting it
2069 // wxDELETE(m_childView);
2070 wxView *childView = m_childView;
2072 wxDELETE(childView);
2076 m_childDocument = NULL;
2081 // ----------------------------------------------------------------------------
2082 // wxDocParentFrameAnyBase
2083 // ----------------------------------------------------------------------------
2085 bool wxDocParentFrameAnyBase::TryProcessEvent(wxEvent& event)
2087 if ( !m_docManager )
2090 // If we have an active view, its associated child frame may have
2091 // already forwarded the event to wxDocManager, check for this:
2092 if ( wxView* const view = m_docManager->GetAnyUsableView() )
2094 wxDocChildFrameAnyBase* const childFrame = view->GetDocChildFrame();
2095 if ( childFrame && childFrame->HasAlreadyProcessed(event) )
2099 // But forward the event to wxDocManager ourselves if there are no views at
2100 // all or if this event hadn't been sent to the child frame previously.
2101 return m_docManager->ProcessEventLocally(event);
2104 // ----------------------------------------------------------------------------
2106 // ----------------------------------------------------------------------------
2108 #if wxUSE_PRINTING_ARCHITECTURE
2113 wxString GetAppropriateTitle(const wxView *view, const wxString& titleGiven)
2115 wxString title(titleGiven);
2116 if ( title.empty() )
2118 if ( view && view->GetDocument() )
2119 title = view->GetDocument()->GetUserReadableName();
2121 title = _("Printout");
2127 } // anonymous namespace
2129 wxDocPrintout::wxDocPrintout(wxView *view, const wxString& title)
2130 : wxPrintout(GetAppropriateTitle(view, title))
2132 m_printoutView = view;
2135 bool wxDocPrintout::OnPrintPage(int WXUNUSED(page))
2139 // Get the logical pixels per inch of screen and printer
2140 int ppiScreenX, ppiScreenY;
2141 GetPPIScreen(&ppiScreenX, &ppiScreenY);
2142 wxUnusedVar(ppiScreenY);
2143 int ppiPrinterX, ppiPrinterY;
2144 GetPPIPrinter(&ppiPrinterX, &ppiPrinterY);
2145 wxUnusedVar(ppiPrinterY);
2147 // This scales the DC so that the printout roughly represents the
2148 // the screen scaling. The text point size _should_ be the right size
2149 // but in fact is too small for some reason. This is a detail that will
2150 // need to be addressed at some point but can be fudged for the
2152 float scale = (float)((float)ppiPrinterX/(float)ppiScreenX);
2154 // Now we have to check in case our real page size is reduced
2155 // (e.g. because we're drawing to a print preview memory DC)
2156 int pageWidth, pageHeight;
2158 dc->GetSize(&w, &h);
2159 GetPageSizePixels(&pageWidth, &pageHeight);
2160 wxUnusedVar(pageHeight);
2162 // If printer pageWidth == current DC width, then this doesn't
2163 // change. But w might be the preview bitmap width, so scale down.
2164 float overallScale = scale * (float)(w/(float)pageWidth);
2165 dc->SetUserScale(overallScale, overallScale);
2169 m_printoutView->OnDraw(dc);
2174 bool wxDocPrintout::HasPage(int pageNum)
2176 return (pageNum == 1);
2179 bool wxDocPrintout::OnBeginDocument(int startPage, int endPage)
2181 if (!wxPrintout::OnBeginDocument(startPage, endPage))
2187 void wxDocPrintout::GetPageInfo(int *minPage, int *maxPage,
2188 int *selPageFrom, int *selPageTo)
2196 #endif // wxUSE_PRINTING_ARCHITECTURE
2198 // ----------------------------------------------------------------------------
2199 // Permits compatibility with existing file formats and functions that
2200 // manipulate files directly
2201 // ----------------------------------------------------------------------------
2203 #if wxUSE_STD_IOSTREAM
2205 bool wxTransferFileToStream(const wxString& filename, wxSTD ostream& stream)
2208 wxFFile file(filename, wxT("rb"));
2210 wxFile file(filename, wxFile::read);
2212 if ( !file.IsOpened() )
2220 nRead = file.Read(buf, WXSIZEOF(buf));
2224 stream.write(buf, nRead);
2228 while ( !file.Eof() );
2233 bool wxTransferStreamToFile(wxSTD istream& stream, const wxString& filename)
2236 wxFFile file(filename, wxT("wb"));
2238 wxFile file(filename, wxFile::write);
2240 if ( !file.IsOpened() )
2246 stream.read(buf, WXSIZEOF(buf));
2247 if ( !stream.bad() ) // fail may be set on EOF, don't use operator!()
2249 if ( !file.Write(buf, stream.gcount()) )
2253 while ( !stream.eof() );
2258 #else // !wxUSE_STD_IOSTREAM
2260 bool wxTransferFileToStream(const wxString& filename, wxOutputStream& stream)
2263 wxFFile file(filename, wxT("rb"));
2265 wxFile file(filename, wxFile::read);
2267 if ( !file.IsOpened() )
2275 nRead = file.Read(buf, WXSIZEOF(buf));
2279 stream.Write(buf, nRead);
2283 while ( !file.Eof() );
2288 bool wxTransferStreamToFile(wxInputStream& stream, const wxString& filename)
2291 wxFFile file(filename, wxT("wb"));
2293 wxFile file(filename, wxFile::write);
2295 if ( !file.IsOpened() )
2301 stream.Read(buf, WXSIZEOF(buf));
2303 const size_t nRead = stream.LastRead();
2312 if ( !file.Write(buf, nRead) )
2319 #endif // wxUSE_STD_IOSTREAM/!wxUSE_STD_IOSTREAM
2321 #endif // wxUSE_DOC_VIEW_ARCHITECTURE