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

  


   This class represents the events generated by a splitter control. Also there
   is only one event class, the data associated to the different events is not
   the same and so not all accessor functions may be called for each event. The
   documentation mentions the kind of event(s) for which the given accessor
   function makes sense: calling it for other types of events will result in
   assert failure (in debug mode) and will return meaningless results.
  
 
.SH "PARENTS"

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

  
.SS  wxSplitterEvent (wxEventType eventType = wxEVT_NULLwxSplitterWindow * splitter = NULL)

     


      Constructor. Used internally by wxWidgets only.
     
    
   
  
.SS int GetSashPosition ()

     


      Returns the new sash position.
     
     


      May only be called while processing
      wxEVT_COMMAND_SPLITTER_SASH_POS_CHANGING and
      wxEVT_COMMAND_SPLITTER_SASH_POS_CHANGED events.
     
    
   
  
.SS int GetX ()

     


      Returns the x coordinate of the double-click point.
     
     


      May only be called while processing wxEVT_COMMAND_SPLITTER_DOUBLECLICKED
      events.
     
    
   
  
.SS int GetY ()

     


      Returns the y coordinate of the double-click point.
     
     


      May only be called while processing wxEVT_COMMAND_SPLITTER_DOUBLECLICKED
      events.
     
    
   
  
.SS wxWindow* GetWindowBeingRemoved ()

     


      Returns a pointer to the window being removed when a splitter window is
      unsplit.
     
     


      May only be called while processing wxEVT_COMMAND_SPLITTER_UNSPLIT events.
     
    
   
  
.SS void SetSashPosition (int pos)

     


      In the case of wxEVT_COMMAND_SPLITTER_SASH_POS_CHANGED events, sets the
      new sash position. In the case of wxEVT_COMMAND_SPLITTER_SASH_POS_CHANGING
      events, sets the new tracking bar position so visual feedback during
      dragging will represent that change that will actually take place. Set to
      -1 from the event handler code to prevent repositioning.
     
     


      May only be called while processing
      wxEVT_COMMAND_SPLITTER_SASH_POS_CHANGING and
      wxEVT_COMMAND_SPLITTER_SASH_POS_CHANGED events.
     
    
 
.SH EVENTS

.SS EVT_SPLITTER_SASH_POS_CHANGING(id, func)

   The sash position is in the process of being changed. You may prevent this change from happening by calling 
   Veto
    or you may also modify the position of the tracking bar to properly reflect the position that would be set if the drag were to be completed at this point. Processes a wxEVT_COMMAND_SPLITTER_SASH_POS_CHANGING event.
  
.SS EVT_SPLITTER_SASH_POS_CHANGED(id, func)

   The sash position was changed. This event is generated after the user releases the mouse after dragging the splitter. Processes a wxEVT_COMMAND_SPLITTER_SASH_POS_CHANGED event.
  
.SS EVT_SPLITTER_UNSPLIT(id, func)

   The splitter has been just unsplit. Processes a wxEVT_COMMAND_SPLITTER_UNSPLIT event. This event can't be vetoed.
  
.SS EVT_SPLITTER_DCLICK(id, func)

   The sash was double clicked. The default behaviour is to unsplit the window when this happens (unless the minimum pane size has been set to a value greater than zero). This won't happen if you veto this event. Processes a wxEVT_COMMAND_SPLITTER_DOUBLECLICKED event.
  
.SH "SEE ALSO"

  wxNotifyEvent
   
  wxCommandEvent
   
  wxEvent
   
  wxObject
 
  wxSplitterWindow
  , 
  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.