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