wx.aui.AuiMDIChildFrame¶

wx.aui.AuiMDIChildFrame represents one child document inside an wx.aui.AuiMDIParentFrame.

In AUI MDI, child frames are displayed as pages of the parent’s wx.aui.AuiMDIClientWindow, not as independently movable native child frames. The child’s title is used as the tab label and its menu bar, if any, is shown by the parent frame while the child is active.

Create AUI MDI children with a wx.aui.AuiMDIParentFrame parent, not directly with the client notebook.

Class Hierarchy¶

Inheritance diagram for class AuiMDIChildFrame:

Methods Summary¶

`__init__`	Default constructor.
`Activate`
`Create`	Used in two-step child-frame construction.
`CreateStatusBar`
`CreateToolBar`
`Destroy`	Destroys the window safely.
`GetClassDefaultAttributes`
`GetIcon`
`GetIcons`
`GetMDIParentFrame`	Returns the `AUI` MDI parent frame containing this child.
`GetMenuBar`
`GetStatusBar`
`GetTitle`	Returns the child title.
`GetToolBar`
`Iconize`
`IsFullScreen`
`IsIconized`
`IsMaximized`
`IsTopLevel`	Returns `True` if the given window is a top-level one.
`Maximize`
`Restore`
`SetIcon`
`SetIcons`
`SetMDIParentFrame`	Sets the `AUI` MDI parent frame containing this child.
`SetMenuBar`
`SetStatusText`
`SetStatusWidths`
`SetTitle`	Sets the child title, which is used as its notebook tab label.
`Show`	Shows or hides the window.
`ShowFullScreen`

Properties Summary¶

`Icon`	See `GetIcon` and `SetIcon`
`Icons`	See `GetIcons` and `SetIcons`
`MDIParentFrame`	See `GetMDIParentFrame` and `SetMDIParentFrame`
`MenuBar`	See `GetMenuBar` and `SetMenuBar`
`StatusBar`	See `GetStatusBar`
`Title`	See `GetTitle` and `SetTitle`
`ToolBar`	See `GetToolBar`

Class API¶

class wx.aui.AuiMDIChildFrame(TDIChildFrame)¶

Possible constructors:

AuiMDIChildFrame() -> None

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

AuiMDIChildFrame represents one child document inside an AuiMDIParentFrame.

Methods¶

__init__(self, *args, **kw)¶

Overloaded Implementations:

__init__ (self)

Default constructor.

Use Create to finish constructing the child frame.

Return type:: None

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

Constructor, creating the child frame.

Parameters:

parent (wx.aui.AuiMDIParentFrame)
winid (wx.WindowID)
title (string)
pos (wx.Point)
size (wx.Size)
style (long)
name (string)

Return type:

None

Activate(self)¶

Return type:: None

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

Used in two-step child-frame construction.

See wx.aui.AuiMDIChildFrame for the parameter descriptions.

Parameters:

parent (wx.aui.AuiMDIParentFrame)
winid (wx.WindowID)
title (string)
pos (wx.Point)
size (wx.Size)
style (long)
name (string)

Return type:

bool

CreateStatusBar(self, number=1, style=1, winid=1, name='')¶

Parameters:

number (int)
style (long)
winid (wx.WindowID)
name (string)

Return type:

StatusBar

CreateToolBar(self, style, winid, name)¶

Parameters:

style (long)
winid (wx.WindowID)
name (string)

Return type:

ToolBar

Destroy(self)¶

Destroys the window safely.

Use this function instead of the delete operator, since different window classes can be destroyed differently. Frames and dialogs are not destroyed immediately when this function is called – they are added to a list of windows to be deleted on idle time, when all the window’s events have been processed. This prevents problems with events being sent to non-existent windows.

Return type:: bool
Returns:: True if the window has either been successfully deleted, or it has been added to the list of windows pending real deletion.

static GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL)¶

Parameters:: variant (WindowVariant)
Return type:: VisualAttributes

GetIcon(self)¶

Return type:: Icon

GetIcons(self)¶

Return type:: IconBundle

GetMDIParentFrame(self)¶

Returns the AUI MDI parent frame containing this child.

Return type:: wx.aui.AuiMDIParentFrame

GetMenuBar(self)¶

Return type:: MenuBar

GetStatusBar(self)¶

Return type:: StatusBar

GetTitle(self)¶

Returns the child title.

Return type:: str

GetToolBar(self)¶

Return type:: ToolBar

Iconize(self, iconize=True)¶

Parameters:: iconize (bool)
Return type:: None

IsFullScreen(self)¶

Return type:: bool

IsIconized(self)¶

Return type:: bool

IsMaximized(self)¶

Return type:: bool

IsTopLevel(self)¶

Returns True if the given window is a top-level one.

Currently all frames and dialogs are considered to be top-level windows (even if they have a parent window).

Return type:: bool

Maximize(self, maximize=True)¶

Parameters:: maximize (bool)
Return type:: None

Restore(self)¶

Return type:: None

SetIcon(self, icon)¶

Parameters:: icon (wx.Icon)
Return type:: None

SetIcons(self, icons)¶

Parameters:: icons (wx.IconBundle)
Return type:: None

SetMDIParentFrame(self, parent)¶

Sets the AUI MDI parent frame containing this child.

Parameters:: parent (wx.aui.AuiMDIParentFrame)
Return type:: None

SetMenuBar(self, menuBar)¶

Parameters:: menuBar (wx.MenuBar)
Return type:: None

SetStatusText(self, text, number=0)¶

Parameters:

text (string)
number (int)

Return type:

None

SetStatusWidths(self, widths)¶

Parameters:: widths (list of integers)
Return type:: None

SetTitle(self, title)¶

Sets the child title, which is used as its notebook tab label.

Parameters:: title (string)
Return type:: None

Show(self, show=True)¶

Shows or hides the window.

You may need to call Raise for a top level window if you want to bring it to top, although this is not needed if Show is called immediately after the frame creation.

Notice that the default state of newly created top level windows is hidden (to allow you to create their contents without flicker) unlike for all the other, not derived from wx.TopLevelWindow, windows that are by default created in the shown state.

Parameters:: show (bool) – If True displays the window. Otherwise, hides it.
Return type:: bool
Returns:: True if the window has been shown or hidden or False if nothing was done because it already was in the requested state.