QMdiSubWindow¶

Inheritance diagram of QMdiSubWindow

Synopsis¶

Detailed Description¶

The PySide.QtGui.QMdiSubWindow class provides a subwindow class for PySide.QtGui.QMdiArea .

PySide.QtGui.QMdiSubWindow represents a top-level window in a PySide.QtGui.QMdiArea , and consists of a title bar with window decorations, an internal widget, and (depending on the current style) a window frame and a size grip. PySide.QtGui.QMdiSubWindow has its own layout, which consists of the title bar and a center area for the internal widget.

The most common way to construct a PySide.QtGui.QMdiSubWindow is to call QMdiArea.addSubWindow() with the internal widget as the argument. You can also create a subwindow yourself, and set an internal widget by calling PySide.QtGui.QMdiSubWindow.setWidget() .

You use the same API when programming with subwindows as with regular top-level windows (e.g., you can call functions such as PySide.QtGui.QWidget.show() , PySide.QtGui.QWidget.hide() , PySide.QtGui.QWidget.showMaximized() , and PySide.QtGui.QWidget.setWindowTitle() ).

Subwindow Handling¶

PySide.QtGui.QMdiSubWindow also supports behavior specific to subwindows in an MDI area.

By default, each PySide.QtGui.QMdiSubWindow is visible inside the MDI area viewport when moved around, but it is also possible to specify transparent window movement and resizing behavior, where only the outline of a subwindow is updated during these operations. The PySide.QtGui.QMdiSubWindow.setOption() function is used to enable this behavior.

The PySide.QtGui.QMdiSubWindow.isShaded() function detects whether the subwindow is currently shaded (i.e., the window is collapsed so that only the title bar is visible). To enter shaded mode, call PySide.QtGui.QMdiSubWindow.showShaded() . PySide.QtGui.QMdiSubWindow emits the PySide.QtGui.QMdiSubWindow.windowStateChanged() signal whenever the window state has changed (e.g., when the window becomes minimized, or is restored). It also emits PySide.QtGui.QMdiSubWindow.aboutToActivate() before it is activated.

In keyboard-interactive mode, the windows are moved and resized with the keyboard. You can enter this mode through the system menu of the window. The PySide.QtGui.QMdiSubWindow.keyboardSingleStep() and PySide.QtGui.QMdiSubWindow.keyboardPageStep() properties control the distance the widget is moved or resized for each keypress event. When shift is pressed down page step is used; otherwise single step is used.

You can also change the active window with the keyboard. By pressing the control and tab keys at the same time, the next (using the current QMdiArea.WindowOrder ) subwindow will be activated. By pressing control, shift, and tab, you will activate the previous window. This is equivalent to calling PySide.QtGui.QMdiArea.activateNextSubWindow() and PySide.QtGui.QMdiArea.activatePreviousSubWindow() . Note that these shortcuts overrides global shortcuts, but not the PySide.QtGui.QMdiArea s shortcuts.

See also

PySide.QtGui.QMdiArea

class PySide.QtGui.QMdiSubWindow([parent=None[, flags=0]])¶

Parameters:	flags – `PySide.QtCore.Qt.WindowFlags` parent – `PySide.QtGui.QWidget`

PySide.QtGui.QMdiSubWindow.SubWindowOption¶

This enum describes options that customize the behavior of PySide.QtGui.QMdiSubWindow .

Constant	Description
QMdiSubWindow.RubberBandResize	If you enable this option, a rubber band control is used to represent the subwindow’s outline, and the user resizes this instead of the subwindow itself. As a result, the subwindow maintains its original position and size until the resize operation has been completed, at which time it will receive a single `PySide.QtGui.QResizeEvent` . By default, this option is disabled.
QMdiSubWindow.RubberBandMove	If you enable this option, a rubber band control is used to represent the subwindow’s outline, and the user moves this instead of the subwindow itself. As a result, the subwindow remains in its original position until the move operation has completed, at which time a `PySide.QtGui.QMoveEvent` is sent to the window. By default, this option is disabled.

PySide.QtGui.QMdiSubWindow.aboutToActivate()¶

PySide.QtGui.QMdiSubWindow.isShaded()¶

Return type:	`PySide.QtCore.bool`

Returns true if this window is shaded; otherwise returns false.

A window is shaded if it is collapsed so that only the title bar is visible.

PySide.QtGui.QMdiSubWindow.keyboardPageStep()¶

Return type:	`PySide.QtCore.int`

This property holds sets how far a widget should move or resize when using the keyboard page keys..

When in keyboard-interactive mode, you can use the arrow and page keys to either move or resize the window. This property controls the page keys. The common way to enter keyboard interactive mode is to enter the subwindow menu, and select either “resize” or “move”.

The default keyboard page step value is 20 pixels.

PySide.QtGui.QMdiSubWindow.keyboardSingleStep()¶

Return type:	`PySide.QtCore.int`

This property holds sets how far a widget should move or resize when using the keyboard arrow keys..

When in keyboard-interactive mode, you can use the arrow and page keys to either move or resize the window. This property controls the arrow keys. The common way to enter keyboard interactive mode is to enter the subwindow menu, and select either “resize” or “move”.

The default keyboard single step value is 5 pixels.

PySide.QtGui.QMdiSubWindow.maximizedButtonsWidget()¶

Return type:	`PySide.QtGui.QWidget`

PySide.QtGui.QMdiSubWindow.maximizedSystemMenuIconWidget()¶

Return type:	`PySide.QtGui.QWidget`

PySide.QtGui.QMdiSubWindow.mdiArea()¶

Return type:	`PySide.QtGui.QMdiArea`

Returns the area containing this sub-window, or 0 if there is none.

See also

QMdiArea.addSubWindow()

PySide.QtGui.QMdiSubWindow.setKeyboardPageStep(step)¶

Parameters:	step – `PySide.QtCore.int`

This property holds sets how far a widget should move or resize when using the keyboard page keys..

When in keyboard-interactive mode, you can use the arrow and page keys to either move or resize the window. This property controls the page keys. The common way to enter keyboard interactive mode is to enter the subwindow menu, and select either “resize” or “move”.

The default keyboard page step value is 20 pixels.

PySide.QtGui.QMdiSubWindow.setKeyboardSingleStep(step)¶

Parameters:	step – `PySide.QtCore.int`

This property holds sets how far a widget should move or resize when using the keyboard arrow keys..

When in keyboard-interactive mode, you can use the arrow and page keys to either move or resize the window. This property controls the arrow keys. The common way to enter keyboard interactive mode is to enter the subwindow menu, and select either “resize” or “move”.

The default keyboard single step value is 5 pixels.

PySide.QtGui.QMdiSubWindow.setOption(option[, on=true])¶

Parameters:	option – `PySide.QtGui.QMdiSubWindow.SubWindowOption` on – `PySide.QtCore.bool`

If on is true, option is enabled on the subwindow; otherwise it is disabled. See QMdiSubWindow.SubWindowOption for the effect of each option.

See also

QMdiSubWindow.SubWindowOption PySide.QtGui.QMdiSubWindow.testOption()

PySide.QtGui.QMdiSubWindow.setSystemMenu(systemMenu)¶

Parameters:	systemMenu – `PySide.QtGui.QMenu`

Sets systemMenu as the current system menu for this subwindow.

By default, each PySide.QtGui.QMdiSubWindow has a standard system menu.

QActions for the system menu created by PySide.QtGui.QMdiSubWindow will automatically be updated depending on the current window state; e.g., the minimize action will be disabled after the window is minimized.

QActions added by the user are not updated by PySide.QtGui.QMdiSubWindow .

PySide.QtGui.QMdiSubWindow takes ownership of systemMenu ; you do not have to delete it. Any existing menus will be deleted.

PySide.QtGui.QMdiSubWindow.setWidget(widget)¶

Parameters:	widget – `PySide.QtGui.QWidget`

Sets widget as the internal widget of this subwindow. The internal widget is displayed in the center of the subwindow beneath the title bar.

PySide.QtGui.QMdiSubWindow takes temporary ownership of widget ; you do not have to delete it. Any existing internal widget will be removed and reparented to the root window.

See also

PySide.QtGui.QMdiSubWindow.widget()

PySide.QtGui.QMdiSubWindow.showShaded()¶

Calling this function makes the subwindow enter the shaded mode. When the subwindow is shaded, only the title bar is visible.

Although shading is not supported by all styles, this function will still show the subwindow as shaded, regardless of whether support for shading is available. However, when used with styles without shading support, the user will be unable to return from shaded mode through the user interface (e.g., through a shade button in the title bar).

See also

PySide.QtGui.QMdiSubWindow.isShaded()

PySide.QtGui.QMdiSubWindow.showSystemMenu()¶: Shows the system menu below the system menu icon in the title bar.

See also

PySide.QtGui.QMdiSubWindow.setSystemMenu() PySide.QtGui.QMdiSubWindow.systemMenu()

PySide.QtGui.QMdiSubWindow.systemMenu()¶

Return type:	`PySide.QtGui.QMenu`

Returns a pointer to the current system menu, or zero if no system menu is set. PySide.QtGui.QMdiSubWindow provides a default system menu, but you can also set the menu with PySide.QtGui.QMdiSubWindow.setSystemMenu() .

PySide.QtGui.QMdiSubWindow.testOption(arg__1)¶

Parameters:	arg__1 – `PySide.QtGui.QMdiSubWindow.SubWindowOption`
Return type:	`PySide.QtCore.bool`

Returns true if option is enabled; otherwise returns false.

See also

QMdiSubWindow.SubWindowOption PySide.QtGui.QMdiSubWindow.setOption()

PySide.QtGui.QMdiSubWindow.widget()¶

Return type:	`PySide.QtGui.QWidget`

Returns the current internal widget.

PySide.QtGui.QMdiSubWindow.windowStateChanged(oldState, newState)¶

Parameters:	oldState – `PySide.QtCore.Qt.WindowStates` newState – `PySide.QtCore.Qt.WindowStates`

Table Of Contents

Previous topic

Next topic

QMdiSubWindow¶

Synopsis¶

Functions¶

Slots¶

Signals¶

Detailed Description¶

Subwindow Handling¶

Table Of Contents

Previous topic

Next topic

Quick search

QMdiSubWindow¶

Synopsis¶

Functions¶

Slots¶

Signals¶

Detailed Description¶

Subwindow Handling¶