wxMDIParentFrame

Table of Contents
wxMDIParentFrame
wxWidgets Documentation for wxMDIParentFrame
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).

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.

Creation Parameters
Functions/Procedures
Supertopics
Subtopics

wxMDIParentFrame

Table of Contents

[proc]
activate_next_mdi ( atom parent_frame )

Category: wxMDIParentFrame

Activates the MDI child following the currently active one.

wxMDIParentFrame

Table of Contents

[proc]
activate_prev_mdi ( atom parent_frame )

Category: wxMDIParentFrame

Activates the MDI child preceding the currently active one.

wxMDIParentFrame

Table of Contents

[proc]
arrange_mdi_icons ( atom parent )

Category: wxMDIParentFrame

Arranges any iconized (minimized) MDI child windows

wxMDIParentFrame

Table of Contents

[proc]
cascade_mdi ( atom parent )

Category: wxMDIParentFrame

Arranges the MDI child windows in a cascade.

wxMDIParentFrame

Table of Contents

[func]
get_active_mdi_child ( atom parent_frame )

Category: wxMDIParentFrame

Returns a pointer to the active MDI child, if there is one.

wxMDIParentFrame

Table of Contents

[func]
get_client_window ( atom parent_frame )

Category: wxMDIParentFrame

Returns a pointer to the client window.

wxMDIParentFrame

Table of Contents

[func]
get_mdi_window_menu ( atom parent_frame )

Category: wxMDIParentFrame

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

wxMDIParentFrame

Table of Contents

[proc]
set_mdi_toolbar ( atom parent_frame, atom toolbar )

Category: wxMDIParentFrame

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.

When the frame is resized, the toolbar is resized to be the width of the frame client area, and the toolbar height is kept the same.

The parent of the toolbar must be this frame.

wxMDIParentFrame

Table of Contents

[proc]
set_mdi_window_menu ( atom parent_frame, atom menu )

Category: wxMDIParentFrame

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.

wxMDIParentFrame

Table of Contents

[proc]
tile_mdi ( atom parent, atom orient )

Category: wxMDIParentFrame

Arranges the MDI child windows in a tile pattern. orient may be wxHORIZONTAL or wxVERTICAL