X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/b4a980f4f57a4e7eea00c55cbb3d139f97d90c20..d8359d3ca077993d3ef61d6c09000ce7beeb577b:/include/wx/docview.h diff --git a/include/wx/docview.h b/include/wx/docview.h index 8c7213338f..6568e7654a 100644 --- a/include/wx/docview.h +++ b/include/wx/docview.h @@ -24,15 +24,15 @@ #include "wx/print.h" #endif -class WXDLLEXPORT wxWindow; -class WXDLLEXPORT wxDocument; -class WXDLLEXPORT wxView; -class WXDLLEXPORT wxDocTemplate; -class WXDLLEXPORT wxDocManager; -class WXDLLEXPORT wxPrintInfo; -class WXDLLEXPORT wxCommandProcessor; -class WXDLLEXPORT wxFileHistory; -class WXDLLEXPORT wxConfigBase; +class WXDLLIMPEXP_FWD_CORE wxWindow; +class WXDLLIMPEXP_FWD_CORE wxDocument; +class WXDLLIMPEXP_FWD_CORE wxView; +class WXDLLIMPEXP_FWD_CORE wxDocTemplate; +class WXDLLIMPEXP_FWD_CORE wxDocManager; +class WXDLLIMPEXP_FWD_CORE wxPrintInfo; +class WXDLLIMPEXP_FWD_CORE wxCommandProcessor; +class WXDLLIMPEXP_FWD_CORE wxFileHistory; +class WXDLLIMPEXP_FWD_BASE wxConfigBase; #if wxUSE_STD_IOSTREAM #include "wx/iosfwrap.h" @@ -40,14 +40,11 @@ class WXDLLEXPORT wxConfigBase; #include "wx/stream.h" #endif -// Document manager flags +// Flags for wxDocManager (can be combined). enum { - wxDOC_SDI = 1, - wxDOC_MDI, - wxDOC_NEW, - wxDOC_SILENT, - wxDEFAULT_DOCMAN_FLAGS = wxDOC_SDI + wxDOC_NEW = 1, + wxDOC_SILENT = 2 }; // Document template flags @@ -60,25 +57,32 @@ enum #define wxMAX_FILE_HISTORY 9 -class WXDLLEXPORT wxDocument : public wxEvtHandler +class WXDLLIMPEXP_CORE wxDocument : public wxEvtHandler { public: - wxDocument(wxDocument *parent = (wxDocument *) NULL); + wxDocument(wxDocument *parent = NULL); virtual ~wxDocument(); // accessors void SetFilename(const wxString& filename, bool notifyViews = false); wxString GetFilename() const { return m_documentFile; } - void SetTitle(const wxString& title) { m_documentTitle = title; }; + void SetTitle(const wxString& title) { m_documentTitle = title; } wxString GetTitle() const { return m_documentTitle; } - void SetDocumentName(const wxString& name) { m_documentTypeName = name; }; + 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(); @@ -103,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 @@ -129,7 +137,7 @@ public: const wxList& GetViews() const { return m_documentViews; } wxView *GetFirstView() const; - virtual void UpdateAllViews(wxView *sender = (wxView *) NULL, wxObject *hint = (wxObject *) NULL); + virtual void UpdateAllViews(wxView *sender = NULL, wxObject *hint = NULL); virtual void NotifyClosing(); // Remove all views (because we're closing the document) @@ -140,8 +148,17 @@ public: virtual wxDocTemplate *GetDocumentTemplate() const { return m_documentTemplate; } virtual void SetDocumentTemplate(wxDocTemplate *temp) { m_documentTemplate = temp; } - // Get title, or filename if no title, else [unnamed] - virtual bool GetPrintableName(wxString& buf) const; + // 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, + // "unnamed" otherwise + virtual wxString GetUserReadableName() const; + +#if WXWIN_COMPATIBILITY_2_8 + // use GetUserReadableName() instead + wxDEPRECATED_BUT_USED_INTERNALLY( + virtual bool GetPrintableName(wxString& buf) const + ); +#endif // WXWIN_COMPATIBILITY_2_8 // Returns a window that can be used as a parent for document-related // dialogs. Override if necessary. @@ -164,15 +181,17 @@ protected: virtual bool DoSaveDocument(const wxString& file); virtual bool DoOpenDocument(const wxString& file); + // the default implementation of GetUserReadableName() + wxString DoGetUserReadableName() const; + private: DECLARE_ABSTRACT_CLASS(wxDocument) DECLARE_NO_COPY_CLASS(wxDocument) }; -class WXDLLEXPORT wxView: public wxEvtHandler +class WXDLLIMPEXP_CORE wxView: public wxEvtHandler { public: - // wxView(wxDocument *doc = (wxDocument *) NULL); wxView(); virtual ~wxView(); @@ -180,7 +199,7 @@ public: virtual void SetDocument(wxDocument *doc); wxString GetViewName() const { return m_viewTypeName; } - void SetViewName(const wxString& name) { m_viewTypeName = name; }; + void SetViewName(const wxString& name) { m_viewTypeName = name; } wxWindow *GetFrame() const { return m_viewFrame ; } void SetFrame(wxWindow *frame) { m_viewFrame = frame; } @@ -188,13 +207,14 @@ public: 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 OnUpdate(wxView *sender, wxObject *hint = 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 @@ -204,9 +224,6 @@ public: // Override to do cleanup/veto close virtual bool OnClose(bool deleteWindow); - // Extend event processing to search the document's event table - virtual bool ProcessEvent(wxEvent& event); - // A view's window can call this to notify the view it is (in)active. // The function then notifies the document manager. virtual void Activate(bool activate); @@ -219,6 +236,9 @@ public: #endif protected: + // hook the document into event handlers chain here + virtual bool TryValidator(wxEvent& event); + wxDocument* m_viewDocument; wxString m_viewTypeName; wxWindow* m_viewFrame; @@ -229,10 +249,10 @@ private: }; // Represents user interface (and other) properties of documents and views -class WXDLLEXPORT wxDocTemplate: public wxObject +class WXDLLIMPEXP_CORE wxDocTemplate: public wxObject { -friend class WXDLLEXPORT wxDocManager; +friend class WXDLLIMPEXP_FWD_CORE wxDocManager; public: // Associate document and view types. They're for identifying what view is @@ -244,8 +264,8 @@ public: const wxString& ext, const wxString& docTypeName, const wxString& viewTypeName, - wxClassInfo *docClassInfo = (wxClassInfo *) NULL, - wxClassInfo *viewClassInfo = (wxClassInfo *)NULL, + wxClassInfo *docClassInfo = NULL, + wxClassInfo *viewClassInfo = NULL, long flags = wxDEFAULT_TEMPLATE_FLAGS); virtual ~wxDocTemplate(); @@ -260,21 +280,21 @@ public: // creation virtual bool InitDocument(wxDocument* doc, const wxString& path, long flags = 0); - wxString GetDefaultExtension() const { return m_defaultExt; }; + wxString GetDefaultExtension() const { return m_defaultExt; } wxString GetDescription() const { return m_description; } - wxString GetDirectory() const { return m_directory; }; + wxString GetDirectory() const { return m_directory; } wxDocManager *GetDocumentManager() const { return m_documentManager; } void SetDocumentManager(wxDocManager *manager) { m_documentManager = manager; } - wxString GetFileFilter() const { return m_fileFilter; }; - long GetFlags() const { return m_flags; }; + wxString GetFileFilter() const { return m_fileFilter; } + long GetFlags() const { return m_flags; } virtual wxString GetViewName() const { return m_viewTypeName; } virtual wxString GetDocumentName() const { return m_docTypeName; } - void SetFileFilter(const wxString& filter) { m_fileFilter = filter; }; - void SetDirectory(const wxString& dir) { m_directory = dir; }; - void SetDescription(const wxString& descr) { m_description = descr; }; - void SetDefaultExtension(const wxString& ext) { m_defaultExt = ext; }; - void SetFlags(long flags) { m_flags = flags; }; + void SetFileFilter(const wxString& filter) { m_fileFilter = filter; } + void SetDirectory(const wxString& dir) { m_directory = dir; } + void SetDescription(const wxString& descr) { m_description = descr; } + 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); } @@ -310,10 +330,11 @@ private: // One object of this class may be created in an application, to manage all // the templates and documents. -class WXDLLEXPORT wxDocManager: public wxEvtHandler +class WXDLLIMPEXP_CORE wxDocManager: public wxEvtHandler { public: - wxDocManager(long flags = wxDEFAULT_DOCMAN_FLAGS, bool initialize = true); + // NB: flags are unused, don't pass wxDOC_XXX to this ctor + wxDocManager(long flags = 0, bool initialize = true); virtual ~wxDocManager(); virtual bool Initialize(); @@ -333,25 +354,22 @@ public: // Handlers for UI update commands void OnUpdateFileOpen(wxUpdateUIEvent& event); - void OnUpdateFileClose(wxUpdateUIEvent& event); - void OnUpdateFileRevert(wxUpdateUIEvent& event); + void OnUpdateDisableIfNoDoc(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); + + // wrapper around CreateDocument() with a more clear name + wxDocument *CreateNewDocument() + { return CreateDocument(wxString(), wxDOC_NEW); } + virtual wxView *CreateView(wxDocument *doc, long flags = 0); virtual void DeleteTemplate(wxDocTemplate *temp, long flags = 0); virtual bool FlushDoc(wxDocument *doc); @@ -393,8 +411,9 @@ public: wxList& GetDocuments() { return m_docs; } wxList& GetTemplates() { return m_templates; } - // Make a default document name - virtual bool MakeDefaultName(wxString& buf); + // Return the default name for a new document (by default returns strings + // in the form "unnamed " but can be overridden) + virtual wxString MakeNewDocumentName(); // Make a frame title (override this to do something different) virtual wxString MakeFrameTitle(wxDocument* doc); @@ -410,7 +429,7 @@ public: virtual void FileHistoryUseMenu(wxMenu *menu); virtual void FileHistoryRemoveMenu(wxMenu *menu); #if wxUSE_CONFIG - virtual void FileHistoryLoad(wxConfigBase& config); + virtual void FileHistoryLoad(const wxConfigBase& config); virtual void FileHistorySave(wxConfigBase& config); #endif // wxUSE_CONFIG @@ -423,13 +442,22 @@ public: // Get the current document manager static wxDocManager* GetDocumentManager() { return sm_docManager; } +#if WXWIN_COMPATIBILITY_2_8 + // deprecated, override GetDefaultName() instead + wxDEPRECATED_BUT_USED_INTERNALLY( + virtual bool MakeDefaultName(wxString& buf) + ); +#endif + #if WXWIN_COMPATIBILITY_2_6 // deprecated, use GetHistoryFilesCount() instead wxDEPRECATED( size_t GetNoHistoryFiles() const ); #endif // WXWIN_COMPATIBILITY_2_6 protected: - long m_flags; + // hook the currently active view into event handlers chain here + virtual bool TryValidator(wxEvent& event); + int m_defaultDocumentNameCounter; int m_maxDocsOpen; wxList m_docs; @@ -455,7 +483,7 @@ inline size_t wxDocManager::GetNoHistoryFiles() const // A default child frame // ---------------------------------------------------------------------------- -class WXDLLEXPORT wxDocChildFrame : public wxFrame +class WXDLLIMPEXP_CORE wxDocChildFrame : public wxFrame { public: wxDocChildFrame(wxDocument *doc, @@ -466,12 +494,9 @@ 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(){} - // Extend event processing to search the view's event table - virtual bool ProcessEvent(wxEvent& event); - void OnActivate(wxActivateEvent& event); void OnCloseWindow(wxCloseEvent& event); @@ -479,9 +504,12 @@ 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(); } + bool Destroy() { m_childView = NULL; return wxFrame::Destroy(); } protected: + // hook the child view into event handlers chain here + virtual bool TryValidator(wxEvent& event); + wxDocument* m_childDocument; wxView* m_childView; @@ -495,7 +523,7 @@ private: // A default parent frame // ---------------------------------------------------------------------------- -class WXDLLEXPORT wxDocParentFrame : public wxFrame +class WXDLLIMPEXP_CORE wxDocParentFrame : public wxFrame { public: wxDocParentFrame(); @@ -517,9 +545,6 @@ public: long style = wxDEFAULT_FRAME_STYLE, const wxString& name = wxFrameNameStr); - // Extend event processing to search the document manager's event table - virtual bool ProcessEvent(wxEvent& event); - wxDocManager *GetDocumentManager() const { return m_docManager; } void OnExit(wxCommandEvent& event); @@ -527,6 +552,9 @@ public: void OnCloseWindow(wxCloseEvent& event); protected: + // hook the document manager into event handling chain here + virtual bool TryValidator(wxEvent& event); + wxDocManager *m_docManager; private: @@ -541,10 +569,10 @@ private: // ---------------------------------------------------------------------------- #if wxUSE_PRINTING_ARCHITECTURE -class WXDLLEXPORT wxDocPrintout : public wxPrintout +class WXDLLIMPEXP_CORE wxDocPrintout : public wxPrintout { public: - wxDocPrintout(wxView *view = (wxView *) NULL, const wxString& title = wxT("Printout")); + wxDocPrintout(wxView *view = NULL, const wxString& title = wxT("Printout")); bool OnPrintPage(int page); bool HasPage(int page); bool OnBeginDocument(int startPage, int endPage); @@ -565,11 +593,10 @@ private: // File history management // ---------------------------------------------------------------------------- -class WXDLLEXPORT wxFileHistory : public wxObject +class WXDLLIMPEXP_CORE wxFileHistory : public wxObject { public: wxFileHistory(size_t maxFiles = 9, wxWindowID idBase = wxID_FILE1); - virtual ~wxFileHistory(); // Operations virtual void AddFileToHistory(const wxString& file); @@ -581,7 +608,7 @@ public: virtual void RemoveMenu(wxMenu *menu); #if wxUSE_CONFIG - virtual void Load(wxConfigBase& config); + virtual void Load(const wxConfigBase& config); virtual void Save(wxConfigBase& config); #endif // wxUSE_CONFIG @@ -624,22 +651,34 @@ private: #if WXWIN_COMPATIBILITY_2_6 inline size_t wxFileHistory::GetNoHistoryFiles() const { - return m_fileHistoryN; + return m_fileHistory.GetCount(); } #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 WXDLLEXPORT wxTransferFileToStream(const wxString& filename, wxSTD ostream& stream); -bool WXDLLEXPORT wxTransferStreamToFile(wxSTD istream& stream, const wxString& filename); +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 WXDLLEXPORT wxTransferFileToStream(const wxString& filename, wxOutputStream& stream); -bool WXDLLEXPORT 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 + +// these flags are not used anywhere by wxWidgets and kept only for an unlikely +// case of existing user code using them for its own purposes +#ifdef WXWIN_COMPATIBILITY_2_8 +enum +{ + wxDOC_SDI = 1, + wxDOC_MDI, + wxDEFAULT_DOCMAN_FLAGS = wxDOC_SDI +}; +#endif // WXWIN_COMPATIBILITY_2_8 + #endif // wxUSE_DOC_VIEW_ARCHITECTURE #endif // _WX_DOCH__