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