Go to main content

man pages section 3: Extended Library Functions, Volume 1

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

wxPopupTransientWindow (3erl)

Name

wxPopupTransientWindow - Functions for wxPopupTransientWindow class

Synopsis

Please see following description for synopsis

Description

wxPopupTransientWindow(3)  Erlang Module Definition  wxPopupTransientWindow(3)



NAME
       wxPopupTransientWindow - Functions for wxPopupTransientWindow class

DESCRIPTION
       A  wxPopupWindow  which  disappears  automatically when the user clicks
       mouse outside it or if it loses focus in any other way.

       This window can be useful for implementing  custom  combobox-like  con-
       trols for example.

       See: wxPopupWindow

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

       wxWidgets docs: wxPopupTransientWindow

DATA TYPES
       wxPopupTransientWindow() = wx:wx_object()

EXPORTS
       new() -> wxPopupTransientWindow()

              Default constructor.

       new(Parent) -> wxPopupTransientWindow()

              Types:

                 Parent = wxWindow:wxWindow()

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

              Types:

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

              Constructor.

       popup(This) -> ok

              Types:

                 This = wxPopupTransientWindow()

       popup(This, Options :: [Option]) -> ok

              Types:

                 This = wxPopupTransientWindow()
                 Option = {focus, wxWindow:wxWindow()}

              Popup the window (this will show it too).

              If focus is non-NULL, it will be kept focused while this  window
              is  shown  if  supported  by the current platform, otherwise the
              popup itself will receive focus. In any  case,  the  popup  will
              disappear  automatically  if  it  loses  focus because of a user
              action.

              See: dismiss/1

       dismiss(This) -> ok

              Types:

                 This = wxPopupTransientWindow()

              Hide the window.

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

              Destroys the object.



wxWidgets team.                    wx 2.1.1          wxPopupTransientWindow(3)