account for scroll offset correctly in the mouse event handler

[wxWidgets.git] / include / wx / docview.h

diff --git a/include/wx/docview.h b/include/wx/docview.h
index f60233b2ce532d5d28f547491f08126560d5ab51..0eaf23b8ba1eeab80351e356cadee3d1f6063c5d 100644 (file)
--- a/include/wx/docview.h
+++ b/include/wx/docview.h
@@ -40,14 +40,11 @@ class WXDLLIMPEXP_FWD_BASE wxConfigBase;
   #include "wx/stream.h"
 #endif
 
   #include "wx/stream.h"
 #endif
 

-// Document manager flags
+// Flags for wxDocManager (can be combined).

 enum
 {
 enum
 {

-    wxDOC_SDI = 1,
-    wxDOC_MDI,
-    wxDOC_NEW,
-    wxDOC_SILENT,
-    wxDEFAULT_DOCMAN_FLAGS = wxDOC_SDI
+    wxDOC_NEW    = 1,
+    wxDOC_SILENT = 2

 };
 
 // Document template flags
 };
 
 // Document template flags


@@ -63,7 +60,7 @@ enum
 class WXDLLIMPEXP_CORE wxDocument : public wxEvtHandler
 {
 public:
 class WXDLLIMPEXP_CORE wxDocument : public wxEvtHandler
 {
 public:

-    wxDocument(wxDocument *parent = (wxDocument *) NULL);
+    wxDocument(wxDocument *parent = NULL);

     virtual ~wxDocument();
 
     // accessors
     virtual ~wxDocument();
 
     // accessors


@@ -76,9 +73,16 @@ public:
     void SetDocumentName(const wxString& name) { m_documentTypeName = name; }
     wxString GetDocumentName() const { return m_documentTypeName; }
 
     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; }
 
     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();
     virtual bool Close();
     virtual bool Save();
     virtual bool SaveAs();


@@ -129,7 +133,7 @@ public:
     const wxList& GetViews() const { return m_documentViews; }
     wxView *GetFirstView() const;
 
     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)
     virtual void NotifyClosing();
 
     // Remove all views (because we're closing the document)


@@ -184,7 +188,6 @@ private:
 class WXDLLIMPEXP_CORE wxView: public wxEvtHandler
 {
 public:
 class WXDLLIMPEXP_CORE wxView: public wxEvtHandler
 {
 public:

-    //  wxView(wxDocument *doc = (wxDocument *) NULL);

     wxView();
     virtual ~wxView();
 
     wxView();
     virtual ~wxView();
 


@@ -200,13 +203,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 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 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
 
     // 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 +220,6 @@ public:
     // Override to do cleanup/veto close
     virtual bool OnClose(bool deleteWindow);
 
     // 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);
     // 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 +232,9 @@ public:
 #endif
 
 protected:
 #endif
 
 protected:

+    // hook the document into event handlers chain here
+    virtual bool TryValidator(wxEvent& event);
+

     wxDocument*       m_viewDocument;
     wxString          m_viewTypeName;
     wxWindow*         m_viewFrame;
     wxDocument*       m_viewDocument;
     wxString          m_viewTypeName;
     wxWindow*         m_viewFrame;


@@ -256,8 +260,8 @@ public:
                   const wxString& ext,
                   const wxString& docTypeName,
                   const wxString& viewTypeName,
                   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();
                   long flags = wxDEFAULT_TEMPLATE_FLAGS);
 
     virtual ~wxDocTemplate();


@@ -325,7 +329,8 @@ private:
 class WXDLLIMPEXP_CORE wxDocManager: public wxEvtHandler
 {
 public:
 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();
     virtual ~wxDocManager();
 
     virtual bool Initialize();


@@ -345,25 +350,22 @@ public:
 
     // Handlers for UI update commands
     void OnUpdateFileOpen(wxUpdateUIEvent& event);
 
     // 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 OnUpdateFileNew(wxUpdateUIEvent& event);
     void OnUpdateFileSave(wxUpdateUIEvent& event);

-    void OnUpdateFileSaveAs(wxUpdateUIEvent& event);

     void OnUpdateUndo(wxUpdateUIEvent& event);
     void OnUpdateRedo(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);
     // 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);
     virtual wxView *CreateView(wxDocument *doc, long flags = 0);
     virtual void DeleteTemplate(wxDocTemplate *temp, long flags = 0);
     virtual bool FlushDoc(wxDocument *doc);


@@ -423,7 +425,7 @@ public:
     virtual void FileHistoryUseMenu(wxMenu *menu);
     virtual void FileHistoryRemoveMenu(wxMenu *menu);
 #if wxUSE_CONFIG
     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 FileHistorySave(wxConfigBase& config);
 #endif // wxUSE_CONFIG
 


@@ -449,7 +451,9 @@ public:
 #endif // WXWIN_COMPATIBILITY_2_6
 
 protected:
 #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;
     int               m_defaultDocumentNameCounter;
     int               m_maxDocsOpen;
     wxList            m_docs;


@@ -486,12 +490,9 @@ public:
                     const wxPoint& pos = wxDefaultPosition,
                     const wxSize& size = wxDefaultSize,
                     long type = wxDEFAULT_FRAME_STYLE,
                     const wxPoint& pos = wxDefaultPosition,
                     const wxSize& size = wxDefaultSize,
                     long type = wxDEFAULT_FRAME_STYLE,

-                    const wxString& name = wxT("frame"));
+                    const wxString& name = wxFrameNameStr);

     virtual ~wxDocChildFrame(){}
 
     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);
 
     void OnActivate(wxActivateEvent& event);
     void OnCloseWindow(wxCloseEvent& event);
 


@@ -499,9 +500,12 @@ public:
     wxView *GetView() const { return m_childView; }
     void SetDocument(wxDocument *doc) { m_childDocument = doc; }
     void SetView(wxView *view) { m_childView = view; }
     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:
 
 protected:

+    // hook the child view into event handlers chain here
+    virtual bool TryValidator(wxEvent& event);
+

     wxDocument*       m_childDocument;
     wxView*           m_childView;
 
     wxDocument*       m_childDocument;
     wxView*           m_childView;
 


@@ -537,9 +541,6 @@ public:
                 long style = wxDEFAULT_FRAME_STYLE,
                 const wxString& name = wxFrameNameStr);
 
                 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);
     wxDocManager *GetDocumentManager() const { return m_docManager; }
 
     void OnExit(wxCommandEvent& event);


@@ -547,6 +548,9 @@ public:
     void OnCloseWindow(wxCloseEvent& event);
 
 protected:
     void OnCloseWindow(wxCloseEvent& event);
 
 protected:

+    // hook the document manager into event handling chain here
+    virtual bool TryValidator(wxEvent& event);
+

     wxDocManager *m_docManager;
 
 private:
     wxDocManager *m_docManager;
 
 private:


@@ -564,7 +568,7 @@ private:
 class WXDLLIMPEXP_CORE wxDocPrintout : public wxPrintout
 {
 public:
 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);
     bool OnPrintPage(int page);
     bool HasPage(int page);
     bool OnBeginDocument(int startPage, int endPage);


@@ -589,7 +593,6 @@ class WXDLLIMPEXP_CORE wxFileHistory : public wxObject
 {
 public:
     wxFileHistory(size_t maxFiles = 9, wxWindowID idBase = wxID_FILE1);
 {
 public:
     wxFileHistory(size_t maxFiles = 9, wxWindowID idBase = wxID_FILE1);

-    virtual ~wxFileHistory();

 
     // Operations
     virtual void AddFileToHistory(const wxString& file);
 
     // Operations
     virtual void AddFileToHistory(const wxString& file);


@@ -601,7 +604,7 @@ public:
     virtual void RemoveMenu(wxMenu *menu);
 
 #if wxUSE_CONFIG
     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
 
     virtual void Save(wxConfigBase& config);
 #endif // wxUSE_CONFIG
 


@@ -660,6 +663,18 @@ bool WXDLLIMPEXP_CORE wxTransferFileToStream(const wxString& filename, wxOutputS
 bool WXDLLIMPEXP_CORE wxTransferStreamToFile(wxInputStream& stream, const wxString& filename);
 #endif // wxUSE_STD_IOSTREAM
 
 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__
 #endif // wxUSE_DOC_VIEW_ARCHITECTURE
 
 #endif // _WX_DOCH__