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