]>
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> | |
371a5b4e | 9 | // License: wxWindows licence |
1e6feb95 VZ |
10 | /////////////////////////////////////////////////////////////////////////////// |
11 | ||
12 | #ifndef _WX_POPUPWIN_H_BASE_ | |
13 | #define _WX_POPUPWIN_H_BASE_ | |
14 | ||
af49c4b8 | 15 | #if defined(__GNUG__) && !defined(__APPLE__) |
6522713c | 16 | #pragma interface "popupwinbase.h" |
1e6feb95 VZ |
17 | #endif |
18 | ||
19 | #include "wx/window.h" | |
20 | ||
21 | #if wxUSE_POPUPWIN | |
1e6feb95 VZ |
22 | // ---------------------------------------------------------------------------- |
23 | // wxPopupWindow: a special kind of top level window used for popup menus, | |
24 | // combobox popups and such. | |
25 | // ---------------------------------------------------------------------------- | |
26 | ||
27 | class WXDLLEXPORT wxPopupWindowBase : public wxWindow | |
28 | { | |
29 | public: | |
30 | wxPopupWindowBase() { } | |
799ea011 | 31 | virtual ~wxPopupWindowBase(); |
1e6feb95 VZ |
32 | |
33 | // create the popup window | |
34 | // | |
35 | // style may only contain border flags | |
36 | bool Create(wxWindow *parent, int style = wxBORDER_NONE); | |
37 | ||
38 | // move the popup window to the right position, i.e. such that it is | |
39 | // entirely visible | |
40 | // | |
41 | // the popup is positioned at ptOrigin + size if it opens below and to the | |
42 | // right (default), at ptOrigin - sizePopup if it opens above and to the | |
43 | // left &c | |
44 | // | |
45 | // the point must be given in screen coordinates! | |
46 | virtual void Position(const wxPoint& ptOrigin, | |
47 | const wxSize& size); | |
fc7a2a60 VZ |
48 | |
49 | DECLARE_NO_COPY_CLASS(wxPopupWindowBase) | |
1e6feb95 VZ |
50 | }; |
51 | ||
19193a2c | 52 | |
1e6feb95 VZ |
53 | // include the real class declaration |
54 | #ifdef __WXMSW__ | |
55 | #include "wx/msw/popupwin.h" | |
19193a2c KB |
56 | #elif __WXPM__ |
57 | #include "wx/os2/popupwin.h" | |
9f41d601 RR |
58 | #elif __WXGTK__ |
59 | #include "wx/gtk/popupwin.h" | |
eddf46fe | 60 | #elif __WXX11__ |
83df96d6 | 61 | #include "wx/x11/popupwin.h" |
544c782d VS |
62 | #elif __WXMGL__ |
63 | #include "wx/mgl/popupwin.h" | |
1e6feb95 VZ |
64 | #else |
65 | #error "wxPopupWindow is not supported under this platform." | |
66 | #endif | |
67 | ||
68 | // ---------------------------------------------------------------------------- | |
69 | // wxPopupTransientWindow: a wxPopupWindow which disappears automatically | |
70 | // when the user clicks mouse outside it or if it loses focus in any other way | |
71 | // ---------------------------------------------------------------------------- | |
72 | ||
fbfb3fb3 VZ |
73 | class WXDLLEXPORT wxPopupWindowHandler; |
74 | class WXDLLEXPORT wxPopupFocusHandler; | |
75 | ||
1e6feb95 VZ |
76 | class WXDLLEXPORT wxPopupTransientWindow : public wxPopupWindow |
77 | { | |
78 | public: | |
79 | // ctors | |
80 | wxPopupTransientWindow() { Init(); } | |
758bce95 | 81 | wxPopupTransientWindow(wxWindow *parent, int style = wxBORDER_NONE); |
1e6feb95 VZ |
82 | |
83 | virtual ~wxPopupTransientWindow(); | |
84 | ||
85 | // popup the window (this will show it too) and keep focus at winFocus | |
86 | // (or itself if it's NULL), dismiss the popup if we lose focus | |
87 | virtual void Popup(wxWindow *focus = NULL); | |
88 | ||
89 | // hide the window | |
90 | virtual void Dismiss(); | |
ea1ad04b | 91 | |
7e25f59e VZ |
92 | // can the window be dismissed now? |
93 | // | |
94 | // VZ: where is this used?? | |
ea1ad04b RR |
95 | virtual bool CanDismiss() |
96 | { return TRUE; } | |
1e6feb95 VZ |
97 | |
98 | // called when a mouse is pressed while the popup is shown: return TRUE | |
99 | // from here to prevent its normal processing by the popup (which consists | |
100 | // in dismissing it if the mouse is cilcked outside it) | |
101 | virtual bool ProcessLeftDown(wxMouseEvent& event); | |
102 | ||
103 | protected: | |
104 | // common part of all ctors | |
105 | void Init(); | |
106 | ||
107 | // this is called when the popup is disappeared because of anything | |
108 | // else but direct call to Dismiss() | |
109 | virtual void OnDismiss(); | |
110 | ||
111 | // dismiss and notify the derived class | |
112 | void DismissAndNotify(); | |
113 | ||
114 | // remove our event handlers | |
115 | void PopHandlers(); | |
116 | ||
117 | // the child of this popup if any | |
118 | wxWindow *m_child; | |
119 | ||
120 | // the window which has the focus while we're shown | |
121 | wxWindow *m_focus; | |
122 | ||
d7cff34d | 123 | // these classes may call our DismissAndNotify() |
1e6feb95 VZ |
124 | friend class wxPopupWindowHandler; |
125 | friend class wxPopupFocusHandler; | |
6c3422e9 | 126 | |
d7cff34d VZ |
127 | // the handlers we created, may be NULL (if not, must be deleted) |
128 | wxPopupWindowHandler *m_handlerPopup; | |
129 | wxPopupFocusHandler *m_handlerFocus; | |
130 | ||
6c3422e9 | 131 | DECLARE_DYNAMIC_CLASS(wxPopupTransientWindow) |
22f3361e | 132 | DECLARE_NO_COPY_CLASS(wxPopupTransientWindow) |
1e6feb95 VZ |
133 | }; |
134 | ||
c9cdd31d | 135 | #if wxUSE_COMBOBOX && defined(__WXUNIVERSAL__) |
1e6feb95 VZ |
136 | |
137 | // ---------------------------------------------------------------------------- | |
138 | // wxPopupComboWindow: wxPopupTransientWindow used by wxComboBox | |
139 | // ---------------------------------------------------------------------------- | |
140 | ||
141 | class WXDLLEXPORT wxComboBox; | |
142 | class WXDLLEXPORT wxComboControl; | |
143 | ||
144 | class WXDLLEXPORT wxPopupComboWindow : public wxPopupTransientWindow | |
145 | { | |
146 | public: | |
6b598e05 | 147 | wxPopupComboWindow() { m_combo = NULL; } |
1e6feb95 VZ |
148 | wxPopupComboWindow(wxComboControl *parent); |
149 | ||
150 | bool Create(wxComboControl *parent); | |
151 | ||
152 | // position the window correctly relatively to the combo | |
153 | void PositionNearCombo(); | |
154 | ||
155 | protected: | |
156 | // notify the combo here | |
157 | virtual void OnDismiss(); | |
158 | ||
e0c83227 VZ |
159 | // forward the key presses to the combobox |
160 | void OnKeyDown(wxKeyEvent& event); | |
161 | ||
1e6feb95 VZ |
162 | // the parent combobox |
163 | wxComboControl *m_combo; | |
6c3422e9 | 164 | |
e0c83227 | 165 | DECLARE_EVENT_TABLE() |
6c3422e9 | 166 | DECLARE_DYNAMIC_CLASS(wxPopupComboWindow) |
1e6feb95 VZ |
167 | }; |
168 | ||
c9cdd31d | 169 | #endif // wxUSE_COMBOBOX && defined(__WXUNIVERSAL__) |
1e6feb95 VZ |
170 | |
171 | #endif // wxUSE_POPUPWIN | |
172 | ||
173 | #endif // _WX_POPUPWIN_H_BASE_ | |
174 |