]> git.saurik.com Git - wxWidgets.git/blobdiff - include/wx/docview.h
in debug mode when clicking with the middle mouse button draw borders around all...
[wxWidgets.git] / include / wx / docview.h
index f60233b2ce532d5d28f547491f08126560d5ab51..a7c6df2620c120388ba92d2632f98fdc0465fd18 100644 (file)
@@ -40,21 +40,18 @@ class WXDLLIMPEXP_FWD_BASE 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
 enum
 {
     wxTEMPLATE_VISIBLE = 1,
-    wxTEMPLATE_INVISIBLE,
+    wxTEMPLATE_INVISIBLE = 2,
     wxDEFAULT_TEMPLATE_FLAGS = wxTEMPLATE_VISIBLE
 };
 
@@ -63,7 +60,7 @@ enum
 class WXDLLIMPEXP_CORE wxDocument : public wxEvtHandler
 {
 public:
-    wxDocument(wxDocument *parent = (wxDocument *) NULL);
+    wxDocument(wxDocument *parent = NULL);
     virtual ~wxDocument();
 
     // accessors
@@ -76,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();
@@ -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
@@ -110,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.
@@ -129,7 +139,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)
@@ -137,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,
@@ -184,7 +196,6 @@ private:
 class WXDLLIMPEXP_CORE wxView: public wxEvtHandler
 {
 public:
-    //  wxView(wxDocument *doc = (wxDocument *) NULL);
     wxView();
     virtual ~wxView();
 
@@ -197,16 +208,19 @@ 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 = (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
@@ -216,9 +230,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);
@@ -231,6 +242,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;
@@ -256,8 +270,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();
@@ -270,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; }
@@ -288,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; }
@@ -309,9 +326,11 @@ 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();
 
@@ -325,7 +344,8 @@ private:
 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();
@@ -345,25 +365,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);
@@ -400,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; }
@@ -423,14 +440,14 @@ 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
 
     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
@@ -449,7 +466,18 @@ public:
 #endif // WXWIN_COMPATIBILITY_2_6
 
 protected:
-    long              m_flags;
+    // 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;
@@ -486,12 +514,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);
 
@@ -499,9 +524,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;
 
@@ -537,9 +565,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);
@@ -547,6 +572,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:
@@ -564,11 +592,14 @@ private:
 class WXDLLIMPEXP_CORE wxDocPrintout : public wxPrintout
 {
 public:
-    wxDocPrintout(wxView *view = (wxView *) 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);
+    wxDocPrintout(wxView *view = NULL, const wxString& title = wxT("Printout"));
+
+    // 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; }
 
@@ -589,7 +620,6 @@ 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);
@@ -601,7 +631,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
 
@@ -648,18 +678,32 @@ 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
 
+
+// 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__