wxSashWindow

Module

wxSashWindow

Module Summary

Functions for wxSashWindow class

Description

wxSashWindow allows any of its edges to have a sash which can be dragged to resize the window. The actual content window will be created by the application as a child of wxSashWindow.

The window (or an ancestor) will be notified of a drag via a wxSashEvent notification.

Styles

This class supports the following styles:

See: wxSashEvent, wxSashLayoutWindow, Overview events

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

wxWidgets docs: wxSashWindow

Events

Event types emitted from this class: sash_dragged

Data Types

wxSashWindow() = wx:wx_object()

Exports

new() -> wxSashWindow()

Default ctor.

new(Parent) -> wxSashWindow()

Types

Parent = wxWindow:wxWindow()

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

Types

Parent = wxWindow:wxWindow()

Option =
    {id, integer()} |
    {pos, {X :: integer(), Y :: integer()}} |
    {size, {W :: integer(), H :: integer()}} |
    {style, integer()}

Constructs a sash window, which can be a child of a frame, dialog or any other non-control window.

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

Destructor.

getSashVisible(This, Edge) -> boolean()

Types

This = wxSashWindow()

Edge = wx:wx_enum()

Returns true if a sash is visible on the given edge, false otherwise.

See: setSashVisible/3

getMaximumSizeX(This) -> integer()

Types

This = wxSashWindow()

Gets the maximum window size in the x direction.

getMaximumSizeY(This) -> integer()

Types

This = wxSashWindow()

Gets the maximum window size in the y direction.

getMinimumSizeX(This) -> integer()

Types

This = wxSashWindow()

Gets the minimum window size in the x direction.

getMinimumSizeY(This) -> integer()

Types

This = wxSashWindow()

Gets the minimum window size in the y direction.

setMaximumSizeX(This, Min) -> ok

Types

This = wxSashWindow()

Min = integer()

Sets the maximum window size in the x direction.

setMaximumSizeY(This, Min) -> ok

Types

This = wxSashWindow()

Min = integer()

Sets the maximum window size in the y direction.

setMinimumSizeX(This, Min) -> ok

Types

This = wxSashWindow()

Min = integer()

Sets the minimum window size in the x direction.

setMinimumSizeY(This, Min) -> ok

Types

This = wxSashWindow()

Min = integer()

Sets the minimum window size in the y direction.

setSashVisible(This, Edge, Visible) -> ok

Types

This = wxSashWindow()

Edge = wx:wx_enum()

Visible = boolean()

Call this function to make a sash visible or invisible on a particular edge.

See: getSashVisible/2