/////////////////////////////////////////////////////////////////////////////
// Name: sashwin.h
-// Purpose: documentation for wxSashWindow class
+// Purpose: interface of wxSashWindow
// Author: wxWidgets team
// RCS-ID: $Id$
// Licence: wxWindows license
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.
@library{wxadv}
@category{miscwnd}
- @seealso
- wxSashEvent, wxSashLayoutWindow, @ref overview_eventhandlingoverview
+ @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
/**
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.
-
+
@see SetSashVisible()
*/
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.
-
+
@see SetSashBorder()
*/
bool HasBorder(wxSashEdgePosition edge) const;
/**
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
/**
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.
-
+
@see GetSashVisible()
*/
void SetSashVisible(wxSashEdgePosition edge, bool visible);
};
+
/**
@class wxSashEvent
@wxheader{sashwin.h}
@library{wxadv}
@category{FIXME}
- @seealso
- wxSashWindow, @ref overview_eventhandlingoverview
+ @see wxSashWindow, @ref overview_eventhandlingoverview
*/
class wxSashEvent : public wxCommandEvent
{
*/
wxSashEdgePosition GetEdge() const;
};
+