1 /////////////////////////////////////////////////////////////////////////////
2 // Name: src/common/docview.cpp
3 // Purpose: Document/view classes
4 // Author: Julian Smart
5 // Modified by: Vadim Zeitlin
8 // Copyright: (c) Julian Smart
9 // Licence: wxWindows licence
10 /////////////////////////////////////////////////////////////////////////////
12 // ============================================================================
14 // ============================================================================
16 // ----------------------------------------------------------------------------
18 // ----------------------------------------------------------------------------
20 // For compilers that support precompilation, includes "wx.h".
21 #include "wx/wxprec.h"
27 #if wxUSE_DOC_VIEW_ARCHITECTURE
29 #include "wx/docview.h"
33 #include "wx/string.h"
37 #include "wx/dialog.h"
39 #include "wx/filedlg.h"
42 #include "wx/msgdlg.h"
44 #include "wx/choicdlg.h"
47 #if wxUSE_PRINTING_ARCHITECTURE
48 #include "wx/prntbase.h"
49 #include "wx/printdlg.h"
52 #include "wx/confbase.h"
53 #include "wx/filename.h"
56 #include "wx/cmdproc.h"
57 #include "wx/tokenzr.h"
58 #include "wx/filename.h"
59 #include "wx/stdpaths.h"
60 #include "wx/vector.h"
61 #include "wx/scopedarray.h"
62 #include "wx/scopedptr.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 typedef wxVector
<wxDocTemplate
*> wxDocTemplates
;
80 // ----------------------------------------------------------------------------
82 // ----------------------------------------------------------------------------
84 IMPLEMENT_ABSTRACT_CLASS(wxDocument
, wxEvtHandler
)
85 IMPLEMENT_ABSTRACT_CLASS(wxView
, wxEvtHandler
)
86 IMPLEMENT_ABSTRACT_CLASS(wxDocTemplate
, wxObject
)
87 IMPLEMENT_DYNAMIC_CLASS(wxDocManager
, wxEvtHandler
)
88 IMPLEMENT_CLASS(wxDocChildFrame
, wxFrame
)
89 IMPLEMENT_CLASS(wxDocParentFrame
, wxFrame
)
91 #if wxUSE_PRINTING_ARCHITECTURE
92 IMPLEMENT_DYNAMIC_CLASS(wxDocPrintout
, wxPrintout
)
95 IMPLEMENT_DYNAMIC_CLASS(wxFileHistory
, wxObject
)
97 // ============================================================================
99 // ============================================================================
101 // ----------------------------------------------------------------------------
103 // ----------------------------------------------------------------------------
108 wxWindow
*wxFindSuitableParent()
110 wxWindow
* const win
= wxGetTopLevelParent(wxWindow::FindFocus());
112 return win
? win
: wxTheApp
->GetTopWindow();
115 wxString
FindExtension(const wxString
& path
)
118 wxFileName::SplitPath(path
, NULL
, NULL
, &ext
);
120 // VZ: extensions are considered not case sensitive - is this really a good
122 return ext
.MakeLower();
125 // return the string used for the MRU list items in the menu
127 // NB: the index n is 0-based, as usual, but the strings start from 1
128 wxString
GetMRUEntryLabel(int n
, const wxString
& path
)
130 // we need to quote '&' characters which are used for mnemonics
131 wxString
pathInMenu(path
);
132 pathInMenu
.Replace("&", "&&");
134 return wxString::Format("&%d %s", n
+ 1, pathInMenu
);
137 } // anonymous namespace
139 // ----------------------------------------------------------------------------
140 // Definition of wxDocument
141 // ----------------------------------------------------------------------------
143 wxDocument::wxDocument(wxDocument
*parent
)
145 m_documentModified
= false;
146 m_documentParent
= parent
;
147 m_documentTemplate
= NULL
;
148 m_commandProcessor
= NULL
;
152 bool wxDocument::DeleteContents()
157 wxDocument::~wxDocument()
161 delete m_commandProcessor
;
163 if (GetDocumentManager())
164 GetDocumentManager()->RemoveDocument(this);
166 // Not safe to do here, since it'll invoke virtual view functions
167 // expecting to see valid derived objects: and by the time we get here,
168 // we've called destructors higher up.
172 bool wxDocument::Close()
174 if ( !OnSaveModified() )
177 return OnCloseDocument();
180 bool wxDocument::OnCloseDocument()
182 // Tell all views that we're about to close
189 // Note that this implicitly deletes the document when the last view is
191 bool wxDocument::DeleteAllViews()
193 wxDocManager
* manager
= GetDocumentManager();
195 // first check if all views agree to be closed
196 const wxList::iterator end
= m_documentViews
.end();
197 for ( wxList::iterator i
= m_documentViews
.begin(); i
!= end
; ++i
)
199 wxView
*view
= (wxView
*)*i
;
200 if ( !view
->Close() )
204 // all views agreed to close, now do close them
205 if ( m_documentViews
.empty() )
207 // normally the document would be implicitly deleted when the last view
208 // is, but if don't have any views, do it here instead
209 if ( manager
&& manager
->GetDocuments().Member(this) )
214 // as we delete elements we iterate over, don't use the usual "from
215 // begin to end" loop
218 wxView
*view
= (wxView
*)*m_documentViews
.begin();
220 bool isLastOne
= m_documentViews
.size() == 1;
222 // this always deletes the node implicitly and if this is the last
223 // view also deletes this object itself (also implicitly, great),
224 // so we can't test for m_documentViews.empty() after calling this!
235 wxView
*wxDocument::GetFirstView() const
237 if ( m_documentViews
.empty() )
240 return static_cast<wxView
*>(m_documentViews
.GetFirst()->GetData());
243 wxDocManager
*wxDocument::GetDocumentManager() const
245 return m_documentTemplate
? m_documentTemplate
->GetDocumentManager() : NULL
;
248 bool wxDocument::OnNewDocument()
250 // notice that there is no need to neither reset nor even check the
251 // modified flag here as the document itself is a new object (this is only
252 // called from CreateDocument()) and so it shouldn't be saved anyhow even
253 // if it is modified -- this could happen if the user code creates
254 // documents pre-filled with some user-entered (and which hence must not be
257 SetDocumentSaved(false);
259 const wxString name
= GetDocumentManager()->MakeNewDocumentName();
261 SetFilename(name
, true);
266 bool wxDocument::Save()
268 if ( AlreadySaved() )
271 if ( m_documentFile
.empty() || !m_savedYet
)
274 return OnSaveDocument(m_documentFile
);
277 bool wxDocument::SaveAs()
279 wxDocTemplate
*docTemplate
= GetDocumentTemplate();
283 #ifdef wxHAS_MULTIPLE_FILEDLG_FILTERS
284 wxString filter
= docTemplate
->GetDescription() + wxT(" (") +
285 docTemplate
->GetFileFilter() + wxT(")|") +
286 docTemplate
->GetFileFilter();
288 // Now see if there are some other template with identical view and document
289 // classes, whose filters may also be used.
290 if (docTemplate
->GetViewClassInfo() && docTemplate
->GetDocClassInfo())
292 wxList::compatibility_iterator
293 node
= docTemplate
->GetDocumentManager()->GetTemplates().GetFirst();
296 wxDocTemplate
*t
= (wxDocTemplate
*) node
->GetData();
298 if (t
->IsVisible() && t
!= docTemplate
&&
299 t
->GetViewClassInfo() == docTemplate
->GetViewClassInfo() &&
300 t
->GetDocClassInfo() == docTemplate
->GetDocClassInfo())
302 // add a '|' to separate this filter from the previous one
303 if ( !filter
.empty() )
306 filter
<< t
->GetDescription()
307 << wxT(" (") << t
->GetFileFilter() << wxT(") |")
308 << t
->GetFileFilter();
311 node
= node
->GetNext();
315 wxString filter
= docTemplate
->GetFileFilter() ;
318 wxString defaultDir
= docTemplate
->GetDirectory();
319 if ( defaultDir
.empty() )
321 defaultDir
= wxPathOnly(GetFilename());
322 if ( defaultDir
.empty() )
323 defaultDir
= GetDocumentManager()->GetLastDirectory();
326 wxString fileName
= wxFileSelector(_("Save As"),
328 wxFileNameFromPath(GetFilename()),
329 docTemplate
->GetDefaultExtension(),
331 wxFD_SAVE
| wxFD_OVERWRITE_PROMPT
,
332 GetDocumentWindow());
334 if (fileName
.empty())
335 return false; // cancelled by user
338 wxFileName::SplitPath(fileName
, NULL
, NULL
, &ext
);
342 fileName
+= wxT(".");
343 fileName
+= docTemplate
->GetDefaultExtension();
346 // Files that were not saved correctly are not added to the FileHistory.
347 if (!OnSaveDocument(fileName
))
350 SetTitle(wxFileNameFromPath(fileName
));
351 SetFilename(fileName
, true); // will call OnChangeFileName automatically
353 // A file that doesn't use the default extension of its document template
354 // cannot be opened via the FileHistory, so we do not add it.
355 if (docTemplate
->FileMatchesTemplate(fileName
))
357 GetDocumentManager()->AddFileToHistory(fileName
);
359 //else: the user will probably not be able to open the file again, so we
360 // could warn about the wrong file-extension here
365 bool wxDocument::OnSaveDocument(const wxString
& file
)
370 if ( !DoSaveDocument(file
) )
375 SetDocumentSaved(true);
376 #if defined( __WXOSX_MAC__ ) && wxOSX_USE_CARBON
377 wxFileName
fn(file
) ;
378 fn
.MacSetDefaultTypeAndCreator() ;
383 bool wxDocument::OnOpenDocument(const wxString
& file
)
385 // notice that there is no need to check the modified flag here for the
386 // reasons explained in OnNewDocument()
388 if ( !DoOpenDocument(file
) )
391 SetFilename(file
, true);
393 // stretching the logic a little this does make sense because the document
394 // had been saved into the file we just loaded it from, it just could have
395 // happened during a previous program execution, it's just that the name of
396 // this method is a bit unfortunate, it should probably have been called
397 // HasAssociatedFileName()
398 SetDocumentSaved(true);
405 #if wxUSE_STD_IOSTREAM
406 wxSTD istream
& wxDocument::LoadObject(wxSTD istream
& stream
)
408 wxInputStream
& wxDocument::LoadObject(wxInputStream
& stream
)
414 #if wxUSE_STD_IOSTREAM
415 wxSTD ostream
& wxDocument::SaveObject(wxSTD ostream
& stream
)
417 wxOutputStream
& wxDocument::SaveObject(wxOutputStream
& stream
)
423 bool wxDocument::Revert()
429 // Get title, or filename if no title, else unnamed
430 #if WXWIN_COMPATIBILITY_2_8
431 bool wxDocument::GetPrintableName(wxString
& buf
) const
433 // this function can not only be overridden by the user code but also
434 // called by it so we need to ensure that we return the same thing as
435 // GetUserReadableName() but we can't call it because this would result in
436 // an infinite recursion, hence we use the helper DoGetUserReadableName()
437 buf
= DoGetUserReadableName();
441 #endif // WXWIN_COMPATIBILITY_2_8
443 wxString
wxDocument::GetUserReadableName() const
445 #if WXWIN_COMPATIBILITY_2_8
446 // we need to call the old virtual function to ensure that the overridden
447 // version of it is still called
449 if ( GetPrintableName(name
) )
451 #endif // WXWIN_COMPATIBILITY_2_8
453 return DoGetUserReadableName();
456 wxString
wxDocument::DoGetUserReadableName() const
458 if ( !m_documentTitle
.empty() )
459 return m_documentTitle
;
461 if ( !m_documentFile
.empty() )
462 return wxFileNameFromPath(m_documentFile
);
467 wxWindow
*wxDocument::GetDocumentWindow() const
469 wxView
* const view
= GetFirstView();
471 return view
? view
->GetFrame() : wxTheApp
->GetTopWindow();
474 wxCommandProcessor
*wxDocument::OnCreateCommandProcessor()
476 return new wxCommandProcessor
;
479 // true if safe to close
480 bool wxDocument::OnSaveModified()
484 switch ( wxMessageBox
488 _("Do you want to save changes to %s?"),
489 GetUserReadableName()
491 wxTheApp
->GetAppDisplayName(),
492 wxYES_NO
| wxCANCEL
| wxICON_QUESTION
| wxCENTRE
,
493 wxFindSuitableParent()
511 bool wxDocument::Draw(wxDC
& WXUNUSED(context
))
516 bool wxDocument::AddView(wxView
*view
)
518 if ( !m_documentViews
.Member(view
) )
520 m_documentViews
.Append(view
);
526 bool wxDocument::RemoveView(wxView
*view
)
528 (void)m_documentViews
.DeleteObject(view
);
533 bool wxDocument::OnCreate(const wxString
& WXUNUSED(path
), long flags
)
535 return GetDocumentTemplate()->CreateView(this, flags
) != NULL
;
538 // Called after a view is added or removed.
539 // The default implementation deletes the document if
540 // there are no more views.
541 void wxDocument::OnChangedViewList()
543 if ( m_documentViews
.empty() && OnSaveModified() )
547 void wxDocument::UpdateAllViews(wxView
*sender
, wxObject
*hint
)
549 wxList::compatibility_iterator node
= m_documentViews
.GetFirst();
552 wxView
*view
= (wxView
*)node
->GetData();
554 view
->OnUpdate(sender
, hint
);
555 node
= node
->GetNext();
559 void wxDocument::NotifyClosing()
561 wxList::compatibility_iterator node
= m_documentViews
.GetFirst();
564 wxView
*view
= (wxView
*)node
->GetData();
565 view
->OnClosingDocument();
566 node
= node
->GetNext();
570 void wxDocument::SetFilename(const wxString
& filename
, bool notifyViews
)
572 m_documentFile
= filename
;
573 OnChangeFilename(notifyViews
);
576 void wxDocument::OnChangeFilename(bool notifyViews
)
580 // Notify the views that the filename has changed
581 wxList::compatibility_iterator node
= m_documentViews
.GetFirst();
584 wxView
*view
= (wxView
*)node
->GetData();
585 view
->OnChangeFilename();
586 node
= node
->GetNext();
591 bool wxDocument::DoSaveDocument(const wxString
& file
)
593 #if wxUSE_STD_IOSTREAM
594 wxSTD ofstream
store(file
.mb_str(), wxSTD
ios::binary
);
597 wxFileOutputStream
store(file
);
598 if ( store
.GetLastError() != wxSTREAM_NO_ERROR
)
601 wxLogError(_("File \"%s\" could not be opened for writing."), file
);
605 if (!SaveObject(store
))
607 wxLogError(_("Failed to save document to the file \"%s\"."), file
);
614 bool wxDocument::DoOpenDocument(const wxString
& file
)
616 #if wxUSE_STD_IOSTREAM
617 wxSTD ifstream
store(file
.mb_str(), wxSTD
ios::binary
);
620 wxFileInputStream
store(file
);
621 if (store
.GetLastError() != wxSTREAM_NO_ERROR
|| !store
.IsOk())
624 wxLogError(_("File \"%s\" could not be opened for reading."), file
);
628 #if wxUSE_STD_IOSTREAM
632 int res
= LoadObject(store
).GetLastError();
633 if ( res
!= wxSTREAM_NO_ERROR
&& res
!= wxSTREAM_EOF
)
636 wxLogError(_("Failed to read document from the file \"%s\"."), file
);
644 // ----------------------------------------------------------------------------
646 // ----------------------------------------------------------------------------
650 m_viewDocument
= NULL
;
654 m_docChildFrame
= NULL
;
659 GetDocumentManager()->ActivateView(this, false);
661 // reset our frame view first, before removing it from the document as
662 // SetView(NULL) is a simple call while RemoveView() may result in user
663 // code being executed and this user code can, for example, show a message
664 // box which would result in an activation event for m_docChildFrame and so
665 // could reactivate the view being destroyed -- unless we reset it first
666 if ( m_docChildFrame
&& m_docChildFrame
->GetView() == this )
668 // prevent it from doing anything with us
669 m_docChildFrame
->SetView(NULL
);
671 // it doesn't make sense to leave the frame alive if its associated
672 // view doesn't exist any more so unconditionally close it as well
674 // notice that we only get here if m_docChildFrame is non-NULL in the
675 // first place and it will be always NULL if we're deleted because our
676 // frame was closed, so this only catches the case of directly deleting
677 // the view, as it happens if its creation fails in wxDocTemplate::
678 // CreateView() for example
679 m_docChildFrame
->GetWindow()->Destroy();
682 if ( m_viewDocument
)
683 m_viewDocument
->RemoveView(this);
686 void wxView::SetDocChildFrame(wxDocChildFrameAnyBase
*docChildFrame
)
688 SetFrame(docChildFrame
? docChildFrame
->GetWindow() : NULL
);
689 m_docChildFrame
= docChildFrame
;
692 bool wxView::TryBefore(wxEvent
& event
)
694 wxDocument
* const doc
= GetDocument();
695 return doc
&& doc
->ProcessEventHere(event
);
698 void wxView::OnActivateView(bool WXUNUSED(activate
),
699 wxView
*WXUNUSED(activeView
),
700 wxView
*WXUNUSED(deactiveView
))
704 void wxView::OnPrint(wxDC
*dc
, wxObject
*WXUNUSED(info
))
709 void wxView::OnUpdate(wxView
*WXUNUSED(sender
), wxObject
*WXUNUSED(hint
))
713 void wxView::OnChangeFilename()
715 // GetFrame can return wxWindow rather than wxTopLevelWindow due to
716 // generic MDI implementation so use SetLabel rather than SetTitle.
717 // It should cause SetTitle() for top level windows.
718 wxWindow
*win
= GetFrame();
721 wxDocument
*doc
= GetDocument();
724 win
->SetLabel(doc
->GetUserReadableName());
727 void wxView::SetDocument(wxDocument
*doc
)
729 m_viewDocument
= doc
;
734 bool wxView::Close(bool deleteWindow
)
736 return OnClose(deleteWindow
);
739 void wxView::Activate(bool activate
)
741 if (GetDocument() && GetDocumentManager())
743 OnActivateView(activate
, this, GetDocumentManager()->GetCurrentView());
744 GetDocumentManager()->ActivateView(this, activate
);
748 bool wxView::OnClose(bool WXUNUSED(deleteWindow
))
750 return GetDocument() ? GetDocument()->Close() : true;
753 #if wxUSE_PRINTING_ARCHITECTURE
754 wxPrintout
*wxView::OnCreatePrintout()
756 return new wxDocPrintout(this);
758 #endif // wxUSE_PRINTING_ARCHITECTURE
760 // ----------------------------------------------------------------------------
762 // ----------------------------------------------------------------------------
764 wxDocTemplate::wxDocTemplate(wxDocManager
*manager
,
765 const wxString
& descr
,
766 const wxString
& filter
,
769 const wxString
& docTypeName
,
770 const wxString
& viewTypeName
,
771 wxClassInfo
*docClassInfo
,
772 wxClassInfo
*viewClassInfo
,
775 m_documentManager
= manager
;
776 m_description
= descr
;
779 m_fileFilter
= filter
;
781 m_docTypeName
= docTypeName
;
782 m_viewTypeName
= viewTypeName
;
783 m_documentManager
->AssociateTemplate(this);
785 m_docClassInfo
= docClassInfo
;
786 m_viewClassInfo
= viewClassInfo
;
789 wxDocTemplate::~wxDocTemplate()
791 m_documentManager
->DisassociateTemplate(this);
794 // Tries to dynamically construct an object of the right class.
795 wxDocument
*wxDocTemplate::CreateDocument(const wxString
& path
, long flags
)
797 // InitDocument() is supposed to delete the document object if its
798 // initialization fails so don't use wxScopedPtr<> here: this is fragile
799 // but unavoidable because the default implementation uses CreateView()
800 // which may -- or not -- create a wxView and if it does create it and its
801 // initialization fails then the view destructor will delete the document
802 // (via RemoveView()) and as we can't distinguish between the two cases we
803 // just have to assume that it always deletes it in case of failure
804 wxDocument
* const doc
= DoCreateDocument();
806 return doc
&& InitDocument(doc
, path
, flags
) ? doc
: NULL
;
810 wxDocTemplate::InitDocument(wxDocument
* doc
, const wxString
& path
, long flags
)
812 doc
->SetFilename(path
);
813 doc
->SetDocumentTemplate(this);
814 GetDocumentManager()->AddDocument(doc
);
815 doc
->SetCommandProcessor(doc
->OnCreateCommandProcessor());
817 if (doc
->OnCreate(path
, flags
))
820 if (GetDocumentManager()->GetDocuments().Member(doc
))
821 doc
->DeleteAllViews();
825 wxView
*wxDocTemplate::CreateView(wxDocument
*doc
, long flags
)
827 wxScopedPtr
<wxView
> view(DoCreateView());
831 view
->SetDocument(doc
);
832 if ( !view
->OnCreate(doc
, flags
) )
835 return view
.release();
838 // The default (very primitive) format detection: check is the extension is
839 // that of the template
840 bool wxDocTemplate::FileMatchesTemplate(const wxString
& path
)
842 wxStringTokenizer
parser (GetFileFilter(), wxT(";"));
843 wxString anything
= wxT ("*");
844 while (parser
.HasMoreTokens())
846 wxString filter
= parser
.GetNextToken();
847 wxString filterExt
= FindExtension (filter
);
848 if ( filter
.IsSameAs (anything
) ||
849 filterExt
.IsSameAs (anything
) ||
850 filterExt
.IsSameAs (FindExtension (path
)) )
853 return GetDefaultExtension().IsSameAs(FindExtension(path
));
856 wxDocument
*wxDocTemplate::DoCreateDocument()
861 return static_cast<wxDocument
*>(m_docClassInfo
->CreateObject());
864 wxView
*wxDocTemplate::DoCreateView()
866 if (!m_viewClassInfo
)
869 return static_cast<wxView
*>(m_viewClassInfo
->CreateObject());
872 // ----------------------------------------------------------------------------
874 // ----------------------------------------------------------------------------
876 BEGIN_EVENT_TABLE(wxDocManager
, wxEvtHandler
)
877 EVT_MENU(wxID_OPEN
, wxDocManager::OnFileOpen
)
878 EVT_MENU(wxID_CLOSE
, wxDocManager::OnFileClose
)
879 EVT_MENU(wxID_CLOSE_ALL
, wxDocManager::OnFileCloseAll
)
880 EVT_MENU(wxID_REVERT
, wxDocManager::OnFileRevert
)
881 EVT_MENU(wxID_NEW
, wxDocManager::OnFileNew
)
882 EVT_MENU(wxID_SAVE
, wxDocManager::OnFileSave
)
883 EVT_MENU(wxID_SAVEAS
, wxDocManager::OnFileSaveAs
)
884 EVT_MENU(wxID_UNDO
, wxDocManager::OnUndo
)
885 EVT_MENU(wxID_REDO
, wxDocManager::OnRedo
)
887 EVT_UPDATE_UI(wxID_OPEN
, wxDocManager::OnUpdateFileOpen
)
888 EVT_UPDATE_UI(wxID_CLOSE
, wxDocManager::OnUpdateDisableIfNoDoc
)
889 EVT_UPDATE_UI(wxID_CLOSE_ALL
, wxDocManager::OnUpdateDisableIfNoDoc
)
890 EVT_UPDATE_UI(wxID_REVERT
, wxDocManager::OnUpdateDisableIfNoDoc
)
891 EVT_UPDATE_UI(wxID_NEW
, wxDocManager::OnUpdateFileNew
)
892 EVT_UPDATE_UI(wxID_SAVE
, wxDocManager::OnUpdateFileSave
)
893 EVT_UPDATE_UI(wxID_SAVEAS
, wxDocManager::OnUpdateDisableIfNoDoc
)
894 EVT_UPDATE_UI(wxID_UNDO
, wxDocManager::OnUpdateUndo
)
895 EVT_UPDATE_UI(wxID_REDO
, wxDocManager::OnUpdateRedo
)
897 #if wxUSE_PRINTING_ARCHITECTURE
898 EVT_MENU(wxID_PRINT
, wxDocManager::OnPrint
)
899 EVT_MENU(wxID_PREVIEW
, wxDocManager::OnPreview
)
901 EVT_UPDATE_UI(wxID_PRINT
, wxDocManager::OnUpdateDisableIfNoDoc
)
902 EVT_UPDATE_UI(wxID_PREVIEW
, wxDocManager::OnUpdateDisableIfNoDoc
)
906 wxDocManager
* wxDocManager::sm_docManager
= NULL
;
908 wxDocManager::wxDocManager(long WXUNUSED(flags
), bool initialize
)
910 wxASSERT_MSG( !sm_docManager
, "multiple wxDocManagers not allowed" );
912 sm_docManager
= this;
914 m_defaultDocumentNameCounter
= 1;
915 m_currentView
= NULL
;
916 m_maxDocsOpen
= INT_MAX
;
917 m_fileHistory
= NULL
;
922 wxDocManager::~wxDocManager()
925 delete m_fileHistory
;
926 sm_docManager
= NULL
;
929 // closes the specified document
930 bool wxDocManager::CloseDocument(wxDocument
* doc
, bool force
)
932 if ( !doc
->Close() && !force
)
935 // Implicitly deletes the document when
936 // the last view is deleted
937 doc
->DeleteAllViews();
939 // Check we're really deleted
940 if (m_docs
.Member(doc
))
946 bool wxDocManager::CloseDocuments(bool force
)
948 wxList::compatibility_iterator node
= m_docs
.GetFirst();
951 wxDocument
*doc
= (wxDocument
*)node
->GetData();
952 wxList::compatibility_iterator next
= node
->GetNext();
954 if (!CloseDocument(doc
, force
))
957 // This assumes that documents are not connected in
958 // any way, i.e. deleting one document does NOT
965 bool wxDocManager::Clear(bool force
)
967 if (!CloseDocuments(force
))
970 m_currentView
= NULL
;
972 wxList::compatibility_iterator node
= m_templates
.GetFirst();
975 wxDocTemplate
*templ
= (wxDocTemplate
*) node
->GetData();
976 wxList::compatibility_iterator next
= node
->GetNext();
983 bool wxDocManager::Initialize()
985 m_fileHistory
= OnCreateFileHistory();
989 wxString
wxDocManager::GetLastDirectory() const
991 // use the system-dependent default location for the document files if
992 // we're being opened for the first time
993 if ( m_lastDirectory
.empty() )
995 wxDocManager
* const self
= const_cast<wxDocManager
*>(this);
996 self
->m_lastDirectory
= wxStandardPaths::Get().GetAppDocumentsDir();
999 return m_lastDirectory
;
1002 wxFileHistory
*wxDocManager::OnCreateFileHistory()
1004 return new wxFileHistory
;
1007 void wxDocManager::OnFileClose(wxCommandEvent
& WXUNUSED(event
))
1009 wxDocument
*doc
= GetCurrentDocument();
1014 doc
->DeleteAllViews();
1015 if (m_docs
.Member(doc
))
1020 void wxDocManager::OnFileCloseAll(wxCommandEvent
& WXUNUSED(event
))
1022 CloseDocuments(false);
1025 void wxDocManager::OnFileNew(wxCommandEvent
& WXUNUSED(event
))
1027 CreateNewDocument();
1030 void wxDocManager::OnFileOpen(wxCommandEvent
& WXUNUSED(event
))
1032 if ( !CreateDocument("") )
1034 OnOpenFileFailure();
1038 void wxDocManager::OnFileRevert(wxCommandEvent
& WXUNUSED(event
))
1040 wxDocument
*doc
= GetCurrentDocument();
1046 void wxDocManager::OnFileSave(wxCommandEvent
& WXUNUSED(event
))
1048 wxDocument
*doc
= GetCurrentDocument();
1054 void wxDocManager::OnFileSaveAs(wxCommandEvent
& WXUNUSED(event
))
1056 wxDocument
*doc
= GetCurrentDocument();
1062 void wxDocManager::OnPrint(wxCommandEvent
& WXUNUSED(event
))
1064 #if wxUSE_PRINTING_ARCHITECTURE
1065 wxView
*view
= GetActiveView();
1069 wxPrintout
*printout
= view
->OnCreatePrintout();
1073 printer
.Print(view
->GetFrame(), printout
, true);
1077 #endif // wxUSE_PRINTING_ARCHITECTURE
1080 void wxDocManager::OnPreview(wxCommandEvent
& WXUNUSED(event
))
1082 #if wxUSE_PRINTING_ARCHITECTURE
1083 wxView
*view
= GetActiveView();
1087 wxPrintout
*printout
= view
->OnCreatePrintout();
1090 // Pass two printout objects: for preview, and possible printing.
1091 wxPrintPreviewBase
*
1092 preview
= new wxPrintPreview(printout
, view
->OnCreatePrintout());
1093 if ( !preview
->Ok() )
1096 wxLogError(_("Print preview creation failed."));
1101 frame
= new wxPreviewFrame(preview
, wxTheApp
->GetTopWindow(),
1102 _("Print Preview"));
1103 frame
->Centre(wxBOTH
);
1104 frame
->Initialize();
1107 #endif // wxUSE_PRINTING_ARCHITECTURE
1110 void wxDocManager::OnUndo(wxCommandEvent
& event
)
1112 wxCommandProcessor
* const cmdproc
= GetCurrentCommandProcessor();
1122 void wxDocManager::OnRedo(wxCommandEvent
& event
)
1124 wxCommandProcessor
* const cmdproc
= GetCurrentCommandProcessor();
1134 // Handlers for UI update commands
1136 void wxDocManager::OnUpdateFileOpen(wxUpdateUIEvent
& event
)
1138 // CreateDocument() (which is called from OnFileOpen) may succeed
1139 // only when there is at least a template:
1140 event
.Enable( GetTemplates().GetCount()>0 );
1143 void wxDocManager::OnUpdateDisableIfNoDoc(wxUpdateUIEvent
& event
)
1145 event
.Enable( GetCurrentDocument() != NULL
);
1148 void wxDocManager::OnUpdateFileNew(wxUpdateUIEvent
& event
)
1150 // CreateDocument() (which is called from OnFileNew) may succeed
1151 // only when there is at least a template:
1152 event
.Enable( GetTemplates().GetCount()>0 );
1155 void wxDocManager::OnUpdateFileSave(wxUpdateUIEvent
& event
)
1157 wxDocument
* const doc
= GetCurrentDocument();
1158 event
.Enable( doc
&& !doc
->AlreadySaved() );
1161 void wxDocManager::OnUpdateUndo(wxUpdateUIEvent
& event
)
1163 wxCommandProcessor
* const cmdproc
= GetCurrentCommandProcessor();
1166 event
.Enable(false);
1170 event
.Enable(cmdproc
->CanUndo());
1171 cmdproc
->SetMenuStrings();
1174 void wxDocManager::OnUpdateRedo(wxUpdateUIEvent
& event
)
1176 wxCommandProcessor
* const cmdproc
= GetCurrentCommandProcessor();
1179 event
.Enable(false);
1183 event
.Enable(cmdproc
->CanRedo());
1184 cmdproc
->SetMenuStrings();
1187 wxView
*wxDocManager::GetActiveView() const
1189 wxView
*view
= GetCurrentView();
1191 if ( !view
&& !m_docs
.empty() )
1193 // if we have exactly one document, consider its view to be the current
1196 // VZ: I'm not exactly sure why is this needed but this is how this
1197 // code used to behave before the bug #9518 was fixed and it seems
1198 // safer to preserve the old logic
1199 wxList::compatibility_iterator node
= m_docs
.GetFirst();
1200 if ( !node
->GetNext() )
1202 wxDocument
*doc
= static_cast<wxDocument
*>(node
->GetData());
1203 view
= doc
->GetFirstView();
1205 //else: we have more than one document
1211 bool wxDocManager::TryBefore(wxEvent
& event
)
1213 wxView
* const view
= GetActiveView();
1214 return view
&& view
->ProcessEventHere(event
);
1220 // helper function: return only the visible templates
1221 wxDocTemplates
GetVisibleTemplates(const wxList
& allTemplates
)
1223 // select only the visible templates
1224 const size_t totalNumTemplates
= allTemplates
.GetCount();
1225 wxDocTemplates templates
;
1226 if ( totalNumTemplates
)
1228 templates
.reserve(totalNumTemplates
);
1230 for ( wxList::const_iterator i
= allTemplates
.begin(),
1231 end
= allTemplates
.end();
1235 wxDocTemplate
* const temp
= (wxDocTemplate
*)*i
;
1236 if ( temp
->IsVisible() )
1237 templates
.push_back(temp
);
1244 } // anonymous namespace
1246 wxDocument
*wxDocManager::CreateDocument(const wxString
& pathOrig
, long flags
)
1248 // this ought to be const but SelectDocumentType/Path() are not
1249 // const-correct and can't be changed as, being virtual, this risks
1250 // breaking user code overriding them
1251 wxDocTemplates
templates(GetVisibleTemplates(m_templates
));
1252 const size_t numTemplates
= templates
.size();
1253 if ( !numTemplates
)
1255 // no templates can be used, can't create document
1260 // normally user should select the template to use but wxDOC_SILENT flag we
1261 // choose one ourselves
1262 wxString path
= pathOrig
; // may be modified below
1263 wxDocTemplate
*temp
;
1264 if ( flags
& wxDOC_SILENT
)
1266 wxASSERT_MSG( !path
.empty(),
1267 "using empty path with wxDOC_SILENT doesn't make sense" );
1269 temp
= FindTemplateForPath(path
);
1272 wxLogWarning(_("The format of file '%s' couldn't be determined."),
1276 else // not silent, ask the user
1278 // for the new file we need just the template, for an existing one we
1279 // need the template and the path, unless it's already specified
1280 if ( (flags
& wxDOC_NEW
) || !path
.empty() )
1281 temp
= SelectDocumentType(&templates
[0], numTemplates
);
1283 temp
= SelectDocumentPath(&templates
[0], numTemplates
, path
, flags
);
1289 // check whether the document with this path is already opened
1290 if ( !path
.empty() )
1292 const wxFileName
fn(path
);
1293 for ( wxList::const_iterator i
= m_docs
.begin(); i
!= m_docs
.end(); ++i
)
1295 wxDocument
* const doc
= (wxDocument
*)*i
;
1297 if ( fn
== doc
->GetFilename() )
1299 // file already open, just activate it and return
1300 if ( doc
->GetFirstView() )
1302 ActivateView(doc
->GetFirstView());
1303 if ( doc
->GetDocumentWindow() )
1304 doc
->GetDocumentWindow()->SetFocus();
1312 // no, we need to create a new document
1315 // if we've reached the max number of docs, close the first one.
1316 if ( (int)GetDocuments().GetCount() >= m_maxDocsOpen
)
1318 if ( !CloseDocument((wxDocument
*)GetDocuments().GetFirst()->GetData()) )
1320 // can't open the new document if closing the old one failed
1326 // do create and initialize the new document finally
1327 wxDocument
* const docNew
= temp
->CreateDocument(path
, flags
);
1331 docNew
->SetDocumentName(temp
->GetDocumentName());
1332 docNew
->SetDocumentTemplate(temp
);
1336 // call the appropriate function depending on whether we're creating a
1337 // new file or opening an existing one
1338 if ( !(flags
& wxDOC_NEW
? docNew
->OnNewDocument()
1339 : docNew
->OnOpenDocument(path
)) )
1341 docNew
->DeleteAllViews();
1345 wxCATCH_ALL( docNew
->DeleteAllViews(); throw; )
1347 // add the successfully opened file to MRU, but only if we're going to be
1348 // able to reopen it successfully later which requires the template for
1349 // this document to be retrievable from the file extension
1350 if ( !(flags
& wxDOC_NEW
) && temp
->FileMatchesTemplate(path
) )
1351 AddFileToHistory(path
);
1356 wxView
*wxDocManager::CreateView(wxDocument
*doc
, long flags
)
1358 wxDocTemplates
templates(GetVisibleTemplates(m_templates
));
1359 const size_t numTemplates
= templates
.size();
1361 if ( numTemplates
== 0 )
1364 wxDocTemplate
* const
1365 temp
= numTemplates
== 1 ? templates
[0]
1366 : SelectViewType(&templates
[0], numTemplates
);
1371 wxView
*view
= temp
->CreateView(doc
, flags
);
1373 view
->SetViewName(temp
->GetViewName());
1377 // Not yet implemented
1379 wxDocManager::DeleteTemplate(wxDocTemplate
*WXUNUSED(temp
), long WXUNUSED(flags
))
1383 // Not yet implemented
1384 bool wxDocManager::FlushDoc(wxDocument
*WXUNUSED(doc
))
1389 wxDocument
*wxDocManager::GetCurrentDocument() const
1391 wxView
* const view
= GetActiveView();
1392 return view
? view
->GetDocument() : NULL
;
1395 wxCommandProcessor
*wxDocManager::GetCurrentCommandProcessor() const
1397 wxDocument
* const doc
= GetCurrentDocument();
1398 return doc
? doc
->GetCommandProcessor() : NULL
;
1401 // Make a default name for a new document
1402 #if WXWIN_COMPATIBILITY_2_8
1403 bool wxDocManager::MakeDefaultName(wxString
& WXUNUSED(name
))
1405 // we consider that this function can only be overridden by the user code,
1406 // not called by it as it only makes sense to call it internally, so we
1407 // don't bother to return anything from here
1410 #endif // WXWIN_COMPATIBILITY_2_8
1412 wxString
wxDocManager::MakeNewDocumentName()
1416 #if WXWIN_COMPATIBILITY_2_8
1417 if ( !MakeDefaultName(name
) )
1418 #endif // WXWIN_COMPATIBILITY_2_8
1420 name
.Printf(_("unnamed%d"), m_defaultDocumentNameCounter
);
1421 m_defaultDocumentNameCounter
++;
1427 // Make a frame title (override this to do something different)
1428 // If docName is empty, a document is not currently active.
1429 wxString
wxDocManager::MakeFrameTitle(wxDocument
* doc
)
1431 wxString appName
= wxTheApp
->GetAppDisplayName();
1437 wxString docName
= doc
->GetUserReadableName();
1438 title
= docName
+ wxString(_(" - ")) + appName
;
1444 // Not yet implemented
1445 wxDocTemplate
*wxDocManager::MatchTemplate(const wxString
& WXUNUSED(path
))
1450 // File history management
1451 void wxDocManager::AddFileToHistory(const wxString
& file
)
1454 m_fileHistory
->AddFileToHistory(file
);
1457 void wxDocManager::RemoveFileFromHistory(size_t i
)
1460 m_fileHistory
->RemoveFileFromHistory(i
);
1463 wxString
wxDocManager::GetHistoryFile(size_t i
) const
1468 histFile
= m_fileHistory
->GetHistoryFile(i
);
1473 void wxDocManager::FileHistoryUseMenu(wxMenu
*menu
)
1476 m_fileHistory
->UseMenu(menu
);
1479 void wxDocManager::FileHistoryRemoveMenu(wxMenu
*menu
)
1482 m_fileHistory
->RemoveMenu(menu
);
1486 void wxDocManager::FileHistoryLoad(const wxConfigBase
& config
)
1489 m_fileHistory
->Load(config
);
1492 void wxDocManager::FileHistorySave(wxConfigBase
& config
)
1495 m_fileHistory
->Save(config
);
1499 void wxDocManager::FileHistoryAddFilesToMenu(wxMenu
* menu
)
1502 m_fileHistory
->AddFilesToMenu(menu
);
1505 void wxDocManager::FileHistoryAddFilesToMenu()
1508 m_fileHistory
->AddFilesToMenu();
1511 size_t wxDocManager::GetHistoryFilesCount() const
1513 return m_fileHistory
? m_fileHistory
->GetCount() : 0;
1517 // Find out the document template via matching in the document file format
1518 // against that of the template
1519 wxDocTemplate
*wxDocManager::FindTemplateForPath(const wxString
& path
)
1521 wxDocTemplate
*theTemplate
= NULL
;
1523 // Find the template which this extension corresponds to
1524 for (size_t i
= 0; i
< m_templates
.GetCount(); i
++)
1526 wxDocTemplate
*temp
= (wxDocTemplate
*)m_templates
.Item(i
)->GetData();
1527 if ( temp
->FileMatchesTemplate(path
) )
1536 // Prompts user to open a file, using file specs in templates.
1537 // Must extend the file selector dialog or implement own; OR
1538 // match the extension to the template extension.
1540 wxDocTemplate
*wxDocManager::SelectDocumentPath(wxDocTemplate
**templates
,
1543 long WXUNUSED(flags
),
1544 bool WXUNUSED(save
))
1546 #ifdef wxHAS_MULTIPLE_FILEDLG_FILTERS
1549 for (int i
= 0; i
< noTemplates
; i
++)
1551 if (templates
[i
]->IsVisible())
1553 // add a '|' to separate this filter from the previous one
1554 if ( !descrBuf
.empty() )
1555 descrBuf
<< wxT('|');
1557 descrBuf
<< templates
[i
]->GetDescription()
1558 << wxT(" (") << templates
[i
]->GetFileFilter() << wxT(") |")
1559 << templates
[i
]->GetFileFilter();
1563 wxString descrBuf
= wxT("*.*");
1564 wxUnusedVar(noTemplates
);
1567 int FilterIndex
= -1;
1569 wxWindow
* parent
= wxFindSuitableParent();
1571 wxString pathTmp
= wxFileSelectorEx(_("Open File"),
1579 wxDocTemplate
*theTemplate
= NULL
;
1580 if (!pathTmp
.empty())
1582 if (!wxFileExists(pathTmp
))
1585 if (!wxTheApp
->GetAppDisplayName().empty())
1586 msgTitle
= wxTheApp
->GetAppDisplayName();
1588 msgTitle
= wxString(_("File error"));
1590 wxMessageBox(_("Sorry, could not open this file."),
1592 wxOK
| wxICON_EXCLAMATION
| wxCENTRE
,
1595 path
= wxEmptyString
;
1599 SetLastDirectory(wxPathOnly(pathTmp
));
1603 // first choose the template using the extension, if this fails (i.e.
1604 // wxFileSelectorEx() didn't fill it), then use the path
1605 if ( FilterIndex
!= -1 )
1606 theTemplate
= templates
[FilterIndex
];
1608 theTemplate
= FindTemplateForPath(path
);
1611 // Since we do not add files with non-default extensions to the
1612 // file history this can only happen if the application changes the
1613 // allowed templates in runtime.
1614 wxMessageBox(_("Sorry, the format for this file is unknown."),
1616 wxOK
| wxICON_EXCLAMATION
| wxCENTRE
,
1628 wxDocTemplate
*wxDocManager::SelectDocumentType(wxDocTemplate
**templates
,
1629 int noTemplates
, bool sort
)
1631 wxArrayString strings
;
1632 wxScopedArray
<wxDocTemplate
*> data(new wxDocTemplate
*[noTemplates
]);
1636 for (i
= 0; i
< noTemplates
; i
++)
1638 if (templates
[i
]->IsVisible())
1642 for (j
= 0; j
< n
; j
++)
1644 //filter out NOT unique documents + view combinations
1645 if ( templates
[i
]->m_docTypeName
== data
[j
]->m_docTypeName
&&
1646 templates
[i
]->m_viewTypeName
== data
[j
]->m_viewTypeName
1653 strings
.Add(templates
[i
]->m_description
);
1655 data
[n
] = templates
[i
];
1663 strings
.Sort(); // ascending sort
1664 // Yes, this will be slow, but template lists
1665 // are typically short.
1667 n
= strings
.Count();
1668 for (i
= 0; i
< n
; i
++)
1670 for (j
= 0; j
< noTemplates
; j
++)
1672 if (strings
[i
] == templates
[j
]->m_description
)
1673 data
[i
] = templates
[j
];
1678 wxDocTemplate
*theTemplate
;
1683 // no visible templates, hence nothing to choose from
1688 // don't propose the user to choose if he has no choice
1689 theTemplate
= data
[0];
1693 // propose the user to choose one of several
1694 theTemplate
= (wxDocTemplate
*)wxGetSingleChoiceData
1696 _("Select a document template"),
1699 (void **)data
.get(),
1700 wxFindSuitableParent()
1707 wxDocTemplate
*wxDocManager::SelectViewType(wxDocTemplate
**templates
,
1708 int noTemplates
, bool sort
)
1710 wxArrayString strings
;
1711 wxScopedArray
<wxDocTemplate
*> data(new wxDocTemplate
*[noTemplates
]);
1715 for (i
= 0; i
< noTemplates
; i
++)
1717 wxDocTemplate
*templ
= templates
[i
];
1718 if ( templ
->IsVisible() && !templ
->GetViewName().empty() )
1722 for (j
= 0; j
< n
; j
++)
1724 //filter out NOT unique views
1725 if ( templates
[i
]->m_viewTypeName
== data
[j
]->m_viewTypeName
)
1731 strings
.Add(templ
->m_viewTypeName
);
1740 strings
.Sort(); // ascending sort
1741 // Yes, this will be slow, but template lists
1742 // are typically short.
1744 n
= strings
.Count();
1745 for (i
= 0; i
< n
; i
++)
1747 for (j
= 0; j
< noTemplates
; j
++)
1749 if (strings
[i
] == templates
[j
]->m_viewTypeName
)
1750 data
[i
] = templates
[j
];
1755 wxDocTemplate
*theTemplate
;
1757 // the same logic as above
1765 theTemplate
= data
[0];
1769 theTemplate
= (wxDocTemplate
*)wxGetSingleChoiceData
1771 _("Select a document view"),
1774 (void **)data
.get(),
1775 wxFindSuitableParent()
1783 void wxDocManager::AssociateTemplate(wxDocTemplate
*temp
)
1785 if (!m_templates
.Member(temp
))
1786 m_templates
.Append(temp
);
1789 void wxDocManager::DisassociateTemplate(wxDocTemplate
*temp
)
1791 m_templates
.DeleteObject(temp
);
1794 // Add and remove a document from the manager's list
1795 void wxDocManager::AddDocument(wxDocument
*doc
)
1797 if (!m_docs
.Member(doc
))
1801 void wxDocManager::RemoveDocument(wxDocument
*doc
)
1803 m_docs
.DeleteObject(doc
);
1806 // Views or windows should inform the document manager
1807 // when a view is going in or out of focus
1808 void wxDocManager::ActivateView(wxView
*view
, bool activate
)
1812 m_currentView
= view
;
1816 if ( m_currentView
== view
)
1818 // don't keep stale pointer
1819 m_currentView
= NULL
;
1824 // ----------------------------------------------------------------------------
1825 // wxDocChildFrameAnyBase
1826 // ----------------------------------------------------------------------------
1828 bool wxDocChildFrameAnyBase::CloseView(wxCloseEvent
& event
)
1832 if ( event
.CanVeto() && !m_childView
->Close(false) )
1838 m_childView
->Activate(false);
1840 // it is important to reset m_childView frame pointer to NULL before
1841 // deleting it because while normally it is the frame which deletes the
1842 // view when it's closed, the view also closes the frame if it is
1843 // deleted directly not by us as indicated by its doc child frame
1844 // pointer still being set
1845 m_childView
->SetDocChildFrame(NULL
);
1850 m_childDocument
= NULL
;
1855 // ----------------------------------------------------------------------------
1856 // Default parent frame
1857 // ----------------------------------------------------------------------------
1859 BEGIN_EVENT_TABLE(wxDocParentFrame
, wxFrame
)
1860 EVT_MENU(wxID_EXIT
, wxDocParentFrame::OnExit
)
1861 EVT_MENU_RANGE(wxID_FILE1
, wxID_FILE9
, wxDocParentFrame::OnMRUFile
)
1862 EVT_CLOSE(wxDocParentFrame::OnCloseWindow
)
1865 wxDocParentFrame::wxDocParentFrame()
1867 m_docManager
= NULL
;
1870 wxDocParentFrame::wxDocParentFrame(wxDocManager
*manager
,
1873 const wxString
& title
,
1877 const wxString
& name
)
1878 : wxFrame(frame
, id
, title
, pos
, size
, style
, name
)
1880 m_docManager
= manager
;
1883 bool wxDocParentFrame::Create(wxDocManager
*manager
,
1886 const wxString
& title
,
1890 const wxString
& name
)
1892 m_docManager
= manager
;
1893 return base_type::Create(frame
, id
, title
, pos
, size
, style
, name
);
1896 void wxDocParentFrame::OnExit(wxCommandEvent
& WXUNUSED(event
))
1901 void wxDocParentFrame::OnMRUFile(wxCommandEvent
& event
)
1903 int n
= event
.GetId() - wxID_FILE1
; // the index in MRU list
1904 wxString
filename(m_docManager
->GetHistoryFile(n
));
1905 if ( filename
.empty() )
1908 wxString errMsg
; // must contain exactly one "%s" if non-empty
1909 if ( wxFile::Exists(filename
) )
1912 if ( m_docManager
->CreateDocument(filename
, wxDOC_SILENT
) )
1915 errMsg
= _("The file '%s' couldn't be opened.");
1917 else // file doesn't exist
1919 errMsg
= _("The file '%s' doesn't exist and couldn't be opened.");
1923 wxASSERT_MSG( !errMsg
.empty(), "should have an error message" );
1925 // remove the file which we can't open from the MRU list
1926 m_docManager
->RemoveFileFromHistory(n
);
1928 // and tell the user about it
1929 wxLogError(errMsg
+ '\n' +
1930 _("It has been removed from the most recently used files list."),
1934 // Extend event processing to search the view's event table
1935 bool wxDocParentFrame::TryBefore(wxEvent
& event
)
1937 if ( m_docManager
&& m_docManager
->ProcessEventHere(event
) )
1940 return wxFrame::TryBefore(event
);
1943 // Define the behaviour for the frame closing
1944 // - must delete all frames except for the main one.
1945 void wxDocParentFrame::OnCloseWindow(wxCloseEvent
& event
)
1947 if (m_docManager
->Clear(!event
.CanVeto()))
1955 #if wxUSE_PRINTING_ARCHITECTURE
1957 wxDocPrintout::wxDocPrintout(wxView
*view
, const wxString
& title
)
1960 m_printoutView
= view
;
1963 bool wxDocPrintout::OnPrintPage(int WXUNUSED(page
))
1967 // Get the logical pixels per inch of screen and printer
1968 int ppiScreenX
, ppiScreenY
;
1969 GetPPIScreen(&ppiScreenX
, &ppiScreenY
);
1970 wxUnusedVar(ppiScreenY
);
1971 int ppiPrinterX
, ppiPrinterY
;
1972 GetPPIPrinter(&ppiPrinterX
, &ppiPrinterY
);
1973 wxUnusedVar(ppiPrinterY
);
1975 // This scales the DC so that the printout roughly represents the
1976 // the screen scaling. The text point size _should_ be the right size
1977 // but in fact is too small for some reason. This is a detail that will
1978 // need to be addressed at some point but can be fudged for the
1980 float scale
= (float)((float)ppiPrinterX
/(float)ppiScreenX
);
1982 // Now we have to check in case our real page size is reduced
1983 // (e.g. because we're drawing to a print preview memory DC)
1984 int pageWidth
, pageHeight
;
1986 dc
->GetSize(&w
, &h
);
1987 GetPageSizePixels(&pageWidth
, &pageHeight
);
1988 wxUnusedVar(pageHeight
);
1990 // If printer pageWidth == current DC width, then this doesn't
1991 // change. But w might be the preview bitmap width, so scale down.
1992 float overallScale
= scale
* (float)(w
/(float)pageWidth
);
1993 dc
->SetUserScale(overallScale
, overallScale
);
1997 m_printoutView
->OnDraw(dc
);
2002 bool wxDocPrintout::HasPage(int pageNum
)
2004 return (pageNum
== 1);
2007 bool wxDocPrintout::OnBeginDocument(int startPage
, int endPage
)
2009 if (!wxPrintout::OnBeginDocument(startPage
, endPage
))
2015 void wxDocPrintout::GetPageInfo(int *minPage
, int *maxPage
,
2016 int *selPageFrom
, int *selPageTo
)
2024 #endif // wxUSE_PRINTING_ARCHITECTURE
2026 // ----------------------------------------------------------------------------
2027 // File history (a.k.a. MRU, most recently used, files list)
2028 // ----------------------------------------------------------------------------
2030 wxFileHistory::wxFileHistory(size_t maxFiles
, wxWindowID idBase
)
2032 m_fileMaxFiles
= maxFiles
;
2036 void wxFileHistory::AddFileToHistory(const wxString
& file
)
2038 // check if we don't already have this file
2039 const wxFileName
fnNew(file
);
2041 numFiles
= m_fileHistory
.size();
2042 for ( i
= 0; i
< numFiles
; i
++ )
2044 if ( fnNew
== m_fileHistory
[i
] )
2046 // we do have it, move it to the top of the history
2047 RemoveFileFromHistory(i
);
2053 // if we already have a full history, delete the one at the end
2054 if ( numFiles
== m_fileMaxFiles
)
2056 RemoveFileFromHistory(--numFiles
);
2059 // add a new menu item to all file menus (they will be updated below)
2060 for ( wxList::compatibility_iterator node
= m_fileMenus
.GetFirst();
2062 node
= node
->GetNext() )
2064 wxMenu
* const menu
= (wxMenu
*)node
->GetData();
2066 if ( !numFiles
&& menu
->GetMenuItemCount() )
2067 menu
->AppendSeparator();
2069 // label doesn't matter, it will be set below anyhow, but it can't
2070 // be empty (this is supposed to indicate a stock item)
2071 menu
->Append(m_idBase
+ numFiles
, " ");
2074 // insert the new file in the beginning of the file history
2075 m_fileHistory
.insert(m_fileHistory
.begin(), file
);
2078 // update the labels in all menus
2079 for ( i
= 0; i
< numFiles
; i
++ )
2081 // if in same directory just show the filename; otherwise the full path
2082 const wxFileName
fnOld(m_fileHistory
[i
]);
2084 wxString pathInMenu
;
2085 if ( fnOld
.GetPath() == fnNew
.GetPath() )
2087 pathInMenu
= fnOld
.GetFullName();
2089 else // file in different directory
2091 // absolute path; could also set relative path
2092 pathInMenu
= m_fileHistory
[i
];
2095 for ( wxList::compatibility_iterator node
= m_fileMenus
.GetFirst();
2097 node
= node
->GetNext() )
2099 wxMenu
* const menu
= (wxMenu
*)node
->GetData();
2101 menu
->SetLabel(m_idBase
+ i
, GetMRUEntryLabel(i
, pathInMenu
));
2106 void wxFileHistory::RemoveFileFromHistory(size_t i
)
2108 size_t numFiles
= m_fileHistory
.size();
2109 wxCHECK_RET( i
< numFiles
,
2110 wxT("invalid index in wxFileHistory::RemoveFileFromHistory") );
2112 // delete the element from the array
2113 m_fileHistory
.RemoveAt(i
);
2116 for ( wxList::compatibility_iterator node
= m_fileMenus
.GetFirst();
2118 node
= node
->GetNext() )
2120 wxMenu
* const menu
= (wxMenu
*) node
->GetData();
2122 // shift filenames up
2123 for ( size_t j
= i
; j
< numFiles
; j
++ )
2125 menu
->SetLabel(m_idBase
+ j
, GetMRUEntryLabel(j
, m_fileHistory
[j
]));
2128 // delete the last menu item which is unused now
2129 const wxWindowID lastItemId
= m_idBase
+ numFiles
;
2130 if ( menu
->FindItem(lastItemId
) )
2131 menu
->Delete(lastItemId
);
2133 // delete the last separator too if no more files are left
2134 if ( m_fileHistory
.empty() )
2136 const wxMenuItemList::compatibility_iterator
2137 nodeLast
= menu
->GetMenuItems().GetLast();
2140 wxMenuItem
* const lastMenuItem
= nodeLast
->GetData();
2141 if ( lastMenuItem
->IsSeparator() )
2142 menu
->Delete(lastMenuItem
);
2144 //else: menu is empty somehow
2149 void wxFileHistory::UseMenu(wxMenu
*menu
)
2151 if ( !m_fileMenus
.Member(menu
) )
2152 m_fileMenus
.Append(menu
);
2155 void wxFileHistory::RemoveMenu(wxMenu
*menu
)
2157 m_fileMenus
.DeleteObject(menu
);
2161 void wxFileHistory::Load(const wxConfigBase
& config
)
2163 m_fileHistory
.Clear();
2166 buf
.Printf(wxT("file%d"), 1);
2168 wxString historyFile
;
2169 while ((m_fileHistory
.GetCount() < m_fileMaxFiles
) &&
2170 config
.Read(buf
, &historyFile
) && !historyFile
.empty())
2172 m_fileHistory
.Add(historyFile
);
2174 buf
.Printf(wxT("file%d"), (int)m_fileHistory
.GetCount()+1);
2175 historyFile
= wxEmptyString
;
2181 void wxFileHistory::Save(wxConfigBase
& config
)
2184 for (i
= 0; i
< m_fileMaxFiles
; i
++)
2187 buf
.Printf(wxT("file%d"), (int)i
+1);
2188 if (i
< m_fileHistory
.GetCount())
2189 config
.Write(buf
, wxString(m_fileHistory
[i
]));
2191 config
.Write(buf
, wxEmptyString
);
2194 #endif // wxUSE_CONFIG
2196 void wxFileHistory::AddFilesToMenu()
2198 if ( m_fileHistory
.empty() )
2201 for ( wxList::compatibility_iterator node
= m_fileMenus
.GetFirst();
2203 node
= node
->GetNext() )
2205 AddFilesToMenu((wxMenu
*) node
->GetData());
2209 void wxFileHistory::AddFilesToMenu(wxMenu
* menu
)
2211 if ( m_fileHistory
.empty() )
2214 if ( menu
->GetMenuItemCount() )
2215 menu
->AppendSeparator();
2217 for ( size_t i
= 0; i
< m_fileHistory
.GetCount(); i
++ )
2219 menu
->Append(m_idBase
+ i
, GetMRUEntryLabel(i
, m_fileHistory
[i
]));
2223 // ----------------------------------------------------------------------------
2224 // Permits compatibility with existing file formats and functions that
2225 // manipulate files directly
2226 // ----------------------------------------------------------------------------
2228 #if wxUSE_STD_IOSTREAM
2230 bool wxTransferFileToStream(const wxString
& filename
, wxSTD ostream
& stream
)
2232 wxFFile
file(filename
, _T("rb"));
2233 if ( !file
.IsOpened() )
2241 nRead
= file
.Read(buf
, WXSIZEOF(buf
));
2245 stream
.write(buf
, nRead
);
2249 while ( !file
.Eof() );
2254 bool wxTransferStreamToFile(wxSTD istream
& stream
, const wxString
& filename
)
2256 wxFFile
file(filename
, _T("wb"));
2257 if ( !file
.IsOpened() )
2263 stream
.read(buf
, WXSIZEOF(buf
));
2264 if ( !stream
.bad() ) // fail may be set on EOF, don't use operator!()
2266 if ( !file
.Write(buf
, stream
.gcount()) )
2270 while ( !stream
.eof() );
2275 #else // !wxUSE_STD_IOSTREAM
2277 bool wxTransferFileToStream(const wxString
& filename
, wxOutputStream
& stream
)
2279 wxFFile
file(filename
, _T("rb"));
2280 if ( !file
.IsOpened() )
2288 nRead
= file
.Read(buf
, WXSIZEOF(buf
));
2292 stream
.Write(buf
, nRead
);
2296 while ( !file
.Eof() );
2301 bool wxTransferStreamToFile(wxInputStream
& stream
, const wxString
& filename
)
2303 wxFFile
file(filename
, _T("wb"));
2304 if ( !file
.IsOpened() )
2310 stream
.Read(buf
, WXSIZEOF(buf
));
2312 const size_t nRead
= stream
.LastRead();
2321 if ( !file
.Write(buf
, nRead
) )
2328 #endif // wxUSE_STD_IOSTREAM/!wxUSE_STD_IOSTREAM
2330 #endif // wxUSE_DOC_VIEW_ARCHITECTURE