| 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(NO_GCC_PRAGMA) |
| 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 | // a guard against infinite recursion |
| 96 | bool m_inSetFocus; |
| 97 | |
| 98 | DECLARE_NO_COPY_CLASS(wxControlContainer) |
| 99 | }; |
| 100 | |
| 101 | // this function is for wxWidgets internal use only |
| 102 | extern bool wxSetFocusToChild(wxWindow *win, wxWindow **child); |
| 103 | |
| 104 | // ---------------------------------------------------------------------------- |
| 105 | // macros which may be used by the classes wishing to implement TAB navigation |
| 106 | // among their children |
| 107 | // ---------------------------------------------------------------------------- |
| 108 | |
| 109 | // declare the methods to be forwarded |
| 110 | #define WX_DECLARE_CONTROL_CONTAINER() \ |
| 111 | public: \ |
| 112 | void OnNavigationKey(wxNavigationKeyEvent& event); \ |
| 113 | void OnFocus(wxFocusEvent& event); \ |
| 114 | virtual void OnChildFocus(wxChildFocusEvent& event); \ |
| 115 | virtual void SetFocus(); \ |
| 116 | virtual void SetFocusIgnoringChildren(); \ |
| 117 | virtual void RemoveChild(wxWindowBase *child); \ |
| 118 | virtual wxWindow *GetDefaultItem() const; \ |
| 119 | virtual wxWindow *SetDefaultItem(wxWindow *child); \ |
| 120 | virtual void SetTmpDefaultItem(wxWindow *win); \ |
| 121 | virtual bool AcceptsFocus() const; \ |
| 122 | \ |
| 123 | protected: \ |
| 124 | wxControlContainer m_container |
| 125 | |
| 126 | // implement the event table entries for wxControlContainer |
| 127 | #define WX_EVENT_TABLE_CONTROL_CONTAINER(classname) \ |
| 128 | EVT_SET_FOCUS(classname::OnFocus) \ |
| 129 | EVT_CHILD_FOCUS(classname::OnChildFocus) \ |
| 130 | EVT_NAVIGATION_KEY(classname::OnNavigationKey) |
| 131 | |
| 132 | // implement the methods forwarding to the wxControlContainer |
| 133 | #define WX_DELEGATE_TO_CONTROL_CONTAINER(classname) \ |
| 134 | wxWindow *classname::SetDefaultItem(wxWindow *child) \ |
| 135 | { \ |
| 136 | return m_container.SetDefaultItem(child); \ |
| 137 | } \ |
| 138 | \ |
| 139 | void classname::SetTmpDefaultItem(wxWindow *child) \ |
| 140 | { \ |
| 141 | m_container.SetTmpDefaultItem(child); \ |
| 142 | } \ |
| 143 | \ |
| 144 | wxWindow *classname::GetDefaultItem() const \ |
| 145 | { \ |
| 146 | return m_container.GetDefaultItem(); \ |
| 147 | } \ |
| 148 | \ |
| 149 | void classname::OnNavigationKey( wxNavigationKeyEvent& event ) \ |
| 150 | { \ |
| 151 | m_container.HandleOnNavigationKey(event); \ |
| 152 | } \ |
| 153 | \ |
| 154 | void classname::RemoveChild(wxWindowBase *child) \ |
| 155 | { \ |
| 156 | m_container.HandleOnWindowDestroy(child); \ |
| 157 | \ |
| 158 | wxWindow::RemoveChild(child); \ |
| 159 | } \ |
| 160 | \ |
| 161 | void classname::SetFocus() \ |
| 162 | { \ |
| 163 | if ( !m_container.DoSetFocus() ) \ |
| 164 | wxWindow::SetFocus(); \ |
| 165 | } \ |
| 166 | \ |
| 167 | void classname::SetFocusIgnoringChildren() \ |
| 168 | { \ |
| 169 | wxWindow::SetFocus(); \ |
| 170 | } \ |
| 171 | \ |
| 172 | void classname::OnChildFocus(wxChildFocusEvent& event) \ |
| 173 | { \ |
| 174 | m_container.SetLastFocus(event.GetWindow()); \ |
| 175 | } \ |
| 176 | \ |
| 177 | void classname::OnFocus(wxFocusEvent& event) \ |
| 178 | { \ |
| 179 | m_container.HandleOnFocus(event); \ |
| 180 | } \ |
| 181 | bool classname::AcceptsFocus() const \ |
| 182 | { \ |
| 183 | return m_container.AcceptsFocus(); \ |
| 184 | } |
| 185 | |
| 186 | |
| 187 | #endif // _WX_CONTAINR_H_ |