]>
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> | |
9 | // License: wxWindows license | |
10 | /////////////////////////////////////////////////////////////////////////////// | |
11 | ||
12 | #ifndef _WX_POPUPWIN_H_BASE_ | |
13 | #define _WX_POPUPWIN_H_BASE_ | |
14 | ||
15 | #ifdef __GNUG__ | |
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); | |
48 | }; | |
49 | ||
19193a2c | 50 | |
1e6feb95 VZ |
51 | // include the real class declaration |
52 | #ifdef __WXMSW__ | |
53 | #include "wx/msw/popupwin.h" | |
19193a2c KB |
54 | #elif __WXPM__ |
55 | #include "wx/os2/popupwin.h" | |
9f41d601 RR |
56 | #elif __WXGTK__ |
57 | #include "wx/gtk/popupwin.h" | |
544c782d VS |
58 | #elif __WXMGL__ |
59 | #include "wx/mgl/popupwin.h" | |
1e6feb95 VZ |
60 | #else |
61 | #error "wxPopupWindow is not supported under this platform." | |
62 | #endif | |
63 | ||
64 | // ---------------------------------------------------------------------------- | |
65 | // wxPopupTransientWindow: a wxPopupWindow which disappears automatically | |
66 | // when the user clicks mouse outside it or if it loses focus in any other way | |
67 | // ---------------------------------------------------------------------------- | |
68 | ||
69 | class WXDLLEXPORT wxPopupTransientWindow : public wxPopupWindow | |
70 | { | |
71 | public: | |
72 | // ctors | |
73 | wxPopupTransientWindow() { Init(); } | |
758bce95 | 74 | wxPopupTransientWindow(wxWindow *parent, int style = wxBORDER_NONE); |
1e6feb95 VZ |
75 | |
76 | virtual ~wxPopupTransientWindow(); | |
77 | ||
78 | // popup the window (this will show it too) and keep focus at winFocus | |
79 | // (or itself if it's NULL), dismiss the popup if we lose focus | |
80 | virtual void Popup(wxWindow *focus = NULL); | |
81 | ||
82 | // hide the window | |
83 | virtual void Dismiss(); | |
84 | ||
85 | // called when a mouse is pressed while the popup is shown: return TRUE | |
86 | // from here to prevent its normal processing by the popup (which consists | |
87 | // in dismissing it if the mouse is cilcked outside it) | |
88 | virtual bool ProcessLeftDown(wxMouseEvent& event); | |
89 | ||
90 | protected: | |
91 | // common part of all ctors | |
92 | void Init(); | |
93 | ||
94 | // this is called when the popup is disappeared because of anything | |
95 | // else but direct call to Dismiss() | |
96 | virtual void OnDismiss(); | |
97 | ||
98 | // dismiss and notify the derived class | |
99 | void DismissAndNotify(); | |
100 | ||
101 | // remove our event handlers | |
102 | void PopHandlers(); | |
103 | ||
104 | // the child of this popup if any | |
105 | wxWindow *m_child; | |
106 | ||
107 | // the window which has the focus while we're shown | |
108 | wxWindow *m_focus; | |
109 | ||
d7cff34d | 110 | // these classes may call our DismissAndNotify() |
1e6feb95 VZ |
111 | friend class wxPopupWindowHandler; |
112 | friend class wxPopupFocusHandler; | |
6c3422e9 | 113 | |
d7cff34d VZ |
114 | // the handlers we created, may be NULL (if not, must be deleted) |
115 | wxPopupWindowHandler *m_handlerPopup; | |
116 | wxPopupFocusHandler *m_handlerFocus; | |
117 | ||
6c3422e9 | 118 | DECLARE_DYNAMIC_CLASS(wxPopupTransientWindow) |
1e6feb95 VZ |
119 | }; |
120 | ||
c9cdd31d | 121 | #if wxUSE_COMBOBOX && defined(__WXUNIVERSAL__) |
1e6feb95 VZ |
122 | |
123 | // ---------------------------------------------------------------------------- | |
124 | // wxPopupComboWindow: wxPopupTransientWindow used by wxComboBox | |
125 | // ---------------------------------------------------------------------------- | |
126 | ||
127 | class WXDLLEXPORT wxComboBox; | |
128 | class WXDLLEXPORT wxComboControl; | |
129 | ||
130 | class WXDLLEXPORT wxPopupComboWindow : public wxPopupTransientWindow | |
131 | { | |
132 | public: | |
6b598e05 | 133 | wxPopupComboWindow() { m_combo = NULL; } |
1e6feb95 VZ |
134 | wxPopupComboWindow(wxComboControl *parent); |
135 | ||
136 | bool Create(wxComboControl *parent); | |
137 | ||
138 | // position the window correctly relatively to the combo | |
139 | void PositionNearCombo(); | |
140 | ||
141 | protected: | |
142 | // notify the combo here | |
143 | virtual void OnDismiss(); | |
144 | ||
145 | // the parent combobox | |
146 | wxComboControl *m_combo; | |
6c3422e9 VZ |
147 | |
148 | DECLARE_DYNAMIC_CLASS(wxPopupComboWindow) | |
1e6feb95 VZ |
149 | }; |
150 | ||
c9cdd31d | 151 | #endif // wxUSE_COMBOBOX && defined(__WXUNIVERSAL__) |
1e6feb95 VZ |
152 | |
153 | #endif // wxUSE_POPUPWIN | |
154 | ||
155 | #endif // _WX_POPUPWIN_H_BASE_ | |
156 |