added wxConvFileName which is a variable, not define as wxConvFile; added comments...

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

diff --git a/include/wx/docview.h b/include/wx/docview.h
index 11989e4c1a51610aca6902afda20a02ebb27cfd0..00c2fb976bb5e7b59c5fde7e509b41cadd4f477b 100644 (file)
--- a/include/wx/docview.h
+++ b/include/wx/docview.h
@@ -72,7 +72,7 @@ public:
     ~wxDocument();
 
     // accessors
     ~wxDocument();
 
     // accessors

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

     wxString GetFilename() const { return m_documentFile; }
 
     void SetTitle(const wxString& title) { m_documentTitle = title; };
     wxString GetFilename() const { return m_documentFile; }
 
     void SetTitle(const wxString& title) { m_documentTitle = title; };


@@ -82,7 +82,7 @@ public:
     wxString GetDocumentName() const { return m_documentTypeName; }
 
     bool GetDocumentSaved() const { return m_savedYet; }
     wxString GetDocumentName() const { return m_documentTypeName; }
 
     bool GetDocumentSaved() const { return m_savedYet; }

-    void SetDocumentSaved(bool saved = TRUE) { m_savedYet = saved; }
+    void SetDocumentSaved(bool saved = true) { m_savedYet = saved; }

 
     virtual bool Close();
     virtual bool Save();
 
     virtual bool Close();
     virtual bool Save();


@@ -97,15 +97,15 @@ public:
     virtual wxInputStream& LoadObject(wxInputStream& stream);
 #endif
 
     virtual wxInputStream& LoadObject(wxInputStream& stream);
 #endif
 

-    // Called by wxWindows
+    // Called by wxWidgets

     virtual bool OnSaveDocument(const wxString& filename);
     virtual bool OnOpenDocument(const wxString& filename);
     virtual bool OnNewDocument();
     virtual bool OnCloseDocument();
 
     virtual bool OnSaveDocument(const wxString& filename);
     virtual bool OnOpenDocument(const wxString& filename);
     virtual bool OnNewDocument();
     virtual bool OnCloseDocument();
 

-    // Prompts for saving if about to close a modified document. Returns TRUE
+    // Prompts for saving if about to close a modified document. Returns true

     // if ok to close the document (may have saved in the meantime, or set
     // if ok to close the document (may have saved in the meantime, or set

-    // modified to FALSE)
+    // modified to false)

     virtual bool OnSaveModified();
 
     // Called by framework if created automatically by the default document
     virtual bool OnSaveModified();
 
     // Called by framework if created automatically by the default document


@@ -162,6 +162,12 @@ protected:
     wxCommandProcessor*   m_commandProcessor;
     bool                  m_savedYet;
 
     wxCommandProcessor*   m_commandProcessor;
     bool                  m_savedYet;
 

+    // Called by OnSaveDocument and OnOpenDocument to implement standard
+    // Save/Load behavior. Re-implement in derived class for custom
+    // behavior.
+    virtual bool DoSaveDocument(const wxString& file);
+    virtual bool DoOpenDocument(const wxString& file);
+

 private:
     DECLARE_ABSTRACT_CLASS(wxDocument)
     DECLARE_NO_COPY_CLASS(wxDocument)
 private:
     DECLARE_ABSTRACT_CLASS(wxDocument)
     DECLARE_NO_COPY_CLASS(wxDocument)


@@ -187,17 +193,17 @@ public:
     virtual void OnDraw(wxDC *dc) = 0;
     virtual void OnPrint(wxDC *dc, wxObject *info);
     virtual void OnUpdate(wxView *sender, wxObject *hint = (wxObject *) NULL);
     virtual void OnDraw(wxDC *dc) = 0;
     virtual void OnPrint(wxDC *dc, wxObject *info);
     virtual void OnUpdate(wxView *sender, wxObject *hint = (wxObject *) NULL);

-    virtual void OnClosingDocument() {};
+    virtual void OnClosingDocument() {}

     virtual void OnChangeFilename();
 
     // Called by framework if created automatically by the default document
     // manager class: gives view a chance to initialise
     virtual void OnChangeFilename();
 
     // Called by framework if created automatically by the default document
     // manager class: gives view a chance to initialise

-    virtual bool OnCreate(wxDocument *WXUNUSED(doc), long WXUNUSED(flags)) { return TRUE; };
+    virtual bool OnCreate(wxDocument *WXUNUSED(doc), long WXUNUSED(flags)) { return true; };

 
     // Checks if the view is the last one for the document; if so, asks user
     // to confirm save data (if modified). If ok, deletes itself and returns
 
     // Checks if the view is the last one for the document; if so, asks user
     // to confirm save data (if modified). If ok, deletes itself and returns

-    // TRUE.
-    virtual bool Close(bool deleteWindow = TRUE);
+    // true.
+    virtual bool Close(bool deleteWindow = true);

 
     // Override to do cleanup/veto close
     virtual bool OnClose(bool deleteWindow);
 
     // Override to do cleanup/veto close
     virtual bool OnClose(bool deleteWindow);


@@ -254,6 +260,10 @@ public:
     virtual wxDocument *CreateDocument(const wxString& path, long flags = 0);
     virtual wxView *CreateView(wxDocument *doc, long flags = 0);
 
     virtual wxDocument *CreateDocument(const wxString& path, long flags = 0);
     virtual wxView *CreateView(wxDocument *doc, long flags = 0);
 

+    // Helper method for CreateDocument; also allows you to do your own document
+    // creation
+    virtual bool InitDocument(wxDocument* doc, const wxString& path, long flags = 0);
+

     wxString GetDefaultExtension() const { return m_defaultExt; };
     wxString GetDescription() const { return m_description; }
     wxString GetDirectory() const { return m_directory; };
     wxString GetDefaultExtension() const { return m_defaultExt; };
     wxString GetDescription() const { return m_description; }
     wxString GetDirectory() const { return m_directory; };


@@ -272,6 +282,9 @@ public:
 
     bool IsVisible() const { return ((m_flags & wxTEMPLATE_VISIBLE) == wxTEMPLATE_VISIBLE); }
 
 
     bool IsVisible() const { return ((m_flags & wxTEMPLATE_VISIBLE) == wxTEMPLATE_VISIBLE); }
 

+    wxClassInfo* GetDocClassInfo() const { return m_docClassInfo; }
+    wxClassInfo* GetViewClassInfo() const { return m_viewClassInfo; }
+

     virtual bool FileMatchesTemplate(const wxString& path);
 
 protected:
     virtual bool FileMatchesTemplate(const wxString& path);
 
 protected:


@@ -288,6 +301,12 @@ protected:
     wxClassInfo*      m_docClassInfo;
     wxClassInfo*      m_viewClassInfo;
 
     wxClassInfo*      m_docClassInfo;
     wxClassInfo*      m_viewClassInfo;
 

+    // Called by CreateDocument and CreateView to create the actual document/view object.
+    // By default uses the ClassInfo provided to the constructor. Override these functions
+    // to provide a different method of creation.
+    virtual wxDocument *DoCreateDocument();
+    virtual wxView *DoCreateView();
+

 private:
     DECLARE_CLASS(wxDocTemplate)
     DECLARE_NO_COPY_CLASS(wxDocTemplate)
 private:
     DECLARE_CLASS(wxDocTemplate)
     DECLARE_NO_COPY_CLASS(wxDocTemplate)


@@ -298,7 +317,7 @@ private:
 class WXDLLEXPORT wxDocManager: public wxEvtHandler
 {
 public:
 class WXDLLEXPORT wxDocManager: public wxEvtHandler
 {
 public:

-    wxDocManager(long flags = wxDEFAULT_DOCMAN_FLAGS, bool initialize = TRUE);
+    wxDocManager(long flags = wxDEFAULT_DOCMAN_FLAGS, bool initialize = true);

     ~wxDocManager();
 
     virtual bool Initialize();
     ~wxDocManager();
 
     virtual bool Initialize();


@@ -312,7 +331,6 @@ public:
     void OnFileSave(wxCommandEvent& event);
     void OnFileSaveAs(wxCommandEvent& event);
     void OnPrint(wxCommandEvent& event);
     void OnFileSave(wxCommandEvent& event);
     void OnFileSaveAs(wxCommandEvent& event);
     void OnPrint(wxCommandEvent& event);

-    void OnPrintSetup(wxCommandEvent& event);

     void OnPreview(wxCommandEvent& event);
     void OnUndo(wxCommandEvent& event);
     void OnRedo(wxCommandEvent& event);
     void OnPreview(wxCommandEvent& event);
     void OnUndo(wxCommandEvent& event);
     void OnRedo(wxCommandEvent& event);


@@ -328,7 +346,6 @@ public:
     void OnUpdateRedo(wxUpdateUIEvent& event);
 
     void OnUpdatePrint(wxUpdateUIEvent& event);
     void OnUpdateRedo(wxUpdateUIEvent& event);
 
     void OnUpdatePrint(wxUpdateUIEvent& event);

-    void OnUpdatePrintSetup(wxUpdateUIEvent& event);

     void OnUpdatePreview(wxUpdateUIEvent& event);
 
     // Extend event processing to search the view's event table
     void OnUpdatePreview(wxUpdateUIEvent& event);
 
     // Extend event processing to search the view's event table


@@ -344,11 +361,11 @@ public:
     virtual bool FlushDoc(wxDocument *doc);
     virtual wxDocTemplate *MatchTemplate(const wxString& path);
     virtual wxDocTemplate *SelectDocumentPath(wxDocTemplate **templates,
     virtual bool FlushDoc(wxDocument *doc);
     virtual wxDocTemplate *MatchTemplate(const wxString& path);
     virtual wxDocTemplate *SelectDocumentPath(wxDocTemplate **templates,

-            int noTemplates, wxString& path, long flags, bool save = FALSE);
+            int noTemplates, wxString& path, long flags, bool save = false);

     virtual wxDocTemplate *SelectDocumentType(wxDocTemplate **templates,
     virtual wxDocTemplate *SelectDocumentType(wxDocTemplate **templates,

-            int noTemplates, bool sort = FALSE);
+            int noTemplates, bool sort = false);

     virtual wxDocTemplate *SelectViewType(wxDocTemplate **templates,
     virtual wxDocTemplate *SelectViewType(wxDocTemplate **templates,

-            int noTemplates, bool sort = FALSE);
+            int noTemplates, bool sort = false);

     virtual wxDocTemplate *FindTemplateForPath(const wxString& path);
 
     void AssociateTemplate(wxDocTemplate *temp);
     virtual wxDocTemplate *FindTemplateForPath(const wxString& path);
 
     void AssociateTemplate(wxDocTemplate *temp);


@@ -364,17 +381,17 @@ public:
     void RemoveDocument(wxDocument *doc);
 
     // closes all currently open documents
     void RemoveDocument(wxDocument *doc);
 
     // closes all currently open documents

-    bool CloseDocuments(bool force = TRUE);
+    bool CloseDocuments(bool force = true);

 
     // closes the specified document
 
     // closes the specified document

-    bool CloseDocument(wxDocument* doc, bool force = FALSE);
+    bool CloseDocument(wxDocument* doc, bool force = false);

 
     // Clear remaining documents and templates
 
     // Clear remaining documents and templates

-    bool Clear(bool force = TRUE);
+    bool Clear(bool force = true);

 
     // Views or windows should inform the document manager
     // when a view is going in or out of focus
 
     // Views or windows should inform the document manager
     // when a view is going in or out of focus

-    virtual void ActivateView(wxView *view, bool activate = TRUE);
+    virtual void ActivateView(wxView *view, bool activate = true);

     virtual wxView *GetCurrentView() const;
 
     wxList& GetDocuments() { return m_docs; }
     virtual wxView *GetCurrentView() const;
 
     wxList& GetDocuments() { return m_docs; }


@@ -450,7 +467,7 @@ public:
                     const wxSize& size = wxDefaultSize,
                     long type = wxDEFAULT_FRAME_STYLE,
                     const wxString& name = wxT("frame"));
                     const wxSize& size = wxDefaultSize,
                     long type = wxDEFAULT_FRAME_STYLE,
                     const wxString& name = wxT("frame"));

-    ~wxDocChildFrame();
+    ~wxDocChildFrame(){}

 
     // Extend event processing to search the view's event table
     virtual bool ProcessEvent(wxEvent& event);
 
     // Extend event processing to search the view's event table
     virtual bool ProcessEvent(wxEvent& event);


@@ -546,7 +563,7 @@ public:
     // Operations
     virtual void AddFileToHistory(const wxString& file);
     virtual void RemoveFileFromHistory(size_t i);
     // Operations
     virtual void AddFileToHistory(const wxString& file);
     virtual void RemoveFileFromHistory(size_t i);

-    virtual int GetMaxFiles() const { return m_fileMaxFiles; }
+    virtual int GetMaxFiles() const { return (int)m_fileMaxFiles; }

     virtual void UseMenu(wxMenu *menu);
 
     // Remove menu from the list (MDI child may be closing)
     virtual void UseMenu(wxMenu *menu);
 
     // Remove menu from the list (MDI child may be closing)