wxSashWindow(3)

NAME
wxSashWindow - wxSashWindow allows any of its edges to have a sash which can be dragged to resize the window.

DESCRIPTION

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:

    • 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().

FUNCTIONS

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

    Destroys the object
getMaximumSizeX(This) -> integer() when This :: wxSashWindow().

    Gets the maximum window size in the x direction.
getMaximumSizeY(This) -> integer() when This :: wxSashWindow().

    Gets the maximum window size in the y direction.
getMinimumSizeX(This) -> integer() when This :: wxSashWindow().

    Gets the minimum window size in the x direction.
getMinimumSizeY(This) -> integer() when This :: wxSashWindow().

    Gets the minimum window size in the y direction.
getSashVisible(This, Edge) -> boolean() when This :: wxSashWindow(), Edge :: wx:wx_enum().

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

    See: setSashVisible/3
new() -> wxSashWindow().

    Default ctor.
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, Min) -> ok when This :: wxSashWindow(), Min :: integer().

    Sets the maximum window size in the x direction.
setMaximumSizeY(This, Min) -> ok when This :: wxSashWindow(), Min :: integer().

    Sets the maximum window size in the y direction.
setMinimumSizeX(This, Min) -> ok when This :: wxSashWindow(), Min :: integer().

    Sets the minimum window size in the x direction.
setMinimumSizeY(This, Min) -> ok when This :: wxSashWindow(), Min :: integer().

    Sets the minimum window size in the y direction.
setSashVisible(This, Edge, Visible) -> ok when 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