/////////////////////////////////////////////////////////////////////////////
// Name: sashwin.h
-// Purpose: documentation for wxSashWindow class
+// Purpose: interface of wxSashWindow
// Author: wxWidgets team
// RCS-ID: $Id$
// Licence: wxWindows license
/**
@class wxSashWindow
@wxheader{sashwin.h}
-
+
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.
-
+
@beginStyleTable
- @style{wxSW_3D}:
+ @style{wxSW_3D}
Draws a 3D effect sash and border.
- @style{wxSW_3DSASH}:
+ @style{wxSW_3DSASH}
Draws a 3D effect sash.
- @style{wxSW_3DBORDER}:
+ @style{wxSW_3DBORDER}
Draws a 3D effect border.
- @style{wxSW_BORDER}:
+ @style{wxSW_BORDER}
Draws a thin black border.
@endStyleTable
-
- @beginEventTable
- @event{EVT_SASH_DRAGGED(id\, func)}:
+
+ @beginEventTable{wxSashEvent}
+ @event{EVT_SASH_DRAGGED(id, func)}
Process a wxEVT_SASH_DRAGGED event, when the user has finished
dragging a sash.
- @event{EVT_SASH_DRAGGED_RANGE(id1\, id2\, func)}:
+ @event{EVT_SASH_DRAGGED_RANGE(id1, id2, func)}
Process a wxEVT_SASH_DRAGGED_RANGE event, when the user has
finished dragging a sash. The event handler is called when windows
with ids in the given range have their sashes dragged.
@endEventTable
-
+
@library{wxadv}
@category{miscwnd}
-
- @seealso
- wxSashEvent, wxSashLayoutWindow, @ref overview_eventhandlingoverview "Event
- handling overview"
+
+ @see wxSashEvent, wxSashLayoutWindow, @ref overview_eventhandling
*/
class wxSashWindow : public wxWindow
{
/**
Constructs a sash window, which can be a child of a frame, dialog or any other
non-control window.
-
- @param parent
- Pointer to a parent window.
-
- @param id
- Window identifier. If -1, will automatically create an identifier.
-
- @param pos
- Window position. wxDefaultPosition is (-1, -1) which indicates that
+
+ @param parent
+ Pointer to a parent window.
+ @param id
+ Window identifier. If -1, will automatically create an identifier.
+ @param pos
+ Window position. wxDefaultPosition is (-1, -1) which indicates that
wxSashWindows
- should generate a default position for the window. If using the wxSashWindow
- class directly, supply
- an actual position.
-
- @param size
- Window size. wxDefaultSize is (-1, -1) which indicates that wxSashWindows
- should generate a default size for the window.
-
- @param style
- Window style. For window styles, please see wxSashWindow.
-
- @param name
- Window name.
+ should generate a default position for the window. If using the
+ wxSashWindow class directly, supply
+ an actual position.
+ @param size
+ Window size. wxDefaultSize is (-1, -1) which indicates that wxSashWindows
+ should generate a default size for the window.
+ @param style
+ Window style. For window styles, please see wxSashWindow.
+ @param name
+ Window name.
*/
wxSashWindow();
- wxSashWindow(wxWindow* parent, wxWindowID id,
- const wxPoint& pos = wxDefaultPosition,
- const wxSize& size = wxDefaultSize,
- long style = wxCLIP_CHILDREN | wxSW_3D,
- const wxString& name = "sashWindow");
+ wxSashWindow(wxWindow* parent, wxWindowID id,
+ const wxPoint& pos = wxDefaultPosition,
+ const wxSize& size = wxDefaultSize,
+ long style = wxCLIP_CHILDREN | wxSW_3D,
+ const wxString& name = "sashWindow");
//@}
/**
/**
Gets the maximum window size in the x direction.
*/
- int GetMaximumSizeX();
+ int GetMaximumSizeX() const;
/**
Gets the maximum window size in the y direction.
*/
- int GetMaximumSizeY();
+ int GetMaximumSizeY() const;
/**
Gets the minimum window size in the x direction.
/**
Gets the minimum window size in the y direction.
*/
- int GetMinimumSizeY();
+ int GetMinimumSizeY() const;
/**
Returns @true if a sash is visible on the given edge, @false otherwise.
-
- @param edge
- Edge. One of wxSASH_TOP, wxSASH_RIGHT, wxSASH_BOTTOM, wxSASH_LEFT.
-
- @sa SetSashVisible()
+
+ @param edge
+ Edge. One of wxSASH_TOP, wxSASH_RIGHT, wxSASH_BOTTOM, wxSASH_LEFT.
+
+ @see SetSashVisible()
*/
- bool GetSashVisible(wxSashEdgePosition edge);
+ bool GetSashVisible(wxSashEdgePosition edge) const;
/**
Returns @true if the sash has a border, @false otherwise.
This function is obsolete since the sash border property is unused.
-
- @param edge
- Edge. One of wxSASH_TOP, wxSASH_RIGHT, wxSASH_BOTTOM, wxSASH_LEFT.
-
- @sa SetSashBorder()
+
+ @param edge
+ Edge. One of wxSASH_TOP, wxSASH_RIGHT, wxSASH_BOTTOM, wxSASH_LEFT.
+
+ @see SetSashBorder()
*/
- bool HasBorder(wxSashEdgePosition edge);
+ bool HasBorder(wxSashEdgePosition edge) const;
/**
Sets the maximum window size in the x direction.
/**
Call this function to give the sash a border, or remove the border.
This function is obsolete since the sash border property is unused.
-
- @param edge
- Edge to change. One of wxSASH_TOP, wxSASH_RIGHT, wxSASH_BOTTOM, wxSASH_LEFT.
-
- @param hasBorder
- @true to give the sash a border visible, @false to remove it.
+
+ @param edge
+ Edge to change. One of wxSASH_TOP, wxSASH_RIGHT, wxSASH_BOTTOM, wxSASH_LEFT.
+ @param hasBorder
+ @true to give the sash a border visible, @false to remove it.
*/
void SetSashBorder(wxSashEdgePosition edge, bool hasBorder);
/**
Call this function to make a sash visible or invisible on a particular edge.
-
- @param edge
- Edge to change. One of wxSASH_TOP, wxSASH_RIGHT, wxSASH_BOTTOM, wxSASH_LEFT.
-
- @param visible
- @true to make the sash visible, @false to make it invisible.
-
- @sa GetSashVisible()
+
+ @param edge
+ Edge to change. One of wxSASH_TOP, wxSASH_RIGHT, wxSASH_BOTTOM, wxSASH_LEFT.
+ @param visible
+ @true to make the sash visible, @false to make it invisible.
+
+ @see GetSashVisible()
*/
void SetSashVisible(wxSashEdgePosition edge, bool visible);
};
+
/**
@class wxSashEvent
@wxheader{sashwin.h}
-
+
A sash event is sent when the sash of a wxSashWindow has been
dragged by the user.
-
+
@library{wxadv}
@category{FIXME}
-
- @seealso
- wxSashWindow, @ref overview_eventhandlingoverview "Event handling overview"
+
+ @see wxSashWindow, @ref overview_eventhandlingoverview
*/
class wxSashEvent : public wxCommandEvent
{
resize was applied. It is
up to the application to set the window size if required.
*/
- wxRect GetDragRect();
+ wxRect GetDragRect() const;
/**
Returns the status of the sash: one of wxSASH_STATUS_OK,
If the drag caused the notional bounding box of the window to flip over, for
example, the drag will be out of rage.
*/
- wxSashDragStatus GetDragStatus();
+ wxSashDragStatus GetDragStatus() const;
/**
Returns the dragged edge. The return value is one of wxSASH_TOP, wxSASH_RIGHT,
wxSASH_BOTTOM, wxSASH_LEFT.
*/
- wxSashEdgePosition GetEdge();
+ wxSashEdgePosition GetEdge() const;
};
+
projects / wxWidgets.git / blobdiff