Make all instances of HasEditorCtrl() const, not just a few

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

diff --git a/include/wx/docview.h b/include/wx/docview.h
index a7c6df2620c120388ba92d2632f98fdc0465fd18..0ff527c40368e6d271375327978ef2756fe80e0b 100644 (file)
--- a/include/wx/docview.h
+++ b/include/wx/docview.h
@@ -34,6 +34,8 @@ class WXDLLIMPEXP_FWD_CORE wxCommandProcessor;
 class WXDLLIMPEXP_FWD_CORE wxFileHistory;
 class WXDLLIMPEXP_FWD_BASE wxConfigBase;
 
 class WXDLLIMPEXP_FWD_CORE wxFileHistory;
 class WXDLLIMPEXP_FWD_BASE wxConfigBase;
 

+class wxDocChildFrameAnyBase;
+

 #if wxUSE_STD_IOSTREAM
   #include "wx/iosfwrap.h"
 #else
 #if wxUSE_STD_IOSTREAM
   #include "wx/iosfwrap.h"
 #else


@@ -107,7 +109,7 @@ public:
     // modified to false)
     virtual bool OnSaveModified();
 
     // modified to false)
     virtual bool OnSaveModified();
 

-    // if you override, remember to call the default 
+    // if you override, remember to call the default

     // implementation (wxDocument::OnChangeFilename)
     virtual void OnChangeFilename(bool notifyViews);
 
     // implementation (wxDocument::OnChangeFilename)
     virtual void OnChangeFilename(bool notifyViews);
 


@@ -190,7 +192,7 @@ protected:
 
 private:
     DECLARE_ABSTRACT_CLASS(wxDocument)
 
 private:
     DECLARE_ABSTRACT_CLASS(wxDocument)

-    DECLARE_NO_COPY_CLASS(wxDocument)
+    wxDECLARE_NO_COPY_CLASS(wxDocument);

 };
 
 class WXDLLIMPEXP_CORE wxView: public wxEvtHandler
 };
 
 class WXDLLIMPEXP_CORE wxView: public wxEvtHandler


@@ -241,17 +243,29 @@ public:
     virtual wxPrintout *OnCreatePrintout();
 #endif
 
     virtual wxPrintout *OnCreatePrintout();
 #endif
 

+    // implementation only
+    // -------------------
+
+    // set the associated frame, it is used to reset its view when we're
+    // destroyed
+    void SetDocChildFrame(wxDocChildFrameAnyBase *docChildFrame)
+    {
+        m_docChildFrame = docChildFrame;
+    }
+

 protected:
     // hook the document into event handlers chain here
 protected:
     // hook the document into event handlers chain here

-    virtual bool TryValidator(wxEvent& event);
+    virtual bool TryBefore(wxEvent& event);

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

+    wxDocChildFrameAnyBase *m_docChildFrame;
+

 private:
     DECLARE_ABSTRACT_CLASS(wxView)
 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
 };
 
 // Represents user interface (and other) properties of documents and views


@@ -336,7 +350,7 @@ protected:
 
 private:
     DECLARE_CLASS(wxDocTemplate)
 
 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
 };
 
 // One object of this class may be created in an application, to manage all


@@ -467,7 +481,7 @@ public:
 
 protected:
     // hook the currently active view into event handlers chain here
 
 protected:
     // hook the currently active view into event handlers chain here

-    virtual bool TryValidator(wxEvent& event);
+    virtual bool TryBefore(wxEvent& event);

 
     // return the command processor for the current document, if any
     wxCommandProcessor *GetCurrentCommandProcessor() const;
 
     // return the command processor for the current document, if any
     wxCommandProcessor *GetCurrentCommandProcessor() const;


@@ -489,7 +503,7 @@ protected:
 
     DECLARE_EVENT_TABLE()
     DECLARE_DYNAMIC_CLASS(wxDocManager)
 
     DECLARE_EVENT_TABLE()
     DECLARE_DYNAMIC_CLASS(wxDocManager)

-    DECLARE_NO_COPY_CLASS(wxDocManager)
+    wxDECLARE_NO_COPY_CLASS(wxDocManager);

 };
 
 #if WXWIN_COMPATIBILITY_2_6
 };
 
 #if WXWIN_COMPATIBILITY_2_6


@@ -500,45 +514,164 @@ inline size_t wxDocManager::GetNoHistoryFiles() const
 #endif // WXWIN_COMPATIBILITY_2_6
 
 // ----------------------------------------------------------------------------
 #endif // WXWIN_COMPATIBILITY_2_6
 
 // ----------------------------------------------------------------------------

-// A default child frame
+// Base class for child frames -- this is what wxView renders itself into
+//
+// Notice that this is a mix-in class so it doesn't derive from wxWindow, only
+// wxDocChildFrameAny does

 // ----------------------------------------------------------------------------
 
 // ----------------------------------------------------------------------------
 

-class WXDLLIMPEXP_CORE wxDocChildFrame : public wxFrame
+class WXDLLIMPEXP_CORE wxDocChildFrameAnyBase

 {
 public:
 {
 public:

-    wxDocChildFrame(wxDocument *doc,
-                    wxView *view,
-                    wxFrame *frame,
-                    wxWindowID id,
-                    const wxString& title,
-                    const wxPoint& pos = wxDefaultPosition,
-                    const wxSize& size = wxDefaultSize,
-                    long type = wxDEFAULT_FRAME_STYLE,
-                    const wxString& name = wxFrameNameStr);
-    virtual ~wxDocChildFrame(){}
+    wxDocChildFrameAnyBase(wxDocument *doc, wxView *view)
+    {
+        m_childDocument = doc;
+        m_childView = view;

 
 

-    void OnActivate(wxActivateEvent& event);
-    void OnCloseWindow(wxCloseEvent& event);
+        if ( view )
+            view->SetDocChildFrame(this);
+    }

 
     wxDocument *GetDocument() const { return m_childDocument; }
     wxView *GetView() const { return m_childView; }
     void SetDocument(wxDocument *doc) { m_childDocument = doc; }
     void SetView(wxView *view) { m_childView = view; }
 
     wxDocument *GetDocument() const { return m_childDocument; }
     wxView *GetView() const { return m_childView; }
     void SetDocument(wxDocument *doc) { m_childDocument = doc; }
     void SetView(wxView *view) { m_childView = view; }

-    bool Destroy() { m_childView = NULL; return wxFrame::Destroy(); }

 
 protected:
 
 protected:

-    // hook the child view into event handlers chain here
-    virtual bool TryValidator(wxEvent& event);
+    // we're not a wxEvtHandler but we provide this wxEvtHandler-like function
+    // which is called from TryBefore() of the derived classes to give our view
+    // a chance to process the message before the frame event handlers are used
+    bool TryProcessEvent(wxEvent& event)
+    {
+        return m_childView && m_childView->ProcessEventHere(event);
+    }
+
+    // called from EVT_CLOSE handler in the frame: check if we can close and do
+    // cleanup if so; veto the event otherwise
+    bool CloseView(wxCloseEvent& event);
+

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

+    wxDECLARE_NO_COPY_CLASS(wxDocChildFrameAnyBase);
+};
+
+// ----------------------------------------------------------------------------
+// Template implementing child frame concept using the given wxFrame-like class
+//
+// This is used to define wxDocChildFrame and wxDocMDIChildFrame: ChildFrame is
+// a wxFrame or wxMDIChildFrame (although in theory it could be any wxWindow-
+// derived class as long as it provided a ctor with the same signature as
+// wxFrame and OnActivate() method) and ParentFrame is either wxFrame or
+// wxMDIParentFrame.
+// ----------------------------------------------------------------------------
+
+template <class ChildFrame, class ParentFrame>
+class WXDLLIMPEXP_CORE wxDocChildFrameAny : public ChildFrame,
+                                            public wxDocChildFrameAnyBase
+{
+public:
+    typedef ChildFrame BaseClass;
+
+    // ctor for a frame showing the given view of the specified document
+    wxDocChildFrameAny(wxDocument *doc,
+                       wxView *view,
+                       ParentFrame *parent,
+                       wxWindowID id,
+                       const wxString& title,
+                       const wxPoint& pos = wxDefaultPosition,
+                       const wxSize& size = wxDefaultSize,
+                       long style = wxDEFAULT_FRAME_STYLE,
+                       const wxString& name = wxFrameNameStr)
+        : BaseClass(parent, id, title, pos, size, style, name),
+          wxDocChildFrameAnyBase(doc, view)
+    {
+        if ( view )
+            view->SetFrame(this);
+
+        this->Connect(wxEVT_ACTIVATE,
+                      wxActivateEventHandler(wxDocChildFrameAny::OnActivate));
+        this->Connect(wxEVT_CLOSE_WINDOW,
+                      wxCloseEventHandler(wxDocChildFrameAny::OnCloseWindow));
+    }
+
+    virtual bool Destroy()
+    {
+        // FIXME: why exactly do we do this? to avoid activation events during
+        //        destructions maybe?
+        m_childView = NULL;
+        return BaseClass::Destroy();
+    }
+
+protected:
+    // hook the child view into event handlers chain here
+    virtual bool TryBefore(wxEvent& event)
+    {
+        return TryProcessEvent(event) || BaseClass::TryBefore(event);
+    }
+
+private:
+    void OnActivate(wxActivateEvent& event)
+    {
+        BaseClass::OnActivate(event);
+
+        if ( m_childView )
+            m_childView->Activate(event.GetActive());
+    }
+
+    void OnCloseWindow(wxCloseEvent& event)
+    {
+        if ( CloseView(event) )
+            Destroy();
+        //else: vetoed
+    }
+
+    wxDECLARE_NO_COPY_TEMPLATE_CLASS_2(wxDocChildFrameAny,
+                                        ChildFrame, ParentFrame);
+};
+
+// ----------------------------------------------------------------------------
+// A default child frame: we need to define it as a class just for wxRTTI,
+// otherwise we could simply typedef it
+// ----------------------------------------------------------------------------
+
+#ifdef __VISUALC6__
+    // "non dll-interface class 'wxDocChildFrameAny<>' used as base interface
+    // for dll-interface class 'wxDocChildFrame'" -- this is bogus as the
+    // template will be DLL-exported but only once it is used as base class
+    // here!
+    #pragma warning (disable:4275)
+#endif
+
+typedef wxDocChildFrameAny<wxFrame, wxFrame> wxDocChildFrameBase;
+
+class WXDLLIMPEXP_CORE wxDocChildFrame : public wxDocChildFrameBase
+{
+public:
+    wxDocChildFrame(wxDocument *doc,
+                    wxView *view,
+                    wxFrame *parent,
+                    wxWindowID id,
+                    const wxString& title,
+                    const wxPoint& pos = wxDefaultPosition,
+                    const wxSize& size = wxDefaultSize,
+                    long style = wxDEFAULT_FRAME_STYLE,
+                    const wxString& name = wxFrameNameStr)
+        : wxDocChildFrameBase(doc, view,
+                              parent, id, title, pos, size, style, name)
+    {
+    }
+

 private:
     DECLARE_CLASS(wxDocChildFrame)
 private:
     DECLARE_CLASS(wxDocChildFrame)

-    DECLARE_EVENT_TABLE()
-    DECLARE_NO_COPY_CLASS(wxDocChildFrame)
+    wxDECLARE_NO_COPY_CLASS(wxDocChildFrame);

 };
 
 };
 

+#ifdef __VISUALC6__
+    #pragma warning (default:4275)
+#endif
+

 // ----------------------------------------------------------------------------
 // A default parent frame
 // ----------------------------------------------------------------------------
 // ----------------------------------------------------------------------------
 // A default parent frame
 // ----------------------------------------------------------------------------


@@ -573,7 +706,7 @@ public:
 
 protected:
     // hook the document manager into event handling chain here
 
 protected:
     // hook the document manager into event handling chain here

-    virtual bool TryValidator(wxEvent& event);
+    virtual bool TryBefore(wxEvent& event);

 
     wxDocManager *m_docManager;
 
 
     wxDocManager *m_docManager;
 


@@ -581,7 +714,7 @@ private:
     typedef wxFrame base_type;
     DECLARE_CLASS(wxDocParentFrame)
     DECLARE_EVENT_TABLE()
     typedef wxFrame base_type;
     DECLARE_CLASS(wxDocParentFrame)
     DECLARE_EVENT_TABLE()

-    DECLARE_NO_COPY_CLASS(wxDocParentFrame)
+    wxDECLARE_NO_COPY_CLASS(wxDocParentFrame);

 };
 
 // ----------------------------------------------------------------------------
 };
 
 // ----------------------------------------------------------------------------


@@ -608,7 +741,7 @@ protected:
 
 private:
     DECLARE_DYNAMIC_CLASS(wxDocPrintout)
 
 private:
     DECLARE_DYNAMIC_CLASS(wxDocPrintout)

-    DECLARE_NO_COPY_CLASS(wxDocPrintout)
+    wxDECLARE_NO_COPY_CLASS(wxDocPrintout);

 };
 #endif // wxUSE_PRINTING_ARCHITECTURE
 
 };
 #endif // wxUSE_PRINTING_ARCHITECTURE
 


@@ -668,7 +801,7 @@ private:
     wxWindowID m_idBase;
 
     DECLARE_DYNAMIC_CLASS(wxFileHistory)
     wxWindowID m_idBase;
 
     DECLARE_DYNAMIC_CLASS(wxFileHistory)

-    DECLARE_NO_COPY_CLASS(wxFileHistory)
+    wxDECLARE_NO_COPY_CLASS(wxFileHistory);

 };
 
 #if WXWIN_COMPATIBILITY_2_6
 };
 
 #if WXWIN_COMPATIBILITY_2_6