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