| 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/window.h" |
| 20 | |
| 21 | // ---------------------------------------------------------------------------- |
| 22 | // wxPopupWindow: a special kind of top level window used for popup menus, |
| 23 | // combobox popups and such. |
| 24 | // ---------------------------------------------------------------------------- |
| 25 | |
| 26 | class WXDLLEXPORT wxPopupWindowBase : public wxWindow |
| 27 | { |
| 28 | public: |
| 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(__WXGTK__) |
| 60 | #include "wx/gtk/popupwin.h" |
| 61 | #elif defined(__WXX11__) |
| 62 | #include "wx/x11/popupwin.h" |
| 63 | #elif defined(__WXMOTIF__) |
| 64 | #include "wx/motif/popupwin.h" |
| 65 | #elif defined(__WXMGL__) |
| 66 | #include "wx/mgl/popupwin.h" |
| 67 | #else |
| 68 | #error "wxPopupWindow is not supported under this platform." |
| 69 | #endif |
| 70 | |
| 71 | // ---------------------------------------------------------------------------- |
| 72 | // wxPopupTransientWindow: a wxPopupWindow which disappears automatically |
| 73 | // when the user clicks mouse outside it or if it loses focus in any other way |
| 74 | // ---------------------------------------------------------------------------- |
| 75 | |
| 76 | class WXDLLEXPORT wxPopupWindowHandler; |
| 77 | class WXDLLEXPORT wxPopupFocusHandler; |
| 78 | |
| 79 | class WXDLLEXPORT wxPopupTransientWindow : public wxPopupWindow |
| 80 | { |
| 81 | public: |
| 82 | // ctors |
| 83 | wxPopupTransientWindow() { Init(); } |
| 84 | wxPopupTransientWindow(wxWindow *parent, int style = wxBORDER_NONE); |
| 85 | |
| 86 | virtual ~wxPopupTransientWindow(); |
| 87 | |
| 88 | // popup the window (this will show it too) and keep focus at winFocus |
| 89 | // (or itself if it's NULL), dismiss the popup if we lose focus |
| 90 | virtual void Popup(wxWindow *focus = NULL); |
| 91 | |
| 92 | // hide the window |
| 93 | virtual void Dismiss(); |
| 94 | |
| 95 | // can the window be dismissed now? |
| 96 | // |
| 97 | // VZ: where is this used?? |
| 98 | virtual bool CanDismiss() |
| 99 | { return true; } |
| 100 | |
| 101 | // called when a mouse is pressed while the popup is shown: return true |
| 102 | // from here to prevent its normal processing by the popup (which consists |
| 103 | // in dismissing it if the mouse is cilcked outside it) |
| 104 | virtual bool ProcessLeftDown(wxMouseEvent& event); |
| 105 | |
| 106 | // Overridden to grab the input on some plaforms |
| 107 | virtual bool Show( bool show = true ); |
| 108 | |
| 109 | protected: |
| 110 | // common part of all ctors |
| 111 | void Init(); |
| 112 | |
| 113 | // this is called when the popup is disappeared because of anything |
| 114 | // else but direct call to Dismiss() |
| 115 | virtual void OnDismiss(); |
| 116 | |
| 117 | // dismiss and notify the derived class |
| 118 | void DismissAndNotify(); |
| 119 | |
| 120 | // remove our event handlers |
| 121 | void PopHandlers(); |
| 122 | |
| 123 | // get alerted when child gets deleted from under us |
| 124 | void OnDestroy(wxWindowDestroyEvent& event); |
| 125 | |
| 126 | #ifdef __WXMSW__ |
| 127 | // check if the mouse needs captured or released |
| 128 | void OnIdle(wxIdleEvent& event); |
| 129 | #endif |
| 130 | |
| 131 | // the child of this popup if any |
| 132 | wxWindow *m_child; |
| 133 | |
| 134 | // the window which has the focus while we're shown |
| 135 | wxWindow *m_focus; |
| 136 | |
| 137 | // these classes may call our DismissAndNotify() |
| 138 | friend class wxPopupWindowHandler; |
| 139 | friend class wxPopupFocusHandler; |
| 140 | |
| 141 | // the handlers we created, may be NULL (if not, must be deleted) |
| 142 | wxPopupWindowHandler *m_handlerPopup; |
| 143 | wxPopupFocusHandler *m_handlerFocus; |
| 144 | |
| 145 | DECLARE_EVENT_TABLE() |
| 146 | DECLARE_DYNAMIC_CLASS(wxPopupTransientWindow) |
| 147 | DECLARE_NO_COPY_CLASS(wxPopupTransientWindow) |
| 148 | }; |
| 149 | |
| 150 | #if wxUSE_COMBOBOX && defined(__WXUNIVERSAL__) |
| 151 | |
| 152 | // ---------------------------------------------------------------------------- |
| 153 | // wxPopupComboWindow: wxPopupTransientWindow used by wxComboBox |
| 154 | // ---------------------------------------------------------------------------- |
| 155 | |
| 156 | class WXDLLEXPORT wxComboBox; |
| 157 | class WXDLLEXPORT wxComboControl; |
| 158 | |
| 159 | class WXDLLEXPORT wxPopupComboWindow : public wxPopupTransientWindow |
| 160 | { |
| 161 | public: |
| 162 | wxPopupComboWindow() { m_combo = NULL; } |
| 163 | wxPopupComboWindow(wxComboControl *parent); |
| 164 | |
| 165 | bool Create(wxComboControl *parent); |
| 166 | |
| 167 | // position the window correctly relatively to the combo |
| 168 | void PositionNearCombo(); |
| 169 | |
| 170 | protected: |
| 171 | // notify the combo here |
| 172 | virtual void OnDismiss(); |
| 173 | |
| 174 | // forward the key presses to the combobox |
| 175 | void OnKeyDown(wxKeyEvent& event); |
| 176 | |
| 177 | // the parent combobox |
| 178 | wxComboControl *m_combo; |
| 179 | |
| 180 | DECLARE_EVENT_TABLE() |
| 181 | DECLARE_DYNAMIC_CLASS(wxPopupComboWindow) |
| 182 | }; |
| 183 | |
| 184 | #endif // wxUSE_COMBOBOX && defined(__WXUNIVERSAL__) |
| 185 | |
| 186 | #endif // wxUSE_POPUPWIN |
| 187 | |
| 188 | #endif // _WX_POPUPWIN_H_BASE_ |