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/vector.h"
60 #include "wx/ptr_scpd.h"
62 #if wxUSE_STD_IOSTREAM
63 #include "wx/ioswrap.h"
64 #include "wx/beforestd.h"
70 #include "wx/afterstd.h"
72 #include "wx/wfstream.h"
75 typedef wxVector
<wxDocTemplate
*> wxDocTemplates
;
77 // ----------------------------------------------------------------------------
79 // ----------------------------------------------------------------------------
81 IMPLEMENT_ABSTRACT_CLASS(wxDocument
, wxEvtHandler
)
82 IMPLEMENT_ABSTRACT_CLASS(wxView
, wxEvtHandler
)
83 IMPLEMENT_ABSTRACT_CLASS(wxDocTemplate
, wxObject
)
84 IMPLEMENT_DYNAMIC_CLASS(wxDocManager
, wxEvtHandler
)
85 IMPLEMENT_CLASS(wxDocChildFrame
, wxFrame
)
86 IMPLEMENT_CLASS(wxDocParentFrame
, wxFrame
)
88 #if wxUSE_PRINTING_ARCHITECTURE
89 IMPLEMENT_DYNAMIC_CLASS(wxDocPrintout
, wxPrintout
)
92 IMPLEMENT_DYNAMIC_CLASS(wxFileHistory
, wxObject
)
94 // ============================================================================
96 // ============================================================================
98 // ----------------------------------------------------------------------------
100 // ----------------------------------------------------------------------------
105 wxWindow
*wxFindSuitableParent()
107 wxWindow
* const win
= wxGetTopLevelParent(wxWindow::FindFocus());
109 return win
? win
: wxTheApp
->GetTopWindow();
112 wxString
FindExtension(const wxString
& path
)
115 wxFileName::SplitPath(path
, NULL
, NULL
, &ext
);
117 // VZ: extensions are considered not case sensitive - is this really a good
119 return ext
.MakeLower();
122 // return the string used for the MRU list items in the menu
124 // NB: the index n is 0-based, as usual, but the strings start from 1
125 wxString
GetMRUEntryLabel(int n
, const wxString
& path
)
127 // we need to quote '&' characters which are used for mnemonics
128 wxString
pathInMenu(path
);
129 pathInMenu
.Replace("&", "&&");
131 return wxString::Format("&%d %s", n
+ 1, pathInMenu
);
134 } // anonymous namespace
136 // ----------------------------------------------------------------------------
137 // Definition of wxDocument
138 // ----------------------------------------------------------------------------
140 wxDocument::wxDocument(wxDocument
*parent
)
142 m_documentModified
= false;
143 m_documentParent
= parent
;
144 m_documentTemplate
= NULL
;
145 m_commandProcessor
= NULL
;
149 bool wxDocument::DeleteContents()
154 wxDocument::~wxDocument()
158 if (m_commandProcessor
)
159 delete m_commandProcessor
;
161 if (GetDocumentManager())
162 GetDocumentManager()->RemoveDocument(this);
164 // Not safe to do here, since it'll invoke virtual view functions
165 // expecting to see valid derived objects: and by the time we get here,
166 // we've called destructors higher up.
170 bool wxDocument::Close()
172 if (OnSaveModified())
173 return OnCloseDocument();
178 bool wxDocument::OnCloseDocument()
180 // Tell all views that we're about to close
187 // Note that this implicitly deletes the document when the last view is
189 bool wxDocument::DeleteAllViews()
191 wxDocManager
* manager
= GetDocumentManager();
193 // first check if all views agree to be closed
194 const wxList::iterator end
= m_documentViews
.end();
195 for ( wxList::iterator i
= m_documentViews
.begin(); i
!= end
; ++i
)
197 wxView
*view
= (wxView
*)*i
;
198 if ( !view
->Close() )
202 // all views agreed to close, now do close them
203 if ( m_documentViews
.empty() )
205 // normally the document would be implicitly deleted when the last view
206 // is, but if don't have any views, do it here instead
207 if ( manager
&& manager
->GetDocuments().Member(this) )
212 // as we delete elements we iterate over, don't use the usual "from
213 // begin to end" loop
216 wxView
*view
= (wxView
*)*m_documentViews
.begin();
218 bool isLastOne
= m_documentViews
.size() == 1;
220 // this always deletes the node implicitly and if this is the last
221 // view also deletes this object itself (also implicitly, great),
222 // so we can't test for m_documentViews.empty() after calling this!
233 wxView
*wxDocument::GetFirstView() const
235 if (m_documentViews
.GetCount() == 0)
237 return (wxView
*)m_documentViews
.GetFirst()->GetData();
240 wxDocManager
*wxDocument::GetDocumentManager() const
242 return m_documentTemplate
? m_documentTemplate
->GetDocumentManager() : NULL
;
245 bool wxDocument::OnNewDocument()
247 if ( !OnSaveModified() )
252 SetDocumentSaved(false);
254 const wxString name
= GetDocumentManager()->MakeNewDocumentName();
256 SetFilename(name
, true);
261 bool wxDocument::Save()
263 if ( AlreadySaved() )
266 if ( m_documentFile
.empty() || !m_savedYet
)
269 return OnSaveDocument(m_documentFile
);
272 bool wxDocument::SaveAs()
274 wxDocTemplate
*docTemplate
= GetDocumentTemplate();
278 #if defined(__WXMSW__) || defined(__WXGTK__) || defined(__WXMAC__)
279 wxString filter
= docTemplate
->GetDescription() + wxT(" (") + docTemplate
->GetFileFilter() + wxT(")|") + docTemplate
->GetFileFilter();
281 // Now see if there are some other template with identical view and document
282 // classes, whose filters may also be used.
284 if (docTemplate
->GetViewClassInfo() && docTemplate
->GetDocClassInfo())
286 wxList::compatibility_iterator node
= docTemplate
->GetDocumentManager()->GetTemplates().GetFirst();
289 wxDocTemplate
*t
= (wxDocTemplate
*) node
->GetData();
291 if (t
->IsVisible() && t
!= docTemplate
&&
292 t
->GetViewClassInfo() == docTemplate
->GetViewClassInfo() &&
293 t
->GetDocClassInfo() == docTemplate
->GetDocClassInfo())
295 // add a '|' to separate this filter from the previous one
296 if ( !filter
.empty() )
299 filter
<< t
->GetDescription() << wxT(" (") << t
->GetFileFilter() << wxT(") |")
300 << t
->GetFileFilter();
303 node
= node
->GetNext();
307 wxString filter
= docTemplate
->GetFileFilter() ;
309 wxString defaultDir
= docTemplate
->GetDirectory();
310 if (defaultDir
.IsEmpty())
311 defaultDir
= wxPathOnly(GetFilename());
313 wxString fileName
= wxFileSelector(_("Save As"),
315 wxFileNameFromPath(GetFilename()),
316 docTemplate
->GetDefaultExtension(),
318 wxFD_SAVE
| wxFD_OVERWRITE_PROMPT
,
319 GetDocumentWindow());
321 if (fileName
.empty())
325 wxFileName::SplitPath(fileName
, NULL
, NULL
, &ext
);
329 fileName
+= wxT(".");
330 fileName
+= docTemplate
->GetDefaultExtension();
333 // Files that were not saved correctly are not added to the FileHistory.
334 if (!OnSaveDocument(fileName
))
337 SetTitle(wxFileNameFromPath(fileName
));
338 SetFilename(fileName
, true); // will call OnChangeFileName automatically
340 // A file that doesn't use the default extension of its document template cannot be opened
341 // via the FileHistory, so we do not add it.
342 if (docTemplate
->FileMatchesTemplate(fileName
))
344 GetDocumentManager()->AddFileToHistory(fileName
);
348 // The user will probably not be able to open the file again, so
349 // we could warn about the wrong file-extension here.
354 bool wxDocument::OnSaveDocument(const wxString
& file
)
359 if ( !DoSaveDocument(file
) )
364 SetDocumentSaved(true);
365 #if defined( __WXOSX_MAC__ ) && wxOSX_USE_CARBON
366 wxFileName
fn(file
) ;
367 fn
.MacSetDefaultTypeAndCreator() ;
372 bool wxDocument::OnOpenDocument(const wxString
& file
)
374 if ( !OnSaveModified() )
377 if ( !DoOpenDocument(file
) )
380 SetFilename(file
, true);
389 #if wxUSE_STD_IOSTREAM
390 wxSTD istream
& wxDocument::LoadObject(wxSTD istream
& stream
)
392 wxInputStream
& wxDocument::LoadObject(wxInputStream
& stream
)
398 #if wxUSE_STD_IOSTREAM
399 wxSTD ostream
& wxDocument::SaveObject(wxSTD ostream
& stream
)
401 wxOutputStream
& wxDocument::SaveObject(wxOutputStream
& stream
)
407 bool wxDocument::Revert()
413 // Get title, or filename if no title, else unnamed
414 #if WXWIN_COMPATIBILITY_2_8
415 bool wxDocument::GetPrintableName(wxString
& buf
) const
417 // this function can not only be overridden by the user code but also
418 // called by it so we need to ensure that we return the same thing as
419 // GetUserReadableName() but we can't call it because this would result in
420 // an infinite recursion, hence we use the helper DoGetUserReadableName()
421 buf
= DoGetUserReadableName();
425 #endif // WXWIN_COMPATIBILITY_2_8
427 wxString
wxDocument::GetUserReadableName() const
429 #if WXWIN_COMPATIBILITY_2_8
430 // we need to call the old virtual function to ensure that the overridden
431 // version of it is still called
433 if ( GetPrintableName(name
) )
435 #endif // WXWIN_COMPATIBILITY_2_8
437 return DoGetUserReadableName();
440 wxString
wxDocument::DoGetUserReadableName() const
442 if ( !m_documentTitle
.empty() )
443 return m_documentTitle
;
445 if ( !m_documentFile
.empty() )
446 return wxFileNameFromPath(m_documentFile
);
451 wxWindow
*wxDocument::GetDocumentWindow() const
453 wxView
*view
= GetFirstView();
455 return view
->GetFrame();
457 return wxTheApp
->GetTopWindow();
460 wxCommandProcessor
*wxDocument::OnCreateCommandProcessor()
462 return new wxCommandProcessor
;
465 // true if safe to close
466 bool wxDocument::OnSaveModified()
470 switch ( wxMessageBox
474 _("Do you want to save changes to document %s?"),
475 GetUserReadableName()
477 wxTheApp
->GetAppDisplayName(),
478 wxYES_NO
| wxCANCEL
| wxICON_QUESTION
| wxCENTRE
,
479 wxFindSuitableParent()
497 bool wxDocument::Draw(wxDC
& WXUNUSED(context
))
502 bool wxDocument::AddView(wxView
*view
)
504 if ( !m_documentViews
.Member(view
) )
506 m_documentViews
.Append(view
);
512 bool wxDocument::RemoveView(wxView
*view
)
514 (void)m_documentViews
.DeleteObject(view
);
519 bool wxDocument::OnCreate(const wxString
& WXUNUSED(path
), long flags
)
521 return GetDocumentTemplate()->CreateView(this, flags
) != NULL
;
524 // Called after a view is added or removed.
525 // The default implementation deletes the document if
526 // there are no more views.
527 void wxDocument::OnChangedViewList()
529 if ( m_documentViews
.empty() && OnSaveModified() )
533 void wxDocument::UpdateAllViews(wxView
*sender
, wxObject
*hint
)
535 wxList::compatibility_iterator node
= m_documentViews
.GetFirst();
538 wxView
*view
= (wxView
*)node
->GetData();
540 view
->OnUpdate(sender
, hint
);
541 node
= node
->GetNext();
545 void wxDocument::NotifyClosing()
547 wxList::compatibility_iterator node
= m_documentViews
.GetFirst();
550 wxView
*view
= (wxView
*)node
->GetData();
551 view
->OnClosingDocument();
552 node
= node
->GetNext();
556 void wxDocument::SetFilename(const wxString
& filename
, bool notifyViews
)
558 m_documentFile
= filename
;
559 OnChangeFilename(notifyViews
);
562 void wxDocument::OnChangeFilename(bool notifyViews
)
566 // Notify the views that the filename has changed
567 wxList::compatibility_iterator node
= m_documentViews
.GetFirst();
570 wxView
*view
= (wxView
*)node
->GetData();
571 view
->OnChangeFilename();
572 node
= node
->GetNext();
577 bool wxDocument::DoSaveDocument(const wxString
& file
)
579 #if wxUSE_STD_IOSTREAM
580 wxSTD ofstream
store(file
.mb_str(), wxSTD
ios::binary
);
583 wxFileOutputStream
store(file
);
584 if ( store
.GetLastError() != wxSTREAM_NO_ERROR
)
587 wxLogError(_("File \"%s\" could not be opened for writing."), file
);
591 if (!SaveObject(store
))
593 wxLogError(_("Failed to save document to the file \"%s\"."), file
);
600 bool wxDocument::DoOpenDocument(const wxString
& file
)
602 #if wxUSE_STD_IOSTREAM
603 wxSTD ifstream
store(file
.mb_str(), wxSTD
ios::binary
);
606 wxFileInputStream
store(file
);
607 if (store
.GetLastError() != wxSTREAM_NO_ERROR
|| !store
.IsOk())
610 wxLogError(_("File \"%s\" could not be opened for reading."), file
);
614 #if wxUSE_STD_IOSTREAM
618 int res
= LoadObject(store
).GetLastError();
619 if ( res
!= wxSTREAM_NO_ERROR
&& res
!= wxSTREAM_EOF
)
622 wxLogError(_("Failed to read document from the file \"%s\"."), file
);
630 // ----------------------------------------------------------------------------
632 // ----------------------------------------------------------------------------
636 m_viewDocument
= NULL
;
643 GetDocumentManager()->ActivateView(this, false);
644 m_viewDocument
->RemoveView(this);
647 bool wxView::TryValidator(wxEvent
& event
)
649 wxDocument
* const doc
= GetDocument();
650 return doc
&& doc
->ProcessEventHere(event
);
653 void wxView::OnActivateView(bool WXUNUSED(activate
), wxView
*WXUNUSED(activeView
), wxView
*WXUNUSED(deactiveView
))
657 void wxView::OnPrint(wxDC
*dc
, wxObject
*WXUNUSED(info
))
662 void wxView::OnUpdate(wxView
*WXUNUSED(sender
), wxObject
*WXUNUSED(hint
))
666 void wxView::OnChangeFilename()
668 // GetFrame can return wxWindow rather than wxTopLevelWindow due to
669 // generic MDI implementation so use SetLabel rather than SetTitle.
670 // It should cause SetTitle() for top level windows.
671 wxWindow
*win
= GetFrame();
674 wxDocument
*doc
= GetDocument();
677 win
->SetLabel(doc
->GetUserReadableName());
680 void wxView::SetDocument(wxDocument
*doc
)
682 m_viewDocument
= doc
;
687 bool wxView::Close(bool deleteWindow
)
689 return OnClose(deleteWindow
);
692 void wxView::Activate(bool activate
)
694 if (GetDocument() && GetDocumentManager())
696 OnActivateView(activate
, this, GetDocumentManager()->GetCurrentView());
697 GetDocumentManager()->ActivateView(this, activate
);
701 bool wxView::OnClose(bool WXUNUSED(deleteWindow
))
703 return GetDocument() ? GetDocument()->Close() : true;
706 #if wxUSE_PRINTING_ARCHITECTURE
707 wxPrintout
*wxView::OnCreatePrintout()
709 return new wxDocPrintout(this);
711 #endif // wxUSE_PRINTING_ARCHITECTURE
713 // ----------------------------------------------------------------------------
715 // ----------------------------------------------------------------------------
717 wxDocTemplate::wxDocTemplate(wxDocManager
*manager
,
718 const wxString
& descr
,
719 const wxString
& filter
,
722 const wxString
& docTypeName
,
723 const wxString
& viewTypeName
,
724 wxClassInfo
*docClassInfo
,
725 wxClassInfo
*viewClassInfo
,
728 m_documentManager
= manager
;
729 m_description
= descr
;
732 m_fileFilter
= filter
;
734 m_docTypeName
= docTypeName
;
735 m_viewTypeName
= viewTypeName
;
736 m_documentManager
->AssociateTemplate(this);
738 m_docClassInfo
= docClassInfo
;
739 m_viewClassInfo
= viewClassInfo
;
742 wxDocTemplate::~wxDocTemplate()
744 m_documentManager
->DisassociateTemplate(this);
747 // Tries to dynamically construct an object of the right class.
748 wxDocument
*wxDocTemplate::CreateDocument(const wxString
& path
, long flags
)
750 wxDocument
* const doc
= DoCreateDocument();
752 // VZ: this code doesn't delete doc if InitDocument() (i.e. doc->OnCreate())
753 // fails, is this intentional?
755 return doc
&& InitDocument(doc
, path
, flags
) ? doc
: NULL
;
759 wxDocTemplate::InitDocument(wxDocument
* doc
, const wxString
& path
, long flags
)
761 doc
->SetFilename(path
);
762 doc
->SetDocumentTemplate(this);
763 GetDocumentManager()->AddDocument(doc
);
764 doc
->SetCommandProcessor(doc
->OnCreateCommandProcessor());
766 if (doc
->OnCreate(path
, flags
))
770 if (GetDocumentManager()->GetDocuments().Member(doc
))
771 doc
->DeleteAllViews();
776 wxView
*wxDocTemplate::CreateView(wxDocument
*doc
, long flags
)
778 wxScopedPtr
<wxView
> view(DoCreateView());
782 view
->SetDocument(doc
);
783 if ( !view
->OnCreate(doc
, flags
) )
786 return view
.release();
789 // The default (very primitive) format detection: check is the extension is
790 // that of the template
791 bool wxDocTemplate::FileMatchesTemplate(const wxString
& path
)
793 wxStringTokenizer
parser (GetFileFilter(), wxT(";"));
794 wxString anything
= wxT ("*");
795 while (parser
.HasMoreTokens())
797 wxString filter
= parser
.GetNextToken();
798 wxString filterExt
= FindExtension (filter
);
799 if ( filter
.IsSameAs (anything
) ||
800 filterExt
.IsSameAs (anything
) ||
801 filterExt
.IsSameAs (FindExtension (path
)) )
804 return GetDefaultExtension().IsSameAs(FindExtension(path
));
807 wxDocument
*wxDocTemplate::DoCreateDocument()
812 return (wxDocument
*)m_docClassInfo
->CreateObject();
815 wxView
*wxDocTemplate::DoCreateView()
817 if (!m_viewClassInfo
)
820 return (wxView
*)m_viewClassInfo
->CreateObject();
823 // ----------------------------------------------------------------------------
825 // ----------------------------------------------------------------------------
827 BEGIN_EVENT_TABLE(wxDocManager
, wxEvtHandler
)
828 EVT_MENU(wxID_OPEN
, wxDocManager::OnFileOpen
)
829 EVT_MENU(wxID_CLOSE
, wxDocManager::OnFileClose
)
830 EVT_MENU(wxID_CLOSE_ALL
, wxDocManager::OnFileCloseAll
)
831 EVT_MENU(wxID_REVERT
, wxDocManager::OnFileRevert
)
832 EVT_MENU(wxID_NEW
, wxDocManager::OnFileNew
)
833 EVT_MENU(wxID_SAVE
, wxDocManager::OnFileSave
)
834 EVT_MENU(wxID_SAVEAS
, wxDocManager::OnFileSaveAs
)
835 EVT_MENU(wxID_UNDO
, wxDocManager::OnUndo
)
836 EVT_MENU(wxID_REDO
, wxDocManager::OnRedo
)
838 EVT_UPDATE_UI(wxID_OPEN
, wxDocManager::OnUpdateFileOpen
)
839 EVT_UPDATE_UI(wxID_CLOSE
, wxDocManager::OnUpdateDisableIfNoDoc
)
840 EVT_UPDATE_UI(wxID_CLOSE_ALL
, wxDocManager::OnUpdateDisableIfNoDoc
)
841 EVT_UPDATE_UI(wxID_REVERT
, wxDocManager::OnUpdateDisableIfNoDoc
)
842 EVT_UPDATE_UI(wxID_NEW
, wxDocManager::OnUpdateFileNew
)
843 EVT_UPDATE_UI(wxID_SAVE
, wxDocManager::OnUpdateFileSave
)
844 EVT_UPDATE_UI(wxID_SAVEAS
, wxDocManager::OnUpdateDisableIfNoDoc
)
845 EVT_UPDATE_UI(wxID_UNDO
, wxDocManager::OnUpdateUndo
)
846 EVT_UPDATE_UI(wxID_REDO
, wxDocManager::OnUpdateRedo
)
848 #if wxUSE_PRINTING_ARCHITECTURE
849 EVT_MENU(wxID_PRINT
, wxDocManager::OnPrint
)
850 EVT_MENU(wxID_PREVIEW
, wxDocManager::OnPreview
)
852 EVT_UPDATE_UI(wxID_PRINT
, wxDocManager::OnUpdateDisableIfNoDoc
)
853 EVT_UPDATE_UI(wxID_PREVIEW
, wxDocManager::OnUpdateDisableIfNoDoc
)
857 wxDocManager
* wxDocManager::sm_docManager
= NULL
;
859 wxDocManager::wxDocManager(long WXUNUSED(flags
), bool initialize
)
861 wxASSERT_MSG( !sm_docManager
, "multiple wxDocManagers not allowed" );
863 sm_docManager
= this;
865 m_defaultDocumentNameCounter
= 1;
866 m_currentView
= NULL
;
867 m_maxDocsOpen
= INT_MAX
;
868 m_fileHistory
= NULL
;
873 wxDocManager::~wxDocManager()
876 delete m_fileHistory
;
877 sm_docManager
= NULL
;
880 // closes the specified document
881 bool wxDocManager::CloseDocument(wxDocument
* doc
, bool force
)
883 if (doc
->Close() || force
)
885 // Implicitly deletes the document when
886 // the last view is deleted
887 doc
->DeleteAllViews();
889 // Check we're really deleted
890 if (m_docs
.Member(doc
))
898 bool wxDocManager::CloseDocuments(bool force
)
900 wxList::compatibility_iterator node
= m_docs
.GetFirst();
903 wxDocument
*doc
= (wxDocument
*)node
->GetData();
904 wxList::compatibility_iterator next
= node
->GetNext();
906 if (!CloseDocument(doc
, force
))
909 // This assumes that documents are not connected in
910 // any way, i.e. deleting one document does NOT
917 bool wxDocManager::Clear(bool force
)
919 if (!CloseDocuments(force
))
922 m_currentView
= NULL
;
924 wxList::compatibility_iterator node
= m_templates
.GetFirst();
927 wxDocTemplate
*templ
= (wxDocTemplate
*) node
->GetData();
928 wxList::compatibility_iterator next
= node
->GetNext();
935 bool wxDocManager::Initialize()
937 m_fileHistory
= OnCreateFileHistory();
941 wxFileHistory
*wxDocManager::OnCreateFileHistory()
943 return new wxFileHistory
;
946 void wxDocManager::OnFileClose(wxCommandEvent
& WXUNUSED(event
))
948 wxDocument
*doc
= GetCurrentDocument();
953 doc
->DeleteAllViews();
954 if (m_docs
.Member(doc
))
959 void wxDocManager::OnFileCloseAll(wxCommandEvent
& WXUNUSED(event
))
961 CloseDocuments(false);
964 void wxDocManager::OnFileNew(wxCommandEvent
& WXUNUSED(event
))
969 void wxDocManager::OnFileOpen(wxCommandEvent
& WXUNUSED(event
))
971 if ( !CreateDocument( wxEmptyString
, 0) )
977 void wxDocManager::OnFileRevert(wxCommandEvent
& WXUNUSED(event
))
979 wxDocument
*doc
= GetCurrentDocument();
985 void wxDocManager::OnFileSave(wxCommandEvent
& WXUNUSED(event
))
987 wxDocument
*doc
= GetCurrentDocument();
993 void wxDocManager::OnFileSaveAs(wxCommandEvent
& WXUNUSED(event
))
995 wxDocument
*doc
= GetCurrentDocument();
1001 void wxDocManager::OnPrint(wxCommandEvent
& WXUNUSED(event
))
1003 #if wxUSE_PRINTING_ARCHITECTURE
1004 wxView
*view
= GetCurrentView();
1008 wxPrintout
*printout
= view
->OnCreatePrintout();
1012 printer
.Print(view
->GetFrame(), printout
, true);
1016 #endif // wxUSE_PRINTING_ARCHITECTURE
1019 void wxDocManager::OnPreview(wxCommandEvent
& WXUNUSED(event
))
1021 #if wxUSE_PRINTING_ARCHITECTURE
1022 wxView
*view
= GetCurrentView();
1026 wxPrintout
*printout
= view
->OnCreatePrintout();
1029 // Pass two printout objects: for preview, and possible printing.
1030 wxPrintPreviewBase
*preview
= new wxPrintPreview(printout
, view
->OnCreatePrintout());
1031 if ( !preview
->Ok() )
1034 wxMessageBox( _("Sorry, print preview needs a printer to be installed.") );
1038 wxPreviewFrame
*frame
= new wxPreviewFrame(preview
, (wxFrame
*)wxTheApp
->GetTopWindow(), _("Print Preview"),
1039 wxPoint(100, 100), wxSize(600, 650));
1040 frame
->Centre(wxBOTH
);
1041 frame
->Initialize();
1044 #endif // wxUSE_PRINTING_ARCHITECTURE
1047 void wxDocManager::OnUndo(wxCommandEvent
& event
)
1049 wxDocument
*doc
= GetCurrentDocument();
1052 if (doc
->GetCommandProcessor())
1053 doc
->GetCommandProcessor()->Undo();
1058 void wxDocManager::OnRedo(wxCommandEvent
& event
)
1060 wxDocument
*doc
= GetCurrentDocument();
1063 if (doc
->GetCommandProcessor())
1064 doc
->GetCommandProcessor()->Redo();
1069 // Handlers for UI update commands
1071 void wxDocManager::OnUpdateFileOpen(wxUpdateUIEvent
& event
)
1073 event
.Enable( true );
1076 void wxDocManager::OnUpdateDisableIfNoDoc(wxUpdateUIEvent
& event
)
1078 event
.Enable( GetCurrentDocument() != NULL
);
1081 void wxDocManager::OnUpdateFileNew(wxUpdateUIEvent
& event
)
1083 event
.Enable( true );
1086 void wxDocManager::OnUpdateFileSave(wxUpdateUIEvent
& event
)
1088 wxDocument
* const doc
= GetCurrentDocument();
1089 event
.Enable( doc
&& !doc
->AlreadySaved() );
1092 void wxDocManager::OnUpdateUndo(wxUpdateUIEvent
& event
)
1094 wxDocument
*doc
= GetCurrentDocument();
1096 event
.Enable(false);
1097 else if (!doc
->GetCommandProcessor())
1101 event
.Enable( doc
->GetCommandProcessor()->CanUndo() );
1102 doc
->GetCommandProcessor()->SetMenuStrings();
1106 void wxDocManager::OnUpdateRedo(wxUpdateUIEvent
& event
)
1108 wxDocument
*doc
= GetCurrentDocument();
1110 event
.Enable(false);
1111 else if (!doc
->GetCommandProcessor())
1115 event
.Enable( doc
->GetCommandProcessor()->CanRedo() );
1116 doc
->GetCommandProcessor()->SetMenuStrings();
1120 wxView
*wxDocManager::GetCurrentView() const
1123 return m_currentView
;
1124 if (m_docs
.GetCount() == 1)
1126 wxDocument
* doc
= (wxDocument
*) m_docs
.GetFirst()->GetData();
1127 return doc
->GetFirstView();
1132 bool wxDocManager::TryValidator(wxEvent
& event
)
1134 wxView
* const view
= GetCurrentView();
1135 return view
&& view
->ProcessEventHere(event
);
1141 // helper function: return only the visible templates
1142 wxDocTemplates
GetVisibleTemplates(const wxList
& allTemplates
)
1144 // select only the visible templates
1145 const size_t totalNumTemplates
= allTemplates
.GetCount();
1146 wxDocTemplates templates
;
1147 if ( totalNumTemplates
)
1149 templates
.reserve(totalNumTemplates
);
1151 for ( wxList::const_iterator i
= allTemplates
.begin(),
1152 end
= allTemplates
.end();
1156 wxDocTemplate
* const temp
= (wxDocTemplate
*)*i
;
1157 if ( temp
->IsVisible() )
1158 templates
.push_back(temp
);
1165 } // anonymous namespace
1167 wxDocument
*wxDocManager::CreateDocument(const wxString
& pathOrig
, long flags
)
1169 // this ought to be const but SelectDocumentType/Path() are not
1170 // const-correct and can't be changed as, being virtual, this risks
1171 // breaking user code overriding them
1172 wxDocTemplates
templates(GetVisibleTemplates(m_templates
));
1173 const size_t numTemplates
= templates
.size();
1174 if ( !numTemplates
)
1176 // no templates can be used, can't create document
1181 // normally user should select the template to use but wxDOC_SILENT flag we
1182 // choose one ourselves
1183 wxString path
= pathOrig
; // may be modified below
1184 wxDocTemplate
*temp
;
1185 if ( flags
& wxDOC_SILENT
)
1187 wxASSERT_MSG( !path
.empty(),
1188 "using empty path with wxDOC_SILENT doesn't make sense" );
1190 temp
= FindTemplateForPath(path
);
1193 wxLogWarning(_("The format of file '%s' couldn't be determined."),
1197 else // not silent, ask the user
1199 // for the new file we need just the template, for an existing one we
1200 // need the template and the path, unless it's already specified
1201 if ( (flags
& wxDOC_NEW
) || !path
.empty() )
1202 temp
= SelectDocumentType(&templates
[0], numTemplates
);
1204 temp
= SelectDocumentPath(&templates
[0], numTemplates
, path
, flags
);
1210 // check whether the document with this path is already opened
1211 if ( !path
.empty() )
1213 const wxFileName
fn(path
);
1214 for ( wxList::const_iterator i
= m_docs
.begin(); i
!= m_docs
.end(); ++i
)
1216 wxDocument
* const doc
= (wxDocument
*)*i
;
1218 if ( fn
== doc
->GetFilename() )
1220 // file already open, just activate it and return
1221 if ( doc
->GetFirstView() )
1223 ActivateView(doc
->GetFirstView());
1224 if ( doc
->GetDocumentWindow() )
1225 doc
->GetDocumentWindow()->SetFocus();
1233 // no, we need to create a new document
1236 // if we've reached the max number of docs, close the first one.
1237 if ( (int)GetDocuments().GetCount() >= m_maxDocsOpen
)
1239 if ( !CloseDocument((wxDocument
*)GetDocuments().GetFirst()->GetData()) )
1241 // can't open the new document if closing the old one failed
1247 // do create and initialize the new document finally
1248 wxDocument
* const docNew
= temp
->CreateDocument(path
, flags
);
1252 docNew
->SetDocumentName(temp
->GetDocumentName());
1253 docNew
->SetDocumentTemplate(temp
);
1255 // call the appropriate function depending on whether we're creating a new
1256 // file or opening an existing one
1257 if ( !(flags
& wxDOC_NEW
? docNew
->OnNewDocument()
1258 : docNew
->OnOpenDocument(path
)) )
1260 // Document is implicitly deleted by DeleteAllViews
1261 docNew
->DeleteAllViews();
1265 // add the successfully opened file to MRU, but only if we're going to be
1266 // able to reopen it successfully later which requires the template for
1267 // this document to be retrievable from the file extension
1268 if ( !(flags
& wxDOC_NEW
) && temp
->FileMatchesTemplate(path
) )
1269 AddFileToHistory(path
);
1274 wxView
*wxDocManager::CreateView(wxDocument
*doc
, long flags
)
1276 wxDocTemplates
templates(GetVisibleTemplates(m_templates
));
1277 const size_t numTemplates
= templates
.size();
1279 if ( numTemplates
== 0 )
1282 wxDocTemplate
* const
1283 temp
= numTemplates
== 1 ? templates
[0]
1284 : SelectViewType(&templates
[0], numTemplates
);
1289 wxView
*view
= temp
->CreateView(doc
, flags
);
1291 view
->SetViewName(temp
->GetViewName());
1295 // Not yet implemented
1297 wxDocManager::DeleteTemplate(wxDocTemplate
*WXUNUSED(temp
), long WXUNUSED(flags
))
1301 // Not yet implemented
1302 bool wxDocManager::FlushDoc(wxDocument
*WXUNUSED(doc
))
1307 wxDocument
*wxDocManager::GetCurrentDocument() const
1309 wxView
*view
= GetCurrentView();
1311 return view
->GetDocument();
1316 // Make a default name for a new document
1317 #if WXWIN_COMPATIBILITY_2_8
1318 bool wxDocManager::MakeDefaultName(wxString
& WXUNUSED(name
))
1320 // we consider that this function can only be overridden by the user code,
1321 // not called by it as it only makes sense to call it internally, so we
1322 // don't bother to return anything from here
1325 #endif // WXWIN_COMPATIBILITY_2_8
1327 wxString
wxDocManager::MakeNewDocumentName()
1331 #if WXWIN_COMPATIBILITY_2_8
1332 if ( !MakeDefaultName(name
) )
1333 #endif // WXWIN_COMPATIBILITY_2_8
1335 name
.Printf(_("unnamed%d"), m_defaultDocumentNameCounter
);
1336 m_defaultDocumentNameCounter
++;
1342 // Make a frame title (override this to do something different)
1343 // If docName is empty, a document is not currently active.
1344 wxString
wxDocManager::MakeFrameTitle(wxDocument
* doc
)
1346 wxString appName
= wxTheApp
->GetAppDisplayName();
1352 wxString docName
= doc
->GetUserReadableName();
1353 title
= docName
+ wxString(_(" - ")) + appName
;
1359 // Not yet implemented
1360 wxDocTemplate
*wxDocManager::MatchTemplate(const wxString
& WXUNUSED(path
))
1365 // File history management
1366 void wxDocManager::AddFileToHistory(const wxString
& file
)
1369 m_fileHistory
->AddFileToHistory(file
);
1372 void wxDocManager::RemoveFileFromHistory(size_t i
)
1375 m_fileHistory
->RemoveFileFromHistory(i
);
1378 wxString
wxDocManager::GetHistoryFile(size_t i
) const
1383 histFile
= m_fileHistory
->GetHistoryFile(i
);
1388 void wxDocManager::FileHistoryUseMenu(wxMenu
*menu
)
1391 m_fileHistory
->UseMenu(menu
);
1394 void wxDocManager::FileHistoryRemoveMenu(wxMenu
*menu
)
1397 m_fileHistory
->RemoveMenu(menu
);
1401 void wxDocManager::FileHistoryLoad(const wxConfigBase
& config
)
1404 m_fileHistory
->Load(config
);
1407 void wxDocManager::FileHistorySave(wxConfigBase
& config
)
1410 m_fileHistory
->Save(config
);
1414 void wxDocManager::FileHistoryAddFilesToMenu(wxMenu
* menu
)
1417 m_fileHistory
->AddFilesToMenu(menu
);
1420 void wxDocManager::FileHistoryAddFilesToMenu()
1423 m_fileHistory
->AddFilesToMenu();
1426 size_t wxDocManager::GetHistoryFilesCount() const
1428 return m_fileHistory
? m_fileHistory
->GetCount() : 0;
1432 // Find out the document template via matching in the document file format
1433 // against that of the template
1434 wxDocTemplate
*wxDocManager::FindTemplateForPath(const wxString
& path
)
1436 wxDocTemplate
*theTemplate
= NULL
;
1438 // Find the template which this extension corresponds to
1439 for (size_t i
= 0; i
< m_templates
.GetCount(); i
++)
1441 wxDocTemplate
*temp
= (wxDocTemplate
*)m_templates
.Item(i
)->GetData();
1442 if ( temp
->FileMatchesTemplate(path
) )
1451 // Prompts user to open a file, using file specs in templates.
1452 // Must extend the file selector dialog or implement own; OR
1453 // match the extension to the template extension.
1455 wxDocTemplate
*wxDocManager::SelectDocumentPath(wxDocTemplate
**templates
,
1458 long WXUNUSED(flags
),
1459 bool WXUNUSED(save
))
1461 // We can only have multiple filters in Windows and GTK
1462 #if defined(__WXMSW__) || defined(__WXGTK__) || defined(__WXMAC__)
1466 for (i
= 0; i
< noTemplates
; i
++)
1468 if (templates
[i
]->IsVisible())
1470 // add a '|' to separate this filter from the previous one
1471 if ( !descrBuf
.empty() )
1472 descrBuf
<< wxT('|');
1474 descrBuf
<< templates
[i
]->GetDescription()
1475 << wxT(" (") << templates
[i
]->GetFileFilter() << wxT(") |")
1476 << templates
[i
]->GetFileFilter();
1480 wxString descrBuf
= wxT("*.*");
1481 wxUnusedVar(noTemplates
);
1484 int FilterIndex
= -1;
1486 wxWindow
* parent
= wxFindSuitableParent();
1488 wxString pathTmp
= wxFileSelectorEx(_("Open File"),
1496 wxDocTemplate
*theTemplate
= NULL
;
1497 if (!pathTmp
.empty())
1499 if (!wxFileExists(pathTmp
))
1502 if (!wxTheApp
->GetAppDisplayName().empty())
1503 msgTitle
= wxTheApp
->GetAppDisplayName();
1505 msgTitle
= wxString(_("File error"));
1507 (void)wxMessageBox(_("Sorry, could not open this file."), msgTitle
, wxOK
| wxICON_EXCLAMATION
| wxCENTRE
,
1510 path
= wxEmptyString
;
1513 m_lastDirectory
= wxPathOnly(pathTmp
);
1517 // first choose the template using the extension, if this fails (i.e.
1518 // wxFileSelectorEx() didn't fill it), then use the path
1519 if ( FilterIndex
!= -1 )
1520 theTemplate
= templates
[FilterIndex
];
1522 theTemplate
= FindTemplateForPath(path
);
1525 // Since we do not add files with non-default extensions to the FileHistory this
1526 // can only happen if the application changes the allowed templates in runtime.
1527 (void)wxMessageBox(_("Sorry, the format for this file is unknown."),
1529 wxOK
| wxICON_EXCLAMATION
| wxCENTRE
, wxFindSuitableParent());
1534 path
= wxEmptyString
;
1540 wxDocTemplate
*wxDocManager::SelectDocumentType(wxDocTemplate
**templates
,
1541 int noTemplates
, bool sort
)
1543 wxArrayString strings
;
1544 wxDocTemplate
**data
= new wxDocTemplate
*[noTemplates
];
1548 for (i
= 0; i
< noTemplates
; i
++)
1550 if (templates
[i
]->IsVisible())
1554 for (j
= 0; j
< n
; j
++)
1556 //filter out NOT unique documents + view combinations
1557 if ( templates
[i
]->m_docTypeName
== data
[j
]->m_docTypeName
&&
1558 templates
[i
]->m_viewTypeName
== data
[j
]->m_viewTypeName
1565 strings
.Add(templates
[i
]->m_description
);
1567 data
[n
] = templates
[i
];
1575 strings
.Sort(); // ascending sort
1576 // Yes, this will be slow, but template lists
1577 // are typically short.
1579 n
= strings
.Count();
1580 for (i
= 0; i
< n
; i
++)
1582 for (j
= 0; j
< noTemplates
; j
++)
1584 if (strings
[i
] == templates
[j
]->m_description
)
1585 data
[i
] = templates
[j
];
1590 wxDocTemplate
*theTemplate
;
1595 // no visible templates, hence nothing to choose from
1600 // don't propose the user to choose if he has no choice
1601 theTemplate
= data
[0];
1605 // propose the user to choose one of several
1606 theTemplate
= (wxDocTemplate
*)wxGetSingleChoiceData
1608 _("Select a document template"),
1612 wxFindSuitableParent()
1621 wxDocTemplate
*wxDocManager::SelectViewType(wxDocTemplate
**templates
,
1622 int noTemplates
, bool sort
)
1624 wxArrayString strings
;
1625 wxDocTemplate
**data
= new wxDocTemplate
*[noTemplates
];
1629 for (i
= 0; i
< noTemplates
; i
++)
1631 wxDocTemplate
*templ
= templates
[i
];
1632 if ( templ
->IsVisible() && !templ
->GetViewName().empty() )
1636 for (j
= 0; j
< n
; j
++)
1638 //filter out NOT unique views
1639 if ( templates
[i
]->m_viewTypeName
== data
[j
]->m_viewTypeName
)
1645 strings
.Add(templ
->m_viewTypeName
);
1654 strings
.Sort(); // ascending sort
1655 // Yes, this will be slow, but template lists
1656 // are typically short.
1658 n
= strings
.Count();
1659 for (i
= 0; i
< n
; i
++)
1661 for (j
= 0; j
< noTemplates
; j
++)
1663 if (strings
[i
] == templates
[j
]->m_viewTypeName
)
1664 data
[i
] = templates
[j
];
1669 wxDocTemplate
*theTemplate
;
1671 // the same logic as above
1679 theTemplate
= data
[0];
1683 theTemplate
= (wxDocTemplate
*)wxGetSingleChoiceData
1685 _("Select a document view"),
1689 wxFindSuitableParent()
1698 void wxDocManager::AssociateTemplate(wxDocTemplate
*temp
)
1700 if (!m_templates
.Member(temp
))
1701 m_templates
.Append(temp
);
1704 void wxDocManager::DisassociateTemplate(wxDocTemplate
*temp
)
1706 m_templates
.DeleteObject(temp
);
1709 // Add and remove a document from the manager's list
1710 void wxDocManager::AddDocument(wxDocument
*doc
)
1712 if (!m_docs
.Member(doc
))
1716 void wxDocManager::RemoveDocument(wxDocument
*doc
)
1718 m_docs
.DeleteObject(doc
);
1721 // Views or windows should inform the document manager
1722 // when a view is going in or out of focus
1723 void wxDocManager::ActivateView(wxView
*view
, bool activate
)
1727 m_currentView
= view
;
1731 if ( m_currentView
== view
)
1733 // don't keep stale pointer
1734 m_currentView
= NULL
;
1739 // ----------------------------------------------------------------------------
1740 // Default document child frame
1741 // ----------------------------------------------------------------------------
1743 BEGIN_EVENT_TABLE(wxDocChildFrame
, wxFrame
)
1744 EVT_ACTIVATE(wxDocChildFrame::OnActivate
)
1745 EVT_CLOSE(wxDocChildFrame::OnCloseWindow
)
1748 wxDocChildFrame::wxDocChildFrame(wxDocument
*doc
,
1752 const wxString
& title
,
1756 const wxString
& name
)
1757 : wxFrame(frame
, id
, title
, pos
, size
, style
, name
)
1759 m_childDocument
= doc
;
1762 view
->SetFrame(this);
1765 bool wxDocChildFrame::TryValidator(wxEvent
& event
)
1770 // FIXME: why is this needed here?
1771 m_childView
->Activate(true);
1773 return m_childView
->ProcessEventHere(event
);
1776 void wxDocChildFrame::OnActivate(wxActivateEvent
& event
)
1778 wxFrame::OnActivate(event
);
1781 m_childView
->Activate(event
.GetActive());
1784 void wxDocChildFrame::OnCloseWindow(wxCloseEvent
& event
)
1788 bool ans
= event
.CanVeto()
1789 ? m_childView
->Close(false) // false means don't delete associated window
1790 : true; // Must delete.
1794 m_childView
->Activate(false);
1797 m_childDocument
= NULL
;
1808 // ----------------------------------------------------------------------------
1809 // Default parent frame
1810 // ----------------------------------------------------------------------------
1812 BEGIN_EVENT_TABLE(wxDocParentFrame
, wxFrame
)
1813 EVT_MENU(wxID_EXIT
, wxDocParentFrame::OnExit
)
1814 EVT_MENU_RANGE(wxID_FILE1
, wxID_FILE9
, wxDocParentFrame::OnMRUFile
)
1815 EVT_CLOSE(wxDocParentFrame::OnCloseWindow
)
1818 wxDocParentFrame::wxDocParentFrame()
1820 m_docManager
= NULL
;
1823 wxDocParentFrame::wxDocParentFrame(wxDocManager
*manager
,
1826 const wxString
& title
,
1830 const wxString
& name
)
1831 : wxFrame(frame
, id
, title
, pos
, size
, style
, name
)
1833 m_docManager
= manager
;
1836 bool wxDocParentFrame::Create(wxDocManager
*manager
,
1839 const wxString
& title
,
1843 const wxString
& name
)
1845 m_docManager
= manager
;
1846 return base_type::Create(frame
, id
, title
, pos
, size
, style
, name
);
1849 void wxDocParentFrame::OnExit(wxCommandEvent
& WXUNUSED(event
))
1854 void wxDocParentFrame::OnMRUFile(wxCommandEvent
& event
)
1856 int n
= event
.GetId() - wxID_FILE1
; // the index in MRU list
1857 wxString
filename(m_docManager
->GetHistoryFile(n
));
1858 if ( filename
.empty() )
1861 wxString errMsg
; // must contain exactly one "%s" if non-empty
1862 if ( wxFile::Exists(filename
) )
1865 if ( m_docManager
->CreateDocument(filename
, wxDOC_SILENT
) )
1868 errMsg
= _("The file '%s' couldn't be opened.");
1870 else // file doesn't exist
1872 errMsg
= _("The file '%s' doesn't exist and couldn't be opened.");
1876 wxASSERT_MSG( !errMsg
.empty(), "should have an error message" );
1878 // remove the file which we can't open from the MRU list
1879 m_docManager
->RemoveFileFromHistory(n
);
1881 // and tell the user about it
1882 wxLogError(errMsg
+ '\n' +
1883 _("It has been removed from the most recently used files list."),
1887 // Extend event processing to search the view's event table
1888 bool wxDocParentFrame::TryValidator(wxEvent
& event
)
1890 return m_docManager
&& m_docManager
->ProcessEventHere(event
);
1893 // Define the behaviour for the frame closing
1894 // - must delete all frames except for the main one.
1895 void wxDocParentFrame::OnCloseWindow(wxCloseEvent
& event
)
1897 if (m_docManager
->Clear(!event
.CanVeto()))
1905 #if wxUSE_PRINTING_ARCHITECTURE
1907 wxDocPrintout::wxDocPrintout(wxView
*view
, const wxString
& title
)
1910 m_printoutView
= view
;
1913 bool wxDocPrintout::OnPrintPage(int WXUNUSED(page
))
1917 // Get the logical pixels per inch of screen and printer
1918 int ppiScreenX
, ppiScreenY
;
1919 GetPPIScreen(&ppiScreenX
, &ppiScreenY
);
1920 wxUnusedVar(ppiScreenY
);
1921 int ppiPrinterX
, ppiPrinterY
;
1922 GetPPIPrinter(&ppiPrinterX
, &ppiPrinterY
);
1923 wxUnusedVar(ppiPrinterY
);
1925 // This scales the DC so that the printout roughly represents the
1926 // the screen scaling. The text point size _should_ be the right size
1927 // but in fact is too small for some reason. This is a detail that will
1928 // need to be addressed at some point but can be fudged for the
1930 float scale
= (float)((float)ppiPrinterX
/(float)ppiScreenX
);
1932 // Now we have to check in case our real page size is reduced
1933 // (e.g. because we're drawing to a print preview memory DC)
1934 int pageWidth
, pageHeight
;
1936 dc
->GetSize(&w
, &h
);
1937 GetPageSizePixels(&pageWidth
, &pageHeight
);
1938 wxUnusedVar(pageHeight
);
1940 // If printer pageWidth == current DC width, then this doesn't
1941 // change. But w might be the preview bitmap width, so scale down.
1942 float overallScale
= scale
* (float)(w
/(float)pageWidth
);
1943 dc
->SetUserScale(overallScale
, overallScale
);
1947 m_printoutView
->OnDraw(dc
);
1952 bool wxDocPrintout::HasPage(int pageNum
)
1954 return (pageNum
== 1);
1957 bool wxDocPrintout::OnBeginDocument(int startPage
, int endPage
)
1959 if (!wxPrintout::OnBeginDocument(startPage
, endPage
))
1965 void wxDocPrintout::GetPageInfo(int *minPage
, int *maxPage
, int *selPageFrom
, int *selPageTo
)
1973 #endif // wxUSE_PRINTING_ARCHITECTURE
1975 // ----------------------------------------------------------------------------
1976 // File history (a.k.a. MRU, most recently used, files list)
1977 // ----------------------------------------------------------------------------
1979 wxFileHistory::wxFileHistory(size_t maxFiles
, wxWindowID idBase
)
1981 m_fileMaxFiles
= maxFiles
;
1985 void wxFileHistory::AddFileToHistory(const wxString
& file
)
1987 // check if we don't already have this file
1988 const wxFileName
fnNew(file
);
1990 numFiles
= m_fileHistory
.size();
1991 for ( i
= 0; i
< numFiles
; i
++ )
1993 if ( fnNew
== m_fileHistory
[i
] )
1995 // we do have it, move it to the top of the history
1996 RemoveFileFromHistory(i
);
2002 // if we already have a full history, delete the one at the end
2003 if ( numFiles
== m_fileMaxFiles
)
2005 RemoveFileFromHistory(--numFiles
);
2008 // add a new menu item to all file menus (they will be updated below)
2009 for ( wxList::compatibility_iterator node
= m_fileMenus
.GetFirst();
2011 node
= node
->GetNext() )
2013 wxMenu
* const menu
= (wxMenu
*)node
->GetData();
2015 if ( !numFiles
&& menu
->GetMenuItemCount() )
2016 menu
->AppendSeparator();
2018 // label doesn't matter, it will be set below anyhow, but it can't
2019 // be empty (this is supposed to indicate a stock item)
2020 menu
->Append(m_idBase
+ numFiles
, " ");
2023 // insert the new file in the beginning of the file history
2024 m_fileHistory
.insert(m_fileHistory
.begin(), file
);
2027 // update the labels in all menus
2028 for ( i
= 0; i
< numFiles
; i
++ )
2030 // if in same directory just show the filename; otherwise the full path
2031 const wxFileName
fnOld(m_fileHistory
[i
]);
2033 wxString pathInMenu
;
2034 if ( fnOld
.GetPath() == fnNew
.GetPath() )
2036 pathInMenu
= fnOld
.GetFullName();
2038 else // file in different directory
2040 // absolute path; could also set relative path
2041 pathInMenu
= m_fileHistory
[i
];
2044 for ( wxList::compatibility_iterator node
= m_fileMenus
.GetFirst();
2046 node
= node
->GetNext() )
2048 wxMenu
* const menu
= (wxMenu
*)node
->GetData();
2050 menu
->SetLabel(m_idBase
+ i
, GetMRUEntryLabel(i
, pathInMenu
));
2055 void wxFileHistory::RemoveFileFromHistory(size_t i
)
2057 size_t numFiles
= m_fileHistory
.size();
2058 wxCHECK_RET( i
< numFiles
,
2059 wxT("invalid index in wxFileHistory::RemoveFileFromHistory") );
2061 // delete the element from the array
2062 m_fileHistory
.RemoveAt(i
);
2065 for ( wxList::compatibility_iterator node
= m_fileMenus
.GetFirst();
2067 node
= node
->GetNext() )
2069 wxMenu
* const menu
= (wxMenu
*) node
->GetData();
2071 // shift filenames up
2072 for ( size_t j
= i
; j
< numFiles
; j
++ )
2074 menu
->SetLabel(m_idBase
+ j
, GetMRUEntryLabel(j
, m_fileHistory
[j
]));
2077 // delete the last menu item which is unused now
2078 const wxWindowID lastItemId
= m_idBase
+ numFiles
;
2079 if ( menu
->FindItem(lastItemId
) )
2080 menu
->Delete(lastItemId
);
2082 // delete the last separator too if no more files are left
2083 if ( m_fileHistory
.empty() )
2085 const wxMenuItemList::compatibility_iterator
2086 nodeLast
= menu
->GetMenuItems().GetLast();
2089 wxMenuItem
* const lastMenuItem
= nodeLast
->GetData();
2090 if ( lastMenuItem
->IsSeparator() )
2091 menu
->Delete(lastMenuItem
);
2093 //else: menu is empty somehow
2098 void wxFileHistory::UseMenu(wxMenu
*menu
)
2100 if ( !m_fileMenus
.Member(menu
) )
2101 m_fileMenus
.Append(menu
);
2104 void wxFileHistory::RemoveMenu(wxMenu
*menu
)
2106 m_fileMenus
.DeleteObject(menu
);
2110 void wxFileHistory::Load(const wxConfigBase
& config
)
2112 m_fileHistory
.Clear();
2115 buf
.Printf(wxT("file%d"), 1);
2117 wxString historyFile
;
2118 while ((m_fileHistory
.GetCount() < m_fileMaxFiles
) &&
2119 config
.Read(buf
, &historyFile
) && !historyFile
.empty())
2121 m_fileHistory
.Add(historyFile
);
2123 buf
.Printf(wxT("file%d"), (int)m_fileHistory
.GetCount()+1);
2124 historyFile
= wxEmptyString
;
2130 void wxFileHistory::Save(wxConfigBase
& config
)
2133 for (i
= 0; i
< m_fileMaxFiles
; i
++)
2136 buf
.Printf(wxT("file%d"), (int)i
+1);
2137 if (i
< m_fileHistory
.GetCount())
2138 config
.Write(buf
, wxString(m_fileHistory
[i
]));
2140 config
.Write(buf
, wxEmptyString
);
2143 #endif // wxUSE_CONFIG
2145 void wxFileHistory::AddFilesToMenu()
2147 if ( m_fileHistory
.empty() )
2150 for ( wxList::compatibility_iterator node
= m_fileMenus
.GetFirst();
2152 node
= node
->GetNext() )
2154 AddFilesToMenu((wxMenu
*) node
->GetData());
2158 void wxFileHistory::AddFilesToMenu(wxMenu
* menu
)
2160 if ( m_fileHistory
.empty() )
2163 if ( menu
->GetMenuItemCount() )
2164 menu
->AppendSeparator();
2166 for ( size_t i
= 0; i
< m_fileHistory
.GetCount(); i
++ )
2168 menu
->Append(m_idBase
+ i
, GetMRUEntryLabel(i
, m_fileHistory
[i
]));
2172 // ----------------------------------------------------------------------------
2173 // Permits compatibility with existing file formats and functions that
2174 // manipulate files directly
2175 // ----------------------------------------------------------------------------
2177 #if wxUSE_STD_IOSTREAM
2179 bool wxTransferFileToStream(const wxString
& filename
, wxSTD ostream
& stream
)
2181 wxFFile
file(filename
, _T("rb"));
2182 if ( !file
.IsOpened() )
2190 nRead
= file
.Read(buf
, WXSIZEOF(buf
));
2194 stream
.write(buf
, nRead
);
2198 while ( !file
.Eof() );
2203 bool wxTransferStreamToFile(wxSTD istream
& stream
, const wxString
& filename
)
2205 wxFFile
file(filename
, _T("wb"));
2206 if ( !file
.IsOpened() )
2212 stream
.read(buf
, WXSIZEOF(buf
));
2213 if ( !stream
.bad() ) // fail may be set on EOF, don't use operator!()
2215 if ( !file
.Write(buf
, stream
.gcount()) )
2219 while ( !stream
.eof() );
2224 #else // !wxUSE_STD_IOSTREAM
2226 bool wxTransferFileToStream(const wxString
& filename
, wxOutputStream
& stream
)
2228 wxFFile
file(filename
, _T("rb"));
2229 if ( !file
.IsOpened() )
2237 nRead
= file
.Read(buf
, WXSIZEOF(buf
));
2241 stream
.Write(buf
, nRead
);
2245 while ( !file
.Eof() );
2250 bool wxTransferStreamToFile(wxInputStream
& stream
, const wxString
& filename
)
2252 wxFFile
file(filename
, _T("wb"));
2253 if ( !file
.IsOpened() )
2259 stream
.Read(buf
, WXSIZEOF(buf
));
2261 const size_t nRead
= stream
.LastRead();
2270 if ( !file
.Write(buf
, nRead
) )
2277 #endif // wxUSE_STD_IOSTREAM/!wxUSE_STD_IOSTREAM
2279 #endif // wxUSE_DOC_VIEW_ARCHITECTURE