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