added and documented wxWindow::MoveBefore/AfterInTabOrder()

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

diff --git a/include/wx/docview.h b/include/wx/docview.h
index b564db1b67bef95296626fa31e2e44caca7a81e5..0d005d04b6c4717117bc9d05df7b27c2575f2d20 100644 (file)
--- a/include/wx/docview.h
+++ b/include/wx/docview.h
@@ -12,11 +12,14 @@
 #ifndef _WX_DOCH__
 #define _WX_DOCH__
 
 #ifndef _WX_DOCH__
 #define _WX_DOCH__
 

-#ifdef __GNUG__
+#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)

     #pragma interface "docview.h"
 #endif
 
 #include "wx/defs.h"
     #pragma interface "docview.h"
 #endif
 
 #include "wx/defs.h"

+
+#if wxUSE_DOC_VIEW_ARCHITECTURE
+

 #include "wx/list.h"
 #include "wx/cmndata.h"
 #include "wx/string.h"
 #include "wx/list.h"
 #include "wx/cmndata.h"
 #include "wx/string.h"


@@ -37,7 +40,7 @@ class WXDLLEXPORT wxFileHistory;
 class WXDLLEXPORT wxConfigBase;
 
 #if wxUSE_STD_IOSTREAM
 class WXDLLEXPORT wxConfigBase;
 
 #if wxUSE_STD_IOSTREAM

-  #include "wx/ioswrap.h"
+  #include "wx/iosfwrap.h"

 #else
   #include "wx/stream.h"
 #endif
 #else
   #include "wx/stream.h"
 #endif


@@ -64,8 +67,6 @@ enum
 
 class WXDLLEXPORT wxDocument : public wxEvtHandler
 {
 
 class WXDLLEXPORT wxDocument : public wxEvtHandler
 {

-    DECLARE_ABSTRACT_CLASS(wxDocument)
-

 public:
     wxDocument(wxDocument *parent = (wxDocument *) NULL);
     ~wxDocument();
 public:
     wxDocument(wxDocument *parent = (wxDocument *) NULL);
     ~wxDocument();


@@ -96,7 +97,7 @@ 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 OnSaveDocument(const wxString& filename);
     virtual bool OnOpenDocument(const wxString& filename);
     virtual bool OnNewDocument();


@@ -133,6 +134,7 @@ public:
     wxView *GetFirstView() const;
 
     virtual void UpdateAllViews(wxView *sender = (wxView *) NULL, wxObject *hint = (wxObject *) NULL);
     wxView *GetFirstView() const;
 
     virtual void UpdateAllViews(wxView *sender = (wxView *) NULL, wxObject *hint = (wxObject *) NULL);

+    virtual void NotifyClosing();

 
     // Remove all views (because we're closing the document)
     virtual bool DeleteAllViews();
 
     // Remove all views (because we're closing the document)
     virtual bool DeleteAllViews();


@@ -159,30 +161,33 @@ protected:
     wxDocument*           m_documentParent;
     wxCommandProcessor*   m_commandProcessor;
     bool                  m_savedYet;
     wxDocument*           m_documentParent;
     wxCommandProcessor*   m_commandProcessor;
     bool                  m_savedYet;

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

 };
 
 class WXDLLEXPORT wxView: public wxEvtHandler
 {
 };
 
 class WXDLLEXPORT wxView: public wxEvtHandler
 {

-    DECLARE_ABSTRACT_CLASS(wxView)
-

 public:
     //  wxView(wxDocument *doc = (wxDocument *) NULL);
     wxView();
     ~wxView();
 
     wxDocument *GetDocument() const { return m_viewDocument; }
 public:
     //  wxView(wxDocument *doc = (wxDocument *) NULL);
     wxView();
     ~wxView();
 
     wxDocument *GetDocument() const { return m_viewDocument; }

-    void SetDocument(wxDocument *doc);
+    virtual void SetDocument(wxDocument *doc);

 
     wxString GetViewName() const { return m_viewTypeName; }
     void SetViewName(const wxString& name) { m_viewTypeName = name; };
 
 
     wxString GetViewName() const { return m_viewTypeName; }
     void SetViewName(const wxString& name) { m_viewTypeName = name; };
 

-    wxFrame *GetFrame() const { return m_viewFrame ; }
-    void SetFrame(wxFrame *frame) { m_viewFrame = frame; }
+    wxWindow *GetFrame() const { return m_viewFrame ; }
+    void SetFrame(wxWindow *frame) { m_viewFrame = frame; }

 
     virtual void OnActivateView(bool activate, wxView *activeView, wxView *deactiveView);
     virtual void OnDraw(wxDC *dc) = 0;
     virtual void OnPrint(wxDC *dc, wxObject *info);
     virtual void OnUpdate(wxView *sender, wxObject *hint = (wxObject *) NULL);
 
     virtual void OnActivateView(bool activate, wxView *activeView, wxView *deactiveView);
     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 OnChangeFilename();
 
     // Called by framework if created automatically by the default document
     virtual void OnChangeFilename();
 
     // Called by framework if created automatically by the default document


@@ -197,11 +202,6 @@ public:
     // Override to do cleanup/veto close
     virtual bool OnClose(bool deleteWindow);
 
     // Override to do cleanup/veto close
     virtual bool OnClose(bool deleteWindow);
 

-#if WXWIN_COMPATIBILITY
-    // Defeat compiler warning
-    bool OnClose() { return wxEvtHandler::OnClose(); }
-#endif
-

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


@@ -219,13 +219,16 @@ public:
 protected:
     wxDocument*       m_viewDocument;
     wxString          m_viewTypeName;
 protected:
     wxDocument*       m_viewDocument;
     wxString          m_viewTypeName;

-    wxFrame*          m_viewFrame;
+    wxWindow*         m_viewFrame;
+
+private:
+    DECLARE_ABSTRACT_CLASS(wxView)
+    DECLARE_NO_COPY_CLASS(wxView)

 };
 
 // Represents user interface (and other) properties of documents and views
 class WXDLLEXPORT wxDocTemplate: public wxObject
 {
 };
 
 // Represents user interface (and other) properties of documents and views
 class WXDLLEXPORT wxDocTemplate: public wxObject
 {

-DECLARE_CLASS(wxDocTemplate)

 
 friend class WXDLLEXPORT wxDocManager;
 
 
 friend class WXDLLEXPORT wxDocManager;
 


@@ -251,6 +254,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; };


@@ -269,6 +276,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:


@@ -284,14 +294,16 @@ protected:
     // For dynamic creation of appropriate instances.
     wxClassInfo*      m_docClassInfo;
     wxClassInfo*      m_viewClassInfo;
     // For dynamic creation of appropriate instances.
     wxClassInfo*      m_docClassInfo;
     wxClassInfo*      m_viewClassInfo;

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

 };
 
 // One object of this class may be created in an application, to manage all
 // the templates and documents.
 class WXDLLEXPORT wxDocManager: public wxEvtHandler
 {
 };
 
 // One object of this class may be created in an application, to manage all
 // the templates and documents.
 class WXDLLEXPORT wxDocManager: public wxEvtHandler
 {

-    DECLARE_DYNAMIC_CLASS(wxDocManager)
-

 public:
     wxDocManager(long flags = wxDEFAULT_DOCMAN_FLAGS, bool initialize = TRUE);
     ~wxDocManager();
 public:
     wxDocManager(long flags = wxDEFAULT_DOCMAN_FLAGS, bool initialize = TRUE);
     ~wxDocManager();


@@ -300,6 +312,7 @@ public:
 
     // Handlers for common user commands
     void OnFileClose(wxCommandEvent& event);
 
     // Handlers for common user commands
     void OnFileClose(wxCommandEvent& event);

+    void OnFileCloseAll(wxCommandEvent& event);

     void OnFileNew(wxCommandEvent& event);
     void OnFileOpen(wxCommandEvent& event);
     void OnFileRevert(wxCommandEvent& event);
     void OnFileNew(wxCommandEvent& event);
     void OnFileOpen(wxCommandEvent& event);
     void OnFileRevert(wxCommandEvent& event);


@@ -330,9 +343,6 @@ public:
 
     // called when file format detection didn't work, can be overridden to do
     // something in this case
 
     // called when file format detection didn't work, can be overridden to do
     // something in this case

-    // This is of course completely stupid, because if the file dialog is
-    // cancelled you get an assert. Brilliant. -- JACS
-//    virtual void OnOpenFileFailure() { wxFAIL_MSG(_T("file format mismatch")); }

     virtual void OnOpenFileFailure() { }
 
     virtual wxDocument *CreateDocument(const wxString& path, long flags = 0);
     virtual void OnOpenFileFailure() { }
 
     virtual wxDocument *CreateDocument(const wxString& path, long flags = 0);


@@ -360,12 +370,18 @@ public:
     void AddDocument(wxDocument *doc);
     void RemoveDocument(wxDocument *doc);
 
     void AddDocument(wxDocument *doc);
     void RemoveDocument(wxDocument *doc);
 

+    // closes all currently open documents
+    bool CloseDocuments(bool force = TRUE);
+
+    // closes the specified document
+    bool CloseDocument(wxDocument* doc, bool force = FALSE);
+

     // Clear remaining documents and templates
     bool Clear(bool force = TRUE);
 
     // Views or windows should inform the document manager
     // when a view is going in or out of focus
     // Clear remaining documents and templates
     bool Clear(bool force = TRUE);
 
     // 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, bool deleting = FALSE);
+    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; }


@@ -382,9 +398,9 @@ public:
 
     // File history management
     virtual void AddFileToHistory(const wxString& file);
 
     // File history management
     virtual void AddFileToHistory(const wxString& file);

-    virtual void RemoveFileFromHistory(int i);
-    virtual int GetNoHistoryFiles() const;
-    virtual wxString GetHistoryFile(int i) const;
+    virtual void RemoveFileFromHistory(size_t i);
+    virtual size_t GetHistoryFilesCount() const;
+    virtual wxString GetHistoryFile(size_t i) const;

     virtual void FileHistoryUseMenu(wxMenu *menu);
     virtual void FileHistoryRemoveMenu(wxMenu *menu);
 #if wxUSE_CONFIG
     virtual void FileHistoryUseMenu(wxMenu *menu);
     virtual void FileHistoryRemoveMenu(wxMenu *menu);
 #if wxUSE_CONFIG


@@ -395,12 +411,15 @@ public:
     virtual void FileHistoryAddFilesToMenu();
     virtual void FileHistoryAddFilesToMenu(wxMenu* menu);
 
     virtual void FileHistoryAddFilesToMenu();
     virtual void FileHistoryAddFilesToMenu(wxMenu* menu);
 

-    inline wxString GetLastDirectory() const { return m_lastDirectory; }
-    inline void SetLastDirectory(const wxString& dir) { m_lastDirectory = dir; }
+    wxString GetLastDirectory() const { return m_lastDirectory; }
+    void SetLastDirectory(const wxString& dir) { m_lastDirectory = dir; }

 
     // Get the current document manager
     static wxDocManager* GetDocumentManager() { return sm_docManager; }
 
 
     // Get the current document manager
     static wxDocManager* GetDocumentManager() { return sm_docManager; }
 

+    // deprecated, use GetHistoryFilesCount() instead
+    wxDEPRECATED( size_t GetNoHistoryFiles() const );
+

 protected:
     long              m_flags;
     int               m_defaultDocumentNameCounter;
 protected:
     long              m_flags;
     int               m_defaultDocumentNameCounter;


@@ -413,16 +432,21 @@ protected:
     static wxDocManager* sm_docManager;
 
     DECLARE_EVENT_TABLE()
     static wxDocManager* sm_docManager;
 
     DECLARE_EVENT_TABLE()

+    DECLARE_DYNAMIC_CLASS(wxDocManager)
+    DECLARE_NO_COPY_CLASS(wxDocManager)

 };
 
 };
 

+inline size_t wxDocManager::GetNoHistoryFiles() const
+{
+    return GetHistoryFilesCount();
+}
+

 // ----------------------------------------------------------------------------
 // A default child frame
 // ----------------------------------------------------------------------------
 
 class WXDLLEXPORT wxDocChildFrame : public wxFrame
 {
 // ----------------------------------------------------------------------------
 // A default child frame
 // ----------------------------------------------------------------------------
 
 class WXDLLEXPORT wxDocChildFrame : public wxFrame
 {

-    DECLARE_CLASS(wxDocChildFrame)
-

 public:
     wxDocChildFrame(wxDocument *doc,
                     wxView *view,
 public:
     wxDocChildFrame(wxDocument *doc,
                     wxView *view,


@@ -432,7 +456,7 @@ public:
                     const wxPoint& pos = wxDefaultPosition,
                     const wxSize& size = wxDefaultSize,
                     long type = wxDEFAULT_FRAME_STYLE,
                     const wxPoint& pos = wxDefaultPosition,
                     const wxSize& size = wxDefaultSize,
                     long type = wxDEFAULT_FRAME_STYLE,

-                    const wxString& name = "frame");
+                    const wxString& name = wxT("frame"));

     ~wxDocChildFrame();
 
     // Extend event processing to search the view's event table
     ~wxDocChildFrame();
 
     // Extend event processing to search the view's event table


@@ -451,7 +475,10 @@ protected:
     wxDocument*       m_childDocument;
     wxView*           m_childView;
 
     wxDocument*       m_childDocument;
     wxView*           m_childView;
 

+private:
+    DECLARE_CLASS(wxDocChildFrame)

     DECLARE_EVENT_TABLE()
     DECLARE_EVENT_TABLE()

+    DECLARE_NO_COPY_CLASS(wxDocChildFrame)

 };
 
 // ----------------------------------------------------------------------------
 };
 
 // ----------------------------------------------------------------------------


@@ -460,8 +487,6 @@ protected:
 
 class WXDLLEXPORT wxDocParentFrame : public wxFrame
 {
 
 class WXDLLEXPORT wxDocParentFrame : public wxFrame
 {

-    DECLARE_CLASS(wxDocParentFrame)
-

 public:
     wxDocParentFrame(wxDocManager *manager,
                      wxFrame *frame,
 public:
     wxDocParentFrame(wxDocManager *manager,
                      wxFrame *frame,


@@ -470,7 +495,7 @@ public:
                      const wxPoint& pos = wxDefaultPosition,
                      const wxSize& size = wxDefaultSize,
                      long type = wxDEFAULT_FRAME_STYLE,
                      const wxPoint& pos = wxDefaultPosition,
                      const wxSize& size = wxDefaultSize,
                      long type = wxDEFAULT_FRAME_STYLE,

-                     const wxString& name = "frame");
+                     const wxString& name = wxT("frame"));

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


@@ -484,7 +509,10 @@ public:
 protected:
     wxDocManager *m_docManager;
 
 protected:
     wxDocManager *m_docManager;
 

+private:
+    DECLARE_CLASS(wxDocParentFrame)

     DECLARE_EVENT_TABLE()
     DECLARE_EVENT_TABLE()

+    DECLARE_NO_COPY_CLASS(wxDocParentFrame)

 };
 
 // ----------------------------------------------------------------------------
 };
 
 // ----------------------------------------------------------------------------


@@ -494,10 +522,8 @@ protected:
 #if wxUSE_PRINTING_ARCHITECTURE
 class WXDLLEXPORT wxDocPrintout : public wxPrintout
 {
 #if wxUSE_PRINTING_ARCHITECTURE
 class WXDLLEXPORT wxDocPrintout : public wxPrintout
 {

-    DECLARE_DYNAMIC_CLASS(wxDocPrintout)
-

 public:
 public:

-    wxDocPrintout(wxView *view = (wxView *) NULL, const wxString& title = "Printout");
+    wxDocPrintout(wxView *view = (wxView *) NULL, const wxString& title = wxT("Printout"));

     bool OnPrintPage(int page);
     bool HasPage(int page);
     bool OnBeginDocument(int startPage, int endPage);
     bool OnPrintPage(int page);
     bool HasPage(int page);
     bool OnBeginDocument(int startPage, int endPage);


@@ -507,6 +533,10 @@ public:
 
 protected:
     wxView*       m_printoutView;
 
 protected:
     wxView*       m_printoutView;

+
+private:
+    DECLARE_DYNAMIC_CLASS(wxDocPrintout)
+    DECLARE_NO_COPY_CLASS(wxDocPrintout)

 };
 #endif // wxUSE_PRINTING_ARCHITECTURE
 
 };
 #endif // wxUSE_PRINTING_ARCHITECTURE
 


@@ -516,15 +546,13 @@ protected:
 
 class WXDLLEXPORT wxFileHistory : public wxObject
 {
 
 class WXDLLEXPORT wxFileHistory : public wxObject
 {

-    DECLARE_DYNAMIC_CLASS(wxFileHistory)
-

 public:
 public:

-    wxFileHistory(int maxFiles = 9);
+    wxFileHistory(size_t maxFiles = 9, wxWindowID idBase = wxID_FILE1);

     ~wxFileHistory();
 
     // Operations
     virtual void AddFileToHistory(const wxString& file);
     ~wxFileHistory();
 
     // Operations
     virtual void AddFileToHistory(const wxString& file);

-    virtual void RemoveFileFromHistory(int i);
+    virtual void RemoveFileFromHistory(size_t i);

     virtual int GetMaxFiles() const { return m_fileMaxFiles; }
     virtual void UseMenu(wxMenu *menu);
 
     virtual int GetMaxFiles() const { return m_fileMaxFiles; }
     virtual void UseMenu(wxMenu *menu);
 


@@ -540,25 +568,37 @@ public:
     virtual void AddFilesToMenu(wxMenu* menu); // Single menu
 
     // Accessors
     virtual void AddFilesToMenu(wxMenu* menu); // Single menu
 
     // Accessors

-    virtual wxString GetHistoryFile(int i) const;
+    virtual wxString GetHistoryFile(size_t i) const;
+    virtual size_t GetCount() const { return m_fileHistoryN; }

 
 

-    // A synonym for GetNoHistoryFiles
-    virtual int GetCount() const { return m_fileHistoryN; }
-    int GetNoHistoryFiles() const { return m_fileHistoryN; }
+    const wxList& GetMenus() const { return m_fileMenus; }

 
 

-    wxList& GetMenus() const { return (wxList&) m_fileMenus; }
+    // deprecated, use GetCount() instead
+    wxDEPRECATED( size_t GetNoHistoryFiles() const );

 
 protected:
     // Last n files
     wxChar**          m_fileHistory;
     // Number of files saved
 
 protected:
     // Last n files
     wxChar**          m_fileHistory;
     // Number of files saved

-    int               m_fileHistoryN;
+    size_t            m_fileHistoryN;

     // Menus to maintain (may need several for an MDI app)
     wxList            m_fileMenus;
     // Max files to maintain
     // Menus to maintain (may need several for an MDI app)
     wxList            m_fileMenus;
     // Max files to maintain

-    int               m_fileMaxFiles;
+    size_t            m_fileMaxFiles;
+
+private:
+    // The ID of the first history menu item (Doesn't have to be wxID_FILE1)
+    wxWindowID m_idBase;
+
+    DECLARE_DYNAMIC_CLASS(wxFileHistory)
+    DECLARE_NO_COPY_CLASS(wxFileHistory)

 };
 
 };
 

+inline size_t wxFileHistory::GetNoHistoryFiles() const
+{
+    return m_fileHistoryN;
+}
+

 #if wxUSE_STD_IOSTREAM
 // For compatibility with existing file formats:
 // converts from/to a stream to/from a temporary file.
 #if wxUSE_STD_IOSTREAM
 // For compatibility with existing file formats:
 // converts from/to a stream to/from a temporary file.


@@ -569,6 +609,8 @@ bool WXDLLEXPORT wxTransferStreamToFile(wxSTD istream& stream, const wxString& f
 // converts from/to a stream to/from a temporary file.
 bool WXDLLEXPORT wxTransferFileToStream(const wxString& filename, wxOutputStream& stream);
 bool WXDLLEXPORT wxTransferStreamToFile(wxInputStream& stream, const wxString& filename);
 // converts from/to a stream to/from a temporary file.
 bool WXDLLEXPORT wxTransferFileToStream(const wxString& filename, wxOutputStream& stream);
 bool WXDLLEXPORT wxTransferStreamToFile(wxInputStream& stream, const wxString& filename);

-#endif
+#endif // wxUSE_STD_IOSTREAM
+
+#endif // wxUSE_DOC_VIEW_ARCHITECTURE

 
 #endif // _WX_DOCH__
 
 #endif // _WX_DOCH__