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 #if defined(__GNUG__) && !defined(__APPLE__)
  17     #pragma interface "containr.h"
  18 #endif
  19
  20 class WXDLLEXPORT wxFocusEvent;
  21 class WXDLLEXPORT wxNavigationKeyEvent;
  22 class WXDLLEXPORT wxWindow;
  23 class WXDLLEXPORT wxWindowBase;
  24
  25 /*
  26    Implementation note: wxControlContainer is not a real mix-in but rather
  27    a class meant to be agregated with (and not inherited from). Although
  28    logically it should be a mix-in, doing it like this has no advantage from
  29    the point of view of the existing code but does have some problems (we'd
  30    need to play tricks with event handlers which may be difficult to do
  31    safely). The price we pay for this simplicity is the ugly macros below.
  32  */
  33
  34 // ----------------------------------------------------------------------------
  35 // wxControlContainer
  36 // ----------------------------------------------------------------------------
  37
  38 class WXDLLEXPORT wxControlContainer
  39 {
  40 public:
  41     // ctors and such
  42     wxControlContainer(wxWindow *winParent = NULL);
  43     void SetContainerWindow(wxWindow *winParent) { m_winParent = winParent; }
  44
  45     // default item access: we have a permanent default item which is the one
  46     // set by the user code but we may also have a temporary default item which
  47     // would be chosen if the user pressed "Enter" now but the default action
  48     // reverts to the "permanent" default as soon as this temporary default
  49     // item lsoes focus
  50
  51     // get the default item, temporary or permanent
  52     wxWindow *GetDefaultItem() const
  53         { return m_winTmpDefault ? m_winTmpDefault : m_winDefault; }
  54
  55     // set the permanent default item, return its old value
  56     wxWindow *SetDefaultItem(wxWindow *win)
  57         { wxWindow *winOld = m_winDefault; m_winDefault = win; return winOld; }
  58
  59     // set a temporary default item, SetTmpDefaultItem(NULL) should be called
  60     // soon after a call to SetTmpDefaultItem(window)
  61     void SetTmpDefaultItem(wxWindow *win) { m_winTmpDefault = win; }
  62
  63     // the methods to be called from the window event handlers
  64     void HandleOnNavigationKey(wxNavigationKeyEvent& event);
  65     void HandleOnFocus(wxFocusEvent& event);
  66     void HandleOnWindowDestroy(wxWindowBase *child);
  67
  68     // should be called from SetFocus(), returns FALSE if we did nothing with
  69     // the focus and the default processing should take place
  70     bool DoSetFocus();
  71
  72     // can our child get the focus?
  73     bool AcceptsFocus() const;
  74
  75     // called from OnChildFocus() handler, i.e. when one of our (grand)
  76     // children gets the focus
  77     void SetLastFocus(wxWindow *win);
  78
  79 protected:
  80     // set the focus to the child which had it the last time
  81     bool SetFocusToChild();
  82
  83     // the parent window we manage the children for
  84     wxWindow *m_winParent;
  85
  86     // the child which had the focus last time this panel was activated
  87     wxWindow *m_winLastFocused;
  88
  89     // a default window (usually a button) or NULL
  90     wxWindow *m_winDefault;
  91
  92     // a temporary override of m_winDefault, use the latter if NULL
  93     wxWindow *m_winTmpDefault;
  94
  95     DECLARE_NO_COPY_CLASS(wxControlContainer)
  96 };
  97
  98 // this function is for wxWindows internal use only
  99 extern bool wxSetFocusToChild(wxWindow *win, wxWindow **child);
 100
 101 // ----------------------------------------------------------------------------
 102 // macros which may be used by the classes wishing to implement TAB navigation
 103 // among their children
 104 // ----------------------------------------------------------------------------
 105
 106 // declare the methods to be forwarded
 107 #define WX_DECLARE_CONTROL_CONTAINER() \
 108 public: \
 109     void OnNavigationKey(wxNavigationKeyEvent& event); \
 110     void OnFocus(wxFocusEvent& event); \
 111     virtual void OnChildFocus(wxChildFocusEvent& event); \
 112     virtual void SetFocus(); \
 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::OnChildFocus(wxChildFocusEvent& event) \
 164 { \
 165     m_container.SetLastFocus(event.GetWindow()); \
 166 } \
 167  \
 168 void classname::OnFocus(wxFocusEvent& event) \
 169 { \
 170     m_container.HandleOnFocus(event); \
 171 } \
 172 bool classname::AcceptsFocus() const \
 173 { \
 174     return m_container.AcceptsFocus(); \
 175 }
 176
 177
 178 #endif // _WX_CONTAINR_H_