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