]> git.saurik.com Git - wxWidgets.git/blame - include/wx/containr.h
Added simplistic makefile/project files for wxWinCE.
[wxWidgets.git] / include / wx / containr.h
CommitLineData
456bc6d9
VZ
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
af49c4b8 16#if defined(__GNUG__) && !defined(__APPLE__)
dad5f99a 17 #pragma interface "containr.h"
456bc6d9
VZ
18#endif
19
20class WXDLLEXPORT wxFocusEvent;
21class WXDLLEXPORT wxNavigationKeyEvent;
22class WXDLLEXPORT wxWindow;
6285be72 23class WXDLLEXPORT wxWindowBase;
456bc6d9
VZ
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
38class WXDLLEXPORT wxControlContainer
39{
40public:
41 // ctors and such
9948d31f
VZ
42 wxControlContainer(wxWindow *winParent = NULL);
43 void SetContainerWindow(wxWindow *winParent) { m_winParent = winParent; }
456bc6d9 44
036da5e3
VZ
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
456bc6d9
VZ
56 wxWindow *SetDefaultItem(wxWindow *win)
57 { wxWindow *winOld = m_winDefault; m_winDefault = win; return winOld; }
58
036da5e3
VZ
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
456bc6d9
VZ
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
24a7a198
VZ
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();
456bc6d9 71
9948d31f
VZ
72 // called from OnChildFocus() handler, i.e. when one of our (grand)
73 // children gets the focus
74 void SetLastFocus(wxWindow *win);
75
456bc6d9
VZ
76protected:
77 // set the focus to the child which had it the last time
78 bool SetFocusToChild();
79
80 // the parent window we manage the children for
81 wxWindow *m_winParent;
82
83 // the child which had the focus last time this panel was activated
84 wxWindow *m_winLastFocused;
85
036da5e3 86 // a default window (usually a button) or NULL
456bc6d9 87 wxWindow *m_winDefault;
036da5e3
VZ
88
89 // a temporary override of m_winDefault, use the latter if NULL
90 wxWindow *m_winTmpDefault;
91
92 DECLARE_NO_COPY_CLASS(wxControlContainer)
456bc6d9
VZ
93};
94
95// this function is for wxWindows internal use only
96extern bool wxSetFocusToChild(wxWindow *win, wxWindow **child);
97
98// ----------------------------------------------------------------------------
99// macros which may be used by the classes wishing to implement TAB navigation
100// among their children
101// ----------------------------------------------------------------------------
102
103// declare the methods to be forwarded
104#define WX_DECLARE_CONTROL_CONTAINER() \
6b55490a 105public: \
456bc6d9
VZ
106 void OnNavigationKey(wxNavigationKeyEvent& event); \
107 void OnFocus(wxFocusEvent& event); \
108 virtual void OnChildFocus(wxChildFocusEvent& event); \
109 virtual void SetFocus(); \
110 virtual void RemoveChild(wxWindowBase *child); \
111 virtual wxWindow *GetDefaultItem() const; \
6b55490a 112 virtual wxWindow *SetDefaultItem(wxWindow *child); \
036da5e3 113 virtual void SetTmpDefaultItem(wxWindow *win); \
6b55490a
VZ
114\
115protected: \
116 wxControlContainer m_container
456bc6d9
VZ
117
118// implement the event table entries for wxControlContainer
119#define WX_EVENT_TABLE_CONTROL_CONTAINER(classname) \
120 EVT_SET_FOCUS(classname::OnFocus) \
121 EVT_CHILD_FOCUS(classname::OnChildFocus) \
122 EVT_NAVIGATION_KEY(classname::OnNavigationKey)
123
124// implement the methods forwarding to the wxControlContainer
6b55490a 125#define WX_DELEGATE_TO_CONTROL_CONTAINER(classname) \
456bc6d9
VZ
126wxWindow *classname::SetDefaultItem(wxWindow *child) \
127{ \
6b55490a 128 return m_container.SetDefaultItem(child); \
456bc6d9
VZ
129} \
130 \
036da5e3
VZ
131void classname::SetTmpDefaultItem(wxWindow *child) \
132{ \
133 m_container.SetTmpDefaultItem(child); \
134} \
135 \
456bc6d9
VZ
136wxWindow *classname::GetDefaultItem() const \
137{ \
6b55490a 138 return m_container.GetDefaultItem(); \
456bc6d9
VZ
139} \
140 \
141void classname::OnNavigationKey( wxNavigationKeyEvent& event ) \
142{ \
6b55490a 143 m_container.HandleOnNavigationKey(event); \
456bc6d9
VZ
144} \
145 \
146void classname::RemoveChild(wxWindowBase *child) \
147{ \
6b55490a 148 m_container.HandleOnWindowDestroy(child); \
456bc6d9
VZ
149 \
150 wxWindow::RemoveChild(child); \
151} \
152 \
153void classname::SetFocus() \
154{ \
6b55490a 155 if ( !m_container.DoSetFocus() ) \
24a7a198 156 wxWindow::SetFocus(); \
456bc6d9
VZ
157} \
158 \
159void classname::OnChildFocus(wxChildFocusEvent& event) \
160{ \
6b55490a 161 m_container.SetLastFocus(event.GetWindow()); \
456bc6d9
VZ
162} \
163 \
164void classname::OnFocus(wxFocusEvent& event) \
165{ \
6b55490a 166 m_container.HandleOnFocus(event); \
456bc6d9
VZ
167}
168
169
170#endif // _WX_CONTAINR_H_