Go to main content

man pages section 3: Extended Library Functions, Volume 1

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

wxPopupWindow (3erl)

Name

wxPopupWindow - Functions for wxPopupWindow class

Synopsis

Please see following description for synopsis

Description

wxPopupWindow(3)           Erlang Module Definition           wxPopupWindow(3)



NAME
       wxPopupWindow - Functions for wxPopupWindow class

DESCRIPTION
       A  special kind of top level window used for popup menus, combobox pop-
       ups and such.

       Styles

       This class supports the following styles:

       See: wxDialog, wxFrame

       This  class  is  derived  (and  can  use  functions)   from:   wxWindow
       wxEvtHandler

       wxWidgets docs: wxPopupWindow

DATA TYPES
       wxPopupWindow() = wx:wx_object()

EXPORTS
       new() -> wxPopupWindow()

              Default constructor.

       new(Parent) -> wxPopupWindow()

              Types:

                 Parent = wxWindow:wxWindow()

       new(Parent, Options :: [Option]) -> wxPopupWindow()

              Types:

                 Parent = wxWindow:wxWindow()
                 Option = {flags, integer()}

              Constructor.

       create(This, Parent) -> boolean()

              Types:

                 This = wxPopupWindow()
                 Parent = wxWindow:wxWindow()

       create(This, Parent, Options :: [Option]) -> boolean()

              Types:

                 This = wxPopupWindow()
                 Parent = wxWindow:wxWindow()
                 Option = {flags, integer()}

              Create method for two-step creation.

       position(This, PtOrigin, SizePopup) -> ok

              Types:

                 This = wxPopupWindow()
                 PtOrigin = {X :: integer(), Y :: integer()}
                 SizePopup = {W :: integer(), H :: integer()}

              Move  the  popup window to the right position, i.e. such that it
              is entirely visible.

              The popup is positioned at ptOrigin + size if it opens below and
              to  the  right  (default),  at  ptOrigin - sizePopup if it opens
              above and to the left etc.

       destroy(This :: wxPopupWindow()) -> ok

              Destroys the object.



wxWidgets team.                    wx 2.1.1                   wxPopupWindow(3)