View Source wxSashWindow (wx v2.4.2)
Functions for wxSashWindow class
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
Summary
Functions
Destructor.
Gets the maximum window size in the x direction.
Gets the maximum window size in the y direction.
Gets the minimum window size in the x direction.
Gets the minimum window size in the y direction.
Returns true if a sash is visible on the given edge, false otherwise.
Default ctor.
Constructs a sash window, which can be a child of a frame, dialog or any other non-control window.
Sets the maximum window size in the x direction.
Sets the maximum window size in the y direction.
Sets the minimum window size in the x direction.
Sets the minimum window size in the y direction.
Call this function to make a sash visible or invisible on a particular edge.
Types
-type wxSashWindow() :: wx:wx_object().
Functions
-spec destroy(This :: wxSashWindow()) -> ok.
Destructor.
-spec getMaximumSizeX(This) -> integer() when This :: wxSashWindow().
Gets the maximum window size in the x direction.
-spec getMaximumSizeY(This) -> integer() when This :: wxSashWindow().
Gets the maximum window size in the y direction.
-spec getMinimumSizeX(This) -> integer() when This :: wxSashWindow().
Gets the minimum window size in the x direction.
-spec getMinimumSizeY(This) -> integer() when This :: wxSashWindow().
Gets the minimum window size in the y direction.
-spec 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
-spec new() -> wxSashWindow().
Default ctor.
-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.
-spec setMaximumSizeX(This, Min) -> ok when This :: wxSashWindow(), Min :: integer().
Sets the maximum window size in the x direction.
-spec setMaximumSizeY(This, Min) -> ok when This :: wxSashWindow(), Min :: integer().
Sets the maximum window size in the y direction.
-spec setMinimumSizeX(This, Min) -> ok when This :: wxSashWindow(), Min :: integer().
Sets the minimum window size in the x direction.
-spec setMinimumSizeY(This, Min) -> ok when This :: wxSashWindow(), Min :: integer().
Sets the minimum window size in the y direction.
-spec 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