include/wx/containr.h

   1 ///////////////////////////////////////////////////////////////////////////////
   2 // Name:        wx/containr.h
   3 // Purpose:     wxControlContainer class declration: a "mix-in" class which
   4 //              implements the TAB navigation between the controls
   5 // Author:      Vadim Zeitlin
   6 // Modified by:
   7 // Created:     06.08.01
   8 // RCS-ID:      $Id$
   9 // Copyright:   (c) 2001 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>
  10 // Licence:     wxWindows licence
  11 ///////////////////////////////////////////////////////////////////////////////
  12
  13 #ifndef _WX_CONTAINR_H_
  14 #define _WX_CONTAINR_H_
  15
  16 class WXDLLEXPORT wxFocusEvent;
  17 class WXDLLEXPORT wxNavigationKeyEvent;
  18 class WXDLLEXPORT wxWindow;
  19 class WXDLLEXPORT wxWindowBase;
  20
  21 /*
  22    Implementation note: wxControlContainer is not a real mix-in but rather
  23    a class meant to be agregated with (and not inherited from). Although
  24    logically it should be a mix-in, doing it like this has no advantage from
  25    the point of view of the existing code but does have some problems (we'd
  26    need to play tricks with event handlers which may be difficult to do
  27    safely). The price we pay for this simplicity is the ugly macros below.
  28  */
  29
  30 // ----------------------------------------------------------------------------
  31 // wxControlContainer
  32 // ----------------------------------------------------------------------------
  33
  34 class WXDLLEXPORT wxControlContainer
  35 {
  36 public:
  37     // ctors and such
  38     wxControlContainer(wxWindow *winParent = NULL);
  39     void SetContainerWindow(wxWindow *winParent) { m_winParent = winParent; }
  40
  41     // default item access: we have a permanent default item which is the one
  42     // set by the user code but we may also have a temporary default item which
  43     // would be chosen if the user pressed "Enter" now but the default action
  44     // reverts to the "permanent" default as soon as this temporary default
  45     // item lsoes focus
  46
  47     // get the default item, temporary or permanent
  48     wxWindow *GetDefaultItem() const
  49         { return m_winTmpDefault ? m_winTmpDefault : m_winDefault; }
  50
  51     // set the permanent default item, return its old value
  52     wxWindow *SetDefaultItem(wxWindow *win)
  53         { wxWindow *winOld = m_winDefault; m_winDefault = win; return winOld; }
  54
  55     // set a temporary default item, SetTmpDefaultItem(NULL) should be called
  56     // soon after a call to SetTmpDefaultItem(window)
  57     void SetTmpDefaultItem(wxWindow *win) { m_winTmpDefault = win; }
  58
  59     // the methods to be called from the window event handlers
  60     void HandleOnNavigationKey(wxNavigationKeyEvent& event);
  61     void HandleOnFocus(wxFocusEvent& event);
  62     void HandleOnWindowDestroy(wxWindowBase *child);
  63
  64     // should be called from SetFocus(), returns false if we did nothing with
  65     // the focus and the default processing should take place
  66     bool DoSetFocus();
  67
  68     // can our child get the focus?
  69     bool AcceptsFocus() const;
  70
  71     // called from OnChildFocus() handler, i.e. when one of our (grand)
  72     // children gets the focus
  73     void SetLastFocus(wxWindow *win);
  74
  75 protected:
  76     // set the focus to the child which had it the last time
  77     bool SetFocusToChild();
  78
  79     // the parent window we manage the children for
  80     wxWindow *m_winParent;
  81
  82     // the child which had the focus last time this panel was activated
  83     wxWindow *m_winLastFocused;
  84
  85     // a default window (usually a button) or NULL
  86     wxWindow *m_winDefault;
  87
  88     // a temporary override of m_winDefault, use the latter if NULL
  89     wxWindow *m_winTmpDefault;
  90
  91     // a guard against infinite recursion
  92     bool m_inSetFocus;
  93
  94     DECLARE_NO_COPY_CLASS(wxControlContainer)
  95 };
  96
  97 // this function is for wxWidgets internal use only
  98 extern bool wxSetFocusToChild(wxWindow *win, wxWindow **child);
  99
 100 // ----------------------------------------------------------------------------
 101 // macros which may be used by the classes wishing to implement TAB navigation
 102 // among their children
 103 // ----------------------------------------------------------------------------
 104
 105 // declare the methods to be forwarded
 106 #define WX_DECLARE_CONTROL_CONTAINER() \
 107 public: \
 108     void OnNavigationKey(wxNavigationKeyEvent& event); \
 109     void OnFocus(wxFocusEvent& event); \
 110     virtual void OnChildFocus(wxChildFocusEvent& event); \
 111     virtual void SetFocus(); \
 112     virtual void SetFocusIgnoringChildren(); \
 113     virtual void RemoveChild(wxWindowBase *child); \
 114     virtual wxWindow *GetDefaultItem() const; \
 115     virtual wxWindow *SetDefaultItem(wxWindow *child); \
 116     virtual void SetTmpDefaultItem(wxWindow *win); \
 117     virtual bool AcceptsFocus() const; \
 118 \
 119 protected: \
 120     wxControlContainer m_container
 121
 122 // implement the event table entries for wxControlContainer
 123 #define WX_EVENT_TABLE_CONTROL_CONTAINER(classname) \
 124     EVT_SET_FOCUS(classname::OnFocus) \
 125     EVT_CHILD_FOCUS(classname::OnChildFocus) \
 126     EVT_NAVIGATION_KEY(classname::OnNavigationKey)
 127
 128 // implement the methods forwarding to the wxControlContainer
 129 #define WX_DELEGATE_TO_CONTROL_CONTAINER(classname)  \
 130 wxWindow *classname::SetDefaultItem(wxWindow *child) \
 131 { \
 132     return m_container.SetDefaultItem(child); \
 133 } \
 134  \
 135 void classname::SetTmpDefaultItem(wxWindow *child) \
 136 { \
 137     m_container.SetTmpDefaultItem(child); \
 138 } \
 139  \
 140 wxWindow *classname::GetDefaultItem() const \
 141 { \
 142     return m_container.GetDefaultItem(); \
 143 } \
 144  \
 145 void classname::OnNavigationKey( wxNavigationKeyEvent& event ) \
 146 { \
 147     m_container.HandleOnNavigationKey(event); \
 148 } \
 149  \
 150 void classname::RemoveChild(wxWindowBase *child) \
 151 { \
 152     m_container.HandleOnWindowDestroy(child); \
 153  \
 154     wxWindow::RemoveChild(child); \
 155 } \
 156  \
 157 void classname::SetFocus() \
 158 { \
 159     if ( !m_container.DoSetFocus() ) \
 160         wxWindow::SetFocus(); \
 161 } \
 162  \
 163 void classname::SetFocusIgnoringChildren() \
 164 { \
 165         wxWindow::SetFocus(); \
 166 } \
 167  \
 168 void classname::OnChildFocus(wxChildFocusEvent& event) \
 169 { \
 170     m_container.SetLastFocus(event.GetWindow()); \
 171 } \
 172  \
 173 void classname::OnFocus(wxFocusEvent& event) \
 174 { \
 175     m_container.HandleOnFocus(event); \
 176 } \
 177 bool classname::AcceptsFocus() const \
 178 { \
 179     return m_container.AcceptsFocus(); \
 180 }
 181
 182
 183 #endif // _WX_CONTAINR_H_