]> git.saurik.com Git - wxWidgets.git/blob - include/wx/popupwin.h
wxSizeEvent now carries the total size, not just the client size
[wxWidgets.git] / include / wx / popupwin.h
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__
16 #pragma interface "popupwinbase.h"
17 #endif
18
19 #include "wx/window.h"
20
21 #if wxUSE_POPUPWIN
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() { }
31 virtual ~wxPopupWindowBase();
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
50
51 // include the real class declaration
52 #ifdef __WXMSW__
53 #include "wx/msw/popupwin.h"
54 #elif __WXPM__
55 #include "wx/os2/popupwin.h"
56 #elif __WXGTK__
57 #include "wx/gtk/popupwin.h"
58 #elif __WXX11__
59 #include "wx/x11/popupwin.h"
60 #elif __WXMGL__
61 #include "wx/mgl/popupwin.h"
62 #else
63 #error "wxPopupWindow is not supported under this platform."
64 #endif
65
66 // ----------------------------------------------------------------------------
67 // wxPopupTransientWindow: a wxPopupWindow which disappears automatically
68 // when the user clicks mouse outside it or if it loses focus in any other way
69 // ----------------------------------------------------------------------------
70
71 class WXDLLEXPORT wxPopupWindowHandler;
72 class WXDLLEXPORT wxPopupFocusHandler;
73
74 class WXDLLEXPORT wxPopupTransientWindow : public wxPopupWindow
75 {
76 public:
77 // ctors
78 wxPopupTransientWindow() { Init(); }
79 wxPopupTransientWindow(wxWindow *parent, int style = wxBORDER_NONE);
80
81 virtual ~wxPopupTransientWindow();
82
83 // popup the window (this will show it too) and keep focus at winFocus
84 // (or itself if it's NULL), dismiss the popup if we lose focus
85 virtual void Popup(wxWindow *focus = NULL);
86
87 // hide the window
88 virtual void Dismiss();
89
90
91 virtual bool CanDismiss()
92 { return TRUE; }
93
94 // called when a mouse is pressed while the popup is shown: return TRUE
95 // from here to prevent its normal processing by the popup (which consists
96 // in dismissing it if the mouse is cilcked outside it)
97 virtual bool ProcessLeftDown(wxMouseEvent& event);
98
99 protected:
100 // common part of all ctors
101 void Init();
102
103 // this is called when the popup is disappeared because of anything
104 // else but direct call to Dismiss()
105 virtual void OnDismiss();
106
107 // dismiss and notify the derived class
108 void DismissAndNotify();
109
110 // remove our event handlers
111 void PopHandlers();
112
113 // the child of this popup if any
114 wxWindow *m_child;
115
116 // the window which has the focus while we're shown
117 wxWindow *m_focus;
118
119 // these classes may call our DismissAndNotify()
120 friend class wxPopupWindowHandler;
121 friend class wxPopupFocusHandler;
122
123 // the handlers we created, may be NULL (if not, must be deleted)
124 wxPopupWindowHandler *m_handlerPopup;
125 wxPopupFocusHandler *m_handlerFocus;
126
127 DECLARE_DYNAMIC_CLASS(wxPopupTransientWindow)
128 };
129
130 #if wxUSE_COMBOBOX && defined(__WXUNIVERSAL__)
131
132 // ----------------------------------------------------------------------------
133 // wxPopupComboWindow: wxPopupTransientWindow used by wxComboBox
134 // ----------------------------------------------------------------------------
135
136 class WXDLLEXPORT wxComboBox;
137 class WXDLLEXPORT wxComboControl;
138
139 class WXDLLEXPORT wxPopupComboWindow : public wxPopupTransientWindow
140 {
141 public:
142 wxPopupComboWindow() { m_combo = NULL; }
143 wxPopupComboWindow(wxComboControl *parent);
144
145 bool Create(wxComboControl *parent);
146
147 // position the window correctly relatively to the combo
148 void PositionNearCombo();
149
150 protected:
151 // notify the combo here
152 virtual void OnDismiss();
153
154 // forward the key presses to the combobox
155 void OnKeyDown(wxKeyEvent& event);
156
157 // the parent combobox
158 wxComboControl *m_combo;
159
160 DECLARE_EVENT_TABLE()
161 DECLARE_DYNAMIC_CLASS(wxPopupComboWindow)
162 };
163
164 #endif // wxUSE_COMBOBOX && defined(__WXUNIVERSAL__)
165
166 #endif // wxUSE_POPUPWIN
167
168 #endif // _WX_POPUPWIN_H_BASE_
169