X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/2b5f62a0b2db198609b45dec622a018dae37008e..95a8b77a948f58735eeb1cf41ae4263deb6096e9:/include/wx/docview.h diff --git a/include/wx/docview.h b/include/wx/docview.h index 0a6ca711f4..94a13b2cc5 100644 --- a/include/wx/docview.h +++ b/include/wx/docview.h @@ -12,11 +12,14 @@ #ifndef _WX_DOCH__ #define _WX_DOCH__ -#if defined(__GNUG__) && !defined(__APPLE__) +#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA) #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" @@ -37,7 +40,7 @@ class WXDLLEXPORT wxFileHistory; class WXDLLEXPORT wxConfigBase; #if wxUSE_STD_IOSTREAM - #include "wx/ioswrap.h" + #include "wx/iosfwrap.h" #else #include "wx/stream.h" #endif @@ -94,7 +97,7 @@ public: 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(); @@ -158,9 +161,16 @@ protected: wxDocument* m_documentParent; 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) }; class WXDLLEXPORT wxView: public wxEvtHandler @@ -198,11 +208,6 @@ public: // 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); @@ -221,9 +226,10 @@ protected: wxDocument* m_viewDocument; wxString m_viewTypeName; wxWindow* m_viewFrame; - + private: DECLARE_ABSTRACT_CLASS(wxView) + DECLARE_NO_COPY_CLASS(wxView) }; // Represents user interface (and other) properties of documents and views @@ -254,6 +260,10 @@ public: 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; }; @@ -272,6 +282,9 @@ public: 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: @@ -287,17 +300,22 @@ protected: // For dynamic creation of appropriate instances. 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) }; // 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(); @@ -367,12 +385,15 @@ public: // 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 - 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; } @@ -389,9 +410,9 @@ public: // 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 @@ -402,12 +423,15 @@ public: 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; } + // deprecated, use GetHistoryFilesCount() instead + wxDEPRECATED( size_t GetNoHistoryFiles() const ); + protected: long m_flags; int m_defaultDocumentNameCounter; @@ -420,8 +444,15 @@ protected: 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 // ---------------------------------------------------------------------------- @@ -459,6 +490,7 @@ protected: private: DECLARE_CLASS(wxDocChildFrame) DECLARE_EVENT_TABLE() + DECLARE_NO_COPY_CLASS(wxDocChildFrame) }; // ---------------------------------------------------------------------------- @@ -492,6 +524,7 @@ protected: private: DECLARE_CLASS(wxDocParentFrame) DECLARE_EVENT_TABLE() + DECLARE_NO_COPY_CLASS(wxDocParentFrame) }; // ---------------------------------------------------------------------------- @@ -515,6 +548,7 @@ protected: private: DECLARE_DYNAMIC_CLASS(wxDocPrintout) + DECLARE_NO_COPY_CLASS(wxDocPrintout) }; #endif // wxUSE_PRINTING_ARCHITECTURE @@ -525,12 +559,12 @@ private: class WXDLLEXPORT wxFileHistory : public wxObject { public: - wxFileHistory(int maxFiles = 9); + wxFileHistory(size_t maxFiles = 9, wxWindowID idBase = wxID_FILE1); ~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); @@ -546,28 +580,37 @@ public: 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 - int m_fileHistoryN; + size_t m_fileHistoryN; // 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. @@ -578,6 +621,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); -#endif +#endif // wxUSE_STD_IOSTREAM + +#endif // wxUSE_DOC_VIEW_ARCHITECTURE #endif // _WX_DOCH__