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 "popupwin.h"
  17 #endif
  18
  19 #include "wx/window.h"
  20
  21 #if wxUSE_POPUPWIN
  22
  23 // ----------------------------------------------------------------------------
  24 // wxPopupWindow: a special kind of top level window used for popup menus,
  25 // combobox popups and such.
  26 // ----------------------------------------------------------------------------
  27
  28 class WXDLLEXPORT wxPopupWindowBase : public wxWindow
  29 {
  30 public:
  31     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 // include the real class declaration
  51 #ifdef __WXMSW__
  52     #include "wx/msw/popupwin.h"
  53 #else
  54     #error "wxPopupWindow is not supported under this platform."
  55 #endif
  56
  57 // ----------------------------------------------------------------------------
  58 // wxPopupTransientWindow: a wxPopupWindow which disappears automatically
  59 // when the user clicks mouse outside it or if it loses focus in any other way
  60 // ----------------------------------------------------------------------------
  61
  62 class WXDLLEXPORT wxPopupTransientWindow : public wxPopupWindow
  63 {
  64 public:
  65     // ctors
  66     wxPopupTransientWindow() { Init(); }
  67     wxPopupTransientWindow(wxWindow *parent);
  68
  69     virtual ~wxPopupTransientWindow();
  70
  71     // popup the window (this will show it too) and keep focus at winFocus
  72     // (or itself if it's NULL), dismiss the popup if we lose focus
  73     virtual void Popup(wxWindow *focus = NULL);
  74
  75     // hide the window
  76     virtual void Dismiss();
  77
  78     // called when a mouse is pressed while the popup is shown: return TRUE
  79     // from here to prevent its normal processing by the popup (which consists
  80     // in dismissing it if the mouse is cilcked outside it)
  81     virtual bool ProcessLeftDown(wxMouseEvent& event);
  82
  83 protected:
  84     // common part of all ctors
  85     void Init();
  86
  87     // this is called when the popup is disappeared because of anything
  88     // else but direct call to Dismiss()
  89     virtual void OnDismiss();
  90
  91     // dismiss and notify the derived class
  92     void DismissAndNotify();
  93
  94     // remove our event handlers
  95     void PopHandlers();
  96
  97     // the child of this popup if any
  98     wxWindow *m_child;
  99
 100     // the window which has the focus while we're shown
 101     wxWindow *m_focus;
 102
 103     friend class wxPopupWindowHandler;
 104     friend class wxPopupFocusHandler;
 105 };
 106
 107 #if wxUSE_COMBOBOX
 108
 109 // ----------------------------------------------------------------------------
 110 // wxPopupComboWindow: wxPopupTransientWindow used by wxComboBox
 111 // ----------------------------------------------------------------------------
 112
 113 class WXDLLEXPORT wxComboBox;
 114 class WXDLLEXPORT wxComboControl;
 115
 116 class WXDLLEXPORT wxPopupComboWindow : public wxPopupTransientWindow
 117 {
 118 public:
 119     wxPopupComboWindow(wxComboControl *parent);
 120
 121     bool Create(wxComboControl *parent);
 122
 123     // position the window correctly relatively to the combo
 124     void PositionNearCombo();
 125
 126 protected:
 127     // notify the combo here
 128     virtual void OnDismiss();
 129
 130     // the parent combobox
 131     wxComboControl *m_combo;
 132 };
 133
 134 #endif // wxUSE_COMBOBOX
 135
 136 #endif // wxUSE_POPUPWIN
 137
 138 #endif // _WX_POPUPWIN_H_BASE_
 139