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 #ifdef __GNUG__
  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);
  43
  44     wxWindow *GetDefaultItem() const { return m_winDefault; }
  45     wxWindow *SetDefaultItem(wxWindow *win)
  46         { wxWindow *winOld = m_winDefault; m_winDefault = win; return winOld; }
  47
  48     void SetLastFocus(wxWindow *win);
  49
  50     // the methods to be called from the window event handlers
  51     void HandleOnNavigationKey(wxNavigationKeyEvent& event);
  52     void HandleOnFocus(wxFocusEvent& event);
  53     void HandleOnWindowDestroy(wxWindowBase *child);
  54
  55     // should be called from SetFocus(), returns FALSE if we did nothing with
  56     // the focus and the default processing should take place
  57     bool DoSetFocus();
  58
  59 protected:
  60     // set the focus to the child which had it the last time
  61     bool SetFocusToChild();
  62
  63     // the parent window we manage the children for
  64     wxWindow *m_winParent;
  65
  66     // the child which had the focus last time this panel was activated
  67     wxWindow *m_winLastFocused;
  68
  69     // a default window (e.g. a button) or NULL
  70     wxWindow *m_winDefault;
  71 };
  72
  73 // this function is for wxWindows internal use only
  74 extern bool wxSetFocusToChild(wxWindow *win, wxWindow **child);
  75
  76 // ----------------------------------------------------------------------------
  77 // macros which may be used by the classes wishing to implement TAB navigation
  78 // among their children
  79 // ----------------------------------------------------------------------------
  80
  81 // declare the methods to be forwarded
  82 #define WX_DECLARE_CONTROL_CONTAINER() \
  83 public: \
  84     void OnNavigationKey(wxNavigationKeyEvent& event); \
  85     void OnFocus(wxFocusEvent& event); \
  86     virtual void OnChildFocus(wxChildFocusEvent& event); \
  87     virtual void SetFocus(); \
  88     virtual void RemoveChild(wxWindowBase *child); \
  89     virtual wxWindow *GetDefaultItem() const; \
  90     virtual wxWindow *SetDefaultItem(wxWindow *child); \
  91 \
  92 protected: \
  93     wxControlContainer m_container
  94
  95 // implement the event table entries for wxControlContainer
  96 #define WX_EVENT_TABLE_CONTROL_CONTAINER(classname) \
  97     EVT_SET_FOCUS(classname::OnFocus) \
  98     EVT_CHILD_FOCUS(classname::OnChildFocus) \
  99     EVT_NAVIGATION_KEY(classname::OnNavigationKey)
 100
 101 // implement the methods forwarding to the wxControlContainer
 102 #define WX_DELEGATE_TO_CONTROL_CONTAINER(classname)  \
 103 wxWindow *classname::SetDefaultItem(wxWindow *child) \
 104 { \
 105     return m_container.SetDefaultItem(child); \
 106 } \
 107  \
 108 wxWindow *classname::GetDefaultItem() const \
 109 { \
 110     return m_container.GetDefaultItem(); \
 111 } \
 112  \
 113 void classname::OnNavigationKey( wxNavigationKeyEvent& event ) \
 114 { \
 115     m_container.HandleOnNavigationKey(event); \
 116 } \
 117  \
 118 void classname::RemoveChild(wxWindowBase *child) \
 119 { \
 120     m_container.HandleOnWindowDestroy(child); \
 121  \
 122     wxWindow::RemoveChild(child); \
 123 } \
 124  \
 125 void classname::SetFocus() \
 126 { \
 127     if ( !m_container.DoSetFocus() ) \
 128         wxWindow::SetFocus(); \
 129 } \
 130  \
 131 void classname::OnChildFocus(wxChildFocusEvent& event) \
 132 { \
 133     m_container.SetLastFocus(event.GetWindow()); \
 134 } \
 135  \
 136 void classname::OnFocus(wxFocusEvent& event) \
 137 { \
 138     m_container.HandleOnFocus(event); \
 139 }
 140
 141
 142 #endif // _WX_CONTAINR_H_