.\" This is a wxWidgets manpage page generated from the XML docs
.TH wxSashLayoutWindow 3wx 2005-02-15 "wxWidgets" "wxWidgets class documentation"
.SH NAME
wxSashLayoutWindow \- 
  Window that can be involved in an IDE-like layout arrangement
 
.SH DESCRIPTION

  


   wxSashLayoutWindow responds to OnCalculateLayout events generated by
   wxLayoutAlgorithm
   . It allows the application to use simple accessors to specify how the window
   should be laid out, rather than having to respond to events. The fact that
   the class derives from wxSashWindow allows sashes to be used if required, to
   allow the windows to be user-resizable.
  
  


   The documentation for
   wxLayoutAlgorithm
   explains the purpose of this class in more detail.
  
 
.SH "PARENTS"

  wxSashWindow
   
  wxWindow
   
  wxEvtHandler
   
  wxObject
 
.SH "INCLUDE FILES"
wx/laywin.h
.SH MEMBERS

  
.SS  wxSashLayoutWindow ()

     


      Default constructor.
     
    
.SS  wxSashLayoutWindow (wxSashLayoutWindow* parentwxWindowID idconst wxPoint& pos = wxDefaultPositionconst wxSize& size = wxDefaultSizelong style = wxCLIP_CHILDRENconst wxString& name = "layoutWindow")

     


      Constructs a sash layout window, which can be a child of a frame, dialog
      or any other non-control window.
     
    
   
  
.SS bool Create (wxSashLayoutWindow* parentwxWindowID idconst wxPoint& pos = wxDefaultPositionconst wxSize& size = wxDefaultSizelong style = wxCLIP_CHILDRENconst wxString& name = "layoutWindow")

     


      Initializes a sash layout window, which can be a child of a frame, dialog
      or any other non-control window.
     
    
   
  
.SS wxLayoutAlignment GetAlignment ()

     


      Returns the alignment of the window: one of wxLAYOUT_TOP, wxLAYOUT_LEFT,
      wxLAYOUT_RIGHT, wxLAYOUT_BOTTOM.
     
    
   
  
.SS wxLayoutOrientation GetOrientation ()

     


      Returns the orientation of the window: one of wxLAYOUT_HORIZONTAL,
      wxLAYOUT_VERTICAL.
     
    
   
  
.SS void OnCalculateLayout (wxCalculateLayoutEvent& event)

     


      The default handler for the event that is generated by wxLayoutAlgorithm.
      The implementation of this function calls wxCalculateLayoutEvent::SetRect
      to shrink the provided size according to how much space this window takes
      up. For further details, see
      wxLayoutAlgorithm
      and
      wxCalculateLayoutEvent
      .
     
    
   
  
.SS void OnQueryLayoutInfo (wxQueryLayoutInfoEvent& event)

     


      The default handler for the event that is generated by OnCalculateLayout
      to get size, alignment and orientation information for the window. The
      implementation of this function uses member variables as set by accessors
      called by the application. For further details, see
      wxLayoutAlgorithm
      and
      wxQueryLayoutInfoEvent
      .
     
    
   
  
.SS void SetAlignment (wxLayoutAlignment alignment)

     


      Sets the alignment of the window (which edge of the available parent
      client area the window is attached to).
      
       alignment
      
      is one of wxLAYOUT_TOP, wxLAYOUT_LEFT, wxLAYOUT_RIGHT, wxLAYOUT_BOTTOM.
     
    
   
  
.SS void SetDefaultSize (const wxSize& size)

     


      Sets the default dimensions of the window. The dimension other than the
      orientation will be fixed to this value, and the orientation dimension
      will be ignored and the window stretched to fit the available space.
     
    
   
  
.SS void SetOrientation (wxLayoutOrientation orientation)

     


      Sets the orientation of the window (the direction the window will stretch
      in, to fill the available parent client area).
      
       orientation
      
      is one of wxLAYOUT_HORIZONTAL, wxLAYOUT_VERTICAL.
     
    
 
.SH "WINDOW STYLES"

.SH EVENTS

.SH "SEE ALSO"

  wxSashWindow
   
  wxWindow
   
  wxEvtHandler
   
  wxObject
 
  wxLayoutAlgorithm
  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.