QDesignerFormWindowManagerInterface

The QDesignerFormWindowManagerInterface class allows you to manipulate the collection of form windows in Qt Designer, and control Qt Designer’s form editing actions. More…

Synopsis

Functions

• def actionAdjustSize ()

• def actionBreakLayout ()

• def actionCopy ()

• def actionCut ()

• def actionDelete ()

• def actionFormLayout ()

• def actionGridLayout ()

• def actionHorizontalLayout ()

• def actionLower ()

• def actionPaste ()

• def actionRaise ()

• def actionRedo ()

• def actionSelectAll ()

• def actionSimplifyLayout ()

• def actionSplitHorizontal ()

• def actionSplitVertical ()

• def actionUndo ()

• def actionVerticalLayout ()

Virtual functions

• def action (action)

• def actionGroup (actionGroup)

• def activeFormWindow ()

• def addFormWindow (formWindow)

• def closeAllPreviews ()

• def core ()

• def createFormWindow ([parentWidget=None[, flags=Qt.WindowFlags()]])

• def createPreviewPixmap ()

• def dragItems (item_list)

• def formWindow (index)

• def formWindowCount ()

• def removeFormWindow (formWindow)

• def setActiveFormWindow (formWindow)

• def showPluginDialog ()

• def showPreview ()

Signals

• def activeFormWindowChanged (formWindow)

• def formWindowAdded (formWindow)

• def formWindowRemoved (formWindow)

• def formWindowSettingsChanged (fw)

Detailed Description

QDesignerFormWindowManagerInterface is not intended to be instantiated directly. Qt Designer uses the form window manager to control the various form windows in its workspace. You can retrieve an interface to Qt Designer's form window manager using the formWindowManager() function. For example:

manager = 0
formWindow = 0
manager = formEditor.formWindowManager()
formWindow = manager.formWindow(0)
manager.setActiveFormWindow(formWindow)

When implementing a custom widget plugin, a pointer to Qt Designer's current QDesignerFormEditorInterface object (formEditor in the example above) is provided by the initialize() function’s parameter. You must subclass the QDesignerCustomWidgetInterface to expose your plugin to Qt Designer.

The form window manager interface provides the createFormWindow() function that enables you to create a new form window which you can add to the collection of form windows that the manager maintains, using the addFormWindow() slot. It also provides the formWindowCount() function returning the number of form windows currently under the manager’s control, the formWindow() function returning the form window associated with a given index, and the activeFormWindow() function returning the currently selected form window. The removeFormWindow() slot allows you to reduce the number of form windows the manager must maintain, and the setActiveFormWindow() slot allows you to change the form window focus in Qt Designer's workspace.

In addition, QDesignerFormWindowManagerInterface contains a collection of functions that enables you to intervene and control Qt Designer's form editing actions. All these functions return the original action, making it possible to propagate the function further after intervention.

Finally, the interface provides three signals which are emitted when a form window is added, when the currently selected form window changes, or when a form window is removed, respectively. All the signals carry the form window in question as their parameter.

See also

QDesignerFormEditorInterface QDesignerFormWindowInterface

class PySide6.QtDesigner.QDesignerFormWindowManagerInterface([parent=None])

Parameters

parent – PySide6.QtCore.QObject

Constructs an interface with the given parent for the form window manager.

PySide6.QtDesigner.QDesignerFormWindowManagerInterface.Action

Specifies an action of Qt Designer.

Constant	Description
QDesignerFormWindowManagerInterface.CutAction	Clipboard Cut
QDesignerFormWindowManagerInterface.CopyAction	Clipboard Copy
QDesignerFormWindowManagerInterface.PasteAction	Clipboard Paste
QDesignerFormWindowManagerInterface.DeleteAction	Clipboard Delete
QDesignerFormWindowManagerInterface.SelectAllAction	Select All
QDesignerFormWindowManagerInterface.LowerAction	Lower current widget
QDesignerFormWindowManagerInterface.RaiseAction	Raise current widget
QDesignerFormWindowManagerInterface.UndoAction	Undo
QDesignerFormWindowManagerInterface.RedoAction	Redo
QDesignerFormWindowManagerInterface.HorizontalLayoutAction	Lay out using QHBoxLayout
QDesignerFormWindowManagerInterface.VerticalLayoutAction	Lay out using QVBoxLayout
QDesignerFormWindowManagerInterface.SplitHorizontalAction	Lay out in horizontal QSplitter
QDesignerFormWindowManagerInterface.SplitVerticalAction	Lay out in vertical QSplitter
QDesignerFormWindowManagerInterface.GridLayoutAction	Lay out using QGridLayout
QDesignerFormWindowManagerInterface.FormLayoutAction	Lay out using QFormLayout
QDesignerFormWindowManagerInterface.BreakLayoutAction	Break existing layout
QDesignerFormWindowManagerInterface.AdjustSizeAction	Adjust size
QDesignerFormWindowManagerInterface.SimplifyLayoutAction	Simplify QGridLayout or QFormLayout
QDesignerFormWindowManagerInterface.DefaultPreviewAction	Create a preview in default style
QDesignerFormWindowManagerInterface.FormWindowSettingsDialogAction	Show dialog with form settings

See also

action()

PySide6.QtDesigner.QDesignerFormWindowManagerInterface.ActionGroup

Specifies an action group of Qt Designer.

Constant	Description
QDesignerFormWindowManagerInterface.StyledPreviewActionGroup	Action group containing styled preview actions

See also

actionGroup()

PySide6.QtDesigner.QDesignerFormWindowManagerInterface.action(action)

Parameters

action – Action

Return type

PySide6.QtGui.QAction

Returns the action specified by the enumeration value action.

Obsoletes the action accessors of Qt 4.X.

PySide6.QtDesigner.QDesignerFormWindowManagerInterface.actionAdjustSize()

Return type

PySide6.QtGui.QAction

Allows you to intervene and control Qt Designer's “adjust size” action. The function returns the original action.

Use action() instead.

See also

QAction

PySide6.QtDesigner.QDesignerFormWindowManagerInterface.actionBreakLayout()

Return type

PySide6.QtGui.QAction

Allows you to intervene and control Qt Designer's “break layout” action. The function returns the original action.

Use action() instead.

See also

QAction

PySide6.QtDesigner.QDesignerFormWindowManagerInterface.actionCopy()

Return type

PySide6.QtGui.QAction

Allows you to intervene and control Qt Designer's “copy” action. The function returns the original action.

Use action() instead.

See also

QAction

PySide6.QtDesigner.QDesignerFormWindowManagerInterface.actionCut()

Return type

PySide6.QtGui.QAction

Allows you to intervene and control Qt Designer's “cut” action. The function returns the original action.

Use action() instead.

See also

QAction

PySide6.QtDesigner.QDesignerFormWindowManagerInterface.actionDelete()

Return type

PySide6.QtGui.QAction

Allows you to intervene and control Qt Designer's “delete” action. The function returns the original action.

Use action() instead.

See also

QAction

PySide6.QtDesigner.QDesignerFormWindowManagerInterface.actionFormLayout()

Return type

PySide6.QtGui.QAction

Allows you to intervene and control Qt Designer's “form layout” action. The function returns the original action.

Use action() instead.

See also

QAction

PySide6.QtDesigner.QDesignerFormWindowManagerInterface.actionGridLayout()

Return type

PySide6.QtGui.QAction

Allows you to intervene and control a request for grid layout for a form window in Qt Designer's workspace. The function returns the original action.

Use action() instead.

See also

QAction

PySide6.QtDesigner.QDesignerFormWindowManagerInterface.actionGroup(actionGroup)

Parameters

actionGroup – ActionGroup

Return type

PySide6.QtGui.QActionGroup

Returns the action group specified by the enumeration value actionGroup.

PySide6.QtDesigner.QDesignerFormWindowManagerInterface.actionHorizontalLayout()

Return type

PySide6.QtGui.QAction

Allows you to intervene and control a request for horizontal layout for a form window in Qt Designer's workspace. The function returns the original action.

Use action() instead.

See also

QAction

PySide6.QtDesigner.QDesignerFormWindowManagerInterface.actionLower()

Return type

PySide6.QtGui.QAction

Allows you to intervene and control the action of lowering a form window in Qt Designer's workspace. The function returns the original action.

Use action() instead.

See also

QAction

PySide6.QtDesigner.QDesignerFormWindowManagerInterface.actionPaste()

Return type

PySide6.QtGui.QAction

Allows you to intervene and control Qt Designer's “paste” action. The function returns the original action.

Use action() instead.

See also

QAction

PySide6.QtDesigner.QDesignerFormWindowManagerInterface.actionRaise()

Return type

PySide6.QtGui.QAction

Allows you to intervene and control the action of raising of a form window in Qt Designer's workspace. The function returns the original action.

Use action() instead.

See also

QAction

PySide6.QtDesigner.QDesignerFormWindowManagerInterface.actionRedo()

Return type

PySide6.QtGui.QAction

Allows you to intervene and control Qt Designer's “redo” action. The function returns the original action.

Use action() instead.

See also

QAction

PySide6.QtDesigner.QDesignerFormWindowManagerInterface.actionSelectAll()

Return type

PySide6.QtGui.QAction

Allows you to intervene and control Qt Designer's “select all” action. The function returns the original action.

Use action() instead.

See also

QAction

PySide6.QtDesigner.QDesignerFormWindowManagerInterface.actionSimplifyLayout()

Return type

PySide6.QtGui.QAction

Allows you to intervene and control Qt Designer's “simplify layout” action. The function returns the original action.

Use action() instead.

See also

QAction

PySide6.QtDesigner.QDesignerFormWindowManagerInterface.actionSplitHorizontal()

Return type

PySide6.QtGui.QAction

Allows you to intervene and control Qt Designer's “split horizontal” action. The function returns the original action.

Use action() instead.

See also

QAction

PySide6.QtDesigner.QDesignerFormWindowManagerInterface.actionSplitVertical()

Return type

PySide6.QtGui.QAction

Allows you to intervene and control Qt Designer's “split vertical” action. The function returns the original action.

Use action() instead.

See also

QAction

PySide6.QtDesigner.QDesignerFormWindowManagerInterface.actionUndo()

Return type

PySide6.QtGui.QAction

Allows you to intervene and control Qt Designer's “undo” action. The function returns the original action.

Use action() instead.

See also

QAction

PySide6.QtDesigner.QDesignerFormWindowManagerInterface.actionVerticalLayout()

Return type

PySide6.QtGui.QAction

Allows you to intervene and control a request for vertical layout for a form window in Qt Designer's workspace. The function returns the original action.

Use action() instead.

See also

QAction

PySide6.QtDesigner.QDesignerFormWindowManagerInterface.activeFormWindow()

Return type

PySide6.QtDesigner.QDesignerFormWindowInterface

Returns the currently active form window in Qt Designer's workspace.

See also

setActiveFormWindow() removeFormWindow()

PySide6.QtDesigner.QDesignerFormWindowManagerInterface.activeFormWindowChanged(formWindow)

Parameters

formWindow – PySide6.QtDesigner.QDesignerFormWindowInterface

PySide6.QtDesigner.QDesignerFormWindowManagerInterface.addFormWindow(formWindow)

Parameters

formWindow – PySide6.QtDesigner.QDesignerFormWindowInterface

Adds the given formWindow to the collection of windows that Qt Designer's form window manager maintains.

See also

formWindowAdded()

PySide6.QtDesigner.QDesignerFormWindowManagerInterface.closeAllPreviews()

Close all currently open previews.

See also

showPreview()

PySide6.QtDesigner.QDesignerFormWindowManagerInterface.core()

Return type

PySide6.QtDesigner.QDesignerFormEditorInterface

Returns a pointer to Qt Designer's current QDesignerFormEditorInterface object.

PySide6.QtDesigner.QDesignerFormWindowManagerInterface.createFormWindow([parentWidget=None[, flags=Qt.WindowFlags()]])

Parameters

• parentWidget – PySide6.QtWidgets.QWidget

• flags – WindowFlags

Return type

PySide6.QtDesigner.QDesignerFormWindowInterface

Creates a form window with the given parent and the given window flags.

See also

addFormWindow()

PySide6.QtDesigner.QDesignerFormWindowManagerInterface.createPreviewPixmap()

Return type

PySide6.QtGui.QPixmap

Creates a pixmap representing the preview of the currently active form.

PySide6.QtDesigner.QDesignerFormWindowManagerInterface.dragItems(item_list)

Parameters

item_list –

PySide6.QtDesigner.QDesignerFormWindowManagerInterface.formWindow(index)

Parameters

index – int

Return type

PySide6.QtDesigner.QDesignerFormWindowInterface

Returns the form window at the given index.

See also

setActiveFormWindow() removeFormWindow()

PySide6.QtDesigner.QDesignerFormWindowManagerInterface.formWindowAdded(formWindow)

Parameters

formWindow – PySide6.QtDesigner.QDesignerFormWindowInterface

PySide6.QtDesigner.QDesignerFormWindowManagerInterface.formWindowCount()

Return type

int

Returns the number of form windows maintained by Qt Designer's form window manager.

PySide6.QtDesigner.QDesignerFormWindowManagerInterface.formWindowRemoved(formWindow)

Parameters

formWindow – PySide6.QtDesigner.QDesignerFormWindowInterface

PySide6.QtDesigner.QDesignerFormWindowManagerInterface.formWindowSettingsChanged(fw)

Parameters

fw – PySide6.QtDesigner.QDesignerFormWindowInterface

PySide6.QtDesigner.QDesignerFormWindowManagerInterface.removeFormWindow(formWindow)

Parameters

formWindow – PySide6.QtDesigner.QDesignerFormWindowInterface

Removes the given formWindow from the collection of windows that Qt Designer's form window manager maintains.

See also

formWindow() formWindowRemoved()

PySide6.QtDesigner.QDesignerFormWindowManagerInterface.setActiveFormWindow(formWindow)

Parameters

formWindow – PySide6.QtDesigner.QDesignerFormWindowInterface

Sets the given formWindow to be the currently active form window in Qt Designer's workspace.

See also

activeFormWindow() activeFormWindowChanged()

PySide6.QtDesigner.QDesignerFormWindowManagerInterface.showPluginDialog()

Opens a dialog showing the plugins loaded by Qt Designer's and its plugin load failures.

PySide6.QtDesigner.QDesignerFormWindowManagerInterface.showPreview()

Show a preview of the current form using the default parameters.

See also

closeAllPreviews()