wxPopupTransientWindow — wx v2.6

Search documentation of wx

# wxPopupTransientWindow (wx v2.6)

Copy Markdown View Source

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 controls for example.

See: `wxPopupWindow`

This class is derived, and can use functions, from:

- `wxPopupWindow`

- `wxWindow`

- `wxEvtHandler`

wxWidgets docs: wxPopupTransientWindow

## Summary

### Types

wxPopupTransientWindow()

### Functions

destroy(This)

Destroys the object

dismiss(This)

Hide the window.

new()

Default constructor.

new(Parent)

Equivalent to `new(Parent, [])`.

new/2

Constructor.

popup(This)

Equivalent to `popup(This, [])`.

popup/2

Popup the window (this will show it too).

## Types

# wxPopupTransientWindow()

    -type wxPopupTransientWindow() :: wx:wx_object().

## Functions

# destroy(This)

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

Destroys the object

# dismiss(This)

    -spec dismiss(This) -> ok when This :: wxPopupTransientWindow().

Hide the window.

# new()

    -spec new() -> wxPopupTransientWindow().

Default constructor.

# new(Parent)

    -spec new(Parent) -> wxPopupTransientWindow() when Parent :: wxWindow:wxWindow().

Equivalent to `new(Parent, [])`.

# new/2

    -spec new(Parent, [Option]) -> wxPopupTransientWindow()
                 when Parent :: wxWindow:wxWindow(), Option :: {style, integer()}.

Constructor.

# popup(This)

    -spec popup(This) -> ok when This :: wxPopupTransientWindow().

Equivalent to `popup(This, [])`.

# popup/2

    -spec popup(This, [Option]) -> ok
                   when 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`