interface/wx/docview.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        docview.h
   3 // Purpose:     interface of various doc/view framework classes
   4 // Author:      wxWidgets team
   5 // RCS-ID:      $Id$
   6 // Licence:     wxWindows licence
   7 /////////////////////////////////////////////////////////////////////////////
   8
   9 /**
  10     @class wxDocTemplate
  11
  12     The wxDocTemplate class is used to model the relationship between a
  13     document class and a view class.
  14
  15     @library{wxcore}
  16     @category{docview}
  17
  18     @see @ref overview_docview_wxdoctemplate, wxDocument, wxView
  19 */
  20 class wxDocTemplate : public wxObject
  21 {
  22 public:
  23     /**
  24         Constructor. Create instances dynamically near the start of your
  25         application after creating a wxDocManager instance, and before doing
  26         any document or view operations.
  27
  28         @param manager
  29             The document manager object which manages this template.
  30         @param descr
  31             A short description of what the template is for. This string will
  32             be displayed in the file filter list of Windows file selectors.
  33         @param filter
  34             An appropriate file filter such as "*.txt".
  35         @param dir
  36             The default directory to use for file selectors.
  37         @param ext
  38             The default file extension (such as "txt").
  39         @param docTypeName
  40             A name that should be unique for a given type of document, used for
  41             gathering a list of views relevant to a particular document.
  42         @param viewTypeName
  43             A name that should be unique for a given view.
  44         @param docClassInfo
  45             A pointer to the run-time document class information as returned by
  46             the wxCLASSINFO() macro, e.g. wxCLASSINFO(MyDocumentClass). If this is
  47             not supplied, you will need to derive a new wxDocTemplate class and
  48             override the CreateDocument() member to return a new document
  49             instance on demand.
  50         @param viewClassInfo
  51             A pointer to the run-time view class information as returned by the
  52             wxCLASSINFO() macro, e.g. wxCLASSINFO(MyViewClass). If this is not
  53             supplied, you will need to derive a new wxDocTemplate class and
  54             override the CreateView() member to return a new view instance on
  55             demand.
  56         @param flags
  57             A bit list of the following:
  58             - wxTEMPLATE_VISIBLE       - The template may be displayed to the
  59                                          user in dialogs.
  60             - wxTEMPLATE_INVISIBLE     - The template may not be displayed to
  61                                          the user in dialogs.
  62             - wxDEFAULT_TEMPLATE_FLAGS - Defined as wxTEMPLATE_VISIBLE.
  63
  64         @beginWxPerlOnly
  65
  66         In wxPerl @a docClassInfo and @a viewClassInfo can be either
  67         @c Wx::ClassInfo objects or strings containing the name of the
  68         perl packages which are to be used as @c Wx::Document and
  69         @c Wx::View classes (they must have a constructor named new);
  70         as an example:
  71
  72         - Wx::DocTemplate->new(docmgr, descr, filter, dir, ext,
  73           docTypeName, viewTypeName, docClassInfo, viewClassInfo,
  74           flags): will construct document and view objects from the
  75           class information.
  76         - Wx::DocTemplate->new(docmgr, descr, filter, dir, ext,
  77           docTypeName, viewTypeName, docClassName, viewClassName,
  78           flags): will construct document and view objects from perl
  79           packages.
  80         - Wx::DocTemplate->new(docmgr, descr, filter, dir, ext,
  81           docTypeName, viewTypeName):
  82           in this case @c Wx::DocTemplate::CreateDocument() and
  83           @c Wx::DocTemplate::CreateView() must be overridden
  84         @endWxPerlOnly
  85     */
  86     wxDocTemplate(wxDocManager* manager, const wxString& descr,
  87                   const wxString& filter, const wxString& dir,
  88                   const wxString& ext, const wxString& docTypeName,
  89                   const wxString& viewTypeName, wxClassInfo* docClassInfo = 0,
  90                   wxClassInfo* viewClassInfo = 0,
  91                   long flags = wxTEMPLATE_VISIBLE);
  92
  93     /**
  94         Destructor.
  95     */
  96     virtual ~wxDocTemplate();
  97
  98     /**
  99         Creates a new instance of the associated document class. If you have
 100         not supplied a wxClassInfo parameter to the template constructor, you
 101         will need to override this function to return an appropriate document
 102         instance.
 103
 104         This function calls InitDocument() which in turns calls
 105         wxDocument::OnCreate().
 106     */
 107     virtual wxDocument* CreateDocument(const wxString& path, long flags = 0);
 108
 109     /**
 110         Creates a new instance of the associated view class.
 111
 112         If you have not supplied a wxClassInfo parameter to the template
 113         constructor, you will need to override this function to return an
 114         appropriate view instance.
 115
 116         If the new view initialization fails, it must call
 117         wxDocument::RemoveView() for consistency with the default behaviour of
 118         this function.
 119     */
 120     virtual wxView* CreateView(wxDocument* doc, long flags = 0);
 121
 122     /**
 123         This function implements the default (very primitive) format detection
 124         which checks if the extension is that of the template.
 125
 126         @param path
 127             The path to be checked against the template.
 128     */
 129     virtual bool FileMatchesTemplate(const wxString& path);
 130
 131     /**
 132         Returns the default file extension for the document data, as passed to
 133         the document template constructor.
 134     */
 135     wxString GetDefaultExtension() const;
 136
 137     /**
 138         Returns the text description of this template, as passed to the
 139         document template constructor.
 140     */
 141     wxString GetDescription() const;
 142
 143     /**
 144         Returns the default directory, as passed to the document template
 145         constructor.
 146     */
 147     wxString GetDirectory() const;
 148
 149     /**
 150         Returns the run-time class information that allows document
 151         instances to be constructed dynamically, as passed to the document
 152         template constructor.
 153     */
 154     wxClassInfo* GetDocClassInfo() const;
 155
 156     /**
 157         Returns a pointer to the document manager instance for which this
 158         template was created.
 159     */
 160     wxDocManager* GetDocumentManager() const;
 161
 162     /**
 163         Returns the document type name, as passed to the document template
 164         constructor.
 165     */
 166     virtual wxString GetDocumentName() const;
 167
 168     /**
 169         Returns the file filter, as passed to the document template
 170         constructor.
 171     */
 172     wxString GetFileFilter() const;
 173
 174     /**
 175         Returns the flags, as passed to the document template constructor.
 176     */
 177     long GetFlags() const;
 178
 179     /**
 180         Returns a reference to the wxPageSetupDialogData associated with the
 181         printing operations of this document manager.
 182     */
 183     //@{
 184     wxPageSetupDialogData& GetPageSetupDialogData();
 185     const wxPageSetupDialogData& GetPageSetupDialogData() const;
 186     //@}
 187
 188     /**
 189         Returns the run-time class information that allows view instances
 190         to be constructed dynamically, as passed to the document template
 191         constructor.
 192     */
 193     wxClassInfo* GetViewClassInfo() const;
 194
 195     /**
 196         Returns the view type name, as passed to the document template
 197         constructor.
 198     */
 199     virtual wxString GetViewName() const;
 200
 201     /**
 202         Initialises the document, calling wxDocument::OnCreate().
 203
 204         This is called from CreateDocument().
 205
 206         If you override this method, notice that you must @em delete the @a doc
 207         if its initialization fails for consistency with the default behaviour.
 208
 209         @param doc
 210             The document to initialize.
 211         @param path
 212             The associated file path.
 213         @param flags
 214             Flags passed to CreateDocument().
 215         @return
 216             @true if the initialization was successful or @false if it failed
 217             in which case @a doc should be deleted by this function.
 218     */
 219     virtual bool InitDocument(wxDocument* doc,
 220                               const wxString& path,
 221                               long flags = 0);
 222
 223     /**
 224         Returns @true if the document template can be shown in user dialogs,
 225         @false otherwise.
 226     */
 227     bool IsVisible() const;
 228
 229     /**
 230         Sets the default file extension.
 231     */
 232     void SetDefaultExtension(const wxString& ext);
 233
 234     /**
 235         Sets the template description.
 236     */
 237     void SetDescription(const wxString& descr);
 238
 239     /**
 240         Sets the default directory.
 241     */
 242     void SetDirectory(const wxString& dir);
 243
 244     /**
 245         Sets the pointer to the document manager instance for which this
 246         template was created. Should not be called by the application.
 247     */
 248     void SetDocumentManager(wxDocManager* manager);
 249
 250     /**
 251         Sets the file filter.
 252     */
 253     void SetFileFilter(const wxString& filter);
 254
 255     /**
 256         Sets the internal document template flags (see the constructor
 257         description for more details).
 258     */
 259     void SetFlags(long flags);
 260
 261     /**
 262         The default extension for files of this type.
 263     */
 264     wxString m_defaultExt;
 265
 266     /**
 267         A short description of this template.
 268     */
 269     wxString m_description;
 270
 271     /**
 272         The default directory for files of this type.
 273     */
 274     wxString m_directory;
 275
 276     /**
 277         Run-time class information that allows document instances to be
 278         constructed dynamically.
 279     */
 280     wxClassInfo* m_docClassInfo;
 281
 282     /**
 283         The named type of the document associated with this template.
 284     */
 285     wxString m_docTypeName;
 286
 287     /**
 288         A pointer to the document manager for which this template was created.
 289     */
 290     wxDocTemplate* m_documentManager;
 291
 292     /**
 293         The file filter (such as "*.txt") to be used in file selector dialogs.
 294     */
 295     wxString m_fileFilter;
 296
 297     /**
 298         The flags passed to the constructor.
 299     */
 300     long m_flags;
 301
 302     /**
 303         Run-time class information that allows view instances to be constructed
 304         dynamically.
 305     */
 306     wxClassInfo* m_viewClassInfo;
 307
 308     /**
 309         The named type of the view associated with this template.
 310     */
 311     wxString m_viewTypeName;
 312 };
 313
 314
 315
 316 /**
 317     @class wxDocManager
 318
 319     The wxDocManager class is part of the document/view framework supported by
 320     wxWidgets, and cooperates with the wxView, wxDocument and wxDocTemplate
 321     classes.
 322
 323     @library{wxcore}
 324     @category{docview}
 325
 326     @see @ref overview_docview_wxdocmanager, wxDocument, wxView, wxDocTemplate,
 327          wxFileHistory
 328 */
 329 class wxDocManager : public wxEvtHandler
 330 {
 331 public:
 332     /**
 333         Constructor. Create a document manager instance dynamically near the
 334         start of your application before doing any document or view operations.
 335
 336         If @a initialize is @true, the Initialize() function will be called to
 337         create a default history list object. If you derive from wxDocManager,
 338         you may wish to call the base constructor with @false, and then call
 339         Initialize() in your own constructor, to allow your own Initialize() or
 340         OnCreateFileHistory functions to be called.
 341
 342         @param flags
 343             Currently unused.
 344         @param initialize
 345             Indicates whether Initialize() should be called by this ctor.
 346     */
 347     wxDocManager(long flags = 0, bool initialize = true);
 348
 349     /**
 350         Destructor.
 351     */
 352     virtual ~wxDocManager();
 353
 354     /**
 355         Sets the current view.
 356     */
 357     virtual void ActivateView(wxView* doc, bool activate = true);
 358
 359     /**
 360         Adds the document to the list of documents.
 361     */
 362     void AddDocument(wxDocument* doc);
 363
 364     /**
 365         Adds a file to the file history list, if we have a pointer to an
 366         appropriate file menu.
 367     */
 368     virtual void AddFileToHistory(const wxString& filename);
 369
 370     /**
 371         Adds the template to the document manager's template list.
 372     */
 373     void AssociateTemplate(wxDocTemplate* temp);
 374
 375     /**
 376         Search for a particular document template.
 377
 378         Example:
 379         @code
 380            // creating a document instance of the specified document type:
 381            m_doc = (MyDoc*)docManager->FindTemplate(CLASSINFO(MyDoc))->
 382                         CreateDocument(wxEmptyString, wxDOC_SILENT);
 383         @endcode
 384
 385         @param classinfo
 386             Class info of a document class for which a wxDocTemplate had been
 387             previously created.
 388
 389         @return
 390             Pointer to a wxDocTemplate, or @NULL if none found.
 391
 392         @since 2.9.2
 393      */
 394     wxDocTemplate* FindTemplate(const wxClassInfo* classinfo);
 395
 396     /**
 397         Closes the specified document.
 398
 399         If @a force is @true, the document is closed even if it has unsaved
 400         changes.
 401
 402         @param doc
 403             The document to close, must be non-@NULL.
 404         @param force
 405             If @true, close the document even if wxDocument::Close() returns
 406             @false.
 407         @return
 408             @true if the document was closed or @false if closing it was
 409             cancelled by user (only in @a force = @false case).
 410      */
 411     bool CloseDocument(wxDocument *doc, bool force = false);
 412
 413     /**
 414         Closes all currently opened documents.
 415
 416         @see CloseDocument()
 417     */
 418     bool CloseDocuments(bool force = true);
 419
 420     /**
 421         Creates a new document.
 422
 423         This function can either create a document corresponding to a new
 424         file or to an already existing one depending on whether @c wxDOC_NEW is
 425         specified in the @a flags.
 426
 427         By default, this function asks the user for the type of document to
 428         open and the path to its file if it's not specified, i.e. if @a path is
 429         empty. Specifying @c wxDOC_SILENT flag suppresses any prompts and means
 430         that the @a path must be non-empty and there must be a registered
 431         document template handling the extension of this file, otherwise a
 432         warning message is logged and the function returns @NULL. Notice that
 433         @c wxDOC_SILENT can be combined with @c wxDOC_NEW, however in this case
 434         the @a path must still be specified, even if the file with this path
 435         typically won't exist.
 436
 437         Finally notice that if this document manager was configured to allow
 438         only a limited number of simultaneously opened documents using
 439         SetMaxDocsOpen(), this function will try to close the oldest existing
 440         document if this number was reached before creating a new document.
 441         And if closing the old document fails (e.g. because it was vetoed by
 442         user), this function fails as well.
 443
 444         @param path
 445             Path to a file or an empty string. If the path is empty, the user
 446             will be asked to select it (thus, this is incompatible with the use
 447             of @c wxDOC_SILENT). The file should exist unless @a flags includes
 448             @c wxDOC_NEW.
 449         @param flags
 450             By default, none. May include @c wxDOC_NEW to indicate that the new
 451             document corresponds to a new file and not an existing one and
 452             @c wxDOC_SILENT to suppress any dialogs asking the user about the
 453             file path and type.
 454         @return a new document object or @NULL on failure.
 455     */
 456     virtual wxDocument* CreateDocument(const wxString& path, long flags = 0);
 457
 458     /**
 459         Creates an empty new document.
 460
 461         This is equivalent to calling CreateDocument() with @c wxDOC_NEW flags
 462         and without the file name.
 463      */
 464     wxDocument *CreateNewDocument();
 465
 466     /**
 467         Creates a new view for the given document. If more than one view is
 468         allowed for the document (by virtue of multiple templates mentioning
 469         the same document type), a choice of view is presented to the user.
 470     */
 471     virtual wxView* CreateView(wxDocument* doc, long flags = 0);
 472
 473     /**
 474         Removes the template from the list of templates.
 475     */
 476     void DisassociateTemplate(wxDocTemplate* temp);
 477
 478     /**
 479         Appends the files in the history list to all menus managed by the file
 480         history object.
 481     */
 482     virtual void FileHistoryAddFilesToMenu();
 483     /**
 484         Appends the files in the history list to the given @a menu only.
 485     */
 486     virtual void FileHistoryAddFilesToMenu(wxMenu* menu);
 487
 488     /**
 489         Loads the file history from a config object.
 490
 491         @see wxConfigBase
 492     */
 493     virtual void FileHistoryLoad(const wxConfigBase& config);
 494
 495     /**
 496         Removes the given menu from the list of menus managed by the file
 497         history object.
 498     */
 499     virtual void FileHistoryRemoveMenu(wxMenu* menu);
 500
 501     /**
 502         Saves the file history into a config object. This must be called
 503         explicitly by the application.
 504
 505         @see wxConfigBase
 506     */
 507     virtual void FileHistorySave(wxConfigBase& resourceFile);
 508
 509     /**
 510         Use this menu for appending recently-visited document filenames, for
 511         convenient access. Calling this function with a valid menu pointer
 512         enables the history list functionality.
 513
 514         @note You can add multiple menus using this function, to be managed by
 515               the file history object.
 516     */
 517     virtual void FileHistoryUseMenu(wxMenu* menu);
 518
 519     /**
 520         Given a path, try to find template that matches the extension. This is
 521         only an approximate method of finding a template for creating a
 522         document.
 523     */
 524     virtual wxDocTemplate* FindTemplateForPath(const wxString& path);
 525
 526     /**
 527         Returns the document associated with the currently active view (if
 528         any).
 529     */
 530     wxDocument* GetCurrentDocument() const;
 531
 532     /**
 533         Returns the currently active view
 534     */
 535     virtual wxView* GetCurrentView() const;
 536
 537     /**
 538         Returns a reference to the list of documents.
 539     */
 540     wxList& GetDocuments();
 541
 542     /**
 543         Returns a pointer to file history.
 544     */
 545     virtual wxFileHistory* GetFileHistory() const;
 546
 547     /**
 548         Returns the number of files currently stored in the file history.
 549     */
 550     virtual size_t GetHistoryFilesCount() const;
 551
 552     /**
 553         Returns the directory last selected by the user when opening a file.
 554         Initially empty.
 555     */
 556     wxString GetLastDirectory() const;
 557
 558     /**
 559         Returns the number of documents that can be open simultaneously.
 560     */
 561     int GetMaxDocsOpen() const;
 562
 563     /**
 564         Returns a reference to the list of associated templates.
 565     */
 566     wxList& GetTemplates();
 567
 568     /**
 569         Initializes data; currently just calls OnCreateFileHistory().
 570
 571         Some data cannot always be initialized in the constructor because the
 572         programmer must be given the opportunity to override functionality. If
 573         OnCreateFileHistory() was called from the constructor, an overridden
 574         virtual OnCreateFileHistory() would not be called due to C++'s
 575         'interesting' constructor semantics. In fact Initialize() @e is called
 576         from the wxDocManager constructor, but this can be vetoed by passing
 577         @false to the second argument, allowing the derived class's constructor
 578         to call Initialize(), possibly calling a different
 579         OnCreateFileHistory() from the default.
 580
 581         The bottom line: if you're not deriving from Initialize(), forget it
 582         and construct wxDocManager with no arguments.
 583     */
 584     virtual bool Initialize();
 585
 586     /**
 587         Return a string containing a suitable default name for a new document.
 588         By default this is implemented by appending an integer counter to the
 589         string @b unnamed but can be overridden in the derived classes to do
 590         something more appropriate.
 591     */
 592     virtual wxString MakeNewDocumentName();
 593
 594     /**
 595         A hook to allow a derived class to create a different type of file
 596         history. Called from Initialize().
 597     */
 598     virtual wxFileHistory* OnCreateFileHistory();
 599
 600     /**
 601         Closes and deletes the currently active document.
 602     */
 603     void OnFileClose(wxCommandEvent& event);
 604
 605     /**
 606         Closes and deletes all the currently opened documents.
 607     */
 608     void OnFileCloseAll(wxCommandEvent& event);
 609
 610     /**
 611         Creates a document from a list of templates (if more than one
 612         template).
 613     */
 614     void OnFileNew(wxCommandEvent& event);
 615
 616     /**
 617         Creates a new document and reads in the selected file.
 618     */
 619     void OnFileOpen(wxCommandEvent& event);
 620
 621     /**
 622         Reverts the current document by calling wxDocument::Revert() for the
 623         current document.
 624     */
 625     void OnFileRevert(wxCommandEvent& event);
 626
 627     /**
 628         Saves the current document by calling wxDocument::Save() for the
 629         current document.
 630     */
 631     void OnFileSave(wxCommandEvent& event);
 632
 633     /**
 634         Calls wxDocument::SaveAs() for the current document.
 635     */
 636     void OnFileSaveAs(wxCommandEvent& event);
 637
 638     /**
 639         Removes the document from the list of documents.
 640     */
 641     void RemoveDocument(wxDocument* doc);
 642
 643     /**
 644         Under Windows, pops up a file selector with a list of filters
 645         corresponding to document templates. The wxDocTemplate corresponding to
 646         the selected file's extension is returned.
 647
 648         On other platforms, if there is more than one document template a
 649         choice list is popped up, followed by a file selector.
 650
 651         This function is used in CreateDocument().
 652
 653         @beginWxPerlOnly
 654         In wxPerl @a templates is a reference to a list of templates.
 655         If you override this method in your document manager it must
 656         return two values, eg:
 657
 658         @code
 659         (doctemplate, path) = My::DocManager->SelectDocumentPath(...);
 660         @endcode
 661         @endWxPerlOnly
 662     */
 663     virtual wxDocTemplate* SelectDocumentPath(wxDocTemplate** templates,
 664                                               int noTemplates, wxString& path,
 665                                               long flags, bool save = false);
 666
 667     /**
 668         Returns a document template by asking the user (if there is more than
 669         one template). This function is used in CreateDocument().
 670
 671         @param templates
 672             Pointer to an array of templates from which to choose a desired
 673             template.
 674         @param noTemplates
 675             Number of templates being pointed to by the templates pointer.
 676         @param sort
 677             If more than one template is passed into templates, then this
 678             parameter indicates whether the list of templates that the user
 679             will have to choose from is sorted or not when shown the choice box
 680             dialog. Default is @false.
 681
 682         @beginWxPerlOnly
 683         In wxPerl @a templates is a reference to a list of templates.
 684         @endWxPerlOnly
 685     */
 686     virtual wxDocTemplate* SelectDocumentType(wxDocTemplate** templates,
 687                                               int noTemplates,
 688                                               bool sort = false);
 689
 690     /**
 691         Returns a document template by asking the user (if there is more than
 692         one template), displaying a list of valid views. This function is used
 693         in CreateView(). The dialog normally will not appear because the array
 694         of templates only contains those relevant to the document in question,
 695         and often there will only be one such.
 696
 697         @param templates
 698             Pointer to an array of templates from which to choose a desired
 699             template.
 700         @param noTemplates
 701             Number of templates being pointed to by the templates pointer.
 702         @param sort
 703             If more than one template is passed into templates, then this
 704             parameter indicates whether the list of templates that the user
 705             will have to choose from is sorted or not when shown the choice box
 706             dialog. Default is @false.
 707
 708         @beginWxPerlOnly
 709         In wxPerl @a templates is a reference to a list of templates.
 710         @endWxPerlOnly
 711     */
 712     virtual wxDocTemplate* SelectViewType(wxDocTemplate** templates,
 713                                           int noTemplates, bool sort = false);
 714
 715     /**
 716         Sets the directory to be displayed to the user when opening a file.
 717         Initially this is empty.
 718     */
 719     void SetLastDirectory(const wxString& dir);
 720
 721     /**
 722         Sets the maximum number of documents that can be open at a time. By
 723         default, this is @c INT_MAX, i.e. the number of documents is unlimited.
 724         If you set it to 1, existing documents will be saved and deleted when
 725         the user tries to open or create a new one (similar to the behaviour of
 726         Windows Write, for example). Allowing multiple documents gives
 727         behaviour more akin to MS Word and other Multiple Document Interface
 728         applications.
 729     */
 730     void SetMaxDocsOpen(int n);
 731
 732
 733 protected:
 734     /**
 735         Called when a file selected from the MRU list doesn't exist any more.
 736
 737         The default behaviour is to remove the file from the MRU (most recently
 738         used) files list and the corresponding menu and notify the user about
 739         it but this method can be overridden to customize it.
 740
 741         For example, an application may want to just give an error about the
 742         missing file @a filename but not remove it from the file history. Or it
 743         could ask the user whether the file should be kept or removed.
 744
 745         Notice that this method is called only if the file selected by user
 746         from the MRU files in the menu doesn't exist, but not if opening it
 747         failed for any other reason because in the latter case the default
 748         behaviour of removing the file from the MRU list is inappropriate.
 749         If you still want to do it, you would need to do it by calling
 750         RemoveFileFromHistory() explicitly in the part of the file opening code
 751         that may fail.
 752
 753         @since 2.9.3
 754
 755         @param n
 756             The index of the file in the MRU list, it can be passed to
 757             RemoveFileFromHistory() to remove this file from the list.
 758         @param filename
 759             The full name of the file.
 760      */
 761     virtual void OnMRUFileNotExist(unsigned n, const wxString& filename);
 762
 763     /**
 764         Create the frame used for print preview.
 765
 766         This method can be overridden if you need to change the behaviour or
 767         appearance of the preview window. By default, a standard wxPreviewFrame
 768         is created.
 769
 770         @since 2.9.1
 771
 772         @param preview The associated preview object.
 773         @param parent The parent window for the frame.
 774         @param title The suggested title for the print preview frame.
 775         @return A new print preview frame, must not return @NULL.
 776     */
 777     virtual wxPreviewFrame* CreatePreviewFrame(wxPrintPreviewBase* preview,
 778                                                wxWindow* parent,
 779                                                const wxString& title);
 780
 781     /**
 782         The currently active view.
 783     */
 784     wxView* m_currentView;
 785
 786     /**
 787         Stores the integer to be used for the next default document name.
 788     */
 789     int m_defaultDocumentNameCounter;
 790
 791     /**
 792         A list of all documents.
 793     */
 794     wxList m_docs;
 795
 796     /**
 797         A pointer to an instance of wxFileHistory, which manages the history of
 798         recently-visited files on the File menu.
 799     */
 800     wxFileHistory* m_fileHistory;
 801
 802     /**
 803         The directory last selected by the user when opening a file.
 804     */
 805     wxString m_lastDirectory;
 806
 807     /**
 808         Stores the maximum number of documents that can be opened before
 809         existing documents are closed.
 810
 811         By default, this is @c INT_MAX i.e. practically unlimited.
 812     */
 813     int m_maxDocsOpen;
 814 };
 815
 816
 817
 818 /**
 819     @class wxView
 820
 821     The view class can be used to model the viewing and editing component of
 822     an application's file-based data. It is part of the document/view framework
 823     supported by wxWidgets, and cooperates with the wxDocument, wxDocTemplate
 824     and wxDocManager classes.
 825
 826     @library{wxcore}
 827     @category{docview}
 828
 829     @see @ref overview_docview_wxview, wxDocument, wxDocTemplate, wxDocManager
 830 */
 831 class wxView : public wxEvtHandler
 832 {
 833 public:
 834     /**
 835         Constructor. Define your own default constructor to initialize
 836         application-specific data.
 837     */
 838     wxView();
 839
 840     /**
 841         Destructor. Removes itself from the document's list of views.
 842     */
 843     virtual ~wxView();
 844
 845     /**
 846         Call this from your view frame's wxDocChildFrame::OnActivate() member
 847         to tell the framework which view is currently active. If your windowing
 848         system doesn't call wxDocChildFrame::OnActivate(), you may need to call
 849         this function from any place where you know the view must be active,
 850         and the framework will need to get the current view.
 851
 852         The prepackaged view frame wxDocChildFrame calls Activate() from its
 853         wxDocChildFrame::OnActivate() member.
 854
 855         This function calls OnActivateView().
 856     */
 857     virtual void Activate(bool activate);
 858
 859     /**
 860         Closes the view by calling OnClose(). If @a deleteWindow is @true, this
 861         function should delete the window associated with the view.
 862     */
 863     virtual bool Close(bool deleteWindow = true);
 864
 865     /**
 866         Gets a pointer to the document associated with the view.
 867     */
 868     wxDocument* GetDocument() const;
 869
 870     /**
 871         Returns a pointer to the document manager instance associated with this
 872         view.
 873     */
 874     wxDocManager* GetDocumentManager() const;
 875
 876     /**
 877         Gets the frame associated with the view (if any). Note that this
 878         "frame" is not a wxFrame at all in the generic MDI implementation which
 879         uses notebook pages instead of frames and this is why this method
 880         returns a wxWindow and not a wxFrame.
 881     */
 882     wxWindow* GetFrame() const;
 883
 884     /**
 885         Gets the name associated with the view (passed to the wxDocTemplate
 886         constructor). Not currently used by the framework.
 887     */
 888     wxString GetViewName() const;
 889
 890     /**
 891         Called when a view is activated by means of Activate(). The default
 892         implementation does nothing.
 893     */
 894     virtual void OnActivateView(bool activate, wxView* activeView,
 895                                 wxView* deactiveView);
 896
 897     /**
 898         Called when the filename has changed. The default implementation
 899         constructs a suitable title and sets the title of the view frame (if any).
 900     */
 901     virtual void OnChangeFilename();
 902
 903     /**
 904         Implements closing behaviour. The default implementation calls
 905         wxDocument::Close() to close the associated document. Does not delete
 906         the view. The application may wish to do some cleaning up operations in
 907         this function, @e if a call to wxDocument::Close() succeeded. For
 908         example, if your views all share the same window, you need to
 909         disassociate the window from the view and perhaps clear the window. If
 910         @a deleteWindow is @true, delete the frame associated with the view.
 911     */
 912     virtual bool OnClose(bool deleteWindow);
 913
 914     /**
 915         Override this to clean up the view when the document is being closed.
 916     */
 917     virtual void OnClosingDocument();
 918
 919     /**
 920         wxDocManager or wxDocument creates a wxView via a wxDocTemplate. Just
 921         after the wxDocTemplate creates the wxView, it calls OnCreate(). The
 922         wxView can create a wxDocChildFrame (or derived class) in its
 923         wxView::OnCreate() member function. This wxDocChildFrame provides user
 924         interface elements to view and/or edit the contents of the wxDocument.
 925
 926         By default, simply returns @true. If the function returns @false, the
 927         view will be deleted.
 928     */
 929     virtual bool OnCreate(wxDocument* doc, long flags);
 930
 931     /**
 932         If the printing framework is enabled in the library, this function
 933         returns a wxPrintout object for the purposes of printing. It should
 934         create a new object every time it is called; the framework will delete
 935         objects it creates.
 936
 937         By default, this function returns an instance of wxDocPrintout, which
 938         prints and previews one page by calling OnDraw().
 939
 940         Override to return an instance of a class other than wxDocPrintout.
 941     */
 942     virtual wxPrintout* OnCreatePrintout();
 943
 944     /**
 945         Override this function to render the view on the given device context.
 946     */
 947     virtual void OnDraw(wxDC* dc) = 0;
 948
 949     /**
 950         Called when the view should be updated.
 951
 952         @param sender
 953             A pointer to the wxView that sent the update request, or @NULL if
 954             no single view requested the update (for instance, when the
 955             document is opened).
 956         @param hint
 957             This is unused currently, but may in future contain
 958             application-specific information for making updating more
 959             efficient.
 960     */
 961     virtual void OnUpdate(wxView* sender, wxObject* hint = 0);
 962
 963     /**
 964         Associates the given document with the view. Normally called by the
 965         framework.
 966     */
 967     virtual void SetDocument(wxDocument* doc);
 968
 969     /**
 970         Sets the frame associated with this view. The application should call
 971         this if possible, to tell the view about the frame.
 972
 973         See GetFrame() for the explanation about the mismatch between the
 974         "Frame" in the method name and the type of its parameter.
 975     */
 976     void SetFrame(wxWindow* frame);
 977
 978     /**
 979         Sets the view type name. Should only be called by the framework.
 980     */
 981     void SetViewName(const wxString& name);
 982
 983     /**
 984         The document associated with this view. There may be more than one view
 985         per document, but there can never be more than one document for one
 986         view.
 987     */
 988     wxDocument* m_viewDocument;
 989
 990     /**
 991         Frame associated with the view, if any.
 992     */
 993     wxFrame* m_viewFrame;
 994
 995     /**
 996         The view type name given to the wxDocTemplate constructor, copied to
 997         this variable when the view is created. Not currently used by the
 998         framework.
 999     */
1000     wxString m_viewTypeName;
1001 };
1002
1003
1004
1005 /**
1006     @class wxDocChildFrame
1007
1008     The wxDocChildFrame class provides a default frame for displaying documents
1009     on separate windows. This class can only be used for SDI (not MDI) child
1010     frames.
1011
1012     The class is part of the document/view framework supported by wxWidgets,
1013     and cooperates with the wxView, wxDocument, wxDocManager and wxDocTemplate
1014     classes.
1015
1016     Notice that this class handles ::wxEVT_ACTIVATE event and activates the
1017     child view on receiving it. Don't intercept this event unless you want to
1018     prevent from this happening.
1019
1020     The same remark applies to ::wxEVT_CLOSE_WINDOW, as wxDocParentFrame the
1021     frame handles this event by trying to close the associated view.
1022
1023     @library{wxcore}
1024     @category{docview}
1025
1026     @see @ref overview_docview, @ref page_samples_docview, wxFrame
1027 */
1028 class wxDocChildFrame : public wxFrame
1029 {
1030 public:
1031     /**
1032         Constructor.
1033     */
1034     wxDocChildFrame(wxDocument* doc, wxView* view, wxFrame* parent,
1035                     wxWindowID id, const wxString& title,
1036                     const wxPoint& pos = wxDefaultPosition,
1037                     const wxSize& size = wxDefaultSize,
1038                     long style = wxDEFAULT_FRAME_STYLE,
1039                     const wxString& name = wxFrameNameStr);
1040
1041     /**
1042         Destructor.
1043     */
1044     virtual ~wxDocChildFrame();
1045
1046     /**
1047         Returns the document associated with this frame.
1048     */
1049     wxDocument* GetDocument() const;
1050
1051     /**
1052         Returns the view associated with this frame.
1053     */
1054     wxView* GetView() const;
1055
1056     /**
1057         Sets the document for this frame.
1058     */
1059     void SetDocument(wxDocument* doc);
1060
1061     /**
1062         Sets the view for this frame.
1063     */
1064     void SetView(wxView* view);
1065
1066     /**
1067         The document associated with the frame.
1068     */
1069     wxDocument* m_childDocument;
1070
1071     /**
1072         The view associated with the frame.
1073     */
1074     wxView* m_childView;
1075 };
1076
1077
1078
1079 /**
1080     @class wxDocParentFrame
1081
1082     The wxDocParentFrame class provides a default top-level frame for
1083     applications using the document/view framework. This class can only be used
1084     for SDI (not MDI) parent frames.
1085
1086     It cooperates with the wxView, wxDocument, wxDocManager and wxDocTemplate
1087     classes.
1088
1089     Notice that this class processes ::wxEVT_CLOSE_WINDOW event and tries to
1090     close all open views from its handler. If all the views can be closed, i.e.
1091     if none of them contains unsaved changes or the user decides to not save
1092     them, the window is destroyed. Don't intercept this event in your code
1093     unless you want to replace this logic.
1094
1095     @library{wxcore}
1096     @category{docview}
1097
1098     @see @ref overview_docview, @ref page_samples_docview, wxFrame
1099 */
1100 class wxDocParentFrame : public wxFrame
1101 {
1102 public:
1103     /**
1104         Default constructor.
1105     */
1106     wxDocParentFrame();
1107     /**
1108         Constructor.
1109     */
1110     wxDocParentFrame(wxDocManager* manager, wxFrame* parent,
1111                      wxWindowID id, const wxString& title,
1112                      const wxPoint& pos = wxDefaultPosition,
1113                      const wxSize& size = wxDefaultSize,
1114                      long style = wxDEFAULT_FRAME_STYLE,
1115                      const wxString& name = wxFrameNameStr);
1116
1117     /**
1118         Destructor.
1119     */
1120     virtual ~wxDocParentFrame();
1121
1122     /**
1123         Used in two-step construction.
1124     */
1125     bool Create(wxDocManager* manager, wxFrame* parent, wxWindowID id,
1126                 const wxString& title, const wxPoint& pos = wxDefaultPosition,
1127                 const wxSize& size = wxDefaultSize, long style = 541072960,
1128                 const wxString& name = wxFrameNameStr);
1129
1130     /**
1131         Returns the associated document manager object.
1132     */
1133     wxDocManager* GetDocumentManager() const;
1134 };
1135
1136
1137
1138 /**
1139     @class wxDocument
1140
1141     The document class can be used to model an application's file-based data.
1142
1143     It is part of the document/view framework supported by wxWidgets, and
1144     cooperates with the wxView, wxDocTemplate and wxDocManager classes.
1145
1146     A normal document is the one created without parent document and is
1147     associated with a disk file. Since version 2.9.2 wxWidgets also supports a
1148     special kind of documents called <em>child documents</em> which are virtual
1149     in the sense that they do not correspond to a file but rather to a part of
1150     their parent document. Because of this, the child documents can't be
1151     created directly by user but can only be created by the parent document
1152     (usually when it's being created itself). They also can't be independently
1153     saved. A child document has its own view with the corresponding window.
1154     This view can be closed by user but, importantly, is also automatically
1155     closed when its parent document is closed. Thus, child documents may be
1156     convenient for creating additional windows which need to be closed when the
1157     main document is. The docview sample demonstrates this use of child
1158     documents by creating a child document containing the information about the
1159     parameters of the image opened in the main document.
1160
1161     @library{wxcore}
1162     @category{docview}
1163
1164     @see @ref overview_docview, wxView, wxDocTemplate, wxDocManager
1165 */
1166 class wxDocument : public wxEvtHandler
1167 {
1168 public:
1169     /**
1170         Constructor. Define your own default constructor to initialize
1171         application-specific data.
1172
1173         @param parent
1174             Specifying a non-@c NULL parent document here makes this document a
1175             special <em>child document</em>, see their description in the class
1176             documentation. Notice that this parameter exists but is ignored in
1177             wxWidgets versions prior to 2.9.1.
1178     */
1179     wxDocument(wxDocument* parent = NULL);
1180
1181     /**
1182         Destructor. Removes itself from the document manager.
1183     */
1184     virtual ~wxDocument();
1185
1186     /**
1187         If the view is not already in the list of views, adds the view and
1188         calls OnChangedViewList().
1189     */
1190     virtual bool AddView(wxView* view);
1191
1192     /**
1193         Returns true if the document hasn't been modified since the last time
1194         it had been saved.
1195
1196         Notice that this function returns @false if the document had been never
1197         saved at all, so it may be also used to test whether it makes sense to
1198         save the document: if it returns @true, there is nothing to save but if
1199         @false is returned, it can be saved, even if it might be not modified
1200         (this can be used to create an empty document file by the user).
1201
1202         @see IsModified(), GetDocumentSaved()
1203
1204         @since 2.9.0
1205      */
1206     bool AlreadySaved() const;
1207
1208     /**
1209         Closes the document, by calling OnSaveModified() and then (if this
1210         returned @true) OnCloseDocument(). This does not normally delete the
1211         document object, use DeleteAllViews() to do this implicitly.
1212     */
1213     virtual bool Close();
1214
1215     /**
1216         Calls wxView::Close() and deletes each view. Deleting the final view
1217         will implicitly delete the document itself, because the wxView
1218         destructor calls RemoveView(). This in turns calls OnChangedViewList(),
1219         whose default implemention is to save and delete the document if no
1220         views exist.
1221     */
1222     virtual bool DeleteAllViews();
1223
1224     /**
1225         Virtual method called from OnCloseDocument().
1226
1227         This method may be overridden to perform any additional cleanup which
1228         might be needed when the document is closed.
1229
1230         The return value of this method is currently ignored.
1231
1232         The default version does nothing and simply returns @true.
1233      */
1234     virtual bool DeleteContents();
1235
1236     /**
1237         Returns a pointer to the command processor associated with this
1238         document.
1239
1240         @see wxCommandProcessor
1241     */
1242     virtual wxCommandProcessor* GetCommandProcessor() const;
1243
1244     /**
1245         Gets a pointer to the associated document manager.
1246     */
1247     virtual wxDocManager* GetDocumentManager() const;
1248
1249     /**
1250         Gets the document type name for this document. See the comment for
1251         @ref m_documentTypeName.
1252     */
1253     wxString GetDocumentName() const;
1254
1255     /**
1256         Return true if this document had been already saved.
1257
1258         @see IsModified()
1259      */
1260     bool GetDocumentSaved() const;
1261
1262     /**
1263         Gets a pointer to the template that created the document.
1264     */
1265     virtual wxDocTemplate* GetDocumentTemplate() const;
1266
1267     /**
1268         Intended to return a suitable window for using as a parent for
1269         document-related dialog boxes. By default, uses the frame associated
1270         with the first view.
1271     */
1272     virtual wxWindow* GetDocumentWindow() const;
1273
1274     /**
1275         Gets the filename associated with this document, or "" if none is
1276         associated.
1277     */
1278     wxString GetFilename() const;
1279
1280     /**
1281         A convenience function to get the first view for a document, because in
1282         many cases a document will only have a single view.
1283
1284         @see GetViews()
1285     */
1286     wxView* GetFirstView() const;
1287
1288     /**
1289         Gets the title for this document. The document title is used for an
1290         associated frame (if any), and is usually constructed by the framework
1291         from the filename.
1292     */
1293     wxString GetTitle() const;
1294
1295     /**
1296         Return the document name suitable to be shown to the user. The default
1297         implementation uses the document title, if any, of the name part of the
1298         document filename if it was set or, otherwise, the string @b unnamed.
1299     */
1300     virtual wxString GetUserReadableName() const;
1301
1302     //@{
1303     /**
1304         Returns the list whose elements are the views on the document.
1305
1306         @see GetFirstView()
1307     */
1308     wxList& GetViews();
1309     const wxList& GetViews() const;
1310     //@}
1311
1312     /**
1313         Returns true if this document is a child document corresponding to a
1314         part of the parent document and not a disk file as usual.
1315
1316         This method can be used to check whether file-related operations make
1317         sense for this document as they only apply to top-level documents and
1318         not child ones.
1319
1320         @since 2.9.2
1321      */
1322     bool IsChildDocument() const;
1323
1324     /**
1325         Returns @true if the document has been modified since the last save,
1326         @false otherwise. You may need to override this if your document view
1327         maintains its own record of being modified.
1328
1329         @see Modify()
1330     */
1331     virtual bool IsModified() const;
1332
1333     //@{
1334     /**
1335         Override this function and call it from your own LoadObject() before
1336         streaming your own data. LoadObject() is called by the framework
1337         automatically when the document contents need to be loaded.
1338
1339         @note This version of LoadObject() may not exist depending on how
1340               wxWidgets was configured.
1341     */
1342     virtual istream& LoadObject(istream& stream);
1343     virtual wxInputStream& LoadObject(wxInputStream& stream);
1344     //@}
1345
1346     /**
1347         Call with @true to mark the document as modified since the last save,
1348         @false otherwise. You may need to override this if your document view
1349         maintains its own record of being modified.
1350
1351         @see IsModified()
1352     */
1353     virtual void Modify(bool modify);
1354
1355     /**
1356         Called when a view is added to or deleted from this document. The
1357         default implementation saves and deletes the document if no views exist
1358         (the last one has just been removed).
1359     */
1360     virtual void OnChangedViewList();
1361
1362     /**
1363         This virtual function is called when the document is being closed.
1364
1365         The default implementation calls DeleteContents() (which may be
1366         overridden to perform additional cleanup) and sets the modified flag to
1367         @false. You can override it to supply additional behaviour when the
1368         document is closed with Close().
1369
1370         Notice that previous wxWidgets versions used to call this function also
1371         from OnNewDocument(), rather counter-intuitively. This is no longer the
1372         case since wxWidgets 2.9.0.
1373     */
1374     virtual bool OnCloseDocument();
1375
1376     /**
1377         Called just after the document object is created to give it a chance to
1378         initialize itself.
1379
1380         The default implementation uses the template associated with the
1381         document to create an initial view.
1382
1383         For compatibility reasons, this method may either delete the document
1384         itself if its initialization fails or not do it in which case it is
1385         deleted by caller. It is recommended to delete the document explicitly
1386         in this function if it can't be initialized.
1387
1388         @param path
1389             The associated file path.
1390         @param flags
1391             Flags passed to CreateDocument().
1392         @return
1393             @true if the initialization was successful or @false if it failed.
1394     */
1395     virtual bool OnCreate(const wxString& path, long flags);
1396
1397     /**
1398         Override this function if you want a different (or no) command
1399         processor to be created when the document is created. By default, it
1400         returns an instance of wxCommandProcessor.
1401
1402         @see wxCommandProcessor
1403     */
1404     virtual wxCommandProcessor* OnCreateCommandProcessor();
1405
1406     /**
1407         The default implementation calls OnSaveModified() and DeleteContents(),
1408         makes a default title for the document, and notifies the views that the
1409         filename (in fact, the title) has changed.
1410     */
1411     virtual bool OnNewDocument();
1412
1413     /**
1414         Constructs an input file stream for the given filename (which must not
1415         be empty), and calls LoadObject(). If LoadObject() returns @true, the
1416         document is set to unmodified; otherwise, an error message box is
1417         displayed. The document's views are notified that the filename has
1418         changed, to give windows an opportunity to update their titles. All of
1419         the document's views are then updated.
1420     */
1421     virtual bool OnOpenDocument(const wxString& filename);
1422
1423     /**
1424         Constructs an output file stream for the given filename (which must not
1425         be empty), and calls SaveObject(). If SaveObject() returns @true, the
1426         document is set to unmodified; otherwise, an error message box is
1427         displayed.
1428     */
1429     virtual bool OnSaveDocument(const wxString& filename);
1430
1431     /**
1432         If the document has been modified, prompts the user to ask if the
1433         changes should be saved. If the user replies Yes, the Save() function
1434         is called. If No, the document is marked as unmodified and the function
1435         succeeds. If Cancel, the function fails.
1436     */
1437     virtual bool OnSaveModified();
1438
1439     /**
1440         Removes the view from the document's list of views, and calls
1441         OnChangedViewList().
1442     */
1443     virtual bool RemoveView(wxView* view);
1444
1445     /**
1446         Saves the document by calling OnSaveDocument() if there is an
1447         associated filename, or SaveAs() if there is no filename.
1448     */
1449     virtual bool Save();
1450
1451     /**
1452         Prompts the user for a file to save to, and then calls
1453         OnSaveDocument().
1454     */
1455     virtual bool SaveAs();
1456
1457     /**
1458         Discard changes and load last saved version.
1459
1460         Prompts the user first, and then calls DoOpenDocument() to reload the
1461         current file.
1462     */
1463     virtual bool Revert();
1464
1465     //@{
1466     /**
1467         Override this function and call it from your own SaveObject() before
1468         streaming your own data. SaveObject() is called by the framework
1469         automatically when the document contents need to be saved.
1470
1471         @note This version of SaveObject() may not exist depending on how
1472               wxWidgets was configured.
1473     */
1474     virtual ostream& SaveObject(ostream& stream);
1475     virtual wxOutputStream& SaveObject(wxOutputStream& stream);
1476     //@}
1477
1478     /**
1479         Sets the command processor to be used for this document. The document
1480         will then be responsible for its deletion. Normally you should not call
1481         this; override OnCreateCommandProcessor() instead.
1482
1483         @see wxCommandProcessor
1484     */
1485     virtual void SetCommandProcessor(wxCommandProcessor* processor);
1486
1487     /**
1488         Sets the document type name for this document. See the comment for
1489         @ref m_documentTypeName.
1490     */
1491     void SetDocumentName(const wxString& name);
1492
1493     /**
1494         Sets the pointer to the template that created the document. Should only
1495         be called by the framework.
1496     */
1497     virtual void SetDocumentTemplate(wxDocTemplate* templ);
1498
1499     /**
1500         Sets if this document has been already saved or not.
1501
1502         Normally there is no need to call this function as the document-view
1503         framework does it itself as the documents are loaded from and saved to
1504         the files. However it may be useful in some particular cases, for
1505         example it may be called with @false argument to prevent the user
1506         from saving the just opened document into the same file if this
1507         shouldn't be done for some reason (e.g. file format version changes and
1508         a new extension should be used for saving).
1509
1510         @see GetDocumentSaved(), AlreadySaved()
1511      */
1512     void SetDocumentSaved(bool saved = true);
1513
1514     /**
1515         Sets the filename for this document. Usually called by the framework.
1516
1517         Calls OnChangeFilename() which in turn calls wxView::OnChangeFilename() for
1518         all views if @a notifyViews is @true.
1519     */
1520     void SetFilename(const wxString& filename, bool notifyViews = false);
1521
1522     /**
1523         If @a notifyViews is @true, wxView::OnChangeFilename() is called for
1524         all views.
1525
1526         @since 2.9.0
1527     */
1528     virtual void OnChangeFilename(bool notifyViews);
1529
1530     /**
1531         Sets the title for this document. The document title is used for an
1532         associated frame (if any), and is usually constructed by the framework
1533         from the filename.
1534     */
1535     void SetTitle(const wxString& title);
1536
1537     /**
1538         Updates all views. If @a sender is non-@NULL, does not update this
1539         view. @a hint represents optional information to allow a view to
1540         optimize its update.
1541     */
1542     virtual void UpdateAllViews(wxView* sender = NULL, wxObject* hint = NULL);
1543
1544 protected:
1545     /**
1546         This method is called by OnSaveDocument() to really save the document
1547         contents to the specified file.
1548
1549         Base class version creates a file-based stream and calls SaveObject().
1550         Override this if you need to do something else or prefer not to use
1551         SaveObject() at all.
1552      */
1553     virtual bool DoSaveDocument(const wxString& file);
1554
1555     /**
1556         This method is called by OnOpenDocument() to really load the document
1557         contents from the specified file.
1558
1559         Base class version creates a file-based stream and calls LoadObject().
1560         Override this if you need to do something else or prefer not to use
1561         LoadObject() at all.
1562      */
1563     virtual bool DoOpenDocument(const wxString& file);
1564
1565     /**
1566         A pointer to the command processor associated with this document.
1567     */
1568     wxCommandProcessor* m_commandProcessor;
1569
1570     /**
1571         Filename associated with this document ("" if none).
1572     */
1573     wxString m_documentFile;
1574
1575     /**
1576         @true if the document has been modified, @false otherwise.
1577     */
1578     bool m_documentModified;
1579
1580     /**
1581         A pointer to the template from which this document was created.
1582     */
1583     wxDocTemplate* m_documentTemplate;
1584
1585     /**
1586         Document title. The document title is used for an associated frame (if
1587         any), and is usually constructed by the framework from the filename.
1588     */
1589     wxString m_documentTitle;
1590
1591     /**
1592         The document type name given to the wxDocTemplate constructor, copied
1593         to this variable when the document is created. If several document
1594         templates are created that use the same document type, this variable is
1595         used in wxDocManager::CreateView() to collate a list of alternative
1596         view types that can be used on this kind of document. Do not change the
1597         value of this variable.
1598     */
1599     wxString m_documentTypeName;
1600
1601     /**
1602         List of wxView instances associated with this document.
1603     */
1604     wxList m_documentViews;
1605 };
1606
1607
1608 // ============================================================================
1609 // Global functions/macros
1610 // ============================================================================
1611
1612 /** @addtogroup group_funcmacro_file */
1613 //@{
1614
1615 /**
1616     Copies the given file to @a stream. Useful when converting an old
1617     application to use streams (within the document/view framework, for
1618     example).
1619
1620     @header{wx/docview.h}
1621 */
1622 bool wxTransferFileToStream(const wxString& filename,
1623                             ostream& stream);
1624
1625 /**
1626     Copies the given stream to the file @a filename. Useful when converting an
1627     old application to use streams (within the document/view framework, for
1628     example).
1629
1630     @header{wx/docview.h}
1631 */
1632 bool wxTransferStreamToFile(istream& stream,
1633                              const wxString& filename);
1634
1635 //@}
1636