wxMDIClientWindow — wx v2.4.2

Search documentation of wx

# View Source wxMDIClientWindow (wx v2.4.2)

Functions for wxMDIClientWindow class

An MDI client window is a child of `wxMDIParentFrame`, and manages zero or more `wxMDIChildFrame` 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 `wxMDIClientWindow` 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 `wxMDIParentFrame::OnCreateClient()` (not implemented in wx) 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.

See: `wxMDIChildFrame`, `wxMDIParentFrame`, `wxFrame`

This class is derived (and can use functions) from: `wxWindow` `wxEvtHandler`

wxWidgets docs: wxMDIClientWindow

# Summary

## Types

wxMDIClientWindow()

## Functions

createClient(This, Parent)
createClient/3

Called by `wxMDIParentFrame` immediately after creating the client window.

destroy(This)

Destroys the object.

new()

Default constructor.

# Types

Link to this type

# wxMDIClientWindow()

View Source

    -type wxMDIClientWindow() :: wx:wx_object().

# Functions

Link to this function

# createClient(This, Parent)

View Source

    -spec createClient(This, Parent) -> boolean()
                          when This :: wxMDIClientWindow(), Parent :: wxMDIParentFrame:wxMDIParentFrame().

Link to this function

# createClient/3

View Source

    -spec createClient(This, Parent, [Option]) -> boolean()
                          when
                              This :: wxMDIClientWindow(),
                              Parent :: wxMDIParentFrame:wxMDIParentFrame(),
                              Option :: {style, integer()}.

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

Link to this function

# destroy(This)

View Source

    -spec destroy(This :: wxMDIClientWindow()) -> ok.

Destroys the object.

Link to this function

# new()

View Source

    -spec new() -> wxMDIClientWindow().

Default constructor.

Objects of this class are only created by `wxMDIParentFrame` which uses the default constructor and calls `createClient/3` immediately afterwards.