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 license
  10 ///////////////////////////////////////////////////////////////////////////////
  11
  12 #ifndef _WX_POPUPWIN_H_BASE_
  13 #define _WX_POPUPWIN_H_BASE_
  14
  15 #ifdef __GNUG__
  16     #pragma interface "popupwinbase.h"
  17 #endif
  18
  19 #include "wx/window.h"
  20
  21 #if wxUSE_POPUPWIN
  22 // ----------------------------------------------------------------------------
  23 // wxPopupWindow: a special kind of top level window used for popup menus,
  24 // combobox popups and such.
  25 // ----------------------------------------------------------------------------
  26
  27 class WXDLLEXPORT wxPopupWindowBase : public wxWindow
  28 {
  29 public:
  30     wxPopupWindowBase() { }
  31     virtual ~wxPopupWindowBase();
  32
  33     // create the popup window
  34     //
  35     // style may only contain border flags
  36     bool Create(wxWindow *parent, int style = wxBORDER_NONE);
  37
  38     // move the popup window to the right position, i.e. such that it is
  39     // entirely visible
  40     //
  41     // the popup is positioned at ptOrigin + size if it opens below and to the
  42     // right (default), at ptOrigin - sizePopup if it opens above and to the
  43     // left &c
  44     //
  45     // the point must be given in screen coordinates!
  46     virtual void Position(const wxPoint& ptOrigin,
  47                           const wxSize& size);
  48 };
  49
  50
  51 // include the real class declaration
  52 #ifdef __WXMSW__
  53     #include "wx/msw/popupwin.h"
  54 #elif __WXPM__
  55     #include "wx/os2/popupwin.h"
  56 #elif __WXGTK__
  57     #include "wx/gtk/popupwin.h"
  58 #elif __WXX11__
  59     #include "wx/x11/popupwin.h"
  60 #elif __WXMGL__
  61     #include "wx/mgl/popupwin.h"
  62 #else
  63     #error "wxPopupWindow is not supported under this platform."
  64 #endif
  65
  66 // ----------------------------------------------------------------------------
  67 // wxPopupTransientWindow: a wxPopupWindow which disappears automatically
  68 // when the user clicks mouse outside it or if it loses focus in any other way
  69 // ----------------------------------------------------------------------------
  70
  71 class WXDLLEXPORT wxPopupTransientWindow : public wxPopupWindow
  72 {
  73 public:
  74     // ctors
  75     wxPopupTransientWindow() { Init(); }
  76     wxPopupTransientWindow(wxWindow *parent, int style = wxBORDER_NONE);
  77
  78     virtual ~wxPopupTransientWindow();
  79
  80     // popup the window (this will show it too) and keep focus at winFocus
  81     // (or itself if it's NULL), dismiss the popup if we lose focus
  82     virtual void Popup(wxWindow *focus = NULL);
  83
  84     // hide the window
  85     virtual void Dismiss();
  86
  87     // called when a mouse is pressed while the popup is shown: return TRUE
  88     // from here to prevent its normal processing by the popup (which consists
  89     // in dismissing it if the mouse is cilcked outside it)
  90     virtual bool ProcessLeftDown(wxMouseEvent& event);
  91
  92 protected:
  93     // common part of all ctors
  94     void Init();
  95
  96     // this is called when the popup is disappeared because of anything
  97     // else but direct call to Dismiss()
  98     virtual void OnDismiss();
  99
 100     // dismiss and notify the derived class
 101     void DismissAndNotify();
 102
 103     // remove our event handlers
 104     void PopHandlers();
 105
 106     // the child of this popup if any
 107     wxWindow *m_child;
 108
 109     // the window which has the focus while we're shown
 110     wxWindow *m_focus;
 111
 112     // these classes may call our DismissAndNotify()
 113     friend class wxPopupWindowHandler;
 114     friend class wxPopupFocusHandler;
 115
 116     // the handlers we created, may be NULL (if not, must be deleted)
 117     wxPopupWindowHandler *m_handlerPopup;
 118     wxPopupFocusHandler  *m_handlerFocus;
 119
 120     DECLARE_DYNAMIC_CLASS(wxPopupTransientWindow)
 121 };
 122
 123 #if wxUSE_COMBOBOX && defined(__WXUNIVERSAL__)
 124
 125 // ----------------------------------------------------------------------------
 126 // wxPopupComboWindow: wxPopupTransientWindow used by wxComboBox
 127 // ----------------------------------------------------------------------------
 128
 129 class WXDLLEXPORT wxComboBox;
 130 class WXDLLEXPORT wxComboControl;
 131
 132 class WXDLLEXPORT wxPopupComboWindow : public wxPopupTransientWindow
 133 {
 134 public:
 135     wxPopupComboWindow() { m_combo = NULL; }
 136     wxPopupComboWindow(wxComboControl *parent);
 137
 138     bool Create(wxComboControl *parent);
 139
 140     // position the window correctly relatively to the combo
 141     void PositionNearCombo();
 142
 143 protected:
 144     // notify the combo here
 145     virtual void OnDismiss();
 146
 147     // the parent combobox
 148     wxComboControl *m_combo;
 149
 150     DECLARE_DYNAMIC_CLASS(wxPopupComboWindow)
 151 };
 152
 153 #endif // wxUSE_COMBOBOX && defined(__WXUNIVERSAL__)
 154
 155 #endif // wxUSE_POPUPWIN
 156
 157 #endif // _WX_POPUPWIN_H_BASE_
 158