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 #ifdef __DARWIN__
  32     virtual ~wxPopupWindowBase() { }
  33 #endif
  34
  35     // create the popup window
  36     //
  37     // style may only contain border flags
  38     bool Create(wxWindow *parent, int style = wxBORDER_NONE);
  39
  40     // move the popup window to the right position, i.e. such that it is
  41     // entirely visible
  42     //
  43     // the popup is positioned at ptOrigin + size if it opens below and to the
  44     // right (default), at ptOrigin - sizePopup if it opens above and to the
  45     // left &c
  46     //
  47     // the point must be given in screen coordinates!
  48     virtual void Position(const wxPoint& ptOrigin,
  49                           const wxSize& size);
  50 };
  51
  52
  53 // include the real class declaration
  54 #ifdef __WXMSW__
  55     #include "wx/msw/popupwin.h"
  56 #elif __WXPM__
  57     #include "wx/os2/popupwin.h"
  58 #elif __WXGTK__
  59     #include "wx/gtk/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     friend class wxPopupWindowHandler;
 113     friend class wxPopupFocusHandler;
 114 };
 115
 116 #if wxUSE_COMBOBOX && defined(__WXUNIVERSAL__)
 117
 118 // ----------------------------------------------------------------------------
 119 // wxPopupComboWindow: wxPopupTransientWindow used by wxComboBox
 120 // ----------------------------------------------------------------------------
 121
 122 class WXDLLEXPORT wxComboBox;
 123 class WXDLLEXPORT wxComboControl;
 124
 125 class WXDLLEXPORT wxPopupComboWindow : public wxPopupTransientWindow
 126 {
 127 public:
 128     wxPopupComboWindow(wxComboControl *parent);
 129
 130     bool Create(wxComboControl *parent);
 131
 132     // position the window correctly relatively to the combo
 133     void PositionNearCombo();
 134
 135 protected:
 136     // notify the combo here
 137     virtual void OnDismiss();
 138
 139     // the parent combobox
 140     wxComboControl *m_combo;
 141 };
 142
 143 #endif // wxUSE_COMBOBOX && defined(__WXUNIVERSAL__)
 144
 145 #endif // wxUSE_POPUPWIN
 146
 147 #endif // _WX_POPUPWIN_H_BASE_
 148