include/wx/docview.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        wx/docview.h
   3 // Purpose:     Doc/View classes
   4 // Author:      Julian Smart
   5 // Modified by:
   6 // Created:     01/02/97
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) Julian Smart
   9 // Licence:     wxWindows licence
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 #ifndef _WX_DOCH__
  13 #define _WX_DOCH__
  14
  15 #include "wx/defs.h"
  16
  17 #if wxUSE_DOC_VIEW_ARCHITECTURE
  18
  19 #include "wx/list.h"
  20 #include "wx/dlist.h"
  21 #include "wx/string.h"
  22 #include "wx/frame.h"
  23 #include "wx/filehistory.h"
  24 #include "wx/vector.h"
  25
  26 #if wxUSE_PRINTING_ARCHITECTURE
  27     #include "wx/print.h"
  28 #endif
  29
  30 class WXDLLIMPEXP_FWD_CORE wxWindow;
  31 class WXDLLIMPEXP_FWD_CORE wxDocument;
  32 class WXDLLIMPEXP_FWD_CORE wxView;
  33 class WXDLLIMPEXP_FWD_CORE wxDocTemplate;
  34 class WXDLLIMPEXP_FWD_CORE wxDocManager;
  35 class WXDLLIMPEXP_FWD_CORE wxPrintInfo;
  36 class WXDLLIMPEXP_FWD_CORE wxCommandProcessor;
  37 class WXDLLIMPEXP_FWD_BASE wxConfigBase;
  38
  39 class wxDocChildFrameAnyBase;
  40
  41 #if wxUSE_STD_IOSTREAM
  42   #include "wx/iosfwrap.h"
  43 #else
  44   #include "wx/stream.h"
  45 #endif
  46
  47 // Flags for wxDocManager (can be combined).
  48 enum
  49 {
  50     wxDOC_NEW    = 1,
  51     wxDOC_SILENT = 2
  52 };
  53
  54 // Document template flags
  55 enum
  56 {
  57     wxTEMPLATE_VISIBLE = 1,
  58     wxTEMPLATE_INVISIBLE = 2,
  59     wxDEFAULT_TEMPLATE_FLAGS = wxTEMPLATE_VISIBLE
  60 };
  61
  62 #define wxMAX_FILE_HISTORY 9
  63
  64 typedef wxVector<wxDocument*> wxDocVector;
  65 typedef wxVector<wxView*> wxViewVector;
  66 typedef wxVector<wxDocTemplate*> wxDocTemplateVector;
  67
  68 class WXDLLIMPEXP_CORE wxDocument : public wxEvtHandler
  69 {
  70 public:
  71     wxDocument(wxDocument *parent = NULL);
  72     virtual ~wxDocument();
  73
  74     // accessors
  75     void SetFilename(const wxString& filename, bool notifyViews = false);
  76     wxString GetFilename() const { return m_documentFile; }
  77
  78     void SetTitle(const wxString& title) { m_documentTitle = title; }
  79     wxString GetTitle() const { return m_documentTitle; }
  80
  81     void SetDocumentName(const wxString& name) { m_documentTypeName = name; }
  82     wxString GetDocumentName() const { return m_documentTypeName; }
  83
  84     // access the flag indicating whether this document had been already saved,
  85     // SetDocumentSaved() is only used internally, don't call it
  86     bool GetDocumentSaved() const { return m_savedYet; }
  87     void SetDocumentSaved(bool saved = true) { m_savedYet = saved; }
  88
  89     // activate the first view of the document if any
  90     void Activate();
  91
  92     // return true if the document hasn't been modified since the last time it
  93     // was saved (implying that it returns false if it was never saved, even if
  94     // the document is not modified)
  95     bool AlreadySaved() const { return !IsModified() && GetDocumentSaved(); }
  96
  97     virtual bool Close();
  98     virtual bool Save();
  99     virtual bool SaveAs();
 100     virtual bool Revert();
 101
 102 #if wxUSE_STD_IOSTREAM
 103     virtual wxSTD ostream& SaveObject(wxSTD ostream& stream);
 104     virtual wxSTD istream& LoadObject(wxSTD istream& stream);
 105 #else
 106     virtual wxOutputStream& SaveObject(wxOutputStream& stream);
 107     virtual wxInputStream& LoadObject(wxInputStream& stream);
 108 #endif
 109
 110     // Called by wxWidgets
 111     virtual bool OnSaveDocument(const wxString& filename);
 112     virtual bool OnOpenDocument(const wxString& filename);
 113     virtual bool OnNewDocument();
 114     virtual bool OnCloseDocument();
 115
 116     // Prompts for saving if about to close a modified document. Returns true
 117     // if ok to close the document (may have saved in the meantime, or set
 118     // modified to false)
 119     virtual bool OnSaveModified();
 120
 121     // if you override, remember to call the default
 122     // implementation (wxDocument::OnChangeFilename)
 123     virtual void OnChangeFilename(bool notifyViews);
 124
 125     // Called by framework if created automatically by the default document
 126     // manager: gives document a chance to initialise and (usually) create a
 127     // view
 128     virtual bool OnCreate(const wxString& path, long flags);
 129
 130     // By default, creates a base wxCommandProcessor.
 131     virtual wxCommandProcessor *OnCreateCommandProcessor();
 132     virtual wxCommandProcessor *GetCommandProcessor() const
 133         { return m_commandProcessor; }
 134     virtual void SetCommandProcessor(wxCommandProcessor *proc)
 135         { m_commandProcessor = proc; }
 136
 137     // Called after a view is added or removed. The default implementation
 138     // deletes the document if this is there are no more views.
 139     virtual void OnChangedViewList();
 140
 141     // Called from OnCloseDocument(), does nothing by default but may be
 142     // overridden. Return value is ignored.
 143     virtual bool DeleteContents();
 144
 145     virtual bool Draw(wxDC&);
 146     virtual bool IsModified() const { return m_documentModified; }
 147     virtual void Modify(bool mod);
 148
 149     virtual bool AddView(wxView *view);
 150     virtual bool RemoveView(wxView *view);
 151
 152 #ifndef __VISUALC6__
 153     wxViewVector GetViewsVector() const;
 154 #endif // !__VISUALC6__
 155
 156     wxList& GetViews() { return m_documentViews; }
 157     const wxList& GetViews() const { return m_documentViews; }
 158
 159     wxView *GetFirstView() const;
 160
 161     virtual void UpdateAllViews(wxView *sender = NULL, wxObject *hint = NULL);
 162     virtual void NotifyClosing();
 163
 164     // Remove all views (because we're closing the document)
 165     virtual bool DeleteAllViews();
 166
 167     // Other stuff
 168     virtual wxDocManager *GetDocumentManager() const;
 169     virtual wxDocTemplate *GetDocumentTemplate() const
 170         { return m_documentTemplate; }
 171     virtual void SetDocumentTemplate(wxDocTemplate *temp)
 172         { m_documentTemplate = temp; }
 173
 174     // Get the document name to be shown to the user: the title if there is
 175     // any, otherwise the filename if the document was saved and, finally,
 176     // "unnamed" otherwise
 177     virtual wxString GetUserReadableName() const;
 178
 179 #if WXWIN_COMPATIBILITY_2_8
 180     // use GetUserReadableName() instead
 181     wxDEPRECATED_BUT_USED_INTERNALLY(
 182         virtual bool GetPrintableName(wxString& buf) const
 183     );
 184 #endif // WXWIN_COMPATIBILITY_2_8
 185
 186     // Returns a window that can be used as a parent for document-related
 187     // dialogs. Override if necessary.
 188     virtual wxWindow *GetDocumentWindow() const;
 189
 190     // Returns true if this document is a child document corresponding to a
 191     // part of the parent document and not a disk file as usual.
 192     bool IsChildDocument() const { return m_documentParent != NULL; }
 193
 194 protected:
 195     wxList                m_documentViews;
 196     wxString              m_documentFile;
 197     wxString              m_documentTitle;
 198     wxString              m_documentTypeName;
 199     wxDocTemplate*        m_documentTemplate;
 200     bool                  m_documentModified;
 201
 202     // if the document parent is non-NULL, it's a pseudo-document corresponding
 203     // to a part of the parent document which can't be saved or loaded
 204     // independently of its parent and is always closed when its parent is
 205     wxDocument*           m_documentParent;
 206
 207     wxCommandProcessor*   m_commandProcessor;
 208     bool                  m_savedYet;
 209
 210     // Called by OnSaveDocument and OnOpenDocument to implement standard
 211     // Save/Load behaviour. Re-implement in derived class for custom
 212     // behaviour.
 213     virtual bool DoSaveDocument(const wxString& file);
 214     virtual bool DoOpenDocument(const wxString& file);
 215
 216     // the default implementation of GetUserReadableName()
 217     wxString DoGetUserReadableName() const;
 218
 219 private:
 220     // list of all documents whose m_documentParent is this one
 221     typedef wxDList<wxDocument> DocsList;
 222     DocsList m_childDocuments;
 223
 224     DECLARE_ABSTRACT_CLASS(wxDocument)
 225     wxDECLARE_NO_COPY_CLASS(wxDocument);
 226 };
 227
 228 class WXDLLIMPEXP_CORE wxView: public wxEvtHandler
 229 {
 230 public:
 231     wxView();
 232     virtual ~wxView();
 233
 234     wxDocument *GetDocument() const { return m_viewDocument; }
 235     virtual void SetDocument(wxDocument *doc);
 236
 237     wxString GetViewName() const { return m_viewTypeName; }
 238     void SetViewName(const wxString& name) { m_viewTypeName = name; }
 239
 240     wxWindow *GetFrame() const { return m_viewFrame ; }
 241     void SetFrame(wxWindow *frame) { m_viewFrame = frame; }
 242
 243     virtual void OnActivateView(bool activate,
 244                                 wxView *activeView,
 245                                 wxView *deactiveView);
 246     virtual void OnDraw(wxDC *dc) = 0;
 247     virtual void OnPrint(wxDC *dc, wxObject *info);
 248     virtual void OnUpdate(wxView *sender, wxObject *hint = NULL);
 249     virtual void OnClosingDocument() {}
 250     virtual void OnChangeFilename();
 251
 252     // Called by framework if created automatically by the default document
 253     // manager class: gives view a chance to initialise
 254     virtual bool OnCreate(wxDocument *WXUNUSED(doc), long WXUNUSED(flags))
 255         { return true; }
 256
 257     // Checks if the view is the last one for the document; if so, asks user
 258     // to confirm save data (if modified). If ok, deletes itself and returns
 259     // true.
 260     virtual bool Close(bool deleteWindow = true);
 261
 262     // Override to do cleanup/veto close
 263     virtual bool OnClose(bool deleteWindow);
 264
 265     // A view's window can call this to notify the view it is (in)active.
 266     // The function then notifies the document manager.
 267     virtual void Activate(bool activate);
 268
 269     wxDocManager *GetDocumentManager() const
 270         { return m_viewDocument->GetDocumentManager(); }
 271
 272 #if wxUSE_PRINTING_ARCHITECTURE
 273     virtual wxPrintout *OnCreatePrintout();
 274 #endif
 275
 276     // implementation only
 277     // -------------------
 278
 279     // set the associated frame, it is used to reset its view when we're
 280     // destroyed
 281     void SetDocChildFrame(wxDocChildFrameAnyBase *docChildFrame);
 282
 283 protected:
 284     // hook the document into event handlers chain here
 285     virtual bool TryBefore(wxEvent& event);
 286
 287     wxDocument*       m_viewDocument;
 288     wxString          m_viewTypeName;
 289     wxWindow*         m_viewFrame;
 290
 291     wxDocChildFrameAnyBase *m_docChildFrame;
 292
 293 private:
 294     DECLARE_ABSTRACT_CLASS(wxView)
 295     wxDECLARE_NO_COPY_CLASS(wxView);
 296 };
 297
 298 // Represents user interface (and other) properties of documents and views
 299 class WXDLLIMPEXP_CORE wxDocTemplate: public wxObject
 300 {
 301
 302 friend class WXDLLIMPEXP_FWD_CORE wxDocManager;
 303
 304 public:
 305     // Associate document and view types. They're for identifying what view is
 306     // associated with what template/document type
 307     wxDocTemplate(wxDocManager *manager,
 308                   const wxString& descr,
 309                   const wxString& filter,
 310                   const wxString& dir,
 311                   const wxString& ext,
 312                   const wxString& docTypeName,
 313                   const wxString& viewTypeName,
 314                   wxClassInfo *docClassInfo = NULL,
 315                   wxClassInfo *viewClassInfo = NULL,
 316                   long flags = wxDEFAULT_TEMPLATE_FLAGS);
 317
 318     virtual ~wxDocTemplate();
 319
 320     // By default, these two member functions dynamically creates document and
 321     // view using dynamic instance construction. Override these if you need a
 322     // different method of construction.
 323     virtual wxDocument *CreateDocument(const wxString& path, long flags = 0);
 324     virtual wxView *CreateView(wxDocument *doc, long flags = 0);
 325
 326     // Helper method for CreateDocument; also allows you to do your own document
 327     // creation
 328     virtual bool InitDocument(wxDocument* doc,
 329                               const wxString& path,
 330                               long flags = 0);
 331
 332     wxString GetDefaultExtension() const { return m_defaultExt; }
 333     wxString GetDescription() const { return m_description; }
 334     wxString GetDirectory() const { return m_directory; }
 335     wxDocManager *GetDocumentManager() const { return m_documentManager; }
 336     void SetDocumentManager(wxDocManager *manager)
 337         { m_documentManager = manager; }
 338     wxString GetFileFilter() const { return m_fileFilter; }
 339     long GetFlags() const { return m_flags; }
 340     virtual wxString GetViewName() const { return m_viewTypeName; }
 341     virtual wxString GetDocumentName() const { return m_docTypeName; }
 342
 343     void SetFileFilter(const wxString& filter) { m_fileFilter = filter; }
 344     void SetDirectory(const wxString& dir) { m_directory = dir; }
 345     void SetDescription(const wxString& descr) { m_description = descr; }
 346     void SetDefaultExtension(const wxString& ext) { m_defaultExt = ext; }
 347     void SetFlags(long flags) { m_flags = flags; }
 348
 349     bool IsVisible() const { return (m_flags & wxTEMPLATE_VISIBLE) != 0; }
 350
 351     wxClassInfo* GetDocClassInfo() const { return m_docClassInfo; }
 352     wxClassInfo* GetViewClassInfo() const { return m_viewClassInfo; }
 353
 354     virtual bool FileMatchesTemplate(const wxString& path);
 355
 356 protected:
 357     long              m_flags;
 358     wxString          m_fileFilter;
 359     wxString          m_directory;
 360     wxString          m_description;
 361     wxString          m_defaultExt;
 362     wxString          m_docTypeName;
 363     wxString          m_viewTypeName;
 364     wxDocManager*     m_documentManager;
 365
 366     // For dynamic creation of appropriate instances.
 367     wxClassInfo*      m_docClassInfo;
 368     wxClassInfo*      m_viewClassInfo;
 369
 370     // Called by CreateDocument and CreateView to create the actual
 371     // document/view object.
 372     //
 373     // By default uses the ClassInfo provided to the constructor. Override
 374     // these functions to provide a different method of creation.
 375     virtual wxDocument *DoCreateDocument();
 376     virtual wxView *DoCreateView();
 377
 378 private:
 379     DECLARE_CLASS(wxDocTemplate)
 380     wxDECLARE_NO_COPY_CLASS(wxDocTemplate);
 381 };
 382
 383 // One object of this class may be created in an application, to manage all
 384 // the templates and documents.
 385 class WXDLLIMPEXP_CORE wxDocManager: public wxEvtHandler
 386 {
 387 public:
 388     // NB: flags are unused, don't pass wxDOC_XXX to this ctor
 389     wxDocManager(long flags = 0, bool initialize = true);
 390     virtual ~wxDocManager();
 391
 392     virtual bool Initialize();
 393
 394     // Handlers for common user commands
 395     void OnFileClose(wxCommandEvent& event);
 396     void OnFileCloseAll(wxCommandEvent& event);
 397     void OnFileNew(wxCommandEvent& event);
 398     void OnFileOpen(wxCommandEvent& event);
 399     void OnFileRevert(wxCommandEvent& event);
 400     void OnFileSave(wxCommandEvent& event);
 401     void OnFileSaveAs(wxCommandEvent& event);
 402     void OnMRUFile(wxCommandEvent& event);
 403 #if wxUSE_PRINTING_ARCHITECTURE
 404     void OnPrint(wxCommandEvent& event);
 405     void OnPreview(wxCommandEvent& event);
 406     void OnPageSetup(wxCommandEvent& event);
 407 #endif // wxUSE_PRINTING_ARCHITECTURE
 408     void OnUndo(wxCommandEvent& event);
 409     void OnRedo(wxCommandEvent& event);
 410
 411     // Handlers for UI update commands
 412     void OnUpdateFileOpen(wxUpdateUIEvent& event);
 413     void OnUpdateDisableIfNoDoc(wxUpdateUIEvent& event);
 414     void OnUpdateFileRevert(wxUpdateUIEvent& event);
 415     void OnUpdateFileNew(wxUpdateUIEvent& event);
 416     void OnUpdateFileSave(wxUpdateUIEvent& event);
 417     void OnUpdateFileSaveAs(wxUpdateUIEvent& event);
 418     void OnUpdateUndo(wxUpdateUIEvent& event);
 419     void OnUpdateRedo(wxUpdateUIEvent& event);
 420
 421     // called when file format detection didn't work, can be overridden to do
 422     // something in this case
 423     virtual void OnOpenFileFailure() { }
 424
 425     virtual wxDocument *CreateDocument(const wxString& path, long flags = 0);
 426
 427     // wrapper around CreateDocument() with a more clear name
 428     wxDocument *CreateNewDocument()
 429         { return CreateDocument(wxString(), wxDOC_NEW); }
 430
 431     virtual wxView *CreateView(wxDocument *doc, long flags = 0);
 432     virtual void DeleteTemplate(wxDocTemplate *temp, long flags = 0);
 433     virtual bool FlushDoc(wxDocument *doc);
 434     virtual wxDocTemplate *MatchTemplate(const wxString& path);
 435     virtual wxDocTemplate *SelectDocumentPath(wxDocTemplate **templates,
 436             int noTemplates, wxString& path, long flags, bool save = false);
 437     virtual wxDocTemplate *SelectDocumentType(wxDocTemplate **templates,
 438             int noTemplates, bool sort = false);
 439     virtual wxDocTemplate *SelectViewType(wxDocTemplate **templates,
 440             int noTemplates, bool sort = false);
 441     virtual wxDocTemplate *FindTemplateForPath(const wxString& path);
 442
 443     void AssociateTemplate(wxDocTemplate *temp);
 444     void DisassociateTemplate(wxDocTemplate *temp);
 445
 446     // Find template from document class info, may return NULL.
 447     wxDocTemplate* FindTemplate(const wxClassInfo* documentClassInfo);
 448
 449     wxDocument *GetCurrentDocument() const;
 450
 451     void SetMaxDocsOpen(int n) { m_maxDocsOpen = n; }
 452     int GetMaxDocsOpen() const { return m_maxDocsOpen; }
 453
 454     // Add and remove a document from the manager's list
 455     void AddDocument(wxDocument *doc);
 456     void RemoveDocument(wxDocument *doc);
 457
 458     // closes all currently open documents
 459     bool CloseDocuments(bool force = true);
 460
 461     // closes the specified document
 462     bool CloseDocument(wxDocument* doc, bool force = false);
 463
 464     // Clear remaining documents and templates
 465     bool Clear(bool force = true);
 466
 467     // Views or windows should inform the document manager
 468     // when a view is going in or out of focus
 469     virtual void ActivateView(wxView *view, bool activate = true);
 470     virtual wxView *GetCurrentView() const { return m_currentView; }
 471
 472 #ifndef __VISUALC6__
 473     wxDocVector GetDocumentsVector() const;
 474     wxDocTemplateVector GetTemplatesVector() const;
 475 #endif // !__VISUALC6__
 476
 477     wxList& GetDocuments() { return m_docs; }
 478     wxList& GetTemplates() { return m_templates; }
 479
 480     // Return the default name for a new document (by default returns strings
 481     // in the form "unnamed <counter>" but can be overridden)
 482     virtual wxString MakeNewDocumentName();
 483
 484     // Make a frame title (override this to do something different)
 485     virtual wxString MakeFrameTitle(wxDocument* doc);
 486
 487     virtual wxFileHistory *OnCreateFileHistory();
 488     virtual wxFileHistory *GetFileHistory() const { return m_fileHistory; }
 489
 490     // File history management
 491     virtual void AddFileToHistory(const wxString& file);
 492     virtual void RemoveFileFromHistory(size_t i);
 493     virtual size_t GetHistoryFilesCount() const;
 494     virtual wxString GetHistoryFile(size_t i) const;
 495     virtual void FileHistoryUseMenu(wxMenu *menu);
 496     virtual void FileHistoryRemoveMenu(wxMenu *menu);
 497 #if wxUSE_CONFIG
 498     virtual void FileHistoryLoad(const wxConfigBase& config);
 499     virtual void FileHistorySave(wxConfigBase& config);
 500 #endif // wxUSE_CONFIG
 501
 502     virtual void FileHistoryAddFilesToMenu();
 503     virtual void FileHistoryAddFilesToMenu(wxMenu* menu);
 504
 505     wxString GetLastDirectory() const;
 506     void SetLastDirectory(const wxString& dir) { m_lastDirectory = dir; }
 507
 508     // Get the current document manager
 509     static wxDocManager* GetDocumentManager() { return sm_docManager; }
 510
 511 #if wxUSE_PRINTING_ARCHITECTURE
 512     wxPageSetupDialogData& GetPageSetupDialogData()
 513         { return m_pageSetupDialogData; }
 514     const wxPageSetupDialogData& GetPageSetupDialogData() const
 515         { return m_pageSetupDialogData; }
 516 #endif // wxUSE_PRINTING_ARCHITECTURE
 517
 518 #if WXWIN_COMPATIBILITY_2_8
 519     // deprecated, override GetDefaultName() instead
 520     wxDEPRECATED_BUT_USED_INTERNALLY(
 521         virtual bool MakeDefaultName(wxString& buf)
 522     );
 523 #endif
 524
 525 #if WXWIN_COMPATIBILITY_2_6
 526     // deprecated, use GetHistoryFilesCount() instead
 527     wxDEPRECATED( size_t GetNoHistoryFiles() const );
 528 #endif // WXWIN_COMPATIBILITY_2_6
 529
 530
 531 protected:
 532     // Called when a file selected from the MRU list doesn't exist any more.
 533     // The default behaviour is to remove the file from the MRU and notify the
 534     // user about it but this method can be overridden to customize it.
 535     virtual void OnMRUFileNotExist(unsigned n, const wxString& filename);
 536
 537     // Open the MRU file with the given index in our associated file history.
 538     void DoOpenMRUFile(unsigned n);
 539 #if wxUSE_PRINTING_ARCHITECTURE
 540     virtual wxPreviewFrame* CreatePreviewFrame(wxPrintPreviewBase* preview,
 541                                                wxWindow *parent,
 542                                                const wxString& title);
 543 #endif // wxUSE_PRINTING_ARCHITECTURE
 544
 545     // hook the currently active view into event handlers chain here
 546     virtual bool TryBefore(wxEvent& event);
 547
 548     // return the command processor for the current document, if any
 549     wxCommandProcessor *GetCurrentCommandProcessor() const;
 550
 551     // this method tries to find an active view harder than GetCurrentView():
 552     // if the latter is NULL, it also checks if we don't have just a single
 553     // view and returns it then
 554     wxView *GetActiveView() const;
 555
 556     int               m_defaultDocumentNameCounter;
 557     int               m_maxDocsOpen;
 558     wxList            m_docs;
 559     wxList            m_templates;
 560     wxView*           m_currentView;
 561     wxFileHistory*    m_fileHistory;
 562     wxString          m_lastDirectory;
 563     static wxDocManager* sm_docManager;
 564
 565 #if wxUSE_PRINTING_ARCHITECTURE
 566     wxPageSetupDialogData m_pageSetupDialogData;
 567 #endif // wxUSE_PRINTING_ARCHITECTURE
 568
 569     DECLARE_EVENT_TABLE()
 570     DECLARE_DYNAMIC_CLASS(wxDocManager)
 571     wxDECLARE_NO_COPY_CLASS(wxDocManager);
 572 };
 573
 574 #if WXWIN_COMPATIBILITY_2_6
 575 inline size_t wxDocManager::GetNoHistoryFiles() const
 576 {
 577     return GetHistoryFilesCount();
 578 }
 579 #endif // WXWIN_COMPATIBILITY_2_6
 580
 581 // ----------------------------------------------------------------------------
 582 // Base class for child frames -- this is what wxView renders itself into
 583 //
 584 // Notice that this is a mix-in class so it doesn't derive from wxWindow, only
 585 // wxDocChildFrameAny does
 586 // ----------------------------------------------------------------------------
 587
 588 class WXDLLIMPEXP_CORE wxDocChildFrameAnyBase
 589 {
 590 public:
 591     // default ctor, use Create() after it
 592     wxDocChildFrameAnyBase()
 593     {
 594         m_childDocument = NULL;
 595         m_childView = NULL;
 596         m_win = NULL;
 597     }
 598
 599     // full ctor equivalent to using the default one and Create(0
 600     wxDocChildFrameAnyBase(wxDocument *doc, wxView *view, wxWindow *win)
 601     {
 602         Create(doc, view, win);
 603     }
 604
 605     // method which must be called for an object created using the default ctor
 606     //
 607     // note that it returns bool just for consistency with Create() methods in
 608     // other classes, we never return false from here
 609     bool Create(wxDocument *doc, wxView *view, wxWindow *win)
 610     {
 611         m_childDocument = doc;
 612         m_childView = view;
 613         m_win = win;
 614
 615         if ( view )
 616             view->SetDocChildFrame(this);
 617
 618         return true;
 619     }
 620
 621     // dtor doesn't need to be virtual, an object should never be destroyed via
 622     // a pointer to this class
 623     ~wxDocChildFrameAnyBase()
 624     {
 625         // prevent the view from deleting us if we're being deleted directly
 626         // (and not via Close() + Destroy())
 627         if ( m_childView )
 628             m_childView->SetDocChildFrame(NULL);
 629     }
 630
 631     wxDocument *GetDocument() const { return m_childDocument; }
 632     wxView *GetView() const { return m_childView; }
 633     void SetDocument(wxDocument *doc) { m_childDocument = doc; }
 634     void SetView(wxView *view) { m_childView = view; }
 635
 636     wxWindow *GetWindow() const { return m_win; }
 637
 638 protected:
 639     // we're not a wxEvtHandler but we provide this wxEvtHandler-like function
 640     // which is called from TryBefore() of the derived classes to give our view
 641     // a chance to process the message before the frame event handlers are used
 642     bool TryProcessEvent(wxEvent& event)
 643     {
 644         return m_childView && m_childView->ProcessEventLocally(event);
 645     }
 646
 647     // called from EVT_CLOSE handler in the frame: check if we can close and do
 648     // cleanup if so; veto the event otherwise
 649     bool CloseView(wxCloseEvent& event);
 650
 651
 652     wxDocument*       m_childDocument;
 653     wxView*           m_childView;
 654
 655     // the associated window: having it here is not terribly elegant but it
 656     // allows us to avoid having any virtual functions in this class
 657     wxWindow* m_win;
 658
 659
 660     wxDECLARE_NO_COPY_CLASS(wxDocChildFrameAnyBase);
 661 };
 662
 663 // ----------------------------------------------------------------------------
 664 // Template implementing child frame concept using the given wxFrame-like class
 665 //
 666 // This is used to define wxDocChildFrame and wxDocMDIChildFrame: ChildFrame is
 667 // a wxFrame or wxMDIChildFrame (although in theory it could be any wxWindow-
 668 // derived class as long as it provided a ctor with the same signature as
 669 // wxFrame and OnActivate() method) and ParentFrame is either wxFrame or
 670 // wxMDIParentFrame.
 671 // ----------------------------------------------------------------------------
 672
 673 template <class ChildFrame, class ParentFrame>
 674 class WXDLLIMPEXP_CORE wxDocChildFrameAny : public ChildFrame,
 675                                             public wxDocChildFrameAnyBase
 676 {
 677 public:
 678     typedef ChildFrame BaseClass;
 679
 680     // default ctor, use Create after it
 681     wxDocChildFrameAny() { }
 682
 683     // ctor for a frame showing the given view of the specified document
 684     wxDocChildFrameAny(wxDocument *doc,
 685                        wxView *view,
 686                        ParentFrame *parent,
 687                        wxWindowID id,
 688                        const wxString& title,
 689                        const wxPoint& pos = wxDefaultPosition,
 690                        const wxSize& size = wxDefaultSize,
 691                        long style = wxDEFAULT_FRAME_STYLE,
 692                        const wxString& name = wxFrameNameStr)
 693     {
 694         Create(doc, view, parent, id, title, pos, size, style, name);
 695     }
 696
 697     bool Create(wxDocument *doc,
 698                 wxView *view,
 699                 ParentFrame *parent,
 700                 wxWindowID id,
 701                 const wxString& title,
 702                 const wxPoint& pos = wxDefaultPosition,
 703                 const wxSize& size = wxDefaultSize,
 704                 long style = wxDEFAULT_FRAME_STYLE,
 705                 const wxString& name = wxFrameNameStr)
 706     {
 707         if ( !wxDocChildFrameAnyBase::Create(doc, view, this) )
 708             return false;
 709
 710         if ( !BaseClass::Create(parent, id, title, pos, size, style, name) )
 711             return false;
 712
 713         this->Connect(wxEVT_ACTIVATE,
 714                       wxActivateEventHandler(wxDocChildFrameAny::OnActivate));
 715         this->Connect(wxEVT_CLOSE_WINDOW,
 716                       wxCloseEventHandler(wxDocChildFrameAny::OnCloseWindow));
 717
 718         return true;
 719     }
 720
 721     virtual bool Destroy()
 722     {
 723         // FIXME: why exactly do we do this? to avoid activation events during
 724         //        destructions maybe?
 725         m_childView = NULL;
 726         return BaseClass::Destroy();
 727     }
 728
 729 protected:
 730     // hook the child view into event handlers chain here
 731     virtual bool TryBefore(wxEvent& event)
 732     {
 733         return TryProcessEvent(event) || BaseClass::TryBefore(event);
 734     }
 735
 736 private:
 737     void OnActivate(wxActivateEvent& event)
 738     {
 739         BaseClass::OnActivate(event);
 740
 741         if ( m_childView )
 742             m_childView->Activate(event.GetActive());
 743     }
 744
 745     void OnCloseWindow(wxCloseEvent& event)
 746     {
 747         if ( CloseView(event) )
 748             Destroy();
 749         //else: vetoed
 750     }
 751
 752     wxDECLARE_NO_COPY_TEMPLATE_CLASS_2(wxDocChildFrameAny,
 753                                         ChildFrame, ParentFrame);
 754 };
 755
 756 // ----------------------------------------------------------------------------
 757 // A default child frame: we need to define it as a class just for wxRTTI,
 758 // otherwise we could simply typedef it
 759 // ----------------------------------------------------------------------------
 760
 761 #ifdef __VISUALC6__
 762     // "non dll-interface class 'wxDocChildFrameAny<>' used as base interface
 763     // for dll-interface class 'wxDocChildFrame'" -- this is bogus as the
 764     // template will be DLL-exported but only once it is used as base class
 765     // here!
 766     #pragma warning (push)
 767     #pragma warning (disable:4275)
 768 #endif
 769
 770 typedef wxDocChildFrameAny<wxFrame, wxFrame> wxDocChildFrameBase;
 771
 772 class WXDLLIMPEXP_CORE wxDocChildFrame : public wxDocChildFrameBase
 773 {
 774 public:
 775     wxDocChildFrame()
 776     {
 777     }
 778
 779     wxDocChildFrame(wxDocument *doc,
 780                     wxView *view,
 781                     wxFrame *parent,
 782                     wxWindowID id,
 783                     const wxString& title,
 784                     const wxPoint& pos = wxDefaultPosition,
 785                     const wxSize& size = wxDefaultSize,
 786                     long style = wxDEFAULT_FRAME_STYLE,
 787                     const wxString& name = wxFrameNameStr)
 788         : wxDocChildFrameBase(doc, view,
 789                               parent, id, title, pos, size, style, name)
 790     {
 791     }
 792
 793     bool Create(wxDocument *doc,
 794                 wxView *view,
 795                 wxFrame *parent,
 796                 wxWindowID id,
 797                 const wxString& title,
 798                 const wxPoint& pos = wxDefaultPosition,
 799                 const wxSize& size = wxDefaultSize,
 800                 long style = wxDEFAULT_FRAME_STYLE,
 801                 const wxString& name = wxFrameNameStr)
 802     {
 803         return wxDocChildFrameBase::Create
 804                (
 805                     doc, view,
 806                     parent, id, title, pos, size, style, name
 807                );
 808     }
 809
 810 private:
 811     DECLARE_CLASS(wxDocChildFrame)
 812     wxDECLARE_NO_COPY_CLASS(wxDocChildFrame);
 813 };
 814
 815 // ----------------------------------------------------------------------------
 816 // wxDocParentFrame and related classes.
 817 //
 818 // As with wxDocChildFrame we define a template base class used by both normal
 819 // and MDI versions
 820 // ----------------------------------------------------------------------------
 821
 822 // Base class containing type-independent code of wxDocParentFrameAny
 823 //
 824 // Similarly to wxDocChildFrameAnyBase, this class is a mix-in and doesn't
 825 // derive from wxWindow.
 826 class WXDLLIMPEXP_CORE wxDocParentFrameAnyBase
 827 {
 828 public:
 829     wxDocParentFrameAnyBase() { m_docManager = NULL; }
 830
 831     wxDocManager *GetDocumentManager() const { return m_docManager; }
 832
 833 protected:
 834     wxDocManager *m_docManager;
 835
 836     wxDECLARE_NO_COPY_CLASS(wxDocParentFrameAnyBase);
 837 };
 838
 839 // This is similar to wxDocChildFrameAny and is used to provide common
 840 // implementation for both wxDocParentFrame and wxDocMDIParentFrame
 841 template <class BaseFrame>
 842 class WXDLLIMPEXP_CORE wxDocParentFrameAny : public BaseFrame,
 843                                              public wxDocParentFrameAnyBase
 844 {
 845 public:
 846     wxDocParentFrameAny() { }
 847     wxDocParentFrameAny(wxDocManager *manager,
 848                         wxFrame *frame,
 849                         wxWindowID id,
 850                         const wxString& title,
 851                         const wxPoint& pos = wxDefaultPosition,
 852                         const wxSize& size = wxDefaultSize,
 853                         long style = wxDEFAULT_FRAME_STYLE,
 854                         const wxString& name = wxFrameNameStr)
 855     {
 856         Create(manager, frame, id, title, pos, size, style, name);
 857     }
 858
 859     bool Create(wxDocManager *manager,
 860                 wxFrame *frame,
 861                 wxWindowID id,
 862                 const wxString& title,
 863                 const wxPoint& pos = wxDefaultPosition,
 864                 const wxSize& size = wxDefaultSize,
 865                 long style = wxDEFAULT_FRAME_STYLE,
 866                 const wxString& name = wxFrameNameStr)
 867     {
 868         m_docManager = manager;
 869
 870         if ( !BaseFrame::Create(frame, id, title, pos, size, style, name) )
 871             return false;
 872
 873         this->Connect(wxID_EXIT, wxEVT_COMMAND_MENU_SELECTED,
 874                       wxCommandEventHandler(wxDocParentFrameAny::OnExit));
 875         this->Connect(wxEVT_CLOSE_WINDOW,
 876                       wxCloseEventHandler(wxDocParentFrameAny::OnCloseWindow));
 877
 878         return true;
 879     }
 880
 881 protected:
 882     // hook the document manager into event handling chain here
 883     virtual bool TryBefore(wxEvent& event)
 884     {
 885         if ( m_docManager && m_docManager->ProcessEventLocally(event) )
 886             return true;
 887
 888         return BaseFrame::TryBefore(event);
 889     }
 890
 891 private:
 892     void OnExit(wxCommandEvent& WXUNUSED(event))
 893     {
 894         this->Close();
 895     }
 896
 897     void OnCloseWindow(wxCloseEvent& event)
 898     {
 899         if ( m_docManager && !m_docManager->Clear(!event.CanVeto()) )
 900         {
 901             // The user decided not to close finally, abort.
 902             event.Veto();
 903         }
 904         else
 905         {
 906             // Just skip the event, base class handler will destroy the window.
 907             event.Skip();
 908         }
 909     }
 910
 911
 912     wxDECLARE_NO_COPY_CLASS(wxDocParentFrameAny);
 913 };
 914
 915 typedef wxDocParentFrameAny<wxFrame> wxDocParentFrameBase;
 916
 917 class WXDLLIMPEXP_CORE wxDocParentFrame : public wxDocParentFrameBase
 918 {
 919 public:
 920     wxDocParentFrame() : wxDocParentFrameBase() { }
 921
 922     wxDocParentFrame(wxDocManager *manager,
 923                      wxFrame *parent,
 924                      wxWindowID id,
 925                      const wxString& title,
 926                      const wxPoint& pos = wxDefaultPosition,
 927                      const wxSize& size = wxDefaultSize,
 928                      long style = wxDEFAULT_FRAME_STYLE,
 929                      const wxString& name = wxFrameNameStr)
 930         : wxDocParentFrameBase(manager,
 931                                parent, id, title, pos, size, style, name)
 932     {
 933     }
 934
 935     bool Create(wxDocManager *manager,
 936                 wxFrame *parent,
 937                 wxWindowID id,
 938                 const wxString& title,
 939                 const wxPoint& pos = wxDefaultPosition,
 940                 const wxSize& size = wxDefaultSize,
 941                 long style = wxDEFAULT_FRAME_STYLE,
 942                 const wxString& name = wxFrameNameStr)
 943     {
 944         return wxDocParentFrameBase::Create(manager,
 945                                             parent, id, title,
 946                                             pos, size, style, name);
 947     }
 948
 949 private:
 950     DECLARE_CLASS(wxDocParentFrame)
 951     wxDECLARE_NO_COPY_CLASS(wxDocParentFrame);
 952 };
 953
 954 #ifdef __VISUALC6__
 955     // reenable warning 4275
 956     #pragma warning (pop)
 957 #endif
 958
 959 // ----------------------------------------------------------------------------
 960 // Provide simple default printing facilities
 961 // ----------------------------------------------------------------------------
 962
 963 #if wxUSE_PRINTING_ARCHITECTURE
 964 class WXDLLIMPEXP_CORE wxDocPrintout : public wxPrintout
 965 {
 966 public:
 967     wxDocPrintout(wxView *view = NULL, const wxString& title = wxString());
 968
 969     // implement wxPrintout methods
 970     virtual bool OnPrintPage(int page);
 971     virtual bool HasPage(int page);
 972     virtual bool OnBeginDocument(int startPage, int endPage);
 973     virtual void GetPageInfo(int *minPage, int *maxPage,
 974                              int *selPageFrom, int *selPageTo);
 975
 976     virtual wxView *GetView() { return m_printoutView; }
 977
 978 protected:
 979     wxView*       m_printoutView;
 980
 981 private:
 982     DECLARE_DYNAMIC_CLASS(wxDocPrintout)
 983     wxDECLARE_NO_COPY_CLASS(wxDocPrintout);
 984 };
 985 #endif // wxUSE_PRINTING_ARCHITECTURE
 986
 987 // For compatibility with existing file formats:
 988 // converts from/to a stream to/from a temporary file.
 989 #if wxUSE_STD_IOSTREAM
 990 bool WXDLLIMPEXP_CORE
 991 wxTransferFileToStream(const wxString& filename, wxSTD ostream& stream);
 992 bool WXDLLIMPEXP_CORE
 993 wxTransferStreamToFile(wxSTD istream& stream, const wxString& filename);
 994 #else
 995 bool WXDLLIMPEXP_CORE
 996 wxTransferFileToStream(const wxString& filename, wxOutputStream& stream);
 997 bool WXDLLIMPEXP_CORE
 998 wxTransferStreamToFile(wxInputStream& stream, const wxString& filename);
 999 #endif // wxUSE_STD_IOSTREAM
1000
1001
1002 // these flags are not used anywhere by wxWidgets and kept only for an unlikely
1003 // case of existing user code using them for its own purposes
1004 #if WXWIN_COMPATIBILITY_2_8
1005 enum
1006 {
1007     wxDOC_SDI = 1,
1008     wxDOC_MDI,
1009     wxDEFAULT_DOCMAN_FLAGS = wxDOC_SDI
1010 };
1011 #endif // WXWIN_COMPATIBILITY_2_8
1012
1013 #ifndef __VISUALC6__
1014 inline wxViewVector wxDocument::GetViewsVector() const
1015 {
1016     return m_documentViews.AsVector<wxView*>();
1017 }
1018
1019 inline wxDocVector wxDocManager::GetDocumentsVector() const
1020 {
1021     return m_docs.AsVector<wxDocument*>();
1022 }
1023
1024 inline wxDocTemplateVector wxDocManager::GetTemplatesVector() const
1025 {
1026     return m_templates.AsVector<wxDocTemplate*>();
1027 }
1028 #endif // !__VISUALC6__
1029
1030 #endif // wxUSE_DOC_VIEW_ARCHITECTURE
1031
1032 #endif // _WX_DOCH__