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