interface/popupwin.h

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