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/string.h"
  21 #include "wx/frame.h"
  22
  23 #if wxUSE_PRINTING_ARCHITECTURE
  24     #include "wx/print.h"
  25 #endif
  26
  27 class WXDLLIMPEXP_FWD_CORE wxWindow;
  28 class WXDLLIMPEXP_FWD_CORE wxDocument;
  29 class WXDLLIMPEXP_FWD_CORE wxView;
  30 class WXDLLIMPEXP_FWD_CORE wxDocTemplate;
  31 class WXDLLIMPEXP_FWD_CORE wxDocManager;
  32 class WXDLLIMPEXP_FWD_CORE wxPrintInfo;
  33 class WXDLLIMPEXP_FWD_CORE wxCommandProcessor;
  34 class WXDLLIMPEXP_FWD_CORE wxFileHistory;
  35 class WXDLLIMPEXP_FWD_BASE wxConfigBase;
  36
  37 #if wxUSE_STD_IOSTREAM
  38   #include "wx/iosfwrap.h"
  39 #else
  40   #include "wx/stream.h"
  41 #endif
  42
  43 // Flags for wxDocManager (can be combined).
  44 enum
  45 {
  46     wxDOC_NEW    = 1,
  47     wxDOC_SILENT = 2
  48 };
  49
  50 // Document template flags
  51 enum
  52 {
  53     wxTEMPLATE_VISIBLE = 1,
  54     wxTEMPLATE_INVISIBLE,
  55     wxDEFAULT_TEMPLATE_FLAGS = wxTEMPLATE_VISIBLE
  56 };
  57
  58 #define wxMAX_FILE_HISTORY 9
  59
  60 class WXDLLIMPEXP_CORE wxDocument : public wxEvtHandler
  61 {
  62 public:
  63     wxDocument(wxDocument *parent = NULL);
  64     virtual ~wxDocument();
  65
  66     // accessors
  67     void SetFilename(const wxString& filename, bool notifyViews = false);
  68     wxString GetFilename() const { return m_documentFile; }
  69
  70     void SetTitle(const wxString& title) { m_documentTitle = title; }
  71     wxString GetTitle() const { return m_documentTitle; }
  72
  73     void SetDocumentName(const wxString& name) { m_documentTypeName = name; }
  74     wxString GetDocumentName() const { return m_documentTypeName; }
  75
  76     bool GetDocumentSaved() const { return m_savedYet; }
  77     void SetDocumentSaved(bool saved = true) { m_savedYet = saved; }
  78
  79     virtual bool Close();
  80     virtual bool Save();
  81     virtual bool SaveAs();
  82     virtual bool Revert();
  83
  84 #if wxUSE_STD_IOSTREAM
  85     virtual wxSTD ostream& SaveObject(wxSTD ostream& stream);
  86     virtual wxSTD istream& LoadObject(wxSTD istream& stream);
  87 #else
  88     virtual wxOutputStream& SaveObject(wxOutputStream& stream);
  89     virtual wxInputStream& LoadObject(wxInputStream& stream);
  90 #endif
  91
  92     // Called by wxWidgets
  93     virtual bool OnSaveDocument(const wxString& filename);
  94     virtual bool OnOpenDocument(const wxString& filename);
  95     virtual bool OnNewDocument();
  96     virtual bool OnCloseDocument();
  97
  98     // Prompts for saving if about to close a modified document. Returns true
  99     // if ok to close the document (may have saved in the meantime, or set
 100     // modified to false)
 101     virtual bool OnSaveModified();
 102
 103     // Called by framework if created automatically by the default document
 104     // manager: gives document a chance to initialise and (usually) create a
 105     // view
 106     virtual bool OnCreate(const wxString& path, long flags);
 107
 108     // By default, creates a base wxCommandProcessor.
 109     virtual wxCommandProcessor *OnCreateCommandProcessor();
 110     virtual wxCommandProcessor *GetCommandProcessor() const { return m_commandProcessor; }
 111     virtual void SetCommandProcessor(wxCommandProcessor *proc) { m_commandProcessor = proc; }
 112
 113     // Called after a view is added or removed. The default implementation
 114     // deletes the document if this is there are no more views.
 115     virtual void OnChangedViewList();
 116
 117     virtual bool DeleteContents();
 118
 119     virtual bool Draw(wxDC&);
 120     virtual bool IsModified() const { return m_documentModified; }
 121     virtual void Modify(bool mod) { m_documentModified = mod; }
 122
 123     virtual bool AddView(wxView *view);
 124     virtual bool RemoveView(wxView *view);
 125     wxList& GetViews() { return m_documentViews; }
 126     const wxList& GetViews() const { return m_documentViews; }
 127     wxView *GetFirstView() const;
 128
 129     virtual void UpdateAllViews(wxView *sender = NULL, wxObject *hint = NULL);
 130     virtual void NotifyClosing();
 131
 132     // Remove all views (because we're closing the document)
 133     virtual bool DeleteAllViews();
 134
 135     // Other stuff
 136     virtual wxDocManager *GetDocumentManager() const;
 137     virtual wxDocTemplate *GetDocumentTemplate() const { return m_documentTemplate; }
 138     virtual void SetDocumentTemplate(wxDocTemplate *temp) { m_documentTemplate = temp; }
 139
 140     // Get the document name to be shown to the user: the title if there is
 141     // any, otherwise the filename if the document was saved and, finally,
 142     // "unnamed" otherwise
 143     virtual wxString GetUserReadableName() const;
 144
 145 #if WXWIN_COMPATIBILITY_2_8
 146     // use GetUserReadableName() instead
 147     wxDEPRECATED_BUT_USED_INTERNALLY(
 148         virtual bool GetPrintableName(wxString& buf) const
 149     );
 150 #endif // WXWIN_COMPATIBILITY_2_8
 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     // Called by OnSaveDocument and OnOpenDocument to implement standard
 168     // Save/Load behavior. Re-implement in derived class for custom
 169     // behavior.
 170     virtual bool DoSaveDocument(const wxString& file);
 171     virtual bool DoOpenDocument(const wxString& file);
 172
 173     // the default implementation of GetUserReadableName()
 174     wxString DoGetUserReadableName() const;
 175
 176 private:
 177     DECLARE_ABSTRACT_CLASS(wxDocument)
 178     DECLARE_NO_COPY_CLASS(wxDocument)
 179 };
 180
 181 class WXDLLIMPEXP_CORE wxView: public wxEvtHandler
 182 {
 183 public:
 184     wxView();
 185     virtual ~wxView();
 186
 187     wxDocument *GetDocument() const { return m_viewDocument; }
 188     virtual void SetDocument(wxDocument *doc);
 189
 190     wxString GetViewName() const { return m_viewTypeName; }
 191     void SetViewName(const wxString& name) { m_viewTypeName = name; }
 192
 193     wxWindow *GetFrame() const { return m_viewFrame ; }
 194     void SetFrame(wxWindow *frame) { m_viewFrame = frame; }
 195
 196     virtual void OnActivateView(bool activate, wxView *activeView, wxView *deactiveView);
 197     virtual void OnDraw(wxDC *dc) = 0;
 198     virtual void OnPrint(wxDC *dc, wxObject *info);
 199     virtual void OnUpdate(wxView *sender, wxObject *hint = NULL);
 200     virtual void OnClosingDocument() {}
 201     virtual void OnChangeFilename();
 202
 203     // Called by framework if created automatically by the default document
 204     // manager class: gives view a chance to initialise
 205     virtual bool OnCreate(wxDocument *WXUNUSED(doc), long WXUNUSED(flags))
 206         { return true; }
 207
 208     // Checks if the view is the last one for the document; if so, asks user
 209     // to confirm save data (if modified). If ok, deletes itself and returns
 210     // true.
 211     virtual bool Close(bool deleteWindow = true);
 212
 213     // Override to do cleanup/veto close
 214     virtual bool OnClose(bool deleteWindow);
 215
 216     // A view's window can call this to notify the view it is (in)active.
 217     // The function then notifies the document manager.
 218     virtual void Activate(bool activate);
 219
 220     wxDocManager *GetDocumentManager() const
 221         { return m_viewDocument->GetDocumentManager(); }
 222
 223 #if wxUSE_PRINTING_ARCHITECTURE
 224     virtual wxPrintout *OnCreatePrintout();
 225 #endif
 226
 227 protected:
 228     // hook the document into event handlers chain here
 229     virtual bool TryValidator(wxEvent& event);
 230
 231     wxDocument*       m_viewDocument;
 232     wxString          m_viewTypeName;
 233     wxWindow*         m_viewFrame;
 234
 235 private:
 236     DECLARE_ABSTRACT_CLASS(wxView)
 237     DECLARE_NO_COPY_CLASS(wxView)
 238 };
 239
 240 // Represents user interface (and other) properties of documents and views
 241 class WXDLLIMPEXP_CORE wxDocTemplate: public wxObject
 242 {
 243
 244 friend class WXDLLIMPEXP_FWD_CORE wxDocManager;
 245
 246 public:
 247     // Associate document and view types. They're for identifying what view is
 248     // associated with what template/document type
 249     wxDocTemplate(wxDocManager *manager,
 250                   const wxString& descr,
 251                   const wxString& filter,
 252                   const wxString& dir,
 253                   const wxString& ext,
 254                   const wxString& docTypeName,
 255                   const wxString& viewTypeName,
 256                   wxClassInfo *docClassInfo = NULL,
 257                   wxClassInfo *viewClassInfo = NULL,
 258                   long flags = wxDEFAULT_TEMPLATE_FLAGS);
 259
 260     virtual ~wxDocTemplate();
 261
 262     // By default, these two member functions dynamically creates document and
 263     // view using dynamic instance construction. Override these if you need a
 264     // different method of construction.
 265     virtual wxDocument *CreateDocument(const wxString& path, long flags = 0);
 266     virtual wxView *CreateView(wxDocument *doc, long flags = 0);
 267
 268     // Helper method for CreateDocument; also allows you to do your own document
 269     // creation
 270     virtual bool InitDocument(wxDocument* doc, const wxString& path, long flags = 0);
 271
 272     wxString GetDefaultExtension() const { return m_defaultExt; }
 273     wxString GetDescription() const { return m_description; }
 274     wxString GetDirectory() const { return m_directory; }
 275     wxDocManager *GetDocumentManager() const { return m_documentManager; }
 276     void SetDocumentManager(wxDocManager *manager) { m_documentManager = manager; }
 277     wxString GetFileFilter() const { return m_fileFilter; }
 278     long GetFlags() const { return m_flags; }
 279     virtual wxString GetViewName() const { return m_viewTypeName; }
 280     virtual wxString GetDocumentName() const { return m_docTypeName; }
 281
 282     void SetFileFilter(const wxString& filter) { m_fileFilter = filter; }
 283     void SetDirectory(const wxString& dir) { m_directory = dir; }
 284     void SetDescription(const wxString& descr) { m_description = descr; }
 285     void SetDefaultExtension(const wxString& ext) { m_defaultExt = ext; }
 286     void SetFlags(long flags) { m_flags = flags; }
 287
 288     bool IsVisible() const { return ((m_flags & wxTEMPLATE_VISIBLE) == wxTEMPLATE_VISIBLE); }
 289
 290     wxClassInfo* GetDocClassInfo() const { return m_docClassInfo; }
 291     wxClassInfo* GetViewClassInfo() const { return m_viewClassInfo; }
 292
 293     virtual bool FileMatchesTemplate(const wxString& path);
 294
 295 protected:
 296     long              m_flags;
 297     wxString          m_fileFilter;
 298     wxString          m_directory;
 299     wxString          m_description;
 300     wxString          m_defaultExt;
 301     wxString          m_docTypeName;
 302     wxString          m_viewTypeName;
 303     wxDocManager*     m_documentManager;
 304
 305     // For dynamic creation of appropriate instances.
 306     wxClassInfo*      m_docClassInfo;
 307     wxClassInfo*      m_viewClassInfo;
 308
 309     // Called by CreateDocument and CreateView to create the actual document/view object.
 310     // By default uses the ClassInfo provided to the constructor. Override these functions
 311     // to provide a different method of creation.
 312     virtual wxDocument *DoCreateDocument();
 313     virtual wxView *DoCreateView();
 314
 315 private:
 316     DECLARE_CLASS(wxDocTemplate)
 317     DECLARE_NO_COPY_CLASS(wxDocTemplate)
 318 };
 319
 320 // One object of this class may be created in an application, to manage all
 321 // the templates and documents.
 322 class WXDLLIMPEXP_CORE wxDocManager: public wxEvtHandler
 323 {
 324 public:
 325     // NB: flags are unused, don't pass wxDOC_XXX to this ctor
 326     wxDocManager(long flags = 0, bool initialize = true);
 327     virtual ~wxDocManager();
 328
 329     virtual bool Initialize();
 330
 331     // Handlers for common user commands
 332     void OnFileClose(wxCommandEvent& event);
 333     void OnFileCloseAll(wxCommandEvent& event);
 334     void OnFileNew(wxCommandEvent& event);
 335     void OnFileOpen(wxCommandEvent& event);
 336     void OnFileRevert(wxCommandEvent& event);
 337     void OnFileSave(wxCommandEvent& event);
 338     void OnFileSaveAs(wxCommandEvent& event);
 339     void OnPrint(wxCommandEvent& event);
 340     void OnPreview(wxCommandEvent& event);
 341     void OnUndo(wxCommandEvent& event);
 342     void OnRedo(wxCommandEvent& event);
 343
 344     // Handlers for UI update commands
 345     void OnUpdateFileOpen(wxUpdateUIEvent& event);
 346     void OnUpdateDisableIfNoDoc(wxUpdateUIEvent& event);
 347     void OnUpdateFileNew(wxUpdateUIEvent& event);
 348     void OnUpdateFileSave(wxUpdateUIEvent& event);
 349     void OnUpdateUndo(wxUpdateUIEvent& event);
 350     void OnUpdateRedo(wxUpdateUIEvent& event);
 351
 352     // called when file format detection didn't work, can be overridden to do
 353     // something in this case
 354     virtual void OnOpenFileFailure() { }
 355
 356     virtual wxDocument *CreateDocument(const wxString& path, long flags = 0);
 357
 358     // wrapper around CreateDocument() with a more clear name
 359     wxDocument *CreateNewDocument()
 360         { return CreateDocument(wxString(), wxDOC_NEW); }
 361
 362     virtual wxView *CreateView(wxDocument *doc, long flags = 0);
 363     virtual void DeleteTemplate(wxDocTemplate *temp, long flags = 0);
 364     virtual bool FlushDoc(wxDocument *doc);
 365     virtual wxDocTemplate *MatchTemplate(const wxString& path);
 366     virtual wxDocTemplate *SelectDocumentPath(wxDocTemplate **templates,
 367             int noTemplates, wxString& path, long flags, bool save = false);
 368     virtual wxDocTemplate *SelectDocumentType(wxDocTemplate **templates,
 369             int noTemplates, bool sort = false);
 370     virtual wxDocTemplate *SelectViewType(wxDocTemplate **templates,
 371             int noTemplates, bool sort = false);
 372     virtual wxDocTemplate *FindTemplateForPath(const wxString& path);
 373
 374     void AssociateTemplate(wxDocTemplate *temp);
 375     void DisassociateTemplate(wxDocTemplate *temp);
 376
 377     wxDocument *GetCurrentDocument() const;
 378
 379     void SetMaxDocsOpen(int n) { m_maxDocsOpen = n; }
 380     int GetMaxDocsOpen() const { return m_maxDocsOpen; }
 381
 382     // Add and remove a document from the manager's list
 383     void AddDocument(wxDocument *doc);
 384     void RemoveDocument(wxDocument *doc);
 385
 386     // closes all currently open documents
 387     bool CloseDocuments(bool force = true);
 388
 389     // closes the specified document
 390     bool CloseDocument(wxDocument* doc, bool force = false);
 391
 392     // Clear remaining documents and templates
 393     bool Clear(bool force = true);
 394
 395     // Views or windows should inform the document manager
 396     // when a view is going in or out of focus
 397     virtual void ActivateView(wxView *view, bool activate = true);
 398     virtual wxView *GetCurrentView() const;
 399
 400     wxList& GetDocuments() { return m_docs; }
 401     wxList& GetTemplates() { return m_templates; }
 402
 403     // Return the default name for a new document (by default returns strings
 404     // in the form "unnamed <counter>" but can be overridden)
 405     virtual wxString MakeNewDocumentName();
 406
 407     // Make a frame title (override this to do something different)
 408     virtual wxString MakeFrameTitle(wxDocument* doc);
 409
 410     virtual wxFileHistory *OnCreateFileHistory();
 411     virtual wxFileHistory *GetFileHistory() const { return m_fileHistory; }
 412
 413     // File history management
 414     virtual void AddFileToHistory(const wxString& file);
 415     virtual void RemoveFileFromHistory(size_t i);
 416     virtual size_t GetHistoryFilesCount() const;
 417     virtual wxString GetHistoryFile(size_t i) const;
 418     virtual void FileHistoryUseMenu(wxMenu *menu);
 419     virtual void FileHistoryRemoveMenu(wxMenu *menu);
 420 #if wxUSE_CONFIG
 421     virtual void FileHistoryLoad(const wxConfigBase& config);
 422     virtual void FileHistorySave(wxConfigBase& config);
 423 #endif // wxUSE_CONFIG
 424
 425     virtual void FileHistoryAddFilesToMenu();
 426     virtual void FileHistoryAddFilesToMenu(wxMenu* menu);
 427
 428     wxString GetLastDirectory() const { return m_lastDirectory; }
 429     void SetLastDirectory(const wxString& dir) { m_lastDirectory = dir; }
 430
 431     // Get the current document manager
 432     static wxDocManager* GetDocumentManager() { return sm_docManager; }
 433
 434 #if WXWIN_COMPATIBILITY_2_8
 435     // deprecated, override GetDefaultName() instead
 436     wxDEPRECATED_BUT_USED_INTERNALLY(
 437         virtual bool MakeDefaultName(wxString& buf)
 438     );
 439 #endif
 440
 441 #if WXWIN_COMPATIBILITY_2_6
 442     // deprecated, use GetHistoryFilesCount() instead
 443     wxDEPRECATED( size_t GetNoHistoryFiles() const );
 444 #endif // WXWIN_COMPATIBILITY_2_6
 445
 446 protected:
 447     // hook the currently active view into event handlers chain here
 448     virtual bool TryValidator(wxEvent& event);
 449
 450     int               m_defaultDocumentNameCounter;
 451     int               m_maxDocsOpen;
 452     wxList            m_docs;
 453     wxList            m_templates;
 454     wxView*           m_currentView;
 455     wxFileHistory*    m_fileHistory;
 456     wxString          m_lastDirectory;
 457     static wxDocManager* sm_docManager;
 458
 459     DECLARE_EVENT_TABLE()
 460     DECLARE_DYNAMIC_CLASS(wxDocManager)
 461     DECLARE_NO_COPY_CLASS(wxDocManager)
 462 };
 463
 464 #if WXWIN_COMPATIBILITY_2_6
 465 inline size_t wxDocManager::GetNoHistoryFiles() const
 466 {
 467     return GetHistoryFilesCount();
 468 }
 469 #endif // WXWIN_COMPATIBILITY_2_6
 470
 471 // ----------------------------------------------------------------------------
 472 // A default child frame
 473 // ----------------------------------------------------------------------------
 474
 475 class WXDLLIMPEXP_CORE wxDocChildFrame : public wxFrame
 476 {
 477 public:
 478     wxDocChildFrame(wxDocument *doc,
 479                     wxView *view,
 480                     wxFrame *frame,
 481                     wxWindowID id,
 482                     const wxString& title,
 483                     const wxPoint& pos = wxDefaultPosition,
 484                     const wxSize& size = wxDefaultSize,
 485                     long type = wxDEFAULT_FRAME_STYLE,
 486                     const wxString& name = wxT("frame"));
 487     virtual ~wxDocChildFrame(){}
 488
 489     void OnActivate(wxActivateEvent& event);
 490     void OnCloseWindow(wxCloseEvent& event);
 491
 492     wxDocument *GetDocument() const { return m_childDocument; }
 493     wxView *GetView() const { return m_childView; }
 494     void SetDocument(wxDocument *doc) { m_childDocument = doc; }
 495     void SetView(wxView *view) { m_childView = view; }
 496     bool Destroy() { m_childView = NULL; return wxFrame::Destroy(); }
 497
 498 protected:
 499     // hook the child view into event handlers chain here
 500     virtual bool TryValidator(wxEvent& event);
 501
 502     wxDocument*       m_childDocument;
 503     wxView*           m_childView;
 504
 505 private:
 506     DECLARE_CLASS(wxDocChildFrame)
 507     DECLARE_EVENT_TABLE()
 508     DECLARE_NO_COPY_CLASS(wxDocChildFrame)
 509 };
 510
 511 // ----------------------------------------------------------------------------
 512 // A default parent frame
 513 // ----------------------------------------------------------------------------
 514
 515 class WXDLLIMPEXP_CORE wxDocParentFrame : public wxFrame
 516 {
 517 public:
 518     wxDocParentFrame();
 519     wxDocParentFrame(wxDocManager *manager,
 520                      wxFrame *frame,
 521                      wxWindowID id,
 522                      const wxString& title,
 523                      const wxPoint& pos = wxDefaultPosition,
 524                      const wxSize& size = wxDefaultSize,
 525                      long style = wxDEFAULT_FRAME_STYLE,
 526                      const wxString& name = wxFrameNameStr);
 527
 528     bool Create(wxDocManager *manager,
 529                 wxFrame *frame,
 530                 wxWindowID id,
 531                 const wxString& title,
 532                 const wxPoint& pos = wxDefaultPosition,
 533                 const wxSize& size = wxDefaultSize,
 534                 long style = wxDEFAULT_FRAME_STYLE,
 535                 const wxString& name = wxFrameNameStr);
 536
 537     wxDocManager *GetDocumentManager() const { return m_docManager; }
 538
 539     void OnExit(wxCommandEvent& event);
 540     void OnMRUFile(wxCommandEvent& event);
 541     void OnCloseWindow(wxCloseEvent& event);
 542
 543 protected:
 544     // hook the document manager into event handling chain here
 545     virtual bool TryValidator(wxEvent& event);
 546
 547     wxDocManager *m_docManager;
 548
 549 private:
 550     typedef wxFrame base_type;
 551     DECLARE_CLASS(wxDocParentFrame)
 552     DECLARE_EVENT_TABLE()
 553     DECLARE_NO_COPY_CLASS(wxDocParentFrame)
 554 };
 555
 556 // ----------------------------------------------------------------------------
 557 // Provide simple default printing facilities
 558 // ----------------------------------------------------------------------------
 559
 560 #if wxUSE_PRINTING_ARCHITECTURE
 561 class WXDLLIMPEXP_CORE wxDocPrintout : public wxPrintout
 562 {
 563 public:
 564     wxDocPrintout(wxView *view = NULL, const wxString& title = wxT("Printout"));
 565     bool OnPrintPage(int page);
 566     bool HasPage(int page);
 567     bool OnBeginDocument(int startPage, int endPage);
 568     void GetPageInfo(int *minPage, int *maxPage, int *selPageFrom, int *selPageTo);
 569
 570     virtual wxView *GetView() { return m_printoutView; }
 571
 572 protected:
 573     wxView*       m_printoutView;
 574
 575 private:
 576     DECLARE_DYNAMIC_CLASS(wxDocPrintout)
 577     DECLARE_NO_COPY_CLASS(wxDocPrintout)
 578 };
 579 #endif // wxUSE_PRINTING_ARCHITECTURE
 580
 581 // ----------------------------------------------------------------------------
 582 // File history management
 583 // ----------------------------------------------------------------------------
 584
 585 class WXDLLIMPEXP_CORE wxFileHistory : public wxObject
 586 {
 587 public:
 588     wxFileHistory(size_t maxFiles = 9, wxWindowID idBase = wxID_FILE1);
 589
 590     // Operations
 591     virtual void AddFileToHistory(const wxString& file);
 592     virtual void RemoveFileFromHistory(size_t i);
 593     virtual int GetMaxFiles() const { return (int)m_fileMaxFiles; }
 594     virtual void UseMenu(wxMenu *menu);
 595
 596     // Remove menu from the list (MDI child may be closing)
 597     virtual void RemoveMenu(wxMenu *menu);
 598
 599 #if wxUSE_CONFIG
 600     virtual void Load(const wxConfigBase& config);
 601     virtual void Save(wxConfigBase& config);
 602 #endif // wxUSE_CONFIG
 603
 604     virtual void AddFilesToMenu();
 605     virtual void AddFilesToMenu(wxMenu* menu); // Single menu
 606
 607     // Accessors
 608     virtual wxString GetHistoryFile(size_t i) const { return m_fileHistory[i]; }
 609     virtual size_t GetCount() const { return m_fileHistory.GetCount(); }
 610
 611     const wxList& GetMenus() const { return m_fileMenus; }
 612
 613     // Set/get base id
 614     void SetBaseId(wxWindowID baseId) { m_idBase = baseId; }
 615     wxWindowID GetBaseId() const { return m_idBase; }
 616
 617 #if WXWIN_COMPATIBILITY_2_6
 618     // deprecated, use GetCount() instead
 619     wxDEPRECATED( size_t GetNoHistoryFiles() const );
 620 #endif // WXWIN_COMPATIBILITY_2_6
 621
 622 protected:
 623     // Last n files
 624     wxArrayString     m_fileHistory;
 625
 626     // Menus to maintain (may need several for an MDI app)
 627     wxList            m_fileMenus;
 628
 629     // Max files to maintain
 630     size_t            m_fileMaxFiles;
 631
 632 private:
 633     // The ID of the first history menu item (Doesn't have to be wxID_FILE1)
 634     wxWindowID m_idBase;
 635
 636     DECLARE_DYNAMIC_CLASS(wxFileHistory)
 637     DECLARE_NO_COPY_CLASS(wxFileHistory)
 638 };
 639
 640 #if WXWIN_COMPATIBILITY_2_6
 641 inline size_t wxFileHistory::GetNoHistoryFiles() const
 642 {
 643     return m_fileHistory.GetCount();
 644 }
 645 #endif // WXWIN_COMPATIBILITY_2_6
 646
 647 #if wxUSE_STD_IOSTREAM
 648 // For compatibility with existing file formats:
 649 // converts from/to a stream to/from a temporary file.
 650 bool WXDLLIMPEXP_CORE wxTransferFileToStream(const wxString& filename, wxSTD ostream& stream);
 651 bool WXDLLIMPEXP_CORE wxTransferStreamToFile(wxSTD istream& stream, const wxString& filename);
 652 #else
 653 // For compatibility with existing file formats:
 654 // converts from/to a stream to/from a temporary file.
 655 bool WXDLLIMPEXP_CORE wxTransferFileToStream(const wxString& filename, wxOutputStream& stream);
 656 bool WXDLLIMPEXP_CORE wxTransferStreamToFile(wxInputStream& stream, const wxString& filename);
 657 #endif // wxUSE_STD_IOSTREAM
 658
 659
 660 // these flags are not used anywhere by wxWidgets and kept only for an unlikely
 661 // case of existing user code using them for its own purposes
 662 #ifdef WXWIN_COMPATIBILITY_2_8
 663 enum
 664 {
 665     wxDOC_SDI = 1,
 666     wxDOC_MDI,
 667     wxDEFAULT_DOCMAN_FLAGS = wxDOC_SDI
 668 };
 669 #endif // WXWIN_COMPATIBILITY_2_8
 670
 671 #endif // wxUSE_DOC_VIEW_ARCHITECTURE
 672
 673 #endif // _WX_DOCH__