we don't need reserved virtual functions on HEAD

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

diff --git a/include/wx/containr.h b/include/wx/containr.h
index ca7042e684a38e81bb367aca81581f61696153be..cd79e5dd5b99f7d0195b65485f073f40e750e6f9 100644 (file)
--- a/include/wx/containr.h
+++ b/include/wx/containr.h
@@ -13,13 +13,10 @@
 #ifndef _WX_CONTAINR_H_
 #define _WX_CONTAINR_H_
 
-#ifdef __GNUG__
-    #pragma implementation "containr.h"
-#endif
-
 class WXDLLEXPORT wxFocusEvent;
 class WXDLLEXPORT wxNavigationKeyEvent;
 class WXDLLEXPORT wxWindow;
+class WXDLLEXPORT wxWindowBase;
 
 /*
    Implementation note: wxControlContainer is not a real mix-in but rather
@@ -38,21 +35,42 @@ class WXDLLEXPORT wxControlContainer
 {
 public:
     // ctors and such
-    wxControlContainer(wxWindow *winParent);
+    wxControlContainer(wxWindow *winParent = NULL);
+    void SetContainerWindow(wxWindow *winParent) { m_winParent = winParent; }
+
+    // default item access: we have a permanent default item which is the one
+    // set by the user code but we may also have a temporary default item which
+    // would be chosen if the user pressed "Enter" now but the default action
+    // reverts to the "permanent" default as soon as this temporary default
+    // item lsoes focus
+
+    // get the default item, temporary or permanent
+    wxWindow *GetDefaultItem() const
+        { return m_winTmpDefault ? m_winTmpDefault : m_winDefault; }
 
-    wxWindow *GetDefaultItem() const { return m_winDefault; }
+    // set the permanent default item, return its old value
     wxWindow *SetDefaultItem(wxWindow *win)
         { wxWindow *winOld = m_winDefault; m_winDefault = win; return winOld; }
 
-    void SetLastFocus(wxWindow *win);
+    // set a temporary default item, SetTmpDefaultItem(NULL) should be called
+    // soon after a call to SetTmpDefaultItem(window)
+    void SetTmpDefaultItem(wxWindow *win) { m_winTmpDefault = win; }
 
     // the methods to be called from the window event handlers
     void HandleOnNavigationKey(wxNavigationKeyEvent& event);
     void HandleOnFocus(wxFocusEvent& event);
     void HandleOnWindowDestroy(wxWindowBase *child);
 
-    // should be called from SetFocus()
-    void DoSetFocus();
+    // should be called from SetFocus(), returns false if we did nothing with
+    // the focus and the default processing should take place
+    bool DoSetFocus();
+
+    // can our child get the focus?
+    bool AcceptsFocus() const;
+
+    // called from OnChildFocus() handler, i.e. when one of our (grand)
+    // children gets the focus
+    void SetLastFocus(wxWindow *win);
 
 protected:
     // set the focus to the child which had it the last time
@@ -64,11 +82,19 @@ protected:
     // the child which had the focus last time this panel was activated
     wxWindow *m_winLastFocused;
 
-    // a default window (e.g. a button) or NULL
+    // a default window (usually a button) or NULL
     wxWindow *m_winDefault;
+
+    // a temporary override of m_winDefault, use the latter if NULL
+    wxWindow *m_winTmpDefault;
+
+    // a guard against infinite recursion
+    bool m_inSetFocus;
+
+    DECLARE_NO_COPY_CLASS(wxControlContainer)
 };
 
-// this function is for wxWindows internal use only
+// this function is for wxWidgets internal use only
 extern bool wxSetFocusToChild(wxWindow *win, wxWindow **child);
 
 // ----------------------------------------------------------------------------
@@ -78,13 +104,20 @@ extern bool wxSetFocusToChild(wxWindow *win, wxWindow **child);
 
 // declare the methods to be forwarded
 #define WX_DECLARE_CONTROL_CONTAINER() \
+public: \
     void OnNavigationKey(wxNavigationKeyEvent& event); \
     void OnFocus(wxFocusEvent& event); \
     virtual void OnChildFocus(wxChildFocusEvent& event); \
     virtual void SetFocus(); \
+    virtual void SetFocusIgnoringChildren(); \
     virtual void RemoveChild(wxWindowBase *child); \
     virtual wxWindow *GetDefaultItem() const; \
-    virtual wxWindow *SetDefaultItem(wxWindow *child) \
+    virtual wxWindow *SetDefaultItem(wxWindow *child); \
+    virtual void SetTmpDefaultItem(wxWindow *win); \
+    virtual bool AcceptsFocus() const; \
+\
+protected: \
+    wxControlContainer m_container
 
 // implement the event table entries for wxControlContainer
 #define WX_EVENT_TABLE_CONTROL_CONTAINER(classname) \
@@ -93,42 +126,57 @@ extern bool wxSetFocusToChild(wxWindow *win, wxWindow **child);
     EVT_NAVIGATION_KEY(classname::OnNavigationKey)
 
 // implement the methods forwarding to the wxControlContainer
-#define WX_DELEGATE_TO_CONTROL_CONTAINER(classname, container)  \
+#define WX_DELEGATE_TO_CONTROL_CONTAINER(classname)  \
 wxWindow *classname::SetDefaultItem(wxWindow *child) \
 { \
-    return container->SetDefaultItem(child); \
+    return m_container.SetDefaultItem(child); \
+} \
+ \
+void classname::SetTmpDefaultItem(wxWindow *child) \
+{ \
+    m_container.SetTmpDefaultItem(child); \
 } \
  \
 wxWindow *classname::GetDefaultItem() const \
 { \
-    return container->GetDefaultItem(); \
+    return m_container.GetDefaultItem(); \
 } \
  \
 void classname::OnNavigationKey( wxNavigationKeyEvent& event ) \
 { \
-    container->HandleOnNavigationKey(event); \
+    m_container.HandleOnNavigationKey(event); \
 } \
  \
 void classname::RemoveChild(wxWindowBase *child) \
 { \
-    container->HandleOnWindowDestroy(child); \
+    m_container.HandleOnWindowDestroy(child); \
  \
     wxWindow::RemoveChild(child); \
 } \
  \
 void classname::SetFocus() \
 { \
-    container->DoSetFocus(); \
+    if ( !m_container.DoSetFocus() ) \
+        wxWindow::SetFocus(); \
+} \
+ \
+void classname::SetFocusIgnoringChildren() \
+{ \
+        wxWindow::SetFocus(); \
 } \
  \
 void classname::OnChildFocus(wxChildFocusEvent& event) \
 { \
-    container->SetLastFocus(event.GetWindow()); \
+    m_container.SetLastFocus(event.GetWindow()); \
 } \
  \
 void classname::OnFocus(wxFocusEvent& event) \
 { \
-    container->HandleOnFocus(event); \
+    m_container.HandleOnFocus(event); \
+} \
+bool classname::AcceptsFocus() const \
+{ \
+    return m_container.AcceptsFocus(); \
 }