X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/b54129836cbc680fbeb338bb6087c1a4f80bdf18..ada083260a7c74b3bd084f6092a298e64a6c6b0f:/include/wx/docview.h diff --git a/include/wx/docview.h b/include/wx/docview.h index 49be65f1bb..821c7abc1c 100644 --- a/include/wx/docview.h +++ b/include/wx/docview.h @@ -51,7 +51,7 @@ enum enum { wxTEMPLATE_VISIBLE = 1, - wxTEMPLATE_INVISIBLE, + wxTEMPLATE_INVISIBLE = 2, wxDEFAULT_TEMPLATE_FLAGS = wxTEMPLATE_VISIBLE }; @@ -73,9 +73,16 @@ public: void SetDocumentName(const wxString& name) { m_documentTypeName = name; } wxString GetDocumentName() const { return m_documentTypeName; } + // access the flag indicating whether this document had been already saved, + // SetDocumentSaved() is only used internally, don't call it bool GetDocumentSaved() const { return m_savedYet; } void SetDocumentSaved(bool saved = true) { m_savedYet = saved; } + // return true if the document hasn't been modified since the last time it + // was saved (implying that it returns false if it was never saved, even if + // the document is not modified) + bool AlreadySaved() const { return !IsModified() && GetDocumentSaved(); } + virtual bool Close(); virtual bool Save(); virtual bool SaveAs(); @@ -100,6 +107,10 @@ public: // modified to false) virtual bool OnSaveModified(); + // if you override, remember to call the default + // implementation (wxDocument::OnChangeFilename) + virtual void OnChangeFilename(bool notifyViews); + // Called by framework if created automatically by the default document // manager: gives document a chance to initialise and (usually) create a // view @@ -107,8 +118,10 @@ public: // By default, creates a base wxCommandProcessor. virtual wxCommandProcessor *OnCreateCommandProcessor(); - virtual wxCommandProcessor *GetCommandProcessor() const { return m_commandProcessor; } - virtual void SetCommandProcessor(wxCommandProcessor *proc) { m_commandProcessor = proc; } + virtual wxCommandProcessor *GetCommandProcessor() const + { return m_commandProcessor; } + virtual void SetCommandProcessor(wxCommandProcessor *proc) + { m_commandProcessor = proc; } // Called after a view is added or removed. The default implementation // deletes the document if this is there are no more views. @@ -134,8 +147,10 @@ public: // Other stuff virtual wxDocManager *GetDocumentManager() const; - virtual wxDocTemplate *GetDocumentTemplate() const { return m_documentTemplate; } - virtual void SetDocumentTemplate(wxDocTemplate *temp) { m_documentTemplate = temp; } + virtual wxDocTemplate *GetDocumentTemplate() const + { return m_documentTemplate; } + virtual void SetDocumentTemplate(wxDocTemplate *temp) + { m_documentTemplate = temp; } // Get the document name to be shown to the user: the title if there is // any, otherwise the filename if the document was saved and, finally, @@ -175,7 +190,7 @@ protected: private: DECLARE_ABSTRACT_CLASS(wxDocument) - DECLARE_NO_COPY_CLASS(wxDocument) + wxDECLARE_NO_COPY_CLASS(wxDocument); }; class WXDLLIMPEXP_CORE wxView: public wxEvtHandler @@ -193,7 +208,9 @@ public: wxWindow *GetFrame() const { return m_viewFrame ; } void SetFrame(wxWindow *frame) { m_viewFrame = frame; } - virtual void OnActivateView(bool activate, wxView *activeView, wxView *deactiveView); + 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 = NULL); @@ -234,7 +251,7 @@ protected: private: DECLARE_ABSTRACT_CLASS(wxView) - DECLARE_NO_COPY_CLASS(wxView) + wxDECLARE_NO_COPY_CLASS(wxView); }; // Represents user interface (and other) properties of documents and views @@ -267,13 +284,16 @@ public: // Helper method for CreateDocument; also allows you to do your own document // creation - virtual bool InitDocument(wxDocument* doc, const wxString& path, long flags = 0); + 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; } wxDocManager *GetDocumentManager() const { return m_documentManager; } - void SetDocumentManager(wxDocManager *manager) { m_documentManager = manager; } + void SetDocumentManager(wxDocManager *manager) + { m_documentManager = manager; } wxString GetFileFilter() const { return m_fileFilter; } long GetFlags() const { return m_flags; } virtual wxString GetViewName() const { return m_viewTypeName; } @@ -285,7 +305,7 @@ public: void SetDefaultExtension(const wxString& ext) { m_defaultExt = ext; } void SetFlags(long flags) { m_flags = flags; } - bool IsVisible() const { return ((m_flags & wxTEMPLATE_VISIBLE) == wxTEMPLATE_VISIBLE); } + bool IsVisible() const { return (m_flags & wxTEMPLATE_VISIBLE) != 0; } wxClassInfo* GetDocClassInfo() const { return m_docClassInfo; } wxClassInfo* GetViewClassInfo() const { return m_viewClassInfo; } @@ -306,15 +326,17 @@ protected: 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. + // 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) + wxDECLARE_NO_COPY_CLASS(wxDocTemplate); }; // One object of this class may be created in an application, to manage all @@ -395,7 +417,7 @@ public: // 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 wxView *GetCurrentView() const; + virtual wxView *GetCurrentView() const { return m_currentView; } wxList& GetDocuments() { return m_docs; } wxList& GetTemplates() { return m_templates; } @@ -425,7 +447,7 @@ public: virtual void FileHistoryAddFilesToMenu(); virtual void FileHistoryAddFilesToMenu(wxMenu* menu); - wxString GetLastDirectory() const { return m_lastDirectory; } + wxString GetLastDirectory() const; void SetLastDirectory(const wxString& dir) { m_lastDirectory = dir; } // Get the current document manager @@ -447,6 +469,15 @@ protected: // hook the currently active view into event handlers chain here virtual bool TryValidator(wxEvent& event); + // return the command processor for the current document, if any + wxCommandProcessor *GetCurrentCommandProcessor() const; + + // this method tries to find an active view harder than GetCurrentView(): + // if the latter is NULL, it also checks if we don't have just a single + // view and returns it then + wxView *GetActiveView() const; + + int m_defaultDocumentNameCounter; int m_maxDocsOpen; wxList m_docs; @@ -458,7 +489,7 @@ protected: DECLARE_EVENT_TABLE() DECLARE_DYNAMIC_CLASS(wxDocManager) - DECLARE_NO_COPY_CLASS(wxDocManager) + wxDECLARE_NO_COPY_CLASS(wxDocManager); }; #if WXWIN_COMPATIBILITY_2_6 @@ -483,7 +514,7 @@ public: const wxPoint& pos = wxDefaultPosition, const wxSize& size = wxDefaultSize, long type = wxDEFAULT_FRAME_STYLE, - const wxString& name = wxT("frame")); + const wxString& name = wxFrameNameStr); virtual ~wxDocChildFrame(){} void OnActivate(wxActivateEvent& event); @@ -505,7 +536,7 @@ protected: private: DECLARE_CLASS(wxDocChildFrame) DECLARE_EVENT_TABLE() - DECLARE_NO_COPY_CLASS(wxDocChildFrame) + wxDECLARE_NO_COPY_CLASS(wxDocChildFrame); }; // ---------------------------------------------------------------------------- @@ -550,7 +581,7 @@ private: typedef wxFrame base_type; DECLARE_CLASS(wxDocParentFrame) DECLARE_EVENT_TABLE() - DECLARE_NO_COPY_CLASS(wxDocParentFrame) + wxDECLARE_NO_COPY_CLASS(wxDocParentFrame); }; // ---------------------------------------------------------------------------- @@ -562,10 +593,13 @@ class WXDLLIMPEXP_CORE wxDocPrintout : public wxPrintout { public: wxDocPrintout(wxView *view = NULL, const wxString& title = wxT("Printout")); - bool OnPrintPage(int page); - bool HasPage(int page); - bool OnBeginDocument(int startPage, int endPage); - void GetPageInfo(int *minPage, int *maxPage, int *selPageFrom, int *selPageTo); + + // implement wxPrintout methods + virtual bool OnPrintPage(int page); + virtual bool HasPage(int page); + virtual bool OnBeginDocument(int startPage, int endPage); + virtual void GetPageInfo(int *minPage, int *maxPage, + int *selPageFrom, int *selPageTo); virtual wxView *GetView() { return m_printoutView; } @@ -574,7 +608,7 @@ protected: private: DECLARE_DYNAMIC_CLASS(wxDocPrintout) - DECLARE_NO_COPY_CLASS(wxDocPrintout) + wxDECLARE_NO_COPY_CLASS(wxDocPrintout); }; #endif // wxUSE_PRINTING_ARCHITECTURE @@ -634,7 +668,7 @@ private: wxWindowID m_idBase; DECLARE_DYNAMIC_CLASS(wxFileHistory) - DECLARE_NO_COPY_CLASS(wxFileHistory) + wxDECLARE_NO_COPY_CLASS(wxFileHistory); }; #if WXWIN_COMPATIBILITY_2_6 @@ -644,16 +678,18 @@ inline size_t wxFileHistory::GetNoHistoryFiles() const } #endif // WXWIN_COMPATIBILITY_2_6 -#if wxUSE_STD_IOSTREAM // For compatibility with existing file formats: // converts from/to a stream to/from a temporary file. -bool WXDLLIMPEXP_CORE wxTransferFileToStream(const wxString& filename, wxSTD ostream& stream); -bool WXDLLIMPEXP_CORE wxTransferStreamToFile(wxSTD istream& stream, const wxString& filename); +#if wxUSE_STD_IOSTREAM +bool WXDLLIMPEXP_CORE +wxTransferFileToStream(const wxString& filename, wxSTD ostream& stream); +bool WXDLLIMPEXP_CORE +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 WXDLLIMPEXP_CORE wxTransferFileToStream(const wxString& filename, wxOutputStream& stream); -bool WXDLLIMPEXP_CORE wxTransferStreamToFile(wxInputStream& stream, const wxString& filename); +bool WXDLLIMPEXP_CORE +wxTransferFileToStream(const wxString& filename, wxOutputStream& stream); +bool WXDLLIMPEXP_CORE +wxTransferStreamToFile(wxInputStream& stream, const wxString& filename); #endif // wxUSE_STD_IOSTREAM