]> git.saurik.com Git - wxWidgets.git/blame_incremental - include/wx/containr.h
build fixes
[wxWidgets.git] / include / wx / containr.h
... / ...
CommitLineData
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#include "wx/defs.h"
17
18class WXDLLIMPEXP_FWD_CORE wxWindow;
19class WXDLLIMPEXP_FWD_CORE wxWindowBase;
20
21/*
22 Implementation note: wxControlContainer is not a real mix-in but rather
23 a class meant to be aggregated 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// wxControlContainerBase: common part used in both native and generic cases
32// ----------------------------------------------------------------------------
33
34class WXDLLEXPORT wxControlContainerBase
35{
36public:
37 // default ctor, SetContainerWindow() must be called later
38 wxControlContainerBase()
39 {
40 m_winParent = NULL;
41
42 // do accept focus initially, we'll stop doing it if/when any children
43 // are added
44 m_acceptsFocus = true;
45 m_inSetFocus = false;
46 m_winLastFocused = NULL;
47 }
48 virtual ~wxControlContainerBase() {}
49
50 void SetContainerWindow(wxWindow *winParent)
51 {
52 wxASSERT_MSG( !m_winParent, _T("shouldn't be called twice") );
53
54 m_winParent = winParent;
55 }
56
57 // should be called from SetFocus(), returns false if we did nothing with
58 // the focus and the default processing should take place
59 bool DoSetFocus();
60
61 // should be called when we decide that we should [stop] accepting focus
62 void SetCanFocus(bool acceptsFocus);
63
64 // returns whether we should accept focus ourselves or not
65 bool AcceptsFocus() const { return m_acceptsFocus; }
66
67 // returns whether we or one of our children accepts focus: we always do
68 // because if we don't have any focusable children it probably means that
69 // we're not being used as a container at all (think of wxGrid or generic
70 // wxListCtrl) and so should get focus for ourselves
71 bool AcceptsFocusRecursively() const { return true; }
72
73 // Call this when the number of children of the window changes.
74 // If we have any children, this panel (used just as container for
75 // them) shouldn't get focus for itself.
76 void UpdateCanFocus() { SetCanFocus(!HasAnyFocusableChildren()); }
77
78protected:
79 // set the focus to the child which had it the last time
80 virtual bool SetFocusToChild();
81
82 // return true if we have any children accepting focus
83 bool HasAnyFocusableChildren() const;
84
85 // the parent window we manage the children for
86 wxWindow *m_winParent;
87
88 // the child which had the focus last time this panel was activated
89 wxWindow *m_winLastFocused;
90
91private:
92 // value returned by AcceptsFocus(), should be changed using SetCanFocus()
93 // only
94 bool m_acceptsFocus;
95
96 // a guard against infinite recursion
97 bool m_inSetFocus;
98};
99
100// common part of WX_DECLARE_CONTROL_CONTAINER in the native and generic cases,
101// it should be used in the wxWindow-derived class declaration
102#define WX_DECLARE_CONTROL_CONTAINER_BASE() \
103public: \
104 virtual bool AcceptsFocus() const; \
105 virtual bool AcceptsFocusRecursively() const; \
106 virtual void AddChild(wxWindowBase *child); \
107 virtual void RemoveChild(wxWindowBase *child); \
108 virtual void SetFocus(); \
109 void SetFocusIgnoringChildren(); \
110 void AcceptFocus(bool acceptFocus) \
111 { \
112 m_container.SetCanFocus(acceptFocus); \
113 } \
114 \
115protected: \
116 wxControlContainer m_container
117
118// this macro must be used in the derived class ctor
119#define WX_INIT_CONTROL_CONTAINER() \
120 m_container.SetContainerWindow(this)
121
122// common part of WX_DELEGATE_TO_CONTROL_CONTAINER in the native and generic
123// cases, must be used in the wxWindow-derived class implementation
124#define WX_DELEGATE_TO_CONTROL_CONTAINER_BASE(classname, basename) \
125 void classname::AddChild(wxWindowBase *child) \
126 { \
127 basename::AddChild(child); \
128 \
129 m_container.UpdateCanFocus(); \
130 } \
131 \
132 bool classname::AcceptsFocusRecursively() const \
133 { \
134 return m_container.AcceptsFocusRecursively(); \
135 } \
136 \
137 void classname::SetFocus() \
138 { \
139 if ( !m_container.DoSetFocus() ) \
140 basename::SetFocus(); \
141 } \
142 \
143 bool classname::AcceptsFocus() const \
144 { \
145 return m_container.AcceptsFocus(); \
146 }
147
148
149#ifdef wxHAS_NATIVE_TAB_TRAVERSAL
150
151// ----------------------------------------------------------------------------
152// wxControlContainer for native TAB navigation
153// ----------------------------------------------------------------------------
154
155// this must be a real class as we forward-declare it elsewhere
156class WXDLLEXPORT wxControlContainer : public wxControlContainerBase
157{
158protected:
159 // set the focus to the child which had it the last time
160 virtual bool SetFocusToChild();
161};
162
163#define WX_EVENT_TABLE_CONTROL_CONTAINER(classname)
164
165#define WX_DECLARE_CONTROL_CONTAINER WX_DECLARE_CONTROL_CONTAINER_BASE
166
167#define WX_DELEGATE_TO_CONTROL_CONTAINER(classname, basename) \
168 WX_DELEGATE_TO_CONTROL_CONTAINER_BASE(classname, basename) \
169 \
170 void classname::RemoveChild(wxWindowBase *child) \
171 { \
172 basename::RemoveChild(child); \
173 \
174 m_container.UpdateCanFocus(); \
175 } \
176 \
177 void classname::SetFocusIgnoringChildren() \
178 { \
179 basename::SetFocus(); \
180 }
181
182#else // !wxHAS_NATIVE_TAB_TRAVERSAL
183
184class WXDLLIMPEXP_FWD_CORE wxFocusEvent;
185class WXDLLIMPEXP_FWD_CORE wxNavigationKeyEvent;
186
187// ----------------------------------------------------------------------------
188// wxControlContainer for TAB navigation implemented in wx itself
189// ----------------------------------------------------------------------------
190
191class WXDLLEXPORT wxControlContainer : public wxControlContainerBase
192{
193public:
194 // default ctor, SetContainerWindow() must be called later
195 wxControlContainer();
196
197 // the methods to be called from the window event handlers
198 void HandleOnNavigationKey(wxNavigationKeyEvent& event);
199 void HandleOnFocus(wxFocusEvent& event);
200 void HandleOnWindowDestroy(wxWindowBase *child);
201
202 // called from OnChildFocus() handler, i.e. when one of our (grand)
203 // children gets the focus
204 void SetLastFocus(wxWindow *win);
205
206protected:
207
208 DECLARE_NO_COPY_CLASS(wxControlContainer)
209};
210
211// ----------------------------------------------------------------------------
212// macros which may be used by the classes wishing to implement TAB navigation
213// among their children
214// ----------------------------------------------------------------------------
215
216// declare the methods to be forwarded
217#define WX_DECLARE_CONTROL_CONTAINER() \
218 WX_DECLARE_CONTROL_CONTAINER_BASE(); \
219 \
220public: \
221 void OnNavigationKey(wxNavigationKeyEvent& event); \
222 void OnFocus(wxFocusEvent& event); \
223 virtual void OnChildFocus(wxChildFocusEvent& event)
224
225// implement the event table entries for wxControlContainer
226#define WX_EVENT_TABLE_CONTROL_CONTAINER(classname) \
227 EVT_SET_FOCUS(classname::OnFocus) \
228 EVT_CHILD_FOCUS(classname::OnChildFocus) \
229 EVT_NAVIGATION_KEY(classname::OnNavigationKey)
230
231// implement the methods forwarding to the wxControlContainer
232#define WX_DELEGATE_TO_CONTROL_CONTAINER(classname, basename) \
233 WX_DELEGATE_TO_CONTROL_CONTAINER_BASE(classname, basename) \
234 \
235 void classname::RemoveChild(wxWindowBase *child) \
236 { \
237 m_container.HandleOnWindowDestroy(child); \
238 \
239 basename::RemoveChild(child); \
240 \
241 m_container.UpdateCanFocus(); \
242 } \
243 \
244 void classname::OnNavigationKey( wxNavigationKeyEvent& event ) \
245 { \
246 m_container.HandleOnNavigationKey(event); \
247 } \
248 \
249 void classname::SetFocusIgnoringChildren() \
250 { \
251 basename::SetFocus(); \
252 } \
253 \
254 void classname::OnChildFocus(wxChildFocusEvent& event) \
255 { \
256 m_container.SetLastFocus(event.GetWindow()); \
257 } \
258 \
259 void classname::OnFocus(wxFocusEvent& event) \
260 { \
261 m_container.HandleOnFocus(event); \
262 }
263
264#endif // wxHAS_NATIVE_TAB_TRAVERSAL/!wxHAS_NATIVE_TAB_TRAVERSAL
265
266// this function is for wxWidgets internal use only
267extern bool wxSetFocusToChild(wxWindow *win, wxWindow **child);
268
269#endif // _WX_CONTAINR_H_