wx.MDIChildFrame

An MDI child frame is a frame that can only exist inside a wx.MDIClientWindow, which is itself a child of wx.MDIParentFrame.

Window Styles

This class supports the following styles:

All of the standard wx.Frame styles can be used but most of them are ignored by TDI-based MDI implementations.

Note

Although internally an MDI child frame is a child of the MDI client window, in wxWidgets you create it as a child of wx.MDIParentFrame. In fact, you can usually forget that the client window exists. MDI child frames are clipped to the area of the MDI client window, and may be iconized on the client window. You can associate a menubar with a child frame as usual, although an MDI child doesn’t display its menubar under its own title bar. The MDI parent frame’s menubar will be changed to reflect the currently active child frame. If there are currently no children, the parent frame’s own menubar will be displayed.

See also

wx.MDIClientWindow, wx.MDIParentFrame, wx.Frame

Class Hierarchy

Inheritance diagram for class MDIChildFrame:

Known Subclasses

DocMDIChildFrame

Methods Summary

__init__	Default constructor.
Activate	Activates this MDI child frame.
Create	Used in two-step frame construction.
GetClassDefaultAttributes
GetMDIParent	Returns the MDI parent frame containing this child.
IsAlwaysMaximized	Returns True for MDI children in TDI implementations.
Maximize	Maximizes this MDI child frame.
Restore	Restores this MDI child frame (unmaximizes).

Properties Summary

MDIParent

See GetMDIParent

Class API

class wx.MDIChildFrame(MDIChildFrameBase)

Possible constructors:

MDIChildFrame() -> None

MDIChildFrame(parent, id=ID_ANY, title='', pos=DefaultPosition,
              size=DefaultSize, style=DEFAULT_FRAME_STYLE, name=FrameNameStr) -> None

An MDI child frame is a frame that can only exist inside a MDIClientWindow, which is itself a child of MDIParentFrame.

Methods

__init__(self, *args, **kw)

Overloaded Implementations:

---

__init__ (self)

Default constructor.

Return type:

None

---

__init__ (self, parent, id=ID_ANY, title=’’, pos=DefaultPosition, size=DefaultSize, style=DEFAULT_FRAME_STYLE, name=FrameNameStr)

Constructor, creating the window.

Parameters:

• parent (wx.MDIParentFrame) – The window parent. This should not be None.

• id (wx.WindowID) – The window identifier. It may take a value of -1 to indicate a default value.

• title (string) – The caption to be displayed on the frame’s title bar.

• pos (wx.Point) – The window position. The value wx.DefaultPosition indicates a default position, chosen by either the windowing system or wxWidgets, depending on platform.

• size (wx.Size) – The window size. The value wx.DefaultSize indicates a default size, chosen by either the windowing system or wxWidgets, depending on platform.

• style (long) – The window style. See wx.MDIChildFrame.

• name (string) – The name of the window. This parameter is used to associate a name with the item, allowing the application user to set Motif resource values for individual windows.

Return type:

None

See also

Create

---

---

Activate(self)

Activates this MDI child frame.

Return type:

None

See also

Maximize , Restore

---

Create(self, parent, id=ID_ANY, title='', pos=DefaultPosition, size=DefaultSize, style=DEFAULT_FRAME_STYLE, name=FrameNameStr)

Used in two-step frame construction.

See wx.MDIChildFrame for further details.

Parameters:

• parent (wx.MDIParentFrame)

• id (wx.WindowID)

• title (string)

• pos (wx.Point)

• size (wx.Size)

• style (long)

• name (string)

Return type:

bool

---

static GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL)

Parameters:

variant (WindowVariant)

Return type:

wx.VisualAttributes

---

GetMDIParent(self)

Returns the MDI parent frame containing this child.

Notice that this may return a different object than GetParent as the child frames may be created as children of the client window internally.

Return type:

wx.MDIParentFrame

---

IsAlwaysMaximized(self)

Returns True for MDI children in TDI implementations.

TDI-based implementations represent MDI children as pages in a wx.Notebook and so they are always maximized and can’t be restored or iconized.

Return type:

bool

See also

wx.MDIParentFrame.IsTDI .

---

Maximize(self, maximize=True)

Maximizes this MDI child frame.

This function doesn’t do anything if IsAlwaysMaximized returns True.

Parameters:

maximize (bool)

Return type:

None

See also

Activate , Restore

---

Restore(self)

Restores this MDI child frame (unmaximizes).

This function doesn’t do anything if IsAlwaysMaximized returns True.

Return type:

None

See also

Activate , Maximize

Properties

MDIParent

See GetMDIParent