wxSashWindow (wx v2.5.4)

Copy Markdown View Source

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:

  • wxSW_3D: Draws a 3D effect sash and border.

  • wxSW_3DSASH: Draws a 3D effect sash.

  • wxSW_3DBORDER: Draws a 3D effect border.

  • wxSW_BORDER: Draws a thin black border.

See:

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

wxWidgets docs: wxSashWindow

Events

Event types emitted from this class:

Summary

Types

wxSashWindow()

Functions

destroy(This)

Destroys the object

getMaximumSizeX(This)

Gets the maximum window size in the x direction.

getMaximumSizeY(This)

Gets the maximum window size in the y direction.

getMinimumSizeX(This)

Gets the minimum window size in the x direction.

getMinimumSizeY(This)

Gets the minimum window size in the y direction.

getSashVisible(This, Edge)

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

new()

Default ctor.

new(Parent)
new/2

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

setMaximumSizeX(This, Min)

Sets the maximum window size in the x direction.

setMaximumSizeY(This, Min)

Sets the maximum window size in the y direction.

setMinimumSizeX(This, Min)

Sets the minimum window size in the x direction.

setMinimumSizeY(This, Min)

Sets the minimum window size in the y direction.

setSashVisible(This, Edge, Visible)

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

Types

wxSashWindow()

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

Functions

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

Destroys the object

getMaximumSizeX(This :: wxSashWindow()) -> integer()

Gets the maximum window size in the x direction.

getMaximumSizeY(This :: wxSashWindow()) -> integer()

Gets the maximum window size in the y direction.

getMinimumSizeX(This :: wxSashWindow()) -> integer()

Gets the minimum window size in the x direction.

getMinimumSizeY(This :: wxSashWindow()) -> integer()

Gets the minimum window size in the y direction.

getSashVisible(This :: wxSashWindow(), Edge :: wx:wx_enum()) -> boolean()

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

See: setSashVisible/3

new() -> wxSashWindow()

Default ctor.

new(Parent) ≡ new(Parent, [])

new/2

-spec new(Parent) -> wxSashWindow() when Parent :: wxWindow:wxWindow().
-spec new(Parent, [Option]) -> wxSashWindow()
             when
                 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.

setMaximumSizeX(This :: wxSashWindow(), Min :: integer()) -> ok

Sets the maximum window size in the x direction.

setMaximumSizeY(This :: wxSashWindow(), Min :: integer()) -> ok

Sets the maximum window size in the y direction.

setMinimumSizeX(This :: wxSashWindow(), Min :: integer()) -> ok

Sets the minimum window size in the x direction.

setMinimumSizeY(This :: wxSashWindow(), Min :: integer()) -> ok

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