]>
Commit | Line | Data |
---|---|---|
1e6feb95 VZ |
1 | /////////////////////////////////////////////////////////////////////////////// |
2 | // Name: wx/popupwin.h | |
3 | // Purpose: wxPopupWindow interface declaration | |
4 | // Author: Vadim Zeitlin | |
5 | // Modified by: | |
6 | // Created: 06.01.01 | |
7 | // RCS-ID: $Id$ | |
8 | // Copyright: (c) 2001 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr> | |
65571936 | 9 | // License: wxWindows licence |
1e6feb95 VZ |
10 | /////////////////////////////////////////////////////////////////////////////// |
11 | ||
12 | #ifndef _WX_POPUPWIN_H_BASE_ | |
13 | #define _WX_POPUPWIN_H_BASE_ | |
14 | ||
2ecf902b | 15 | #include "wx/defs.h" |
1e6feb95 VZ |
16 | |
17 | #if wxUSE_POPUPWIN | |
2ecf902b | 18 | |
42b0d8b9 | 19 | #include "wx/nonownedwnd.h" |
2ecf902b | 20 | |
1e6feb95 VZ |
21 | // ---------------------------------------------------------------------------- |
22 | // wxPopupWindow: a special kind of top level window used for popup menus, | |
23 | // combobox popups and such. | |
24 | // ---------------------------------------------------------------------------- | |
25 | ||
42b0d8b9 | 26 | class WXDLLEXPORT wxPopupWindowBase : public wxNonOwnedWindow |
1e6feb95 VZ |
27 | { |
28 | public: | |
29 | wxPopupWindowBase() { } | |
799ea011 | 30 | virtual ~wxPopupWindowBase(); |
1e6feb95 VZ |
31 | |
32 | // create the popup window | |
33 | // | |
34 | // style may only contain border flags | |
35 | bool Create(wxWindow *parent, int style = wxBORDER_NONE); | |
36 | ||
37 | // move the popup window to the right position, i.e. such that it is | |
38 | // entirely visible | |
39 | // | |
40 | // the popup is positioned at ptOrigin + size if it opens below and to the | |
41 | // right (default), at ptOrigin - sizePopup if it opens above and to the | |
42 | // left &c | |
43 | // | |
44 | // the point must be given in screen coordinates! | |
45 | virtual void Position(const wxPoint& ptOrigin, | |
46 | const wxSize& size); | |
fc7a2a60 | 47 | |
7e548f6b | 48 | virtual bool IsTopLevel() const { return true; } |
bd507486 | 49 | |
fc7a2a60 | 50 | DECLARE_NO_COPY_CLASS(wxPopupWindowBase) |
1e6feb95 VZ |
51 | }; |
52 | ||
19193a2c | 53 | |
1e6feb95 | 54 | // include the real class declaration |
0872eaf9 | 55 | #if defined(__WXMSW__) |
1e6feb95 | 56 | #include "wx/msw/popupwin.h" |
0872eaf9 | 57 | #elif defined(__WXPM__) |
19193a2c | 58 | #include "wx/os2/popupwin.h" |
1be7a35c | 59 | #elif defined(__WXGTK20__) |
9f41d601 | 60 | #include "wx/gtk/popupwin.h" |
1be7a35c MR |
61 | #elif defined(__WXGTK__) |
62 | #include "wx/gtk1/popupwin.h" | |
0872eaf9 | 63 | #elif defined(__WXX11__) |
83df96d6 | 64 | #include "wx/x11/popupwin.h" |
0872eaf9 | 65 | #elif defined(__WXMOTIF__) |
833a51f6 | 66 | #include "wx/motif/popupwin.h" |
42b0d8b9 VS |
67 | #elif defined(__WXDFB__) |
68 | #include "wx/dfb/popupwin.h" | |
0872eaf9 | 69 | #elif defined(__WXMGL__) |
544c782d | 70 | #include "wx/mgl/popupwin.h" |
e4346967 SC |
71 | #elif defined(__WXMAC__) |
72 | #include "wx/mac/popupwin.h" | |
1e6feb95 VZ |
73 | #else |
74 | #error "wxPopupWindow is not supported under this platform." | |
75 | #endif | |
76 | ||
77 | // ---------------------------------------------------------------------------- | |
78 | // wxPopupTransientWindow: a wxPopupWindow which disappears automatically | |
79 | // when the user clicks mouse outside it or if it loses focus in any other way | |
80 | // ---------------------------------------------------------------------------- | |
81 | ||
b5dbe15d VS |
82 | class WXDLLIMPEXP_FWD_CORE wxPopupWindowHandler; |
83 | class WXDLLIMPEXP_FWD_CORE wxPopupFocusHandler; | |
fbfb3fb3 | 84 | |
1e6feb95 VZ |
85 | class WXDLLEXPORT wxPopupTransientWindow : public wxPopupWindow |
86 | { | |
87 | public: | |
88 | // ctors | |
89 | wxPopupTransientWindow() { Init(); } | |
758bce95 | 90 | wxPopupTransientWindow(wxWindow *parent, int style = wxBORDER_NONE); |
1e6feb95 VZ |
91 | |
92 | virtual ~wxPopupTransientWindow(); | |
93 | ||
94 | // popup the window (this will show it too) and keep focus at winFocus | |
95 | // (or itself if it's NULL), dismiss the popup if we lose focus | |
96 | virtual void Popup(wxWindow *focus = NULL); | |
97 | ||
98 | // hide the window | |
99 | virtual void Dismiss(); | |
ea1ad04b | 100 | |
7e25f59e VZ |
101 | // can the window be dismissed now? |
102 | // | |
103 | // VZ: where is this used?? | |
ea1ad04b | 104 | virtual bool CanDismiss() |
7e548f6b | 105 | { return true; } |
1e6feb95 | 106 | |
7e548f6b | 107 | // called when a mouse is pressed while the popup is shown: return true |
1e6feb95 VZ |
108 | // from here to prevent its normal processing by the popup (which consists |
109 | // in dismissing it if the mouse is cilcked outside it) | |
110 | virtual bool ProcessLeftDown(wxMouseEvent& event); | |
111 | ||
537a0880 RR |
112 | // Overridden to grab the input on some plaforms |
113 | virtual bool Show( bool show = true ); | |
2ecf902b | 114 | |
1e6feb95 VZ |
115 | protected: |
116 | // common part of all ctors | |
117 | void Init(); | |
118 | ||
119 | // this is called when the popup is disappeared because of anything | |
120 | // else but direct call to Dismiss() | |
121 | virtual void OnDismiss(); | |
122 | ||
123 | // dismiss and notify the derived class | |
124 | void DismissAndNotify(); | |
125 | ||
126 | // remove our event handlers | |
127 | void PopHandlers(); | |
128 | ||
276612f7 RD |
129 | // get alerted when child gets deleted from under us |
130 | void OnDestroy(wxWindowDestroyEvent& event); | |
131 | ||
53b9afde | 132 | #if defined( __WXMSW__ ) || defined( __WXMAC__) |
414f2513 RD |
133 | // check if the mouse needs captured or released |
134 | void OnIdle(wxIdleEvent& event); | |
135 | #endif | |
0872eaf9 | 136 | |
1e6feb95 VZ |
137 | // the child of this popup if any |
138 | wxWindow *m_child; | |
139 | ||
140 | // the window which has the focus while we're shown | |
141 | wxWindow *m_focus; | |
142 | ||
d7cff34d | 143 | // these classes may call our DismissAndNotify() |
1e6feb95 VZ |
144 | friend class wxPopupWindowHandler; |
145 | friend class wxPopupFocusHandler; | |
6c3422e9 | 146 | |
d7cff34d VZ |
147 | // the handlers we created, may be NULL (if not, must be deleted) |
148 | wxPopupWindowHandler *m_handlerPopup; | |
149 | wxPopupFocusHandler *m_handlerFocus; | |
150 | ||
414f2513 | 151 | DECLARE_EVENT_TABLE() |
6c3422e9 | 152 | DECLARE_DYNAMIC_CLASS(wxPopupTransientWindow) |
22f3361e | 153 | DECLARE_NO_COPY_CLASS(wxPopupTransientWindow) |
1e6feb95 VZ |
154 | }; |
155 | ||
c9cdd31d | 156 | #if wxUSE_COMBOBOX && defined(__WXUNIVERSAL__) |
1e6feb95 VZ |
157 | |
158 | // ---------------------------------------------------------------------------- | |
159 | // wxPopupComboWindow: wxPopupTransientWindow used by wxComboBox | |
160 | // ---------------------------------------------------------------------------- | |
161 | ||
b5dbe15d VS |
162 | class WXDLLIMPEXP_FWD_CORE wxComboBox; |
163 | class WXDLLIMPEXP_FWD_CORE wxComboCtrl; | |
1e6feb95 VZ |
164 | |
165 | class WXDLLEXPORT wxPopupComboWindow : public wxPopupTransientWindow | |
166 | { | |
167 | public: | |
6b598e05 | 168 | wxPopupComboWindow() { m_combo = NULL; } |
a57d600f | 169 | wxPopupComboWindow(wxComboCtrl *parent); |
1e6feb95 | 170 | |
a57d600f | 171 | bool Create(wxComboCtrl *parent); |
1e6feb95 VZ |
172 | |
173 | // position the window correctly relatively to the combo | |
174 | void PositionNearCombo(); | |
175 | ||
176 | protected: | |
177 | // notify the combo here | |
178 | virtual void OnDismiss(); | |
179 | ||
e0c83227 VZ |
180 | // forward the key presses to the combobox |
181 | void OnKeyDown(wxKeyEvent& event); | |
182 | ||
1e6feb95 | 183 | // the parent combobox |
a57d600f | 184 | wxComboCtrl *m_combo; |
6c3422e9 | 185 | |
e0c83227 | 186 | DECLARE_EVENT_TABLE() |
6c3422e9 | 187 | DECLARE_DYNAMIC_CLASS(wxPopupComboWindow) |
1e6feb95 VZ |
188 | }; |
189 | ||
c9cdd31d | 190 | #endif // wxUSE_COMBOBOX && defined(__WXUNIVERSAL__) |
1e6feb95 VZ |
191 | |
192 | #endif // wxUSE_POPUPWIN | |
193 | ||
194 | #endif // _WX_POPUPWIN_H_BASE_ |