X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/ac0ac8241f5ea7249ea01c04452efc0b72f49b1f..39de6d6ca1dd08e07d7a71581eaa22cd1ece836d:/include/wx/docview.h diff --git a/include/wx/docview.h b/include/wx/docview.h index 39854b9847..381dd1ac1a 100644 --- a/include/wx/docview.h +++ b/include/wx/docview.h @@ -5,21 +5,25 @@ // Modified by: // Created: 01/02/97 // RCS-ID: $Id$ -// Copyright: (c) +// Copyright: (c) Julian Smart // Licence: wxWindows licence ///////////////////////////////////////////////////////////////////////////// #ifndef _WX_DOCH__ #define _WX_DOCH__ -#ifdef __GNUG__ +#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" +#include "wx/frame.h" #if wxUSE_PRINTING_ARCHITECTURE #include "wx/print.h" @@ -31,13 +35,12 @@ class WXDLLEXPORT wxView; class WXDLLEXPORT wxDocTemplate; class WXDLLEXPORT wxDocManager; class WXDLLEXPORT wxPrintInfo; -class WXDLLEXPORT wxCommand; class WXDLLEXPORT wxCommandProcessor; class WXDLLEXPORT wxFileHistory; class WXDLLEXPORT wxConfigBase; #if wxUSE_STD_IOSTREAM - #include "wx/ioswrap.h" + #include "wx/iosfwrap.h" #else #include "wx/stream.h" #endif @@ -64,14 +67,12 @@ enum class WXDLLEXPORT wxDocument : public wxEvtHandler { - DECLARE_ABSTRACT_CLASS(wxDocument) - public: wxDocument(wxDocument *parent = (wxDocument *) NULL); ~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; }; @@ -81,7 +82,7 @@ public: 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(); @@ -89,27 +90,22 @@ public: virtual bool Revert(); #if wxUSE_STD_IOSTREAM - virtual ostream& SaveObject(ostream& stream); - virtual istream& LoadObject(istream& stream); + virtual wxSTD ostream& SaveObject(wxSTD ostream& stream); + virtual wxSTD istream& LoadObject(wxSTD istream& stream); #else virtual wxOutputStream& SaveObject(wxOutputStream& stream); virtual wxInputStream& LoadObject(wxInputStream& stream); #endif -#if wxUSE_SERIAL - // need this to keep from hiding the virtual from wxObject - virtual void LoadObject(wxObjectInputStream& stream) { wxObject::LoadObject(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(); - // 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 - // modified to FALSE) + // modified to false) virtual bool OnSaveModified(); // Called by framework if created automatically by the default document @@ -138,6 +134,7 @@ public: 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(); @@ -164,49 +161,53 @@ 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 { - DECLARE_ABSTRACT_CLASS(wxView) - 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; }; - 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 OnClosingDocument() {} 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 - // 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); -#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); @@ -224,13 +225,16 @@ public: 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 { -DECLARE_CLASS(wxDocTemplate) friend class WXDLLEXPORT wxDocManager; @@ -256,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; }; @@ -274,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: @@ -289,47 +300,72 @@ 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(long flags = wxDEFAULT_DOCMAN_FLAGS, bool initialize = true); ~wxDocManager(); virtual bool Initialize(); // 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 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); + // Handlers for UI update commands + void OnUpdateFileOpen(wxUpdateUIEvent& event); + void OnUpdateFileClose(wxUpdateUIEvent& event); + void OnUpdateFileRevert(wxUpdateUIEvent& event); + void OnUpdateFileNew(wxUpdateUIEvent& event); + void OnUpdateFileSave(wxUpdateUIEvent& event); + void OnUpdateFileSaveAs(wxUpdateUIEvent& event); + void OnUpdateUndo(wxUpdateUIEvent& event); + void OnUpdateRedo(wxUpdateUIEvent& event); + + void OnUpdatePrint(wxUpdateUIEvent& event); + void OnUpdatePreview(wxUpdateUIEvent& event); + // Extend event processing to search the view's event table virtual bool ProcessEvent(wxEvent& event); + // called when file format detection didn't work, can be overridden to do + // something in this case + virtual void OnOpenFileFailure() { } + virtual wxDocument *CreateDocument(const wxString& path, long flags = 0); virtual wxView *CreateView(wxDocument *doc, long flags = 0); virtual void DeleteTemplate(wxDocTemplate *temp, long flags = 0); 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, - int noTemplates); + int noTemplates, bool sort = false); virtual wxDocTemplate *SelectViewType(wxDocTemplate **templates, - int noTemplates); + int noTemplates, bool sort = false); virtual wxDocTemplate *FindTemplateForPath(const wxString& path); void AssociateTemplate(wxDocTemplate *temp); @@ -344,27 +380,37 @@ public: 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); + 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; - virtual wxList& GetDocuments() const { return (wxList&) m_docs; } + wxList& GetDocuments() { return m_docs; } + wxList& GetTemplates() { return m_templates; } // Make a default document name virtual bool MakeDefaultName(wxString& buf); + // Make a frame title (override this to do something different) + virtual wxString MakeFrameTitle(wxDocument* doc); + virtual wxFileHistory *OnCreateFileHistory(); virtual wxFileHistory *GetFileHistory() const { return m_fileHistory; } // 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 @@ -375,8 +421,14 @@ 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; @@ -387,18 +439,24 @@ protected: wxView* m_currentView; wxFileHistory* m_fileHistory; wxString m_lastDirectory; + 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 { - DECLARE_CLASS(wxDocChildFrame) - public: wxDocChildFrame(wxDocument *doc, wxView *view, @@ -408,8 +466,8 @@ public: const wxPoint& pos = wxDefaultPosition, const wxSize& size = wxDefaultSize, long type = wxDEFAULT_FRAME_STYLE, - const wxString& name = "frame"); - ~wxDocChildFrame(); + const wxString& name = wxT("frame")); + ~wxDocChildFrame(){} // Extend event processing to search the view's event table virtual bool ProcessEvent(wxEvent& event); @@ -421,12 +479,16 @@ public: wxView *GetView() const { return m_childView; } void SetDocument(wxDocument *doc) { m_childDocument = doc; } void SetView(wxView *view) { m_childView = view; } + bool Destroy() { m_childView = (wxView *)NULL; return wxFrame::Destroy(); } protected: wxDocument* m_childDocument; wxView* m_childView; +private: + DECLARE_CLASS(wxDocChildFrame) DECLARE_EVENT_TABLE() + DECLARE_NO_COPY_CLASS(wxDocChildFrame) }; // ---------------------------------------------------------------------------- @@ -435,8 +497,6 @@ protected: class WXDLLEXPORT wxDocParentFrame : public wxFrame { - DECLARE_CLASS(wxDocParentFrame) - public: wxDocParentFrame(wxDocManager *manager, wxFrame *frame, @@ -445,7 +505,7 @@ public: 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); @@ -459,7 +519,10 @@ public: protected: wxDocManager *m_docManager; +private: + DECLARE_CLASS(wxDocParentFrame) DECLARE_EVENT_TABLE() + DECLARE_NO_COPY_CLASS(wxDocParentFrame) }; // ---------------------------------------------------------------------------- @@ -469,10 +532,8 @@ protected: #if wxUSE_PRINTING_ARCHITECTURE class WXDLLEXPORT wxDocPrintout : public wxPrintout { - DECLARE_DYNAMIC_CLASS(wxDocPrintout) - 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); @@ -482,67 +543,12 @@ public: protected: wxView* m_printoutView; -}; -#endif // wxUSE_PRINTING_ARCHITECTURE - -// ---------------------------------------------------------------------------- -// Command processing framework -// ---------------------------------------------------------------------------- - -class WXDLLEXPORT wxCommand : public wxObject -{ - DECLARE_CLASS(wxCommand) -public: - wxCommand(bool canUndoIt = FALSE, const wxString& name = ""); - ~wxCommand(); - - // Override this to perform a command - virtual bool Do() = 0; - - // Override this to undo a command - virtual bool Undo() = 0; - - virtual bool CanUndo() const { return m_canUndo; } - virtual wxString GetName() const { return m_commandName; } - -protected: - bool m_canUndo; - wxString m_commandName; -}; - -class WXDLLEXPORT wxCommandProcessor : public wxObject -{ - DECLARE_DYNAMIC_CLASS(wxCommandProcessor) - -public: - wxCommandProcessor(int maxCommands = 100); - ~wxCommandProcessor(); - - // Pass a command to the processor. The processor calls Do(); if - // successful, is appended to the command history unless storeIt is FALSE. - virtual bool Submit(wxCommand *command, bool storeIt = TRUE); - virtual bool Undo(); - virtual bool Redo(); - virtual bool CanUndo() const; - virtual bool CanRedo() const; - - // Call this to manage an edit menu. - void SetEditMenu(wxMenu *menu) { m_commandEditMenu = menu; } - wxMenu *GetEditMenu() const { return m_commandEditMenu; } - virtual void SetMenuStrings(); - virtual void Initialize(); - - wxList& GetCommands() const { return (wxList&) m_commands; } - int GetMaxCommands() const { return m_maxNoCommands; } - virtual void ClearCommands(); - -protected: - int m_maxNoCommands; - wxList m_commands; - wxNode* m_currentCommand; - wxMenu* m_commandEditMenu; +private: + DECLARE_DYNAMIC_CLASS(wxDocPrintout) + DECLARE_NO_COPY_CLASS(wxDocPrintout) }; +#endif // wxUSE_PRINTING_ARCHITECTURE // ---------------------------------------------------------------------------- // File history management @@ -550,16 +556,14 @@ protected: class WXDLLEXPORT wxFileHistory : public wxObject { - DECLARE_DYNAMIC_CLASS(wxFileHistory) - 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 int GetMaxFiles() const { return m_fileMaxFiles; } + virtual void RemoveFileFromHistory(size_t i); + virtual int GetMaxFiles() const { return (int)m_fileMaxFiles; } virtual void UseMenu(wxMenu *menu); // Remove menu from the list (MDI child may be closing) @@ -574,30 +578,49 @@ 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. -bool WXDLLEXPORT wxTransferFileToStream(const wxString& filename, ostream& stream); -bool WXDLLEXPORT wxTransferStreamToFile(istream& stream, const wxString& filename); -#endif +bool WXDLLEXPORT wxTransferFileToStream(const wxString& filename, wxSTD ostream& stream); +bool WXDLLEXPORT wxTransferStreamToFile(wxSTD istream& stream, const wxString& filename); +#else +// For compatibility with existing file formats: +// 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 // wxUSE_STD_IOSTREAM + +#endif // wxUSE_DOC_VIEW_ARCHITECTURE #endif // _WX_DOCH__