]> git.saurik.com Git - wxWidgets.git/blame_incremental - include/wx/popupwin.h
added wxWeakRef<T> (slightly modified patch 1860953)
[wxWidgets.git] / include / wx / popupwin.h
... / ...
CommitLineData
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 licence
10///////////////////////////////////////////////////////////////////////////////
11
12#ifndef _WX_POPUPWIN_H_BASE_
13#define _WX_POPUPWIN_H_BASE_
14
15#include "wx/defs.h"
16
17#if wxUSE_POPUPWIN
18
19#include "wx/nonownedwnd.h"
20
21// ----------------------------------------------------------------------------
22// wxPopupWindow: a special kind of top level window used for popup menus,
23// combobox popups and such.
24// ----------------------------------------------------------------------------
25
26class WXDLLEXPORT wxPopupWindowBase : public wxNonOwnedWindow
27{
28public:
29 wxPopupWindowBase() { }
30 virtual ~wxPopupWindowBase();
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);
47
48 virtual bool IsTopLevel() const { return true; }
49
50 DECLARE_NO_COPY_CLASS(wxPopupWindowBase)
51};
52
53
54// include the real class declaration
55#if defined(__WXMSW__)
56 #include "wx/msw/popupwin.h"
57#elif defined(__WXPM__)
58 #include "wx/os2/popupwin.h"
59#elif defined(__WXGTK20__)
60 #include "wx/gtk/popupwin.h"
61#elif defined(__WXGTK__)
62 #include "wx/gtk1/popupwin.h"
63#elif defined(__WXX11__)
64 #include "wx/x11/popupwin.h"
65#elif defined(__WXMOTIF__)
66 #include "wx/motif/popupwin.h"
67#elif defined(__WXDFB__)
68 #include "wx/dfb/popupwin.h"
69#elif defined(__WXMGL__)
70 #include "wx/mgl/popupwin.h"
71#elif defined(__WXMAC__)
72 #include "wx/mac/popupwin.h"
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
82class WXDLLIMPEXP_FWD_CORE wxPopupWindowHandler;
83class WXDLLIMPEXP_FWD_CORE wxPopupFocusHandler;
84
85class WXDLLEXPORT wxPopupTransientWindow : public wxPopupWindow
86{
87public:
88 // ctors
89 wxPopupTransientWindow() { Init(); }
90 wxPopupTransientWindow(wxWindow *parent, int style = wxBORDER_NONE);
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();
100
101 // can the window be dismissed now?
102 //
103 // VZ: where is this used??
104 virtual bool CanDismiss()
105 { return true; }
106
107 // called when a mouse is pressed while the popup is shown: return true
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
112 // Overridden to grab the input on some plaforms
113 virtual bool Show( bool show = true );
114
115protected:
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
129 // get alerted when child gets deleted from under us
130 void OnDestroy(wxWindowDestroyEvent& event);
131
132#ifdef __WXMSW__
133 // check if the mouse needs captured or released
134 void OnIdle(wxIdleEvent& event);
135#endif
136
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
143 // these classes may call our DismissAndNotify()
144 friend class wxPopupWindowHandler;
145 friend class wxPopupFocusHandler;
146
147 // the handlers we created, may be NULL (if not, must be deleted)
148 wxPopupWindowHandler *m_handlerPopup;
149 wxPopupFocusHandler *m_handlerFocus;
150
151 DECLARE_EVENT_TABLE()
152 DECLARE_DYNAMIC_CLASS(wxPopupTransientWindow)
153 DECLARE_NO_COPY_CLASS(wxPopupTransientWindow)
154};
155
156#if wxUSE_COMBOBOX && defined(__WXUNIVERSAL__)
157
158// ----------------------------------------------------------------------------
159// wxPopupComboWindow: wxPopupTransientWindow used by wxComboBox
160// ----------------------------------------------------------------------------
161
162class WXDLLIMPEXP_FWD_CORE wxComboBox;
163class WXDLLIMPEXP_FWD_CORE wxComboCtrl;
164
165class WXDLLEXPORT wxPopupComboWindow : public wxPopupTransientWindow
166{
167public:
168 wxPopupComboWindow() { m_combo = NULL; }
169 wxPopupComboWindow(wxComboCtrl *parent);
170
171 bool Create(wxComboCtrl *parent);
172
173 // position the window correctly relatively to the combo
174 void PositionNearCombo();
175
176protected:
177 // notify the combo here
178 virtual void OnDismiss();
179
180 // forward the key presses to the combobox
181 void OnKeyDown(wxKeyEvent& event);
182
183 // the parent combobox
184 wxComboCtrl *m_combo;
185
186 DECLARE_EVENT_TABLE()
187 DECLARE_DYNAMIC_CLASS(wxPopupComboWindow)
188};
189
190#endif // wxUSE_COMBOBOX && defined(__WXUNIVERSAL__)
191
192#endif // wxUSE_POPUPWIN
193
194#endif // _WX_POPUPWIN_H_BASE_