interface/wx/popupwin.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        popupwin.h
   3 // Purpose:     interface of wxPoppWindow
   4 // Author:      wxWidgets team
   5 // RCS-ID:      $Id$
   6 // Licence:     wxWindows licence
   7 /////////////////////////////////////////////////////////////////////////////
   8
   9 /**
  10     @class wxPopupWindow
  11
  12     A special kind of top level window used for popup menus,
  13     combobox popups and such.
  14
  15     @library{wxcore}
  16     @category{managedwnd}
  17
  18     @see wxDialog, wxFrame
  19 */
  20
  21 class wxPopupWindow: public wxNonOwnedWindow
  22 {
  23 public:
  24
  25     /**
  26       Constructor
  27     */
  28     wxPopupWindow(wxWindow *parent, int flags = wxBORDER_NONE);
  29
  30     /**
  31       Create method for two-step creation
  32     */
  33     bool Create(wxWindow *parent, int flags = wxBORDER_NONE);
  34
  35     /**
  36         Move the popup window to the right position, i.e. such that it is
  37         entirely visible.
  38
  39         The popup is positioned at ptOrigin + size if it opens below and to the
  40         right (default), at ptOrigin - sizePopup if it opens above and to the
  41         left etc.
  42
  43         @param ptOrigin
  44             Must be given in screen coordinates!
  45         @param sizePopup
  46             The size of the popup window
  47     */
  48     virtual void Position(const wxPoint& ptOrigin,
  49                           const wxSize& sizePopup);
  50 };
  51