Table Of Contents

Previous topic

MDIChildFrame

Next topic

MDIParentFrame

This Page

phoenix_title MDIClientWindow

An MDI client window is a child of MDIParentFrame, and manages zero or more 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 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 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.


class_hierarchy Inheritance Diagram

Inheritance diagram for class MDIClientWindow

Inheritance diagram of MDIClientWindow


method_summary Methods Summary

__init__ Default constructor.
CreateClient Called by 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()

Methods



__init__(self)

Default constructor.

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



CreateClient(self, parent, style=0)

Called by 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.

Parameters:
  • parent (MDIParentFrame) – The window parent.
  • style (long) – The window style. Only HSCROLL and VSCROLL bits are meaningful here.
Return type:

bool