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 // Licence:     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
  26 class WXDLLIMPEXP_CORE wxPopupWindowBase : public wxNonOwnedWindow
  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     wxDECLARE_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/osx/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
  82 class WXDLLIMPEXP_FWD_CORE wxPopupWindowHandler;
  83 class WXDLLIMPEXP_FWD_CORE wxPopupFocusHandler;
  84
  85 class WXDLLIMPEXP_CORE wxPopupTransientWindow : public wxPopupWindow
  86 {
  87 public:
  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 clicked 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
 115     // Override to implement delayed destruction of this window.
 116     virtual bool Destroy();
 117
 118 protected:
 119     // common part of all ctors
 120     void Init();
 121
 122     // this is called when the popup is disappeared because of anything
 123     // else but direct call to Dismiss()
 124     virtual void OnDismiss();
 125
 126     // dismiss and notify the derived class
 127     void DismissAndNotify();
 128
 129     // remove our event handlers
 130     void PopHandlers();
 131
 132     // get alerted when child gets deleted from under us
 133     void OnDestroy(wxWindowDestroyEvent& event);
 134
 135 #if defined(__WXMSW__) ||(defined(__WXMAC__) && wxOSX_USE_CARBON)
 136     // Check if the mouse needs to be captured or released: we must release
 137     // when it's inside our window if we want the embedded controls to work.
 138     void OnIdle(wxIdleEvent& event);
 139 #endif
 140
 141     // the child of this popup if any
 142     wxWindow *m_child;
 143
 144     // the window which has the focus while we're shown
 145     wxWindow *m_focus;
 146
 147     // these classes may call our DismissAndNotify()
 148     friend class wxPopupWindowHandler;
 149     friend class wxPopupFocusHandler;
 150
 151     // the handlers we created, may be NULL (if not, must be deleted)
 152     wxPopupWindowHandler *m_handlerPopup;
 153     wxPopupFocusHandler  *m_handlerFocus;
 154
 155     DECLARE_EVENT_TABLE()
 156     DECLARE_DYNAMIC_CLASS(wxPopupTransientWindow)
 157     wxDECLARE_NO_COPY_CLASS(wxPopupTransientWindow);
 158 };
 159
 160 #if wxUSE_COMBOBOX && defined(__WXUNIVERSAL__)
 161
 162 // ----------------------------------------------------------------------------
 163 // wxPopupComboWindow: wxPopupTransientWindow used by wxComboBox
 164 // ----------------------------------------------------------------------------
 165
 166 class WXDLLIMPEXP_FWD_CORE wxComboBox;
 167 class WXDLLIMPEXP_FWD_CORE wxComboCtrl;
 168
 169 class WXDLLIMPEXP_CORE wxPopupComboWindow : public wxPopupTransientWindow
 170 {
 171 public:
 172     wxPopupComboWindow() { m_combo = NULL; }
 173     wxPopupComboWindow(wxComboCtrl *parent);
 174
 175     bool Create(wxComboCtrl *parent);
 176
 177     // position the window correctly relatively to the combo
 178     void PositionNearCombo();
 179
 180 protected:
 181     // notify the combo here
 182     virtual void OnDismiss();
 183
 184     // forward the key presses to the combobox
 185     void OnKeyDown(wxKeyEvent& event);
 186
 187     // the parent combobox
 188     wxComboCtrl *m_combo;
 189
 190     DECLARE_EVENT_TABLE()
 191     DECLARE_DYNAMIC_CLASS(wxPopupComboWindow)
 192 };
 193
 194 #endif // wxUSE_COMBOBOX && defined(__WXUNIVERSAL__)
 195
 196 #endif // wxUSE_POPUPWIN
 197
 198 #endif // _WX_POPUPWIN_H_BASE_