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

  


   An MDI (Multiple Document Interface) parent frame is a window which can
   contain MDI child frames in its own `desktop'. It is a convenient way to
   avoid window clutter, and is used in many popular Windows applications, such
   as Microsoft Word(TM).
  
 
.SH REMARKS

  
   There may be multiple MDI parent frames in a single application, but this
   probably only makes sense within programming development environments.
  
  
   Child frames may be of class
   wxMDIChildFrame
   (contained within the parent frame) or
   wxFrame
   (shown as a top-level frame).
  
  
   An MDI parent frame always has a
   wxMDIClientWindow
   associated with it, which is the parent for MDI client frames. This client
   window may be resized to accommodate non-MDI windows, as seen in Microsoft
   Visual C++ (TM) and Microsoft Publisher (TM), where a documentation window is
   placed to one side of the workspace.
  
  
   MDI remains popular despite dire warnings from Microsoft itself that MDI is
   an obsolete user interface style.
  
  
   The implementation is native in Windows, and simulated under Motif. Under
   Motif, the child window frames will often have a different appearance from
   other frames because the window decorations are simulated.
  
 
.SH "PARENTS"

  wxFrame
   
  wxWindow
   
  wxEvtHandler
   
  wxObject
 
.SH "INCLUDE FILES"
wx/mdi.h
.SH MEMBERS

  
.SS  wxMDIParentFrame ()

     


      Default constructor.
     
    
.SS  wxMDIParentFrame (wxWindow* parentwxWindowID idconst wxString& titleconst wxPoint& pos = wxDefaultPositionconst wxSize& size = wxDefaultSizelong style = wxDEFAULT_FRAME_STYLEconst wxString& name = ``frame")

     


      Constructor, creating the window.
     
    
   
  
.SS  ~wxMDIParentFrame ()

     


      Destructor. Destroys all child windows and menu bar if present.
     
    
   
  
.SS void ActivateNext ()

     


      Activates the MDI child following the currently active one.
     
    
   
  
.SS void ActivatePrevious ()

     


      Activates the MDI child preceding the currently active one.
     
    
   
  
.SS void ArrangeIcons ()

     


      Arranges any iconized (minimized) MDI child windows.
     
    
   
  
.SS void Cascade ()

     


      Arranges the MDI child windows in a cascade.
     
    
   
  
.SS bool Create (wxWindow* parentwxWindowID idconst wxString& titleconst wxPoint& pos = wxDefaultPositionconst wxSize& size = wxDefaultSizelong style = wxDEFAULT_FRAME_STYLEconst wxString& name = ``frame")

     


      Used in two-step frame construction. See
      wxMDIParentFrame::wxMDIParentFrame
      for further details.
     
    
   
  
.SS virtual void GetClientSize (int* widthint* height)

     


      This gets the size of the frame `client area' in pixels.
     
    
   
  
.SS wxMDIChildFrame* GetActiveChild ()

     


      Returns a pointer to the active MDI child, if there is one.
     
    
   
  
.SS wxMDIClientWindow* GetClientWindow ()

     


      Returns a pointer to the client window.
     
    
   
  
.SS virtual wxWindow* GetToolBar ()

     


      Returns the window being used as the toolbar for this frame.
     
    
   
  
.SS wxMenu* GetWindowMenu ()

     


      Returns the current Window menu (added by wxWidgets to the menubar). This
      function is available under Windows only.
     
    
   
  
.SS virtual wxMDIClientWindow* OnCreateClient ()

     


      Override this to return a different kind of client window. If you override
      this function, you must create your parent frame in two stages, or your
      function will never be called, due to the way C++ treats virtual functions
      called from constructors. For example:
     
     
  frame = new MyParentFrame;
  frame->Create(parent, myParentFrameId, wxT("My Parent Frame"));

    
   
  
.SS virtual void SetToolBar (wxWindow* toolbar)

     


      Sets the window to be used as a toolbar for this MDI parent window. It
      saves the application having to manage the positioning of the toolbar MDI
      client window.
     
    
   
  
.SS void SetWindowMenu (wxMenu* menu)

     


      Call this to change the current Window menu. Ownership of the menu object
      passes to the frame when you call this function.
     
     


      This call is available under Windows only.
     
     


      To remove the window completely, use the wxFRAME_NO_WINDOW_MENU window
      style.
     
    
   
  
.SS void Tile (wxOrientation orient = wxHORIZONTAL)

     


      Tiles the MDI child windows either horizontally or vertically depending on
      whether
      
       orient
      
      is wxHORIZONTAL or wxVERTICAL.
     
     


      Currently only implemented for MSW, does nothing under the other
      platforms.
     
    
 
.SH "WINDOW STYLES"

.SS wxCAPTION

   Puts a caption on the frame.
  
.SS wxDEFAULT_FRAME_STYLE

   Defined as
   
    wxMINIMIZE_BOX \pipe wxMAXIMIZE_BOX \pipe wxTHICK_FRAME \pipe wxSYSTEM_MENU \pipe wxCAPTION
   
   .
  
.SS wxHSCROLL

   wxHSCROLL
  
.SS wxICONIZE

   Display the frame iconized (minimized) (Windows only).
  
.SS wxMAXIMIZE

   Displays the frame maximized (Windows only).
  
.SS wxMAXIMIZE_BOX

   Displays a maximize box on the frame (Windows and Motif only).
  
.SS wxMINIMIZE

   Identical to
   
    wxICONIZE
   
   .
  
.SS wxMINIMIZE_BOX

   Displays a minimize box on the frame (Windows and Motif only).
  
.SS wxRESIZE_BORDER

   wxRESIZE_BORDER
  
.SS wxSTAY_ON_TOP

   Stay on top of other windows (Windows only).
  
.SS wxSYSTEM_MENU

   Displays a system menu (Windows and Motif only).
  
.SS wxTHICK_FRAME

   Displays a thick frame around the window (Windows and Motif only).
  
.SS wxVSCROLL

   wxVSCROLL
  
.SS wxFRAME_NO_WINDOW_MENU

   wxFRAME_NO_WINDOW_MENU
  
.SH "SEE ALSO"

  wxFrame
   
  wxWindow
   
  wxEvtHandler
   
  wxObject
 
  wxMDIChildFrame
  wxMDIClientWindow
  , 
  wxFrame
  wxDialog
 
.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.