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