call event.Enable(true) in OnUpdateFileOpen and OnUpdateFileNew only if there are...
[wxWidgets.git] / src / common / docview.cpp
1 /////////////////////////////////////////////////////////////////////////////
2 // Name: src/common/docview.cpp
3 // Purpose: Document/view classes
4 // Author: Julian Smart
5 // Modified by: Vadim Zeitlin
6 // Created: 01/02/97
7 // RCS-ID: $Id$
8 // Copyright: (c) Julian Smart
9 // Licence: wxWindows licence
10 /////////////////////////////////////////////////////////////////////////////
11
12 // ============================================================================
13 // declarations
14 // ============================================================================
15
16 // ----------------------------------------------------------------------------
17 // headers
18 // ----------------------------------------------------------------------------
19
20 // For compilers that support precompilation, includes "wx.h".
21 #include "wx/wxprec.h"
22
23 #ifdef __BORLANDC__
24 #pragma hdrstop
25 #endif
26
27 #if wxUSE_DOC_VIEW_ARCHITECTURE
28
29 #include "wx/docview.h"
30
31 #ifndef WX_PRECOMP
32 #include "wx/list.h"
33 #include "wx/string.h"
34 #include "wx/utils.h"
35 #include "wx/app.h"
36 #include "wx/dc.h"
37 #include "wx/dialog.h"
38 #include "wx/menu.h"
39 #include "wx/filedlg.h"
40 #include "wx/intl.h"
41 #include "wx/log.h"
42 #include "wx/msgdlg.h"
43 #include "wx/mdi.h"
44 #include "wx/choicdlg.h"
45 #endif
46
47 #if wxUSE_PRINTING_ARCHITECTURE
48 #include "wx/prntbase.h"
49 #include "wx/printdlg.h"
50 #endif
51
52 #include "wx/confbase.h"
53 #include "wx/filename.h"
54 #include "wx/file.h"
55 #include "wx/ffile.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"
61
62 #if wxUSE_STD_IOSTREAM
63 #include "wx/ioswrap.h"
64 #include "wx/beforestd.h"
65 #if wxUSE_IOSTREAMH
66 #include <fstream.h>
67 #else
68 #include <fstream>
69 #endif
70 #include "wx/afterstd.h"
71 #else
72 #include "wx/wfstream.h"
73 #endif
74
75 typedef wxVector<wxDocTemplate *> wxDocTemplates;
76
77 // ----------------------------------------------------------------------------
78 // wxWidgets macros
79 // ----------------------------------------------------------------------------
80
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)
87
88 #if wxUSE_PRINTING_ARCHITECTURE
89 IMPLEMENT_DYNAMIC_CLASS(wxDocPrintout, wxPrintout)
90 #endif
91
92 IMPLEMENT_DYNAMIC_CLASS(wxFileHistory, wxObject)
93
94 // ============================================================================
95 // implementation
96 // ============================================================================
97
98 // ----------------------------------------------------------------------------
99 // private helpers
100 // ----------------------------------------------------------------------------
101
102 namespace
103 {
104
105 wxWindow *wxFindSuitableParent()
106 {
107 wxWindow * const win = wxGetTopLevelParent(wxWindow::FindFocus());
108
109 return win ? win : wxTheApp->GetTopWindow();
110 }
111
112 wxString FindExtension(const wxString& path)
113 {
114 wxString ext;
115 wxFileName::SplitPath(path, NULL, NULL, &ext);
116
117 // VZ: extensions are considered not case sensitive - is this really a good
118 // idea?
119 return ext.MakeLower();
120 }
121
122 // return the string used for the MRU list items in the menu
123 //
124 // NB: the index n is 0-based, as usual, but the strings start from 1
125 wxString GetMRUEntryLabel(int n, const wxString& path)
126 {
127 // we need to quote '&' characters which are used for mnemonics
128 wxString pathInMenu(path);
129 pathInMenu.Replace("&", "&&");
130
131 return wxString::Format("&%d %s", n + 1, pathInMenu);
132 }
133
134 } // anonymous namespace
135
136 // ----------------------------------------------------------------------------
137 // Definition of wxDocument
138 // ----------------------------------------------------------------------------
139
140 wxDocument::wxDocument(wxDocument *parent)
141 {
142 m_documentModified = false;
143 m_documentParent = parent;
144 m_documentTemplate = NULL;
145 m_commandProcessor = NULL;
146 m_savedYet = false;
147 }
148
149 bool wxDocument::DeleteContents()
150 {
151 return true;
152 }
153
154 wxDocument::~wxDocument()
155 {
156 DeleteContents();
157
158 if (m_commandProcessor)
159 delete m_commandProcessor;
160
161 if (GetDocumentManager())
162 GetDocumentManager()->RemoveDocument(this);
163
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.
167 //DeleteAllViews();
168 }
169
170 bool wxDocument::Close()
171 {
172 if (OnSaveModified())
173 return OnCloseDocument();
174 else
175 return false;
176 }
177
178 bool wxDocument::OnCloseDocument()
179 {
180 // Tell all views that we're about to close
181 NotifyClosing();
182 DeleteContents();
183 Modify(false);
184 return true;
185 }
186
187 // Note that this implicitly deletes the document when the last view is
188 // deleted.
189 bool wxDocument::DeleteAllViews()
190 {
191 wxDocManager* manager = GetDocumentManager();
192
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 )
196 {
197 wxView *view = (wxView *)*i;
198 if ( !view->Close() )
199 return false;
200 }
201
202 // all views agreed to close, now do close them
203 if ( m_documentViews.empty() )
204 {
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) )
208 delete this;
209 }
210 else // have views
211 {
212 // as we delete elements we iterate over, don't use the usual "from
213 // begin to end" loop
214 for ( ;; )
215 {
216 wxView *view = (wxView *)*m_documentViews.begin();
217
218 bool isLastOne = m_documentViews.size() == 1;
219
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!
223 delete view;
224
225 if ( isLastOne )
226 break;
227 }
228 }
229
230 return true;
231 }
232
233 wxView *wxDocument::GetFirstView() const
234 {
235 if (m_documentViews.GetCount() == 0)
236 return NULL;
237 return (wxView *)m_documentViews.GetFirst()->GetData();
238 }
239
240 wxDocManager *wxDocument::GetDocumentManager() const
241 {
242 return m_documentTemplate ? m_documentTemplate->GetDocumentManager() : NULL;
243 }
244
245 bool wxDocument::OnNewDocument()
246 {
247 if ( !OnSaveModified() )
248 return false;
249
250 DeleteContents();
251 Modify(false);
252 SetDocumentSaved(false);
253
254 const wxString name = GetDocumentManager()->MakeNewDocumentName();
255 SetTitle(name);
256 SetFilename(name, true);
257
258 return true;
259 }
260
261 bool wxDocument::Save()
262 {
263 if ( AlreadySaved() )
264 return true;
265
266 if ( m_documentFile.empty() || !m_savedYet )
267 return SaveAs();
268
269 return OnSaveDocument(m_documentFile);
270 }
271
272 bool wxDocument::SaveAs()
273 {
274 wxDocTemplate *docTemplate = GetDocumentTemplate();
275 if (!docTemplate)
276 return false;
277
278 #if defined(__WXMSW__) || defined(__WXGTK__) || defined(__WXMAC__)
279 wxString filter = docTemplate->GetDescription() + wxT(" (") + docTemplate->GetFileFilter() + wxT(")|") + docTemplate->GetFileFilter();
280
281 // Now see if there are some other template with identical view and document
282 // classes, whose filters may also be used.
283
284 if (docTemplate->GetViewClassInfo() && docTemplate->GetDocClassInfo())
285 {
286 wxList::compatibility_iterator node = docTemplate->GetDocumentManager()->GetTemplates().GetFirst();
287 while (node)
288 {
289 wxDocTemplate *t = (wxDocTemplate*) node->GetData();
290
291 if (t->IsVisible() && t != docTemplate &&
292 t->GetViewClassInfo() == docTemplate->GetViewClassInfo() &&
293 t->GetDocClassInfo() == docTemplate->GetDocClassInfo())
294 {
295 // add a '|' to separate this filter from the previous one
296 if ( !filter.empty() )
297 filter << wxT('|');
298
299 filter << t->GetDescription() << wxT(" (") << t->GetFileFilter() << wxT(") |")
300 << t->GetFileFilter();
301 }
302
303 node = node->GetNext();
304 }
305 }
306 #else
307 wxString filter = docTemplate->GetFileFilter() ;
308 #endif
309 wxString defaultDir = docTemplate->GetDirectory();
310 if (defaultDir.IsEmpty())
311 defaultDir = wxPathOnly(GetFilename());
312
313 wxString fileName = wxFileSelector(_("Save As"),
314 defaultDir,
315 wxFileNameFromPath(GetFilename()),
316 docTemplate->GetDefaultExtension(),
317 filter,
318 wxFD_SAVE | wxFD_OVERWRITE_PROMPT,
319 GetDocumentWindow());
320
321 if (fileName.empty())
322 return false;
323
324 wxString ext;
325 wxFileName::SplitPath(fileName, NULL, NULL, &ext);
326
327 if (ext.empty())
328 {
329 fileName += wxT(".");
330 fileName += docTemplate->GetDefaultExtension();
331 }
332
333 // Files that were not saved correctly are not added to the FileHistory.
334 if (!OnSaveDocument(fileName))
335 return false;
336
337 SetTitle(wxFileNameFromPath(fileName));
338 SetFilename(fileName, true); // will call OnChangeFileName automatically
339
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))
343 {
344 GetDocumentManager()->AddFileToHistory(fileName);
345 }
346 else
347 {
348 // The user will probably not be able to open the file again, so
349 // we could warn about the wrong file-extension here.
350 }
351 return true;
352 }
353
354 bool wxDocument::OnSaveDocument(const wxString& file)
355 {
356 if ( !file )
357 return false;
358
359 if ( !DoSaveDocument(file) )
360 return false;
361
362 Modify(false);
363 SetFilename(file);
364 SetDocumentSaved(true);
365 #if defined( __WXOSX_MAC__ ) && wxOSX_USE_CARBON
366 wxFileName fn(file) ;
367 fn.MacSetDefaultTypeAndCreator() ;
368 #endif
369 return true;
370 }
371
372 bool wxDocument::OnOpenDocument(const wxString& file)
373 {
374 if ( !OnSaveModified() )
375 return false;
376
377 if ( !DoOpenDocument(file) )
378 return false;
379
380 SetFilename(file, true);
381 Modify(false);
382 m_savedYet = true;
383
384 UpdateAllViews();
385
386 return true;
387 }
388
389 #if wxUSE_STD_IOSTREAM
390 wxSTD istream& wxDocument::LoadObject(wxSTD istream& stream)
391 #else
392 wxInputStream& wxDocument::LoadObject(wxInputStream& stream)
393 #endif
394 {
395 return stream;
396 }
397
398 #if wxUSE_STD_IOSTREAM
399 wxSTD ostream& wxDocument::SaveObject(wxSTD ostream& stream)
400 #else
401 wxOutputStream& wxDocument::SaveObject(wxOutputStream& stream)
402 #endif
403 {
404 return stream;
405 }
406
407 bool wxDocument::Revert()
408 {
409 return false;
410 }
411
412
413 // Get title, or filename if no title, else unnamed
414 #if WXWIN_COMPATIBILITY_2_8
415 bool wxDocument::GetPrintableName(wxString& buf) const
416 {
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();
422
423 return true;
424 }
425 #endif // WXWIN_COMPATIBILITY_2_8
426
427 wxString wxDocument::GetUserReadableName() const
428 {
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
432 wxString name;
433 if ( GetPrintableName(name) )
434 return name;
435 #endif // WXWIN_COMPATIBILITY_2_8
436
437 return DoGetUserReadableName();
438 }
439
440 wxString wxDocument::DoGetUserReadableName() const
441 {
442 if ( !m_documentTitle.empty() )
443 return m_documentTitle;
444
445 if ( !m_documentFile.empty() )
446 return wxFileNameFromPath(m_documentFile);
447
448 return _("unnamed");
449 }
450
451 wxWindow *wxDocument::GetDocumentWindow() const
452 {
453 wxView *view = GetFirstView();
454 if (view)
455 return view->GetFrame();
456 else
457 return wxTheApp->GetTopWindow();
458 }
459
460 wxCommandProcessor *wxDocument::OnCreateCommandProcessor()
461 {
462 return new wxCommandProcessor;
463 }
464
465 // true if safe to close
466 bool wxDocument::OnSaveModified()
467 {
468 if ( IsModified() )
469 {
470 switch ( wxMessageBox
471 (
472 wxString::Format
473 (
474 _("Do you want to save changes to document %s?"),
475 GetUserReadableName()
476 ),
477 wxTheApp->GetAppDisplayName(),
478 wxYES_NO | wxCANCEL | wxICON_QUESTION | wxCENTRE,
479 wxFindSuitableParent()
480 ) )
481 {
482 case wxNO:
483 Modify(false);
484 break;
485
486 case wxYES:
487 return Save();
488
489 case wxCANCEL:
490 return false;
491 }
492 }
493
494 return true;
495 }
496
497 bool wxDocument::Draw(wxDC& WXUNUSED(context))
498 {
499 return true;
500 }
501
502 bool wxDocument::AddView(wxView *view)
503 {
504 if ( !m_documentViews.Member(view) )
505 {
506 m_documentViews.Append(view);
507 OnChangedViewList();
508 }
509 return true;
510 }
511
512 bool wxDocument::RemoveView(wxView *view)
513 {
514 (void)m_documentViews.DeleteObject(view);
515 OnChangedViewList();
516 return true;
517 }
518
519 bool wxDocument::OnCreate(const wxString& WXUNUSED(path), long flags)
520 {
521 return GetDocumentTemplate()->CreateView(this, flags) != NULL;
522 }
523
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()
528 {
529 if ( m_documentViews.empty() && OnSaveModified() )
530 delete this;
531 }
532
533 void wxDocument::UpdateAllViews(wxView *sender, wxObject *hint)
534 {
535 wxList::compatibility_iterator node = m_documentViews.GetFirst();
536 while (node)
537 {
538 wxView *view = (wxView *)node->GetData();
539 if (view != sender)
540 view->OnUpdate(sender, hint);
541 node = node->GetNext();
542 }
543 }
544
545 void wxDocument::NotifyClosing()
546 {
547 wxList::compatibility_iterator node = m_documentViews.GetFirst();
548 while (node)
549 {
550 wxView *view = (wxView *)node->GetData();
551 view->OnClosingDocument();
552 node = node->GetNext();
553 }
554 }
555
556 void wxDocument::SetFilename(const wxString& filename, bool notifyViews)
557 {
558 m_documentFile = filename;
559 OnChangeFilename(notifyViews);
560 }
561
562 void wxDocument::OnChangeFilename(bool notifyViews)
563 {
564 if ( notifyViews )
565 {
566 // Notify the views that the filename has changed
567 wxList::compatibility_iterator node = m_documentViews.GetFirst();
568 while (node)
569 {
570 wxView *view = (wxView *)node->GetData();
571 view->OnChangeFilename();
572 node = node->GetNext();
573 }
574 }
575 }
576
577 bool wxDocument::DoSaveDocument(const wxString& file)
578 {
579 #if wxUSE_STD_IOSTREAM
580 wxSTD ofstream store(file.mb_str(), wxSTD ios::binary);
581 if ( !store )
582 #else
583 wxFileOutputStream store(file);
584 if ( store.GetLastError() != wxSTREAM_NO_ERROR )
585 #endif
586 {
587 wxLogError(_("File \"%s\" could not be opened for writing."), file);
588 return false;
589 }
590
591 if (!SaveObject(store))
592 {
593 wxLogError(_("Failed to save document to the file \"%s\"."), file);
594 return false;
595 }
596
597 return true;
598 }
599
600 bool wxDocument::DoOpenDocument(const wxString& file)
601 {
602 #if wxUSE_STD_IOSTREAM
603 wxSTD ifstream store(file.mb_str(), wxSTD ios::binary);
604 if ( !store )
605 #else
606 wxFileInputStream store(file);
607 if (store.GetLastError() != wxSTREAM_NO_ERROR || !store.IsOk())
608 #endif
609 {
610 wxLogError(_("File \"%s\" could not be opened for reading."), file);
611 return false;
612 }
613
614 #if wxUSE_STD_IOSTREAM
615 LoadObject(store);
616 if ( !store )
617 #else
618 int res = LoadObject(store).GetLastError();
619 if ( res != wxSTREAM_NO_ERROR && res != wxSTREAM_EOF )
620 #endif
621 {
622 wxLogError(_("Failed to read document from the file \"%s\"."), file);
623 return false;
624 }
625
626 return true;
627 }
628
629
630 // ----------------------------------------------------------------------------
631 // Document view
632 // ----------------------------------------------------------------------------
633
634 wxView::wxView()
635 {
636 m_viewDocument = NULL;
637
638 m_viewFrame = NULL;
639 }
640
641 wxView::~wxView()
642 {
643 GetDocumentManager()->ActivateView(this, false);
644 m_viewDocument->RemoveView(this);
645 }
646
647 bool wxView::TryValidator(wxEvent& event)
648 {
649 wxDocument * const doc = GetDocument();
650 return doc && doc->ProcessEventHere(event);
651 }
652
653 void wxView::OnActivateView(bool WXUNUSED(activate), wxView *WXUNUSED(activeView), wxView *WXUNUSED(deactiveView))
654 {
655 }
656
657 void wxView::OnPrint(wxDC *dc, wxObject *WXUNUSED(info))
658 {
659 OnDraw(dc);
660 }
661
662 void wxView::OnUpdate(wxView *WXUNUSED(sender), wxObject *WXUNUSED(hint))
663 {
664 }
665
666 void wxView::OnChangeFilename()
667 {
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();
672 if (!win) return;
673
674 wxDocument *doc = GetDocument();
675 if (!doc) return;
676
677 win->SetLabel(doc->GetUserReadableName());
678 }
679
680 void wxView::SetDocument(wxDocument *doc)
681 {
682 m_viewDocument = doc;
683 if (doc)
684 doc->AddView(this);
685 }
686
687 bool wxView::Close(bool deleteWindow)
688 {
689 return OnClose(deleteWindow);
690 }
691
692 void wxView::Activate(bool activate)
693 {
694 if (GetDocument() && GetDocumentManager())
695 {
696 OnActivateView(activate, this, GetDocumentManager()->GetCurrentView());
697 GetDocumentManager()->ActivateView(this, activate);
698 }
699 }
700
701 bool wxView::OnClose(bool WXUNUSED(deleteWindow))
702 {
703 return GetDocument() ? GetDocument()->Close() : true;
704 }
705
706 #if wxUSE_PRINTING_ARCHITECTURE
707 wxPrintout *wxView::OnCreatePrintout()
708 {
709 return new wxDocPrintout(this);
710 }
711 #endif // wxUSE_PRINTING_ARCHITECTURE
712
713 // ----------------------------------------------------------------------------
714 // wxDocTemplate
715 // ----------------------------------------------------------------------------
716
717 wxDocTemplate::wxDocTemplate(wxDocManager *manager,
718 const wxString& descr,
719 const wxString& filter,
720 const wxString& dir,
721 const wxString& ext,
722 const wxString& docTypeName,
723 const wxString& viewTypeName,
724 wxClassInfo *docClassInfo,
725 wxClassInfo *viewClassInfo,
726 long flags)
727 {
728 m_documentManager = manager;
729 m_description = descr;
730 m_directory = dir;
731 m_defaultExt = ext;
732 m_fileFilter = filter;
733 m_flags = flags;
734 m_docTypeName = docTypeName;
735 m_viewTypeName = viewTypeName;
736 m_documentManager->AssociateTemplate(this);
737
738 m_docClassInfo = docClassInfo;
739 m_viewClassInfo = viewClassInfo;
740 }
741
742 wxDocTemplate::~wxDocTemplate()
743 {
744 m_documentManager->DisassociateTemplate(this);
745 }
746
747 // Tries to dynamically construct an object of the right class.
748 wxDocument *wxDocTemplate::CreateDocument(const wxString& path, long flags)
749 {
750 wxDocument * const doc = DoCreateDocument();
751
752 // VZ: this code doesn't delete doc if InitDocument() (i.e. doc->OnCreate())
753 // fails, is this intentional?
754
755 return doc && InitDocument(doc, path, flags) ? doc : NULL;
756 }
757
758 bool
759 wxDocTemplate::InitDocument(wxDocument* doc, const wxString& path, long flags)
760 {
761 doc->SetFilename(path);
762 doc->SetDocumentTemplate(this);
763 GetDocumentManager()->AddDocument(doc);
764 doc->SetCommandProcessor(doc->OnCreateCommandProcessor());
765
766 if (doc->OnCreate(path, flags))
767 return true;
768 else
769 {
770 if (GetDocumentManager()->GetDocuments().Member(doc))
771 doc->DeleteAllViews();
772 return false;
773 }
774 }
775
776 wxView *wxDocTemplate::CreateView(wxDocument *doc, long flags)
777 {
778 wxScopedPtr<wxView> view(DoCreateView());
779 if ( !view )
780 return NULL;
781
782 view->SetDocument(doc);
783 if ( !view->OnCreate(doc, flags) )
784 return NULL;
785
786 return view.release();
787 }
788
789 // The default (very primitive) format detection: check is the extension is
790 // that of the template
791 bool wxDocTemplate::FileMatchesTemplate(const wxString& path)
792 {
793 wxStringTokenizer parser (GetFileFilter(), wxT(";"));
794 wxString anything = wxT ("*");
795 while (parser.HasMoreTokens())
796 {
797 wxString filter = parser.GetNextToken();
798 wxString filterExt = FindExtension (filter);
799 if ( filter.IsSameAs (anything) ||
800 filterExt.IsSameAs (anything) ||
801 filterExt.IsSameAs (FindExtension (path)) )
802 return true;
803 }
804 return GetDefaultExtension().IsSameAs(FindExtension(path));
805 }
806
807 wxDocument *wxDocTemplate::DoCreateDocument()
808 {
809 if (!m_docClassInfo)
810 return NULL;
811
812 return (wxDocument *)m_docClassInfo->CreateObject();
813 }
814
815 wxView *wxDocTemplate::DoCreateView()
816 {
817 if (!m_viewClassInfo)
818 return NULL;
819
820 return (wxView *)m_viewClassInfo->CreateObject();
821 }
822
823 // ----------------------------------------------------------------------------
824 // wxDocManager
825 // ----------------------------------------------------------------------------
826
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)
837
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)
847
848 #if wxUSE_PRINTING_ARCHITECTURE
849 EVT_MENU(wxID_PRINT, wxDocManager::OnPrint)
850 EVT_MENU(wxID_PREVIEW, wxDocManager::OnPreview)
851
852 EVT_UPDATE_UI(wxID_PRINT, wxDocManager::OnUpdateDisableIfNoDoc)
853 EVT_UPDATE_UI(wxID_PREVIEW, wxDocManager::OnUpdateDisableIfNoDoc)
854 #endif
855 END_EVENT_TABLE()
856
857 wxDocManager* wxDocManager::sm_docManager = NULL;
858
859 wxDocManager::wxDocManager(long WXUNUSED(flags), bool initialize)
860 {
861 wxASSERT_MSG( !sm_docManager, "multiple wxDocManagers not allowed" );
862
863 sm_docManager = this;
864
865 m_defaultDocumentNameCounter = 1;
866 m_currentView = NULL;
867 m_maxDocsOpen = INT_MAX;
868 m_fileHistory = NULL;
869 if ( initialize )
870 Initialize();
871 }
872
873 wxDocManager::~wxDocManager()
874 {
875 Clear();
876 delete m_fileHistory;
877 sm_docManager = NULL;
878 }
879
880 // closes the specified document
881 bool wxDocManager::CloseDocument(wxDocument* doc, bool force)
882 {
883 if (doc->Close() || force)
884 {
885 // Implicitly deletes the document when
886 // the last view is deleted
887 doc->DeleteAllViews();
888
889 // Check we're really deleted
890 if (m_docs.Member(doc))
891 delete doc;
892
893 return true;
894 }
895 return false;
896 }
897
898 bool wxDocManager::CloseDocuments(bool force)
899 {
900 wxList::compatibility_iterator node = m_docs.GetFirst();
901 while (node)
902 {
903 wxDocument *doc = (wxDocument *)node->GetData();
904 wxList::compatibility_iterator next = node->GetNext();
905
906 if (!CloseDocument(doc, force))
907 return false;
908
909 // This assumes that documents are not connected in
910 // any way, i.e. deleting one document does NOT
911 // delete another.
912 node = next;
913 }
914 return true;
915 }
916
917 bool wxDocManager::Clear(bool force)
918 {
919 if (!CloseDocuments(force))
920 return false;
921
922 m_currentView = NULL;
923
924 wxList::compatibility_iterator node = m_templates.GetFirst();
925 while (node)
926 {
927 wxDocTemplate *templ = (wxDocTemplate*) node->GetData();
928 wxList::compatibility_iterator next = node->GetNext();
929 delete templ;
930 node = next;
931 }
932 return true;
933 }
934
935 bool wxDocManager::Initialize()
936 {
937 m_fileHistory = OnCreateFileHistory();
938 return true;
939 }
940
941 wxFileHistory *wxDocManager::OnCreateFileHistory()
942 {
943 return new wxFileHistory;
944 }
945
946 void wxDocManager::OnFileClose(wxCommandEvent& WXUNUSED(event))
947 {
948 wxDocument *doc = GetCurrentDocument();
949 if (!doc)
950 return;
951 if (doc->Close())
952 {
953 doc->DeleteAllViews();
954 if (m_docs.Member(doc))
955 delete doc;
956 }
957 }
958
959 void wxDocManager::OnFileCloseAll(wxCommandEvent& WXUNUSED(event))
960 {
961 CloseDocuments(false);
962 }
963
964 void wxDocManager::OnFileNew(wxCommandEvent& WXUNUSED(event))
965 {
966 CreateNewDocument();
967 }
968
969 void wxDocManager::OnFileOpen(wxCommandEvent& WXUNUSED(event))
970 {
971 if ( !CreateDocument( wxEmptyString, 0) )
972 {
973 OnOpenFileFailure();
974 }
975 }
976
977 void wxDocManager::OnFileRevert(wxCommandEvent& WXUNUSED(event))
978 {
979 wxDocument *doc = GetCurrentDocument();
980 if (!doc)
981 return;
982 doc->Revert();
983 }
984
985 void wxDocManager::OnFileSave(wxCommandEvent& WXUNUSED(event))
986 {
987 wxDocument *doc = GetCurrentDocument();
988 if (!doc)
989 return;
990 doc->Save();
991 }
992
993 void wxDocManager::OnFileSaveAs(wxCommandEvent& WXUNUSED(event))
994 {
995 wxDocument *doc = GetCurrentDocument();
996 if (!doc)
997 return;
998 doc->SaveAs();
999 }
1000
1001 void wxDocManager::OnPrint(wxCommandEvent& WXUNUSED(event))
1002 {
1003 #if wxUSE_PRINTING_ARCHITECTURE
1004 wxView *view = GetCurrentView();
1005 if (!view)
1006 return;
1007
1008 wxPrintout *printout = view->OnCreatePrintout();
1009 if (printout)
1010 {
1011 wxPrinter printer;
1012 printer.Print(view->GetFrame(), printout, true);
1013
1014 delete printout;
1015 }
1016 #endif // wxUSE_PRINTING_ARCHITECTURE
1017 }
1018
1019 void wxDocManager::OnPreview(wxCommandEvent& WXUNUSED(event))
1020 {
1021 #if wxUSE_PRINTING_ARCHITECTURE
1022 wxView *view = GetCurrentView();
1023 if (!view)
1024 return;
1025
1026 wxPrintout *printout = view->OnCreatePrintout();
1027 if (printout)
1028 {
1029 // Pass two printout objects: for preview, and possible printing.
1030 wxPrintPreviewBase *preview = new wxPrintPreview(printout, view->OnCreatePrintout());
1031 if ( !preview->Ok() )
1032 {
1033 delete preview;
1034 wxMessageBox( _("Sorry, print preview needs a printer to be installed.") );
1035 return;
1036 }
1037
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();
1042 frame->Show(true);
1043 }
1044 #endif // wxUSE_PRINTING_ARCHITECTURE
1045 }
1046
1047 void wxDocManager::OnUndo(wxCommandEvent& event)
1048 {
1049 wxDocument *doc = GetCurrentDocument();
1050 if (!doc)
1051 return;
1052 if (doc->GetCommandProcessor())
1053 doc->GetCommandProcessor()->Undo();
1054 else
1055 event.Skip();
1056 }
1057
1058 void wxDocManager::OnRedo(wxCommandEvent& event)
1059 {
1060 wxDocument *doc = GetCurrentDocument();
1061 if (!doc)
1062 return;
1063 if (doc->GetCommandProcessor())
1064 doc->GetCommandProcessor()->Redo();
1065 else
1066 event.Skip();
1067 }
1068
1069 // Handlers for UI update commands
1070
1071 void wxDocManager::OnUpdateFileOpen(wxUpdateUIEvent& event)
1072 {
1073 // CreateDocument() (which is called from OnFileOpen) may succeed
1074 // only when there is at least a template:
1075 event.Enable( GetTemplates().GetCount()>0 );
1076 }
1077
1078 void wxDocManager::OnUpdateDisableIfNoDoc(wxUpdateUIEvent& event)
1079 {
1080 event.Enable( GetCurrentDocument() != NULL );
1081 }
1082
1083 void wxDocManager::OnUpdateFileNew(wxUpdateUIEvent& event)
1084 {
1085 // CreateDocument() (which is called from OnFileNew) may succeed
1086 // only when there is at least a template:
1087 event.Enable( GetTemplates().GetCount()>0 );
1088 }
1089
1090 void wxDocManager::OnUpdateFileSave(wxUpdateUIEvent& event)
1091 {
1092 wxDocument * const doc = GetCurrentDocument();
1093 event.Enable( doc && !doc->AlreadySaved() );
1094 }
1095
1096 void wxDocManager::OnUpdateUndo(wxUpdateUIEvent& event)
1097 {
1098 wxDocument *doc = GetCurrentDocument();
1099 if (!doc)
1100 event.Enable(false);
1101 else if (!doc->GetCommandProcessor())
1102 event.Skip();
1103 else
1104 {
1105 event.Enable( doc->GetCommandProcessor()->CanUndo() );
1106 doc->GetCommandProcessor()->SetMenuStrings();
1107 }
1108 }
1109
1110 void wxDocManager::OnUpdateRedo(wxUpdateUIEvent& event)
1111 {
1112 wxDocument *doc = GetCurrentDocument();
1113 if (!doc)
1114 event.Enable(false);
1115 else if (!doc->GetCommandProcessor())
1116 event.Skip();
1117 else
1118 {
1119 event.Enable( doc->GetCommandProcessor()->CanRedo() );
1120 doc->GetCommandProcessor()->SetMenuStrings();
1121 }
1122 }
1123
1124 wxView *wxDocManager::GetCurrentView() const
1125 {
1126 if (m_currentView)
1127 return m_currentView;
1128 if (m_docs.GetCount() == 1)
1129 {
1130 wxDocument* doc = (wxDocument*) m_docs.GetFirst()->GetData();
1131 return doc->GetFirstView();
1132 }
1133 return NULL;
1134 }
1135
1136 bool wxDocManager::TryValidator(wxEvent& event)
1137 {
1138 wxView * const view = GetCurrentView();
1139 return view && view->ProcessEventHere(event);
1140 }
1141
1142 namespace
1143 {
1144
1145 // helper function: return only the visible templates
1146 wxDocTemplates GetVisibleTemplates(const wxList& allTemplates)
1147 {
1148 // select only the visible templates
1149 const size_t totalNumTemplates = allTemplates.GetCount();
1150 wxDocTemplates templates;
1151 if ( totalNumTemplates )
1152 {
1153 templates.reserve(totalNumTemplates);
1154
1155 for ( wxList::const_iterator i = allTemplates.begin(),
1156 end = allTemplates.end();
1157 i != end;
1158 ++i )
1159 {
1160 wxDocTemplate * const temp = (wxDocTemplate *)*i;
1161 if ( temp->IsVisible() )
1162 templates.push_back(temp);
1163 }
1164 }
1165
1166 return templates;
1167 }
1168
1169 } // anonymous namespace
1170
1171 wxDocument *wxDocManager::CreateDocument(const wxString& pathOrig, long flags)
1172 {
1173 // this ought to be const but SelectDocumentType/Path() are not
1174 // const-correct and can't be changed as, being virtual, this risks
1175 // breaking user code overriding them
1176 wxDocTemplates templates(GetVisibleTemplates(m_templates));
1177 const size_t numTemplates = templates.size();
1178 if ( !numTemplates )
1179 {
1180 // no templates can be used, can't create document
1181 return NULL;
1182 }
1183
1184
1185 // normally user should select the template to use but wxDOC_SILENT flag we
1186 // choose one ourselves
1187 wxString path = pathOrig; // may be modified below
1188 wxDocTemplate *temp;
1189 if ( flags & wxDOC_SILENT )
1190 {
1191 wxASSERT_MSG( !path.empty(),
1192 "using empty path with wxDOC_SILENT doesn't make sense" );
1193
1194 temp = FindTemplateForPath(path);
1195 if ( !temp )
1196 {
1197 wxLogWarning(_("The format of file '%s' couldn't be determined."),
1198 path);
1199 }
1200 }
1201 else // not silent, ask the user
1202 {
1203 // for the new file we need just the template, for an existing one we
1204 // need the template and the path, unless it's already specified
1205 if ( (flags & wxDOC_NEW) || !path.empty() )
1206 temp = SelectDocumentType(&templates[0], numTemplates);
1207 else
1208 temp = SelectDocumentPath(&templates[0], numTemplates, path, flags);
1209 }
1210
1211 if ( !temp )
1212 return NULL;
1213
1214 // check whether the document with this path is already opened
1215 if ( !path.empty() )
1216 {
1217 const wxFileName fn(path);
1218 for ( wxList::const_iterator i = m_docs.begin(); i != m_docs.end(); ++i )
1219 {
1220 wxDocument * const doc = (wxDocument*)*i;
1221
1222 if ( fn == doc->GetFilename() )
1223 {
1224 // file already open, just activate it and return
1225 if ( doc->GetFirstView() )
1226 {
1227 ActivateView(doc->GetFirstView());
1228 if ( doc->GetDocumentWindow() )
1229 doc->GetDocumentWindow()->SetFocus();
1230 return doc;
1231 }
1232 }
1233 }
1234 }
1235
1236
1237 // no, we need to create a new document
1238
1239
1240 // if we've reached the max number of docs, close the first one.
1241 if ( (int)GetDocuments().GetCount() >= m_maxDocsOpen )
1242 {
1243 if ( !CloseDocument((wxDocument *)GetDocuments().GetFirst()->GetData()) )
1244 {
1245 // can't open the new document if closing the old one failed
1246 return NULL;
1247 }
1248 }
1249
1250
1251 // do create and initialize the new document finally
1252 wxDocument * const docNew = temp->CreateDocument(path, flags);
1253 if ( !docNew )
1254 return NULL;
1255
1256 docNew->SetDocumentName(temp->GetDocumentName());
1257 docNew->SetDocumentTemplate(temp);
1258
1259 // call the appropriate function depending on whether we're creating a new
1260 // file or opening an existing one
1261 if ( !(flags & wxDOC_NEW ? docNew->OnNewDocument()
1262 : docNew->OnOpenDocument(path)) )
1263 {
1264 // Document is implicitly deleted by DeleteAllViews
1265 docNew->DeleteAllViews();
1266 return NULL;
1267 }
1268
1269 // add the successfully opened file to MRU, but only if we're going to be
1270 // able to reopen it successfully later which requires the template for
1271 // this document to be retrievable from the file extension
1272 if ( !(flags & wxDOC_NEW) && temp->FileMatchesTemplate(path) )
1273 AddFileToHistory(path);
1274
1275 return docNew;
1276 }
1277
1278 wxView *wxDocManager::CreateView(wxDocument *doc, long flags)
1279 {
1280 wxDocTemplates templates(GetVisibleTemplates(m_templates));
1281 const size_t numTemplates = templates.size();
1282
1283 if ( numTemplates == 0 )
1284 return NULL;
1285
1286 wxDocTemplate * const
1287 temp = numTemplates == 1 ? templates[0]
1288 : SelectViewType(&templates[0], numTemplates);
1289
1290 if ( !temp )
1291 return NULL;
1292
1293 wxView *view = temp->CreateView(doc, flags);
1294 if ( view )
1295 view->SetViewName(temp->GetViewName());
1296 return view;
1297 }
1298
1299 // Not yet implemented
1300 void
1301 wxDocManager::DeleteTemplate(wxDocTemplate *WXUNUSED(temp), long WXUNUSED(flags))
1302 {
1303 }
1304
1305 // Not yet implemented
1306 bool wxDocManager::FlushDoc(wxDocument *WXUNUSED(doc))
1307 {
1308 return false;
1309 }
1310
1311 wxDocument *wxDocManager::GetCurrentDocument() const
1312 {
1313 wxView *view = GetCurrentView();
1314 if (view)
1315 return view->GetDocument();
1316 else
1317 return NULL;
1318 }
1319
1320 // Make a default name for a new document
1321 #if WXWIN_COMPATIBILITY_2_8
1322 bool wxDocManager::MakeDefaultName(wxString& WXUNUSED(name))
1323 {
1324 // we consider that this function can only be overridden by the user code,
1325 // not called by it as it only makes sense to call it internally, so we
1326 // don't bother to return anything from here
1327 return false;
1328 }
1329 #endif // WXWIN_COMPATIBILITY_2_8
1330
1331 wxString wxDocManager::MakeNewDocumentName()
1332 {
1333 wxString name;
1334
1335 #if WXWIN_COMPATIBILITY_2_8
1336 if ( !MakeDefaultName(name) )
1337 #endif // WXWIN_COMPATIBILITY_2_8
1338 {
1339 name.Printf(_("unnamed%d"), m_defaultDocumentNameCounter);
1340 m_defaultDocumentNameCounter++;
1341 }
1342
1343 return name;
1344 }
1345
1346 // Make a frame title (override this to do something different)
1347 // If docName is empty, a document is not currently active.
1348 wxString wxDocManager::MakeFrameTitle(wxDocument* doc)
1349 {
1350 wxString appName = wxTheApp->GetAppDisplayName();
1351 wxString title;
1352 if (!doc)
1353 title = appName;
1354 else
1355 {
1356 wxString docName = doc->GetUserReadableName();
1357 title = docName + wxString(_(" - ")) + appName;
1358 }
1359 return title;
1360 }
1361
1362
1363 // Not yet implemented
1364 wxDocTemplate *wxDocManager::MatchTemplate(const wxString& WXUNUSED(path))
1365 {
1366 return NULL;
1367 }
1368
1369 // File history management
1370 void wxDocManager::AddFileToHistory(const wxString& file)
1371 {
1372 if (m_fileHistory)
1373 m_fileHistory->AddFileToHistory(file);
1374 }
1375
1376 void wxDocManager::RemoveFileFromHistory(size_t i)
1377 {
1378 if (m_fileHistory)
1379 m_fileHistory->RemoveFileFromHistory(i);
1380 }
1381
1382 wxString wxDocManager::GetHistoryFile(size_t i) const
1383 {
1384 wxString histFile;
1385
1386 if (m_fileHistory)
1387 histFile = m_fileHistory->GetHistoryFile(i);
1388
1389 return histFile;
1390 }
1391
1392 void wxDocManager::FileHistoryUseMenu(wxMenu *menu)
1393 {
1394 if (m_fileHistory)
1395 m_fileHistory->UseMenu(menu);
1396 }
1397
1398 void wxDocManager::FileHistoryRemoveMenu(wxMenu *menu)
1399 {
1400 if (m_fileHistory)
1401 m_fileHistory->RemoveMenu(menu);
1402 }
1403
1404 #if wxUSE_CONFIG
1405 void wxDocManager::FileHistoryLoad(const wxConfigBase& config)
1406 {
1407 if (m_fileHistory)
1408 m_fileHistory->Load(config);
1409 }
1410
1411 void wxDocManager::FileHistorySave(wxConfigBase& config)
1412 {
1413 if (m_fileHistory)
1414 m_fileHistory->Save(config);
1415 }
1416 #endif
1417
1418 void wxDocManager::FileHistoryAddFilesToMenu(wxMenu* menu)
1419 {
1420 if (m_fileHistory)
1421 m_fileHistory->AddFilesToMenu(menu);
1422 }
1423
1424 void wxDocManager::FileHistoryAddFilesToMenu()
1425 {
1426 if (m_fileHistory)
1427 m_fileHistory->AddFilesToMenu();
1428 }
1429
1430 size_t wxDocManager::GetHistoryFilesCount() const
1431 {
1432 return m_fileHistory ? m_fileHistory->GetCount() : 0;
1433 }
1434
1435
1436 // Find out the document template via matching in the document file format
1437 // against that of the template
1438 wxDocTemplate *wxDocManager::FindTemplateForPath(const wxString& path)
1439 {
1440 wxDocTemplate *theTemplate = NULL;
1441
1442 // Find the template which this extension corresponds to
1443 for (size_t i = 0; i < m_templates.GetCount(); i++)
1444 {
1445 wxDocTemplate *temp = (wxDocTemplate *)m_templates.Item(i)->GetData();
1446 if ( temp->FileMatchesTemplate(path) )
1447 {
1448 theTemplate = temp;
1449 break;
1450 }
1451 }
1452 return theTemplate;
1453 }
1454
1455 // Prompts user to open a file, using file specs in templates.
1456 // Must extend the file selector dialog or implement own; OR
1457 // match the extension to the template extension.
1458
1459 wxDocTemplate *wxDocManager::SelectDocumentPath(wxDocTemplate **templates,
1460 int noTemplates,
1461 wxString& path,
1462 long WXUNUSED(flags),
1463 bool WXUNUSED(save))
1464 {
1465 // We can only have multiple filters in Windows and GTK
1466 #if defined(__WXMSW__) || defined(__WXGTK__) || defined(__WXMAC__)
1467 wxString descrBuf;
1468
1469 int i;
1470 for (i = 0; i < noTemplates; i++)
1471 {
1472 if (templates[i]->IsVisible())
1473 {
1474 // add a '|' to separate this filter from the previous one
1475 if ( !descrBuf.empty() )
1476 descrBuf << wxT('|');
1477
1478 descrBuf << templates[i]->GetDescription()
1479 << wxT(" (") << templates[i]->GetFileFilter() << wxT(") |")
1480 << templates[i]->GetFileFilter();
1481 }
1482 }
1483 #else
1484 wxString descrBuf = wxT("*.*");
1485 wxUnusedVar(noTemplates);
1486 #endif
1487
1488 int FilterIndex = -1;
1489
1490 wxWindow* parent = wxFindSuitableParent();
1491
1492 wxString pathTmp = wxFileSelectorEx(_("Open File"),
1493 m_lastDirectory,
1494 wxEmptyString,
1495 &FilterIndex,
1496 descrBuf,
1497 0,
1498 parent);
1499
1500 wxDocTemplate *theTemplate = NULL;
1501 if (!pathTmp.empty())
1502 {
1503 if (!wxFileExists(pathTmp))
1504 {
1505 wxString msgTitle;
1506 if (!wxTheApp->GetAppDisplayName().empty())
1507 msgTitle = wxTheApp->GetAppDisplayName();
1508 else
1509 msgTitle = wxString(_("File error"));
1510
1511 (void)wxMessageBox(_("Sorry, could not open this file."), msgTitle, wxOK | wxICON_EXCLAMATION | wxCENTRE,
1512 parent);
1513
1514 path = wxEmptyString;
1515 return NULL;
1516 }
1517 m_lastDirectory = wxPathOnly(pathTmp);
1518
1519 path = pathTmp;
1520
1521 // first choose the template using the extension, if this fails (i.e.
1522 // wxFileSelectorEx() didn't fill it), then use the path
1523 if ( FilterIndex != -1 )
1524 theTemplate = templates[FilterIndex];
1525 if ( !theTemplate )
1526 theTemplate = FindTemplateForPath(path);
1527 if ( !theTemplate )
1528 {
1529 // Since we do not add files with non-default extensions to the FileHistory this
1530 // can only happen if the application changes the allowed templates in runtime.
1531 (void)wxMessageBox(_("Sorry, the format for this file is unknown."),
1532 _("Open File"),
1533 wxOK | wxICON_EXCLAMATION | wxCENTRE, wxFindSuitableParent());
1534 }
1535 }
1536 else
1537 {
1538 path = wxEmptyString;
1539 }
1540
1541 return theTemplate;
1542 }
1543
1544 wxDocTemplate *wxDocManager::SelectDocumentType(wxDocTemplate **templates,
1545 int noTemplates, bool sort)
1546 {
1547 wxArrayString strings;
1548 wxDocTemplate **data = new wxDocTemplate *[noTemplates];
1549 int i;
1550 int n = 0;
1551
1552 for (i = 0; i < noTemplates; i++)
1553 {
1554 if (templates[i]->IsVisible())
1555 {
1556 int j;
1557 bool want = true;
1558 for (j = 0; j < n; j++)
1559 {
1560 //filter out NOT unique documents + view combinations
1561 if ( templates[i]->m_docTypeName == data[j]->m_docTypeName &&
1562 templates[i]->m_viewTypeName == data[j]->m_viewTypeName
1563 )
1564 want = false;
1565 }
1566
1567 if ( want )
1568 {
1569 strings.Add(templates[i]->m_description);
1570
1571 data[n] = templates[i];
1572 n ++;
1573 }
1574 }
1575 } // for
1576
1577 if (sort)
1578 {
1579 strings.Sort(); // ascending sort
1580 // Yes, this will be slow, but template lists
1581 // are typically short.
1582 int j;
1583 n = strings.Count();
1584 for (i = 0; i < n; i++)
1585 {
1586 for (j = 0; j < noTemplates; j++)
1587 {
1588 if (strings[i] == templates[j]->m_description)
1589 data[i] = templates[j];
1590 }
1591 }
1592 }
1593
1594 wxDocTemplate *theTemplate;
1595
1596 switch ( n )
1597 {
1598 case 0:
1599 // no visible templates, hence nothing to choose from
1600 theTemplate = NULL;
1601 break;
1602
1603 case 1:
1604 // don't propose the user to choose if he has no choice
1605 theTemplate = data[0];
1606 break;
1607
1608 default:
1609 // propose the user to choose one of several
1610 theTemplate = (wxDocTemplate *)wxGetSingleChoiceData
1611 (
1612 _("Select a document template"),
1613 _("Templates"),
1614 strings,
1615 (void **)data,
1616 wxFindSuitableParent()
1617 );
1618 }
1619
1620 delete[] data;
1621
1622 return theTemplate;
1623 }
1624
1625 wxDocTemplate *wxDocManager::SelectViewType(wxDocTemplate **templates,
1626 int noTemplates, bool sort)
1627 {
1628 wxArrayString strings;
1629 wxDocTemplate **data = new wxDocTemplate *[noTemplates];
1630 int i;
1631 int n = 0;
1632
1633 for (i = 0; i < noTemplates; i++)
1634 {
1635 wxDocTemplate *templ = templates[i];
1636 if ( templ->IsVisible() && !templ->GetViewName().empty() )
1637 {
1638 int j;
1639 bool want = true;
1640 for (j = 0; j < n; j++)
1641 {
1642 //filter out NOT unique views
1643 if ( templates[i]->m_viewTypeName == data[j]->m_viewTypeName )
1644 want = false;
1645 }
1646
1647 if ( want )
1648 {
1649 strings.Add(templ->m_viewTypeName);
1650 data[n] = templ;
1651 n ++;
1652 }
1653 }
1654 }
1655
1656 if (sort)
1657 {
1658 strings.Sort(); // ascending sort
1659 // Yes, this will be slow, but template lists
1660 // are typically short.
1661 int j;
1662 n = strings.Count();
1663 for (i = 0; i < n; i++)
1664 {
1665 for (j = 0; j < noTemplates; j++)
1666 {
1667 if (strings[i] == templates[j]->m_viewTypeName)
1668 data[i] = templates[j];
1669 }
1670 }
1671 }
1672
1673 wxDocTemplate *theTemplate;
1674
1675 // the same logic as above
1676 switch ( n )
1677 {
1678 case 0:
1679 theTemplate = NULL;
1680 break;
1681
1682 case 1:
1683 theTemplate = data[0];
1684 break;
1685
1686 default:
1687 theTemplate = (wxDocTemplate *)wxGetSingleChoiceData
1688 (
1689 _("Select a document view"),
1690 _("Views"),
1691 strings,
1692 (void **)data,
1693 wxFindSuitableParent()
1694 );
1695
1696 }
1697
1698 delete[] data;
1699 return theTemplate;
1700 }
1701
1702 void wxDocManager::AssociateTemplate(wxDocTemplate *temp)
1703 {
1704 if (!m_templates.Member(temp))
1705 m_templates.Append(temp);
1706 }
1707
1708 void wxDocManager::DisassociateTemplate(wxDocTemplate *temp)
1709 {
1710 m_templates.DeleteObject(temp);
1711 }
1712
1713 // Add and remove a document from the manager's list
1714 void wxDocManager::AddDocument(wxDocument *doc)
1715 {
1716 if (!m_docs.Member(doc))
1717 m_docs.Append(doc);
1718 }
1719
1720 void wxDocManager::RemoveDocument(wxDocument *doc)
1721 {
1722 m_docs.DeleteObject(doc);
1723 }
1724
1725 // Views or windows should inform the document manager
1726 // when a view is going in or out of focus
1727 void wxDocManager::ActivateView(wxView *view, bool activate)
1728 {
1729 if ( activate )
1730 {
1731 m_currentView = view;
1732 }
1733 else // deactivate
1734 {
1735 if ( m_currentView == view )
1736 {
1737 // don't keep stale pointer
1738 m_currentView = NULL;
1739 }
1740 }
1741 }
1742
1743 // ----------------------------------------------------------------------------
1744 // Default document child frame
1745 // ----------------------------------------------------------------------------
1746
1747 BEGIN_EVENT_TABLE(wxDocChildFrame, wxFrame)
1748 EVT_ACTIVATE(wxDocChildFrame::OnActivate)
1749 EVT_CLOSE(wxDocChildFrame::OnCloseWindow)
1750 END_EVENT_TABLE()
1751
1752 wxDocChildFrame::wxDocChildFrame(wxDocument *doc,
1753 wxView *view,
1754 wxFrame *frame,
1755 wxWindowID id,
1756 const wxString& title,
1757 const wxPoint& pos,
1758 const wxSize& size,
1759 long style,
1760 const wxString& name)
1761 : wxFrame(frame, id, title, pos, size, style, name)
1762 {
1763 m_childDocument = doc;
1764 m_childView = view;
1765 if (view)
1766 view->SetFrame(this);
1767 }
1768
1769 bool wxDocChildFrame::TryValidator(wxEvent& event)
1770 {
1771 if ( !m_childView )
1772 return false;
1773
1774 // FIXME: why is this needed here?
1775 m_childView->Activate(true);
1776
1777 return m_childView->ProcessEventHere(event);
1778 }
1779
1780 void wxDocChildFrame::OnActivate(wxActivateEvent& event)
1781 {
1782 wxFrame::OnActivate(event);
1783
1784 if (m_childView)
1785 m_childView->Activate(event.GetActive());
1786 }
1787
1788 void wxDocChildFrame::OnCloseWindow(wxCloseEvent& event)
1789 {
1790 if (m_childView)
1791 {
1792 bool ans = event.CanVeto()
1793 ? m_childView->Close(false) // false means don't delete associated window
1794 : true; // Must delete.
1795
1796 if (ans)
1797 {
1798 m_childView->Activate(false);
1799 delete m_childView;
1800 m_childView = NULL;
1801 m_childDocument = NULL;
1802
1803 this->Destroy();
1804 }
1805 else
1806 event.Veto();
1807 }
1808 else
1809 event.Veto();
1810 }
1811
1812 // ----------------------------------------------------------------------------
1813 // Default parent frame
1814 // ----------------------------------------------------------------------------
1815
1816 BEGIN_EVENT_TABLE(wxDocParentFrame, wxFrame)
1817 EVT_MENU(wxID_EXIT, wxDocParentFrame::OnExit)
1818 EVT_MENU_RANGE(wxID_FILE1, wxID_FILE9, wxDocParentFrame::OnMRUFile)
1819 EVT_CLOSE(wxDocParentFrame::OnCloseWindow)
1820 END_EVENT_TABLE()
1821
1822 wxDocParentFrame::wxDocParentFrame()
1823 {
1824 m_docManager = NULL;
1825 }
1826
1827 wxDocParentFrame::wxDocParentFrame(wxDocManager *manager,
1828 wxFrame *frame,
1829 wxWindowID id,
1830 const wxString& title,
1831 const wxPoint& pos,
1832 const wxSize& size,
1833 long style,
1834 const wxString& name)
1835 : wxFrame(frame, id, title, pos, size, style, name)
1836 {
1837 m_docManager = manager;
1838 }
1839
1840 bool wxDocParentFrame::Create(wxDocManager *manager,
1841 wxFrame *frame,
1842 wxWindowID id,
1843 const wxString& title,
1844 const wxPoint& pos,
1845 const wxSize& size,
1846 long style,
1847 const wxString& name)
1848 {
1849 m_docManager = manager;
1850 return base_type::Create(frame, id, title, pos, size, style, name);
1851 }
1852
1853 void wxDocParentFrame::OnExit(wxCommandEvent& WXUNUSED(event))
1854 {
1855 Close();
1856 }
1857
1858 void wxDocParentFrame::OnMRUFile(wxCommandEvent& event)
1859 {
1860 int n = event.GetId() - wxID_FILE1; // the index in MRU list
1861 wxString filename(m_docManager->GetHistoryFile(n));
1862 if ( filename.empty() )
1863 return;
1864
1865 wxString errMsg; // must contain exactly one "%s" if non-empty
1866 if ( wxFile::Exists(filename) )
1867 {
1868 // try to open it
1869 if ( m_docManager->CreateDocument(filename, wxDOC_SILENT) )
1870 return;
1871
1872 errMsg = _("The file '%s' couldn't be opened.");
1873 }
1874 else // file doesn't exist
1875 {
1876 errMsg = _("The file '%s' doesn't exist and couldn't be opened.");
1877 }
1878
1879
1880 wxASSERT_MSG( !errMsg.empty(), "should have an error message" );
1881
1882 // remove the file which we can't open from the MRU list
1883 m_docManager->RemoveFileFromHistory(n);
1884
1885 // and tell the user about it
1886 wxLogError(errMsg + '\n' +
1887 _("It has been removed from the most recently used files list."),
1888 filename);
1889 }
1890
1891 // Extend event processing to search the view's event table
1892 bool wxDocParentFrame::TryValidator(wxEvent& event)
1893 {
1894 return m_docManager && m_docManager->ProcessEventHere(event);
1895 }
1896
1897 // Define the behaviour for the frame closing
1898 // - must delete all frames except for the main one.
1899 void wxDocParentFrame::OnCloseWindow(wxCloseEvent& event)
1900 {
1901 if (m_docManager->Clear(!event.CanVeto()))
1902 {
1903 this->Destroy();
1904 }
1905 else
1906 event.Veto();
1907 }
1908
1909 #if wxUSE_PRINTING_ARCHITECTURE
1910
1911 wxDocPrintout::wxDocPrintout(wxView *view, const wxString& title)
1912 : wxPrintout(title)
1913 {
1914 m_printoutView = view;
1915 }
1916
1917 bool wxDocPrintout::OnPrintPage(int WXUNUSED(page))
1918 {
1919 wxDC *dc = GetDC();
1920
1921 // Get the logical pixels per inch of screen and printer
1922 int ppiScreenX, ppiScreenY;
1923 GetPPIScreen(&ppiScreenX, &ppiScreenY);
1924 wxUnusedVar(ppiScreenY);
1925 int ppiPrinterX, ppiPrinterY;
1926 GetPPIPrinter(&ppiPrinterX, &ppiPrinterY);
1927 wxUnusedVar(ppiPrinterY);
1928
1929 // This scales the DC so that the printout roughly represents the
1930 // the screen scaling. The text point size _should_ be the right size
1931 // but in fact is too small for some reason. This is a detail that will
1932 // need to be addressed at some point but can be fudged for the
1933 // moment.
1934 float scale = (float)((float)ppiPrinterX/(float)ppiScreenX);
1935
1936 // Now we have to check in case our real page size is reduced
1937 // (e.g. because we're drawing to a print preview memory DC)
1938 int pageWidth, pageHeight;
1939 int w, h;
1940 dc->GetSize(&w, &h);
1941 GetPageSizePixels(&pageWidth, &pageHeight);
1942 wxUnusedVar(pageHeight);
1943
1944 // If printer pageWidth == current DC width, then this doesn't
1945 // change. But w might be the preview bitmap width, so scale down.
1946 float overallScale = scale * (float)(w/(float)pageWidth);
1947 dc->SetUserScale(overallScale, overallScale);
1948
1949 if (m_printoutView)
1950 {
1951 m_printoutView->OnDraw(dc);
1952 }
1953 return true;
1954 }
1955
1956 bool wxDocPrintout::HasPage(int pageNum)
1957 {
1958 return (pageNum == 1);
1959 }
1960
1961 bool wxDocPrintout::OnBeginDocument(int startPage, int endPage)
1962 {
1963 if (!wxPrintout::OnBeginDocument(startPage, endPage))
1964 return false;
1965
1966 return true;
1967 }
1968
1969 void wxDocPrintout::GetPageInfo(int *minPage, int *maxPage, int *selPageFrom, int *selPageTo)
1970 {
1971 *minPage = 1;
1972 *maxPage = 1;
1973 *selPageFrom = 1;
1974 *selPageTo = 1;
1975 }
1976
1977 #endif // wxUSE_PRINTING_ARCHITECTURE
1978
1979 // ----------------------------------------------------------------------------
1980 // File history (a.k.a. MRU, most recently used, files list)
1981 // ----------------------------------------------------------------------------
1982
1983 wxFileHistory::wxFileHistory(size_t maxFiles, wxWindowID idBase)
1984 {
1985 m_fileMaxFiles = maxFiles;
1986 m_idBase = idBase;
1987 }
1988
1989 void wxFileHistory::AddFileToHistory(const wxString& file)
1990 {
1991 // check if we don't already have this file
1992 const wxFileName fnNew(file);
1993 size_t i,
1994 numFiles = m_fileHistory.size();
1995 for ( i = 0; i < numFiles; i++ )
1996 {
1997 if ( fnNew == m_fileHistory[i] )
1998 {
1999 // we do have it, move it to the top of the history
2000 RemoveFileFromHistory(i);
2001 numFiles--;
2002 break;
2003 }
2004 }
2005
2006 // if we already have a full history, delete the one at the end
2007 if ( numFiles == m_fileMaxFiles )
2008 {
2009 RemoveFileFromHistory(--numFiles);
2010 }
2011
2012 // add a new menu item to all file menus (they will be updated below)
2013 for ( wxList::compatibility_iterator node = m_fileMenus.GetFirst();
2014 node;
2015 node = node->GetNext() )
2016 {
2017 wxMenu * const menu = (wxMenu *)node->GetData();
2018
2019 if ( !numFiles && menu->GetMenuItemCount() )
2020 menu->AppendSeparator();
2021
2022 // label doesn't matter, it will be set below anyhow, but it can't
2023 // be empty (this is supposed to indicate a stock item)
2024 menu->Append(m_idBase + numFiles, " ");
2025 }
2026
2027 // insert the new file in the beginning of the file history
2028 m_fileHistory.insert(m_fileHistory.begin(), file);
2029 numFiles++;
2030
2031 // update the labels in all menus
2032 for ( i = 0; i < numFiles; i++ )
2033 {
2034 // if in same directory just show the filename; otherwise the full path
2035 const wxFileName fnOld(m_fileHistory[i]);
2036
2037 wxString pathInMenu;
2038 if ( fnOld.GetPath() == fnNew.GetPath() )
2039 {
2040 pathInMenu = fnOld.GetFullName();
2041 }
2042 else // file in different directory
2043 {
2044 // absolute path; could also set relative path
2045 pathInMenu = m_fileHistory[i];
2046 }
2047
2048 for ( wxList::compatibility_iterator node = m_fileMenus.GetFirst();
2049 node;
2050 node = node->GetNext() )
2051 {
2052 wxMenu * const menu = (wxMenu *)node->GetData();
2053
2054 menu->SetLabel(m_idBase + i, GetMRUEntryLabel(i, pathInMenu));
2055 }
2056 }
2057 }
2058
2059 void wxFileHistory::RemoveFileFromHistory(size_t i)
2060 {
2061 size_t numFiles = m_fileHistory.size();
2062 wxCHECK_RET( i < numFiles,
2063 wxT("invalid index in wxFileHistory::RemoveFileFromHistory") );
2064
2065 // delete the element from the array
2066 m_fileHistory.RemoveAt(i);
2067 numFiles--;
2068
2069 for ( wxList::compatibility_iterator node = m_fileMenus.GetFirst();
2070 node;
2071 node = node->GetNext() )
2072 {
2073 wxMenu * const menu = (wxMenu *) node->GetData();
2074
2075 // shift filenames up
2076 for ( size_t j = i; j < numFiles; j++ )
2077 {
2078 menu->SetLabel(m_idBase + j, GetMRUEntryLabel(j, m_fileHistory[j]));
2079 }
2080
2081 // delete the last menu item which is unused now
2082 const wxWindowID lastItemId = m_idBase + numFiles;
2083 if ( menu->FindItem(lastItemId) )
2084 menu->Delete(lastItemId);
2085
2086 // delete the last separator too if no more files are left
2087 if ( m_fileHistory.empty() )
2088 {
2089 const wxMenuItemList::compatibility_iterator
2090 nodeLast = menu->GetMenuItems().GetLast();
2091 if ( nodeLast )
2092 {
2093 wxMenuItem * const lastMenuItem = nodeLast->GetData();
2094 if ( lastMenuItem->IsSeparator() )
2095 menu->Delete(lastMenuItem);
2096 }
2097 //else: menu is empty somehow
2098 }
2099 }
2100 }
2101
2102 void wxFileHistory::UseMenu(wxMenu *menu)
2103 {
2104 if ( !m_fileMenus.Member(menu) )
2105 m_fileMenus.Append(menu);
2106 }
2107
2108 void wxFileHistory::RemoveMenu(wxMenu *menu)
2109 {
2110 m_fileMenus.DeleteObject(menu);
2111 }
2112
2113 #if wxUSE_CONFIG
2114 void wxFileHistory::Load(const wxConfigBase& config)
2115 {
2116 m_fileHistory.Clear();
2117
2118 wxString buf;
2119 buf.Printf(wxT("file%d"), 1);
2120
2121 wxString historyFile;
2122 while ((m_fileHistory.GetCount() < m_fileMaxFiles) &&
2123 config.Read(buf, &historyFile) && !historyFile.empty())
2124 {
2125 m_fileHistory.Add(historyFile);
2126
2127 buf.Printf(wxT("file%d"), (int)m_fileHistory.GetCount()+1);
2128 historyFile = wxEmptyString;
2129 }
2130
2131 AddFilesToMenu();
2132 }
2133
2134 void wxFileHistory::Save(wxConfigBase& config)
2135 {
2136 size_t i;
2137 for (i = 0; i < m_fileMaxFiles; i++)
2138 {
2139 wxString buf;
2140 buf.Printf(wxT("file%d"), (int)i+1);
2141 if (i < m_fileHistory.GetCount())
2142 config.Write(buf, wxString(m_fileHistory[i]));
2143 else
2144 config.Write(buf, wxEmptyString);
2145 }
2146 }
2147 #endif // wxUSE_CONFIG
2148
2149 void wxFileHistory::AddFilesToMenu()
2150 {
2151 if ( m_fileHistory.empty() )
2152 return;
2153
2154 for ( wxList::compatibility_iterator node = m_fileMenus.GetFirst();
2155 node;
2156 node = node->GetNext() )
2157 {
2158 AddFilesToMenu((wxMenu *) node->GetData());
2159 }
2160 }
2161
2162 void wxFileHistory::AddFilesToMenu(wxMenu* menu)
2163 {
2164 if ( m_fileHistory.empty() )
2165 return;
2166
2167 if ( menu->GetMenuItemCount() )
2168 menu->AppendSeparator();
2169
2170 for ( size_t i = 0; i < m_fileHistory.GetCount(); i++ )
2171 {
2172 menu->Append(m_idBase + i, GetMRUEntryLabel(i, m_fileHistory[i]));
2173 }
2174 }
2175
2176 // ----------------------------------------------------------------------------
2177 // Permits compatibility with existing file formats and functions that
2178 // manipulate files directly
2179 // ----------------------------------------------------------------------------
2180
2181 #if wxUSE_STD_IOSTREAM
2182
2183 bool wxTransferFileToStream(const wxString& filename, wxSTD ostream& stream)
2184 {
2185 wxFFile file(filename, _T("rb"));
2186 if ( !file.IsOpened() )
2187 return false;
2188
2189 char buf[4096];
2190
2191 size_t nRead;
2192 do
2193 {
2194 nRead = file.Read(buf, WXSIZEOF(buf));
2195 if ( file.Error() )
2196 return false;
2197
2198 stream.write(buf, nRead);
2199 if ( !stream )
2200 return false;
2201 }
2202 while ( !file.Eof() );
2203
2204 return true;
2205 }
2206
2207 bool wxTransferStreamToFile(wxSTD istream& stream, const wxString& filename)
2208 {
2209 wxFFile file(filename, _T("wb"));
2210 if ( !file.IsOpened() )
2211 return false;
2212
2213 char buf[4096];
2214 do
2215 {
2216 stream.read(buf, WXSIZEOF(buf));
2217 if ( !stream.bad() ) // fail may be set on EOF, don't use operator!()
2218 {
2219 if ( !file.Write(buf, stream.gcount()) )
2220 return false;
2221 }
2222 }
2223 while ( !stream.eof() );
2224
2225 return true;
2226 }
2227
2228 #else // !wxUSE_STD_IOSTREAM
2229
2230 bool wxTransferFileToStream(const wxString& filename, wxOutputStream& stream)
2231 {
2232 wxFFile file(filename, _T("rb"));
2233 if ( !file.IsOpened() )
2234 return false;
2235
2236 char buf[4096];
2237
2238 size_t nRead;
2239 do
2240 {
2241 nRead = file.Read(buf, WXSIZEOF(buf));
2242 if ( file.Error() )
2243 return false;
2244
2245 stream.Write(buf, nRead);
2246 if ( !stream )
2247 return false;
2248 }
2249 while ( !file.Eof() );
2250
2251 return true;
2252 }
2253
2254 bool wxTransferStreamToFile(wxInputStream& stream, const wxString& filename)
2255 {
2256 wxFFile file(filename, _T("wb"));
2257 if ( !file.IsOpened() )
2258 return false;
2259
2260 char buf[4096];
2261 for ( ;; )
2262 {
2263 stream.Read(buf, WXSIZEOF(buf));
2264
2265 const size_t nRead = stream.LastRead();
2266 if ( !nRead )
2267 {
2268 if ( stream.Eof() )
2269 break;
2270
2271 return false;
2272 }
2273
2274 if ( !file.Write(buf, nRead) )
2275 return false;
2276 }
2277
2278 return true;
2279 }
2280
2281 #endif // wxUSE_STD_IOSTREAM/!wxUSE_STD_IOSTREAM
2282
2283 #endif // wxUSE_DOC_VIEW_ARCHITECTURE