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