No docs yet, just the bare interace so we can get XML for Phoenix.

[wxWidgets.git] / interface / wx / docview.h

diff --git a/interface/wx/docview.h b/interface/wx/docview.h
index 55effdd85c9d6af4be0d96d29957dec77accc11a..14bf99ba6a9964579f41522e8ca169d344754825 100644 (file)
--- a/interface/wx/docview.h
+++ b/interface/wx/docview.h
@@ -3,7 +3,7 @@
 // Purpose:     interface of various doc/view framework classes
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Purpose:     interface of various doc/view framework classes
 // Author:      wxWidgets team
 // RCS-ID:      $Id$

-// Licence:     wxWindows license
+// Licence:     wxWindows licence

 /////////////////////////////////////////////////////////////////////////////
 
 /**
 /////////////////////////////////////////////////////////////////////////////
 
 /**


@@ -43,13 +43,13 @@ public:
             A name that should be unique for a given view.
         @param docClassInfo
             A pointer to the run-time document class information as returned by
             A name that should be unique for a given view.
         @param docClassInfo
             A pointer to the run-time document class information as returned by

-            the CLASSINFO() macro, e.g. CLASSINFO(MyDocumentClass). If this is
+            the wxCLASSINFO() macro, e.g. wxCLASSINFO(MyDocumentClass). If this is

             not supplied, you will need to derive a new wxDocTemplate class and
             override the CreateDocument() member to return a new document
             instance on demand.
         @param viewClassInfo
             A pointer to the run-time view class information as returned by the
             not supplied, you will need to derive a new wxDocTemplate class and
             override the CreateDocument() member to return a new document
             instance on demand.
         @param viewClassInfo
             A pointer to the run-time view class information as returned by the

-            CLASSINFO() macro, e.g. CLASSINFO(MyViewClass). If this is not
+            wxCLASSINFO() macro, e.g. wxCLASSINFO(MyViewClass). If this is not

             supplied, you will need to derive a new wxDocTemplate class and
             override the CreateView() member to return a new view instance on
             demand.
             supplied, you will need to derive a new wxDocTemplate class and
             override the CreateView() member to return a new view instance on
             demand.


@@ -60,6 +60,28 @@ public:
             - wxTEMPLATE_INVISIBLE     - The template may not be displayed to
                                          the user in dialogs.
             - wxDEFAULT_TEMPLATE_FLAGS - Defined as wxTEMPLATE_VISIBLE.
             - wxTEMPLATE_INVISIBLE     - The template may not be displayed to
                                          the user in dialogs.
             - wxDEFAULT_TEMPLATE_FLAGS - Defined as wxTEMPLATE_VISIBLE.

+
+        @beginWxPerlOnly
+
+        In wxPerl @a docClassInfo and @a viewClassInfo can be either
+        @c Wx::ClassInfo objects or strings containing the name of the
+        perl packages which are to be used as @c Wx::Document and
+        @c Wx::View classes (they must have a constructor named new);
+        as an example:
+
+        - Wx::DocTemplate->new(docmgr, descr, filter, dir, ext,
+          docTypeName, viewTypeName, docClassInfo, viewClassInfo,
+          flags): will construct document and view objects from the
+          class information.
+        - Wx::DocTemplate->new(docmgr, descr, filter, dir, ext,
+          docTypeName, viewTypeName, docClassName, viewClassName,
+          flags): will construct document and view objects from perl
+          packages.
+        - Wx::DocTemplate->new(docmgr, descr, filter, dir, ext,
+          docTypeName, viewTypeName):
+          in this case @c Wx::DocTemplate::CreateDocument() and
+          @c Wx::DocTemplate::CreateView() must be overridden
+        @endWxPerlOnly

     */
     wxDocTemplate(wxDocManager* manager, const wxString& descr,
                   const wxString& filter, const wxString& dir,
     */
     wxDocTemplate(wxDocManager* manager, const wxString& descr,
                   const wxString& filter, const wxString& dir,


@@ -85,12 +107,27 @@ public:
     virtual wxDocument* CreateDocument(const wxString& path, long flags = 0);
 
     /**
     virtual wxDocument* CreateDocument(const wxString& path, long flags = 0);
 
     /**

-        Creates a new instance of the associated view class. If you have not
-        supplied a wxClassInfo parameter to the template constructor, you will
-        need to override this function to return an appropriate view instance.
+        Creates a new instance of the associated view class.
+
+        If you have not supplied a wxClassInfo parameter to the template
+        constructor, you will need to override this function to return an
+        appropriate view instance.
+
+        If the new view initialization fails, it must call
+        wxDocument::RemoveView() for consistency with the default behaviour of
+        this function.

     */
     virtual wxView* CreateView(wxDocument* doc, long flags = 0);
 
     */
     virtual wxView* CreateView(wxDocument* doc, long flags = 0);
 

+    /**
+        This function implements the default (very primitive) format detection
+        which checks if the extension is that of the template.
+
+        @param path
+            The path to be checked against the template.
+    */
+    virtual bool FileMatchesTemplate(const wxString& path);
+

     /**
         Returns the default file extension for the document data, as passed to
         the document template constructor.
     /**
         Returns the default file extension for the document data, as passed to
         the document template constructor.


@@ -109,6 +146,13 @@ public:
     */
     wxString GetDirectory() const;
 
     */
     wxString GetDirectory() const;
 

+    /**
+        Returns the run-time class information that allows document
+        instances to be constructed dynamically, as passed to the document
+        template constructor.
+    */
+    wxClassInfo* GetDocClassInfo() const;
+

     /**
         Returns a pointer to the document manager instance for which this
         template was created.
     /**
         Returns a pointer to the document manager instance for which this
         template was created.


@@ -132,6 +176,13 @@ public:
     */
     long GetFlags() const;
 
     */
     long GetFlags() const;
 

+    /**
+        Returns the run-time class information that allows view instances
+        to be constructed dynamically, as passed to the document template
+        constructor.
+    */
+    wxClassInfo* GetViewClassInfo() const;
+

     /**
         Returns the view type name, as passed to the document template
         constructor.
     /**
         Returns the view type name, as passed to the document template
         constructor.


@@ -139,10 +190,25 @@ public:
     virtual wxString GetViewName() const;
 
     /**
     virtual wxString GetViewName() const;
 
     /**

-        Initialises the document, calling wxDocument::OnCreate(). This is
-        called from CreateDocument().
+        Initialises the document, calling wxDocument::OnCreate().
+
+        This is called from CreateDocument().
+
+        If you override this method, notice that you must @em delete the @a doc
+        if its initialization fails for consistency with the default behaviour.
+
+        @param doc
+            The document to initialize.
+        @param path
+            The associated file path.
+        @param flags
+            Flags passed to CreateDocument().
+        @return
+            @true if the initialization was successful or @false if it failed
+            in which case @a doc should be deleted by this function.

     */
     */

-    virtual bool InitDocument(wxDocument* doc, const wxString& path,
+    virtual bool InitDocument(wxDocument* doc,
+                              const wxString& path,

                               long flags = 0);
 
     /**
                               long flags = 0);
 
     /**


@@ -297,8 +363,48 @@ public:
     */
     void AssociateTemplate(wxDocTemplate* temp);
 
     */
     void AssociateTemplate(wxDocTemplate* temp);
 

+    /**
+        Search for a particular document template.
+
+        Example:
+        @code
+           // creating a document instance of the specified document type:
+           m_doc = (MyDoc*)docManager->FindTemplate(CLASSINFO(MyDoc))->
+                        CreateDocument(wxEmptyString, wxDOC_SILENT);
+        @endcode
+
+        @param classinfo
+            Class info of a document class for which a wxDocTemplate had been
+            previously created.
+
+        @return
+            Pointer to a wxDocTemplate, or @NULL if none found.
+
+        @since 2.9.2
+     */
+    wxDocTemplate* FindTemplate(const wxClassInfo* classinfo);
+
+    /**
+        Closes the specified document.
+
+        If @a force is @true, the document is closed even if it has unsaved
+        changes.
+
+        @param doc
+            The document to close, must be non-@NULL.
+        @param force
+            If @true, close the document even if wxDocument::Close() returns
+            @false.
+        @return
+            @true if the document was closed or @false if closing it was
+            cancelled by user (only in @a force = @false case).
+     */
+    bool CloseDocument(wxDocument *doc, bool force = false);
+

     /**
         Closes all currently opened documents.
     /**
         Closes all currently opened documents.

+
+        @see CloseDocument()

     */
     bool CloseDocuments(bool force = true);
 
     */
     bool CloseDocuments(bool force = true);
 


@@ -450,6 +556,24 @@ public:
     */
     wxList& GetTemplates();
 
     */
     wxList& GetTemplates();
 

+    /**
+        Create the frame used for print preview.
+
+        This method can be overridden if you need to change the behaviour or
+        appearance of the preview window. By default, a standard wxPreviewFrame
+        is created.
+
+        @since 2.9.1
+
+        @param preview The associated preview object.
+        @param parent The parent window for the frame.
+        @param title The suggested title for the print preview frame.
+        @return A new print preview frame, must not return @NULL.
+    */
+    virtual wxPreviewFrame* CreatePreviewFrame(wxPrintPreviewBase* preview,
+                                               wxWindow* parent,
+                                               const wxString& title);
+

     /**
         Initializes data; currently just calls OnCreateFileHistory().
 
     /**
         Initializes data; currently just calls OnCreateFileHistory().
 


@@ -534,6 +658,16 @@ public:
         choice list is popped up, followed by a file selector.
 
         This function is used in CreateDocument().
         choice list is popped up, followed by a file selector.
 
         This function is used in CreateDocument().

+
+        @beginWxPerlOnly
+        In wxPerl @a templates is a reference to a list of templates.
+        If you override this method in your document manager it must
+        return two values, eg:
+
+        @code
+        (doctemplate, path) = My::DocManager->SelectDocumentPath(...);
+        @endcode
+        @endWxPerlOnly

     */
     virtual wxDocTemplate* SelectDocumentPath(wxDocTemplate** templates,
                                               int noTemplates, wxString& path,
     */
     virtual wxDocTemplate* SelectDocumentPath(wxDocTemplate** templates,
                                               int noTemplates, wxString& path,


@@ -553,6 +687,10 @@ public:
             parameter indicates whether the list of templates that the user
             will have to choose from is sorted or not when shown the choice box
             dialog. Default is @false.
             parameter indicates whether the list of templates that the user
             will have to choose from is sorted or not when shown the choice box
             dialog. Default is @false.

+
+        @beginWxPerlOnly
+        In wxPerl @a templates is a reference to a list of templates.
+        @endWxPerlOnly

     */
     virtual wxDocTemplate* SelectDocumentType(wxDocTemplate** templates,
                                               int noTemplates,
     */
     virtual wxDocTemplate* SelectDocumentType(wxDocTemplate** templates,
                                               int noTemplates,


@@ -575,6 +713,10 @@ public:
             parameter indicates whether the list of templates that the user
             will have to choose from is sorted or not when shown the choice box
             dialog. Default is @false.
             parameter indicates whether the list of templates that the user
             will have to choose from is sorted or not when shown the choice box
             dialog. Default is @false.

+
+        @beginWxPerlOnly
+        In wxPerl @a templates is a reference to a list of templates.
+        @endWxPerlOnly

     */
     virtual wxDocTemplate* SelectViewType(wxDocTemplate** templates,
                                           int noTemplates, bool sort = false);
     */
     virtual wxDocTemplate* SelectViewType(wxDocTemplate** templates,
                                           int noTemplates, bool sort = false);


@@ -717,8 +859,7 @@ public:
 
     /**
         Called when the filename has changed. The default implementation
 
     /**
         Called when the filename has changed. The default implementation

-        constructs a suitable title and sets the title of the view frame (if
-        any).
+        constructs a suitable title and sets the title of the view frame (if any).

     */
     virtual void OnChangeFilename();
 
     */
     virtual void OnChangeFilename();
 


@@ -851,7 +992,7 @@ public:
                     const wxPoint& pos = wxDefaultPosition,
                     const wxSize& size = wxDefaultSize,
                     long style = wxDEFAULT_FRAME_STYLE,
                     const wxPoint& pos = wxDefaultPosition,
                     const wxSize& size = wxDefaultSize,
                     long style = wxDEFAULT_FRAME_STYLE,

-                    const wxString& name = "frame");
+                    const wxString& name = wxFrameNameStr);

 
     /**
         Destructor.
 
     /**
         Destructor.


@@ -933,7 +1074,7 @@ public:
                      const wxPoint& pos = wxDefaultPosition,
                      const wxSize& size = wxDefaultSize,
                      long style = wxDEFAULT_FRAME_STYLE,
                      const wxPoint& pos = wxDefaultPosition,
                      const wxSize& size = wxDefaultSize,
                      long style = wxDEFAULT_FRAME_STYLE,

-                     const wxString& name = "frame");
+                     const wxString& name = wxFrameNameStr);

 
     /**
         Destructor.
 
     /**
         Destructor.


@@ -1008,6 +1149,22 @@ public:
     */
     virtual bool AddView(wxView* view);
 
     */
     virtual bool AddView(wxView* view);
 

+    /**
+        Returns true if the document hasn't been modified since the last time
+        it had been saved.
+
+        Notice that this function returns @false if the document had been never
+        saved at all, so it may be also used to test whether it makes sense to
+        save the document: if it returns @true, there is nothing to save but if
+        @false is returned, it can be saved, even if it might be not modified
+        (this can be used to create an empty document file by the user).
+
+        @see IsModified(), GetDocumentSaved()
+
+        @since 2.9.0
+     */
+    bool AlreadySaved() const;
+

     /**
         Closes the document, by calling OnSaveModified() and then (if this
         returned @true) OnCloseDocument(). This does not normally delete the
     /**
         Closes the document, by calling OnSaveModified() and then (if this
         returned @true) OnCloseDocument(). This does not normally delete the


@@ -1024,6 +1181,18 @@ public:
     */
     virtual bool DeleteAllViews();
 
     */
     virtual bool DeleteAllViews();
 

+    /**
+        Virtual method called from OnCloseDocument().
+
+        This method may be overridden to perform any additional cleanup which
+        might be needed when the document is closed.
+
+        The return value of this method is currently ignored.
+
+        The default version does nothing and simply returns @true.
+     */
+    virtual bool DeleteContents();
+

     /**
         Returns a pointer to the command processor associated with this
         document.
     /**
         Returns a pointer to the command processor associated with this
         document.


@@ -1090,12 +1259,15 @@ public:
     */
     virtual wxString GetUserReadableName() const;
 
     */
     virtual wxString GetUserReadableName() const;
 

+    //@{

     /**
         Returns the list whose elements are the views on the document.
 
         @see GetFirstView()
     */
     /**
         Returns the list whose elements are the views on the document.
 
         @see GetFirstView()
     */

-    wxList GetViews() const;
+    wxList& GetViews();
+    const wxList& GetViews() const;
+    //@}

 
     /**
         Returns @true if the document has been modified since the last save,
 
     /**
         Returns @true if the document has been modified since the last save,


@@ -1138,10 +1310,10 @@ public:
     /**
         This virtual function is called when the document is being closed.
 
     /**
         This virtual function is called when the document is being closed.
 

-        The default implementation calls DeleteContents() (an empty
-        implementation) and sets the modified flag to @false. You can override
-        it to supply additional behaviour when the document is closed with
-        Close().
+        The default implementation calls DeleteContents() (which may be
+        overridden to perform additional cleanup) and sets the modified flag to
+        @false. You can override it to supply additional behaviour when the
+        document is closed with Close().

 
         Notice that previous wxWidgets versions used to call this function also
         from OnNewDocument(), rather counter-intuitively. This is no longer the
 
         Notice that previous wxWidgets versions used to call this function also
         from OnNewDocument(), rather counter-intuitively. This is no longer the


@@ -1151,9 +1323,22 @@ public:
 
     /**
         Called just after the document object is created to give it a chance to
 
     /**
         Called just after the document object is created to give it a chance to

-        initialize itself. The default implementation uses the template
-        associated with the document to create an initial view. If this
-        function returns @false, the document is deleted.
+        initialize itself.
+
+        The default implementation uses the template associated with the
+        document to create an initial view.
+
+        For compatibility reasons, this method may either delete the document
+        itself if its initialization fails or not do it in which case it is
+        deleted by caller. It is recommended to delete the document explicitly
+        in this function if it can't be initialized.
+
+        @param path
+            The associated file path.
+        @param flags
+            Flags passed to CreateDocument().
+        @return
+            @true if the initialization was successful or @false if it failed.

     */
     virtual bool OnCreate(const wxString& path, long flags);
 
     */
     virtual bool OnCreate(const wxString& path, long flags);
 


@@ -1193,7 +1378,7 @@ public:
 
     /**
         If the document has been modified, prompts the user to ask if the
 
     /**
         If the document has been modified, prompts the user to ask if the

-        changes should be changed. If the user replies Yes, the Save() function
+        changes should be saved. If the user replies Yes, the Save() function

         is called. If No, the document is marked as unmodified and the function
         succeeds. If Cancel, the function fails.
     */
         is called. If No, the document is marked as unmodified and the function
         succeeds. If Cancel, the function fails.
     */


@@ -1217,6 +1402,14 @@ public:
     */
     virtual bool SaveAs();
 
     */
     virtual bool SaveAs();
 

+    /**
+        Discard changes and load last saved version.
+
+        Prompts the user first, and then calls DoOpenDocument() to reload the
+        current file.
+    */
+    virtual bool Revert();
+

     //@{
     /**
         Override this function and call it from your own SaveObject() before
     //@{
     /**
         Override this function and call it from your own SaveObject() before


@@ -1251,13 +1444,36 @@ public:
     */
     virtual void SetDocumentTemplate(wxDocTemplate* templ);
 
     */
     virtual void SetDocumentTemplate(wxDocTemplate* templ);
 

+    /**
+        Sets if this document has been already saved or not.
+
+        Normally there is no need to call this function as the document-view
+        framework does it itself as the documents are loaded from and saved to
+        the files. However it may be useful in some particular cases, for
+        example it may be called with @false argument to prevent the user
+        from saving the just opened document into the same file if this
+        shouldn't be done for some reason (e.g. file format version changes and
+        a new extension should be used for saving).
+
+        @see GetDocumentSaved(), AlreadySaved()
+     */
+    void SetDocumentSaved(bool saved = true);
+

     /**
         Sets the filename for this document. Usually called by the framework.
 
     /**
         Sets the filename for this document. Usually called by the framework.
 

+        Calls OnChangeFilename() which in turn calls wxView::OnChangeFilename() for
+        all views if @a notifyViews is @true.
+    */
+    void SetFilename(const wxString& filename, bool notifyViews = false);
+
+    /**

         If @a notifyViews is @true, wxView::OnChangeFilename() is called for
         all views.
         If @a notifyViews is @true, wxView::OnChangeFilename() is called for
         all views.

+
+        @since 2.9.0

     */
     */

-    void SetFilename(const wxString& filename, bool notifyViews = false);
+    virtual void OnChangeFilename(bool notifyViews);

 
     /**
         Sets the title for this document. The document title is used for an
 
     /**
         Sets the title for this document. The document title is used for an


@@ -1337,152 +1553,11 @@ protected:
 };
 
 
 };
 
 

-
-/**
-    @class wxFileHistory
-
-    The wxFileHistory encapsulates a user interface convenience, the list of
-    most recently visited files as shown on a menu (usually the File menu).
-
-    wxFileHistory can manage one or more file menus. More than one menu may be
-    required in an MDI application, where the file history should appear on
-    each MDI child menu as well as the MDI parent frame.
-
-    @library{wxcore}
-    @category{docview}
-
-    @see @ref overview_docview, wxDocManager
-*/
-class wxFileHistory : public wxObject
-{
-public:
-    /**
-        Constructor. Pass the maximum number of files that should be stored and
-        displayed.
-
-        @a idBase defaults to wxID_FILE1 and represents the id given to the
-        first history menu item. Since menu items can't share the same ID you
-        should change @a idBase (to one of your own defined IDs) when using
-        more than one wxFileHistory in your application.
-    */
-    wxFileHistory(size_t maxFiles = 9, wxWindowID idBase = wxID_FILE1);
-
-    /**
-        Destructor.
-    */
-    virtual ~wxFileHistory();
-
-    /**
-        Adds a file to the file history list, if the object has a pointer to an
-        appropriate file menu.
-    */
-    virtual void AddFileToHistory(const wxString& filename);
-
-    /**
-        Appends the files in the history list, to all menus managed by the file
-        history object.
-    */
-    virtual void AddFilesToMenu();
-    /**
-        Appends the files in the history list, to the given menu only.
-    */
-    virtual void AddFilesToMenu(wxMenu* menu);
-
-    /**
-        Returns the base identifier for the range used for appending items.
-    */
-    wxWindowID GetBaseId() const;
-
-    /**
-        Returns the number of files currently stored in the file history.
-    */
-    virtual size_t GetCount() const;
-
-    /**
-        Returns the file at this index (zero-based).
-    */
-    virtual wxString GetHistoryFile(size_t index) const;
-
-    /**
-        Returns the maximum number of files that can be stored.
-    */
-    virtual int GetMaxFiles() const;
-
-    /**
-        Returns the list of menus that are managed by this file history object.
-
-        @see UseMenu()
-    */
-    const wxList& GetMenus() const;
-
-    /**
-        Loads the file history from the given config object. This function
-        should be called explicitly by the application.
-
-        @see wxConfigBase
-    */
-    virtual void Load(const wxConfigBase& config);
-
-    /**
-        Removes the specified file from the history.
-    */
-    virtual void RemoveFileFromHistory(size_t i);
-
-    /**
-        Removes this menu from the list of those managed by this object.
-    */
-    virtual void RemoveMenu(wxMenu* menu);
-
-    /**
-        Saves the file history into the given config object. This must be
-        called explicitly by the application.
-
-        @see wxConfigBase
-    */
-    virtual void Save(wxConfigBase& config);
-
-    /**
-        Sets the base identifier for the range used for appending items.
-    */
-    void SetBaseId(wxWindowID baseId);
-
-    /**
-        Adds this menu to the list of those menus that are managed by this file
-        history object. Also see AddFilesToMenu() for initializing the menu
-        with filenames that are already in the history when this function is
-        called, as this is not done automatically.
-    */
-    virtual void UseMenu(wxMenu* menu);
-
-    /**
-        A character array of strings corresponding to the most recently opened
-        files.
-    */
-    char** m_fileHistory;
-
-    /**
-        The number of files stored in the history array.
-    */
-    size_t m_fileHistoryN;
-
-    /**
-        The maximum number of files to be stored and displayed on the menu.
-    */
-    size_t m_fileMaxFiles;
-
-    /**
-        The file menu used to display the file history list (if enabled).
-    */
-    wxMenu* m_fileMenu;
-};
-
-
-

 // ============================================================================
 // Global functions/macros
 // ============================================================================
 
 // ============================================================================
 // Global functions/macros
 // ============================================================================
 

-/** @ingroup group_funcmacro_file */
+/** @addtogroup group_funcmacro_file */

 //@{
 
 /**
 //@{
 
 /**