include/wx/docview.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        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)
   9 // Licence:     wxWindows licence
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 #ifndef _WX_DOCH__
  13 #define _WX_DOCH__
  14
  15 #ifdef __GNUG__
  16     #pragma interface "docview.h"
  17 #endif
  18
  19 #include "wx/defs.h"
  20 #include "wx/list.h"
  21 #include "wx/cmndata.h"
  22 #include "wx/string.h"
  23
  24 #if wxUSE_PRINTING_ARCHITECTURE
  25     #include "wx/print.h"
  26 #endif
  27
  28 class WXDLLEXPORT wxWindow;
  29 class WXDLLEXPORT wxDocument;
  30 class WXDLLEXPORT wxView;
  31 class WXDLLEXPORT wxDocTemplate;
  32 class WXDLLEXPORT wxDocManager;
  33 class WXDLLEXPORT wxPrintInfo;
  34 class WXDLLEXPORT wxCommandProcessor;
  35 class WXDLLEXPORT wxFileHistory;
  36 class WXDLLEXPORT wxConfigBase;
  37
  38 #if wxUSE_STD_IOSTREAM
  39   #include "wx/ioswrap.h"
  40 #else
  41   #include "wx/stream.h"
  42 #endif
  43
  44 // Document manager flags
  45 enum
  46 {
  47     wxDOC_SDI = 1,
  48     wxDOC_MDI,
  49     wxDOC_NEW,
  50     wxDOC_SILENT,
  51     wxDEFAULT_DOCMAN_FLAGS = wxDOC_SDI
  52 };
  53
  54 // Document template flags
  55 enum
  56 {
  57     wxTEMPLATE_VISIBLE = 1,
  58     wxTEMPLATE_INVISIBLE,
  59     wxDEFAULT_TEMPLATE_FLAGS = wxTEMPLATE_VISIBLE
  60 };
  61
  62 #define wxMAX_FILE_HISTORY 9
  63
  64 class WXDLLEXPORT wxDocument : public wxEvtHandler
  65 {
  66     DECLARE_ABSTRACT_CLASS(wxDocument)
  67
  68 public:
  69     wxDocument(wxDocument *parent = (wxDocument *) NULL);
  70     ~wxDocument();
  71
  72     // accessors
  73     void SetFilename(const wxString& filename, bool notifyViews = FALSE);
  74     wxString GetFilename() const { return m_documentFile; }
  75
  76     void SetTitle(const wxString& title) { m_documentTitle = title; };
  77     wxString GetTitle() const { return m_documentTitle; }
  78
  79     void SetDocumentName(const wxString& name) { m_documentTypeName = name; };
  80     wxString GetDocumentName() const { return m_documentTypeName; }
  81
  82     bool GetDocumentSaved() const { return m_savedYet; }
  83     void SetDocumentSaved(bool saved = TRUE) { m_savedYet = saved; }
  84
  85     virtual bool Close();
  86     virtual bool Save();
  87     virtual bool SaveAs();
  88     virtual bool Revert();
  89
  90 #if wxUSE_STD_IOSTREAM
  91     virtual wxSTD ostream& SaveObject(wxSTD ostream& stream);
  92     virtual wxSTD istream& LoadObject(wxSTD istream& stream);
  93 #else
  94     virtual wxOutputStream& SaveObject(wxOutputStream& stream);
  95     virtual wxInputStream& LoadObject(wxInputStream& stream);
  96 #endif
  97
  98 #if wxUSE_SERIAL
  99     // need this to keep from hiding the virtual from wxObject
 100     virtual void LoadObject(wxObjectInputStream& stream) { wxObject::LoadObject(stream); };
 101 #endif
 102
 103     // Called by wxWindows
 104     virtual bool OnSaveDocument(const wxString& filename);
 105     virtual bool OnOpenDocument(const wxString& filename);
 106     virtual bool OnNewDocument();
 107     virtual bool OnCloseDocument();
 108
 109     // Prompts for saving if about to close a modified document. Returns TRUE
 110     // if ok to close the document (may have saved in the meantime, or set
 111     // modified to FALSE)
 112     virtual bool OnSaveModified();
 113
 114     // Called by framework if created automatically by the default document
 115     // manager: gives document a chance to initialise and (usually) create a
 116     // view
 117     virtual bool OnCreate(const wxString& path, long flags);
 118
 119     // By default, creates a base wxCommandProcessor.
 120     virtual wxCommandProcessor *OnCreateCommandProcessor();
 121     virtual wxCommandProcessor *GetCommandProcessor() const { return m_commandProcessor; }
 122     virtual void SetCommandProcessor(wxCommandProcessor *proc) { m_commandProcessor = proc; }
 123
 124     // Called after a view is added or removed. The default implementation
 125     // deletes the document if this is there are no more views.
 126     virtual void OnChangedViewList();
 127
 128     virtual bool DeleteContents();
 129
 130     virtual bool Draw(wxDC&);
 131     virtual bool IsModified() const { return m_documentModified; }
 132     virtual void Modify(bool mod) { m_documentModified = mod; }
 133
 134     virtual bool AddView(wxView *view);
 135     virtual bool RemoveView(wxView *view);
 136     wxList& GetViews() const { return (wxList&) m_documentViews; }
 137     wxView *GetFirstView() const;
 138
 139     virtual void UpdateAllViews(wxView *sender = (wxView *) NULL, wxObject *hint = (wxObject *) NULL);
 140
 141     // Remove all views (because we're closing the document)
 142     virtual bool DeleteAllViews();
 143
 144     // Other stuff
 145     virtual wxDocManager *GetDocumentManager() const;
 146     virtual wxDocTemplate *GetDocumentTemplate() const { return m_documentTemplate; }
 147     virtual void SetDocumentTemplate(wxDocTemplate *temp) { m_documentTemplate = temp; }
 148
 149     // Get title, or filename if no title, else [unnamed]
 150     virtual bool GetPrintableName(wxString& buf) const;
 151
 152     // Returns a window that can be used as a parent for document-related
 153     // dialogs. Override if necessary.
 154     virtual wxWindow *GetDocumentWindow() const;
 155
 156 protected:
 157     wxList                m_documentViews;
 158     wxString              m_documentFile;
 159     wxString              m_documentTitle;
 160     wxString              m_documentTypeName;
 161     wxDocTemplate*        m_documentTemplate;
 162     bool                  m_documentModified;
 163     wxDocument*           m_documentParent;
 164     wxCommandProcessor*   m_commandProcessor;
 165     bool                  m_savedYet;
 166 };
 167
 168 class WXDLLEXPORT wxView: public wxEvtHandler
 169 {
 170     DECLARE_ABSTRACT_CLASS(wxView)
 171
 172 public:
 173     //  wxView(wxDocument *doc = (wxDocument *) NULL);
 174     wxView();
 175     ~wxView();
 176
 177     wxDocument *GetDocument() const { return m_viewDocument; }
 178     void SetDocument(wxDocument *doc);
 179
 180     wxString GetViewName() const { return m_viewTypeName; }
 181     void SetViewName(const wxString& name) { m_viewTypeName = name; };
 182
 183     wxFrame *GetFrame() const { return m_viewFrame ; }
 184     void SetFrame(wxFrame *frame) { m_viewFrame = frame; }
 185
 186     virtual void OnActivateView(bool activate, wxView *activeView, wxView *deactiveView);
 187     virtual void OnDraw(wxDC *dc) = 0;
 188     virtual void OnPrint(wxDC *dc, wxObject *info);
 189     virtual void OnUpdate(wxView *sender, wxObject *hint = (wxObject *) NULL);
 190     virtual void OnChangeFilename();
 191
 192     // Called by framework if created automatically by the default document
 193     // manager class: gives view a chance to initialise
 194     virtual bool OnCreate(wxDocument *WXUNUSED(doc), long WXUNUSED(flags)) { return TRUE; };
 195
 196     // Checks if the view is the last one for the document; if so, asks user
 197     // to confirm save data (if modified). If ok, deletes itself and returns
 198     // TRUE.
 199     virtual bool Close(bool deleteWindow = TRUE);
 200
 201     // Override to do cleanup/veto close
 202     virtual bool OnClose(bool deleteWindow);
 203
 204 #if WXWIN_COMPATIBILITY
 205     // Defeat compiler warning
 206     bool OnClose() { return wxEvtHandler::OnClose(); }
 207 #endif
 208
 209     // Extend event processing to search the document's event table
 210     virtual bool ProcessEvent(wxEvent& event);
 211
 212     // A view's window can call this to notify the view it is (in)active.
 213     // The function then notifies the document manager.
 214     virtual void Activate(bool activate);
 215
 216     wxDocManager *GetDocumentManager() const
 217         { return m_viewDocument->GetDocumentManager(); }
 218
 219 #if wxUSE_PRINTING_ARCHITECTURE
 220     virtual wxPrintout *OnCreatePrintout();
 221 #endif
 222
 223 protected:
 224     wxDocument*       m_viewDocument;
 225     wxString          m_viewTypeName;
 226     wxFrame*          m_viewFrame;
 227 };
 228
 229 // Represents user interface (and other) properties of documents and views
 230 class WXDLLEXPORT wxDocTemplate: public wxObject
 231 {
 232 DECLARE_CLASS(wxDocTemplate)
 233
 234 friend class WXDLLEXPORT wxDocManager;
 235
 236 public:
 237     // Associate document and view types. They're for identifying what view is
 238     // associated with what template/document type
 239     wxDocTemplate(wxDocManager *manager,
 240                   const wxString& descr,
 241                   const wxString& filter,
 242                   const wxString& dir,
 243                   const wxString& ext,
 244                   const wxString& docTypeName,
 245                   const wxString& viewTypeName,
 246                   wxClassInfo *docClassInfo = (wxClassInfo *) NULL,
 247                   wxClassInfo *viewClassInfo = (wxClassInfo *)NULL,
 248                   long flags = wxDEFAULT_TEMPLATE_FLAGS);
 249
 250     ~wxDocTemplate();
 251
 252     // By default, these two member functions dynamically creates document and
 253     // view using dynamic instance construction. Override these if you need a
 254     // different method of construction.
 255     virtual wxDocument *CreateDocument(const wxString& path, long flags = 0);
 256     virtual wxView *CreateView(wxDocument *doc, long flags = 0);
 257
 258     wxString GetDefaultExtension() const { return m_defaultExt; };
 259     wxString GetDescription() const { return m_description; }
 260     wxString GetDirectory() const { return m_directory; };
 261     wxDocManager *GetDocumentManager() const { return m_documentManager; }
 262     void SetDocumentManager(wxDocManager *manager) { m_documentManager = manager; }
 263     wxString GetFileFilter() const { return m_fileFilter; };
 264     long GetFlags() const { return m_flags; };
 265     virtual wxString GetViewName() const { return m_viewTypeName; }
 266     virtual wxString GetDocumentName() const { return m_docTypeName; }
 267
 268     void SetFileFilter(const wxString& filter) { m_fileFilter = filter; };
 269     void SetDirectory(const wxString& dir) { m_directory = dir; };
 270     void SetDescription(const wxString& descr) { m_description = descr; };
 271     void SetDefaultExtension(const wxString& ext) { m_defaultExt = ext; };
 272     void SetFlags(long flags) { m_flags = flags; };
 273
 274     bool IsVisible() const { return ((m_flags & wxTEMPLATE_VISIBLE) == wxTEMPLATE_VISIBLE); }
 275
 276     virtual bool FileMatchesTemplate(const wxString& path);
 277
 278 protected:
 279     long              m_flags;
 280     wxString          m_fileFilter;
 281     wxString          m_directory;
 282     wxString          m_description;
 283     wxString          m_defaultExt;
 284     wxString          m_docTypeName;
 285     wxString          m_viewTypeName;
 286     wxDocManager*     m_documentManager;
 287
 288     // For dynamic creation of appropriate instances.
 289     wxClassInfo*      m_docClassInfo;
 290     wxClassInfo*      m_viewClassInfo;
 291 };
 292
 293 // One object of this class may be created in an application, to manage all
 294 // the templates and documents.
 295 class WXDLLEXPORT wxDocManager: public wxEvtHandler
 296 {
 297     DECLARE_DYNAMIC_CLASS(wxDocManager)
 298
 299 public:
 300     wxDocManager(long flags = wxDEFAULT_DOCMAN_FLAGS, bool initialize = TRUE);
 301     ~wxDocManager();
 302
 303     virtual bool Initialize();
 304
 305     // Handlers for common user commands
 306     void OnFileClose(wxCommandEvent& event);
 307     void OnFileNew(wxCommandEvent& event);
 308     void OnFileOpen(wxCommandEvent& event);
 309     void OnFileRevert(wxCommandEvent& event);
 310     void OnFileSave(wxCommandEvent& event);
 311     void OnFileSaveAs(wxCommandEvent& event);
 312     void OnPrint(wxCommandEvent& event);
 313     void OnPrintSetup(wxCommandEvent& event);
 314     void OnPreview(wxCommandEvent& event);
 315     void OnUndo(wxCommandEvent& event);
 316     void OnRedo(wxCommandEvent& event);
 317
 318     // Handlers for UI update commands
 319     void OnUpdateFileOpen(wxUpdateUIEvent& event);
 320     void OnUpdateFileClose(wxUpdateUIEvent& event);
 321     void OnUpdateFileRevert(wxUpdateUIEvent& event);
 322     void OnUpdateFileNew(wxUpdateUIEvent& event);
 323     void OnUpdateFileSave(wxUpdateUIEvent& event);
 324     void OnUpdateFileSaveAs(wxUpdateUIEvent& event);
 325     void OnUpdateUndo(wxUpdateUIEvent& event);
 326     void OnUpdateRedo(wxUpdateUIEvent& event);
 327
 328     void OnUpdatePrint(wxUpdateUIEvent& event);
 329     void OnUpdatePrintSetup(wxUpdateUIEvent& event);
 330     void OnUpdatePreview(wxUpdateUIEvent& event);
 331
 332     // Extend event processing to search the view's event table
 333     virtual bool ProcessEvent(wxEvent& event);
 334
 335     // called when file format detection didn't work, can be overridden to do
 336     // something in this case
 337     // This is of course completely stupid, because if the file dialog is
 338     // cancelled you get an assert. Brilliant. -- JACS
 339 //    virtual void OnOpenFileFailure() { wxFAIL_MSG(_T("file format mismatch")); }
 340     virtual void OnOpenFileFailure() { }
 341
 342     virtual wxDocument *CreateDocument(const wxString& path, long flags = 0);
 343     virtual wxView *CreateView(wxDocument *doc, long flags = 0);
 344     virtual void DeleteTemplate(wxDocTemplate *temp, long flags = 0);
 345     virtual bool FlushDoc(wxDocument *doc);
 346     virtual wxDocTemplate *MatchTemplate(const wxString& path);
 347     virtual wxDocTemplate *SelectDocumentPath(wxDocTemplate **templates,
 348             int noTemplates, wxString& path, long flags, bool save = FALSE);
 349     virtual wxDocTemplate *SelectDocumentType(wxDocTemplate **templates,
 350             int noTemplates, bool sort = FALSE);
 351     virtual wxDocTemplate *SelectViewType(wxDocTemplate **templates,
 352             int noTemplates, bool sort = FALSE);
 353     virtual wxDocTemplate *FindTemplateForPath(const wxString& path);
 354
 355     void AssociateTemplate(wxDocTemplate *temp);
 356     void DisassociateTemplate(wxDocTemplate *temp);
 357
 358     wxDocument *GetCurrentDocument() const;
 359
 360     void SetMaxDocsOpen(int n) { m_maxDocsOpen = n; }
 361     int GetMaxDocsOpen() const { return m_maxDocsOpen; }
 362
 363     // Add and remove a document from the manager's list
 364     void AddDocument(wxDocument *doc);
 365     void RemoveDocument(wxDocument *doc);
 366
 367     // Clear remaining documents and templates
 368     bool Clear(bool force = TRUE);
 369
 370     // Views or windows should inform the document manager
 371     // when a view is going in or out of focus
 372     virtual void ActivateView(wxView *view, bool activate = TRUE, bool deleting = FALSE);
 373     virtual wxView *GetCurrentView() const;
 374
 375     wxList& GetDocuments() { return m_docs; }
 376     wxList& GetTemplates() { return m_templates; }
 377
 378     // Make a default document name
 379     virtual bool MakeDefaultName(wxString& buf);
 380
 381     // Make a frame title (override this to do something different)
 382     virtual wxString MakeFrameTitle(wxDocument* doc);
 383
 384     virtual wxFileHistory *OnCreateFileHistory();
 385     virtual wxFileHistory *GetFileHistory() const { return m_fileHistory; }
 386
 387     // File history management
 388     virtual void AddFileToHistory(const wxString& file);
 389     virtual void RemoveFileFromHistory(int i);
 390     virtual int GetNoHistoryFiles() const;
 391     virtual wxString GetHistoryFile(int i) const;
 392     virtual void FileHistoryUseMenu(wxMenu *menu);
 393     virtual void FileHistoryRemoveMenu(wxMenu *menu);
 394 #if wxUSE_CONFIG
 395     virtual void FileHistoryLoad(wxConfigBase& config);
 396     virtual void FileHistorySave(wxConfigBase& config);
 397 #endif // wxUSE_CONFIG
 398
 399     virtual void FileHistoryAddFilesToMenu();
 400     virtual void FileHistoryAddFilesToMenu(wxMenu* menu);
 401
 402     inline wxString GetLastDirectory() const { return m_lastDirectory; }
 403     inline void SetLastDirectory(const wxString& dir) { m_lastDirectory = dir; }
 404
 405     // Get the current document manager
 406     static wxDocManager* GetDocumentManager() { return sm_docManager; }
 407
 408 protected:
 409     long              m_flags;
 410     int               m_defaultDocumentNameCounter;
 411     int               m_maxDocsOpen;
 412     wxList            m_docs;
 413     wxList            m_templates;
 414     wxView*           m_currentView;
 415     wxFileHistory*    m_fileHistory;
 416     wxString          m_lastDirectory;
 417     static wxDocManager* sm_docManager;
 418
 419     DECLARE_EVENT_TABLE()
 420 };
 421
 422 // ----------------------------------------------------------------------------
 423 // A default child frame
 424 // ----------------------------------------------------------------------------
 425
 426 class WXDLLEXPORT wxDocChildFrame : public wxFrame
 427 {
 428     DECLARE_CLASS(wxDocChildFrame)
 429
 430 public:
 431     wxDocChildFrame(wxDocument *doc,
 432                     wxView *view,
 433                     wxFrame *frame,
 434                     wxWindowID id,
 435                     const wxString& title,
 436                     const wxPoint& pos = wxDefaultPosition,
 437                     const wxSize& size = wxDefaultSize,
 438                     long type = wxDEFAULT_FRAME_STYLE,
 439                     const wxString& name = "frame");
 440     ~wxDocChildFrame();
 441
 442     // Extend event processing to search the view's event table
 443     virtual bool ProcessEvent(wxEvent& event);
 444
 445     void OnActivate(wxActivateEvent& event);
 446     void OnCloseWindow(wxCloseEvent& event);
 447
 448     wxDocument *GetDocument() const { return m_childDocument; }
 449     wxView *GetView() const { return m_childView; }
 450     void SetDocument(wxDocument *doc) { m_childDocument = doc; }
 451     void SetView(wxView *view) { m_childView = view; }
 452     bool Destroy() { m_childView = (wxView *)NULL; return wxFrame::Destroy(); }
 453
 454 protected:
 455     wxDocument*       m_childDocument;
 456     wxView*           m_childView;
 457
 458     DECLARE_EVENT_TABLE()
 459 };
 460
 461 // ----------------------------------------------------------------------------
 462 // A default parent frame
 463 // ----------------------------------------------------------------------------
 464
 465 class WXDLLEXPORT wxDocParentFrame : public wxFrame
 466 {
 467     DECLARE_CLASS(wxDocParentFrame)
 468
 469 public:
 470     wxDocParentFrame(wxDocManager *manager,
 471                      wxFrame *frame,
 472                      wxWindowID id,
 473                      const wxString& title,
 474                      const wxPoint& pos = wxDefaultPosition,
 475                      const wxSize& size = wxDefaultSize,
 476                      long type = wxDEFAULT_FRAME_STYLE,
 477                      const wxString& name = "frame");
 478
 479     // Extend event processing to search the document manager's event table
 480     virtual bool ProcessEvent(wxEvent& event);
 481
 482     wxDocManager *GetDocumentManager() const { return m_docManager; }
 483
 484     void OnExit(wxCommandEvent& event);
 485     void OnMRUFile(wxCommandEvent& event);
 486     void OnCloseWindow(wxCloseEvent& event);
 487
 488 protected:
 489     wxDocManager *m_docManager;
 490
 491     DECLARE_EVENT_TABLE()
 492 };
 493
 494 // ----------------------------------------------------------------------------
 495 // Provide simple default printing facilities
 496 // ----------------------------------------------------------------------------
 497
 498 #if wxUSE_PRINTING_ARCHITECTURE
 499 class WXDLLEXPORT wxDocPrintout : public wxPrintout
 500 {
 501     DECLARE_DYNAMIC_CLASS(wxDocPrintout)
 502
 503 public:
 504     wxDocPrintout(wxView *view = (wxView *) NULL, const wxString& title = "Printout");
 505     bool OnPrintPage(int page);
 506     bool HasPage(int page);
 507     bool OnBeginDocument(int startPage, int endPage);
 508     void GetPageInfo(int *minPage, int *maxPage, int *selPageFrom, int *selPageTo);
 509
 510     virtual wxView *GetView() { return m_printoutView; }
 511
 512 protected:
 513     wxView*       m_printoutView;
 514 };
 515 #endif // wxUSE_PRINTING_ARCHITECTURE
 516
 517 // ----------------------------------------------------------------------------
 518 // File history management
 519 // ----------------------------------------------------------------------------
 520
 521 class WXDLLEXPORT wxFileHistory : public wxObject
 522 {
 523     DECLARE_DYNAMIC_CLASS(wxFileHistory)
 524
 525 public:
 526     wxFileHistory(int maxFiles = 9);
 527     ~wxFileHistory();
 528
 529     // Operations
 530     virtual void AddFileToHistory(const wxString& file);
 531     virtual void RemoveFileFromHistory(int i);
 532     virtual int GetMaxFiles() const { return m_fileMaxFiles; }
 533     virtual void UseMenu(wxMenu *menu);
 534
 535     // Remove menu from the list (MDI child may be closing)
 536     virtual void RemoveMenu(wxMenu *menu);
 537
 538 #if wxUSE_CONFIG
 539     virtual void Load(wxConfigBase& config);
 540     virtual void Save(wxConfigBase& config);
 541 #endif // wxUSE_CONFIG
 542
 543     virtual void AddFilesToMenu();
 544     virtual void AddFilesToMenu(wxMenu* menu); // Single menu
 545
 546     // Accessors
 547     virtual wxString GetHistoryFile(int i) const;
 548
 549     // A synonym for GetNoHistoryFiles
 550     virtual int GetCount() const { return m_fileHistoryN; }
 551     int GetNoHistoryFiles() const { return m_fileHistoryN; }
 552
 553     wxList& GetMenus() const { return (wxList&) m_fileMenus; }
 554
 555 protected:
 556     // Last n files
 557     wxChar**          m_fileHistory;
 558     // Number of files saved
 559     int               m_fileHistoryN;
 560     // Menus to maintain (may need several for an MDI app)
 561     wxList            m_fileMenus;
 562     // Max files to maintain
 563     int               m_fileMaxFiles;
 564 };
 565
 566 #if wxUSE_STD_IOSTREAM
 567 // For compatibility with existing file formats:
 568 // converts from/to a stream to/from a temporary file.
 569 bool WXDLLEXPORT wxTransferFileToStream(const wxString& filename, wxSTD ostream& stream);
 570 bool WXDLLEXPORT wxTransferStreamToFile(wxSTD istream& stream, const wxString& filename);
 571 #else
 572 // For compatibility with existing file formats:
 573 // converts from/to a stream to/from a temporary file.
 574 bool WXDLLEXPORT wxTransferFileToStream(const wxString& filename, wxOutputStream& stream);
 575 bool WXDLLEXPORT wxTransferStreamToFile(wxInputStream& stream, const wxString& filename);
 576 #endif
 577
 578 #endif // _WX_DOCH__