.\" This is a wxWidgets manpage page generated from the XML docs
.TH wxSashEvent 3wx 2005-02-15 "wxWidgets" "wxWidgets class documentation"
.SH NAME
wxSashEvent \- 
.SH DESCRIPTION

  


   A sash event is sent when the sash of a
   wxSashWindow
   has been dragged by the user.
  
 
.SH REMARKS

  
   When a sash belonging to a sash window is dragged by the user, and then
   released, this event is sent to the window, where it may be processed by an
   event table entry in a derived class, a plug-in event handler or an ancestor
   class.
  
  
   Note that the wxSashWindow doesn't change the window's size itself. It relies
   on the application's event handler to do that. This is because the
   application may have to handle other consequences of the resize, or it may
   wish to veto it altogether. The event handler should look at the drag
   rectangle: see
   wxSashEvent::GetDragRect
   to see what the new size of the window would be if the resize were to be
   applied. It should also call
   wxSashEvent::GetDragStatus
   to see whether the drag was OK or out of the current allowed range.
  
 
.SH "PARENTS"

  wxCommandEvent
   
  wxEvent
   
  wxObject
 
.SH "INCLUDE FILES"
wx/sashwin.h
.SH MEMBERS

  
.SS  wxSashEvent (int id = 0wxSashEdgePosition edge = wxSASH_NONE)

     


      Constructor.
     
    
   
  
.SS wxSashEdgePosition GetEdge ()

     


      Returns the dragged edge. The return value is one of wxSASH_TOP,
      wxSASH_RIGHT, wxSASH_BOTTOM, wxSASH_LEFT.
     
    
   
  
.SS wxRect GetDragRect ()

     


      Returns the rectangle representing the new size the window would be if the
      resize was applied. It is up to the application to set the window size if
      required.
     
    
   
  
.SS wxSashDragStatus GetDragStatus ()

     


      Returns the status of the sash: one of wxSASH_STATUS_OK,
      wxSASH_STATUS_OUT_OF_RANGE. If the drag caused the notional bounding box
      of the window to flip over, for example, the drag will be out of rage.
     
    
 
.SH EVENTS

.SS EVT_SASH_DRAGGED(id, func)

   Process a wxEVT_SASH_DRAGGED event, when the user has finished dragging a sash.
  
.SS 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.
  
.SH "SEE ALSO"

  wxCommandEvent
   
  wxEvent
   
  wxObject
 
  wxSashWindow
  , 
  Event handling overview
 
.SH "AUTHORS"
Documentation content by Julian Smart, Robert Roebling, Vadim Zeitlin, Robin Dunn, et al

Conversion to manpage format by Arnout Engelen (http://bzzt.net), bugreports welcome.