.. include:: headings.inc



.. _MDIClientWindow:

==========================================================================================================================================
|phoenix_title|  **MDIClientWindow**
==========================================================================================================================================

An MDI client window is a child of :ref:`MDIParentFrame`, and manages zero or more :ref:`MDIChildFrame`  objects.          


The client window is the area where MDI child windows exist. It doesn't have to cover the whole parent frame; other windows such as toolbars and a help window might coexist with it. There can be scrollbars on a client window, which are controlled by the parent window style.  

The :ref:`MDIClientWindow`  class is usually adequate without further derivation, and it is created automatically when the MDI parent frame is created. If the application needs to derive a new class, the function :meth:`MDIParentFrame.OnCreateClient`   must be overridden in order to give an opportunity to use a different class of client window. 

Under wxMSW, the client window will automatically have a sunken border style when the active child is not maximized, and no border style when a child is maximized. 







         







.. seealso:: :ref:`MDIChildFrame`, :ref:`MDIParentFrame`, :ref:`Frame`    







|

|class_hierarchy| Inheritance Diagram
=====================================

Inheritance diagram for class **MDIClientWindow**

.. raw:: html

   <p class="graphviz">
   <img src="_static/images/inheritance/MDIClientWindow_inheritance.png" alt="Inheritance diagram of MDIClientWindow" usemap="#dummy" class="inheritance"/>
   <map id="dummy" name="dummy"> <area shape="rect" id="node1" href="Object.html" title="This is the root class of many of the wxWidgets classes." alt="" coords="16,5,88,35"/> <area shape="rect" id="node3" href="EvtHandler.html" title="A class that can handle events from the windowing system." alt="" coords="148,31,247,62"/> <area shape="rect" id="node2" href="Trackable.html" title="Add-on base class for a trackable object." alt="" coords="5,58,99,89"/> <area shape="rect" id="node6" href="Window.html" title="Window  is the base class for all windows and represents any visible object on screen." alt="" coords="297,31,377,62"/> <area shape="rect" id="node8" href="MDIClientWindow.html" title="An MDI client window is a child of MDIParentFrame, and manages zero or more MDIChildFrame  objects." alt="" coords="427,31,579,62"/> </map> 
   </p>

|


|method_summary| Methods Summary
================================

================================================================================ ================================================================================
:meth:`~MDIClientWindow.__init__`                                                Default constructor.
:meth:`~MDIClientWindow.CreateClient`                                            Called by :ref:`MDIParentFrame`  immediately after creating the client window.
================================================================================ ================================================================================


|


|api| Class API
===============
   

.. class:: MDIClientWindow(Window)

   An MDI client window is a child of MDIParentFrame, and manages zero or more MDIChildFrame objects.
   
   **Possible constructors**::

       MDIClientWindow()
       



   .. method:: __init__(self)

      Default constructor.                  

      Objects of this class are only created by :ref:`MDIParentFrame`  which uses the default constructor and calls :meth:`CreateClient`   immediately afterwards.                   





   .. method:: CreateClient(self, parent, style=0)

      Called by :ref:`MDIParentFrame`  immediately after creating the client window.                  

      This function may be overridden in the derived class but the base class version must usually be called first to really create the window. 




      :param `parent`: The window parent.   
      :type `parent`: MDIParentFrame
      :param `style`: The window style. Only ``HSCROLL`` and ``VSCROLL`` bits are meaningful here.   
      :type `style`: long








      :rtype: `bool`