PySide6.QtDesigner.QDesignerFormWindowManagerInterface

class QDesignerFormWindowManagerInterface

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

Synopsis

Methods

• def __init__()

• 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 methods

• def action()

• def actionGroup()

• def activeFormWindow()

• def addFormWindow()

• def closeAllPreviews()

• def core()

• def createFormWindow()

• def createPreviewPixmap()

• def dragItems()

• def formWindow()

• def formWindowCount()

• def removeFormWindow()

• def setActiveFormWindow()

• def showPluginDialog()

• def showPreview()

Signals

• def activeFormWindowChanged()

• def formWindowAdded()

• def formWindowRemoved()

• def formWindowSettingsChanged()

Note

This documentation may contain snippets that were automatically translated from C++ to Python. We always welcome contributions to the snippet translation. If you see an issue with the translation, you can also let us know by creating a ticket on https:/bugreports.qt.io/projects/PYSIDE

Detailed Description

Warning

This section contains snippets that were automatically translated from C++ to Python and may contain errors.

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

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

When implementing a custom widget plugin, a pointer to Qt Widgets 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 Widgets 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 Widgets Designer’s workspace.

In addition, QDesignerFormWindowManagerInterface contains a collection of functions that enables you to intervene and control Qt Widgets 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 Action

Specifies an action of Qt Widgets 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()

class ActionGroup

Specifies an action group of Qt Widgets Designer.

Constant	Description
QDesignerFormWindowManagerInterface.StyledPreviewActionGroup	Action group containing styled preview actions

See also

actionGroup()

__init__([parent=None])

Parameters:

parent – QObject

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

abstract action(action)

Parameters:

action – Action

Return type:

QAction

Returns the action specified by the enumeration value action.

Obsoletes the action accessors of Qt 4.X.

actionAdjustSize()

Return type:

QAction

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

Use action() instead.

See also

QAction

actionBreakLayout()

Return type:

QAction

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

Use action() instead.

See also

QAction

actionCopy()

Return type:

QAction

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

Use action() instead.

See also

QAction

actionCut()

Return type:

QAction

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

Use action() instead.

See also

QAction

actionDelete()

Return type:

QAction

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

Use action() instead.

See also

QAction

actionFormLayout()

Return type:

QAction

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

Use action() instead.

See also

QAction

actionGridLayout()

Return type:

QAction

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

Use action() instead.

See also

QAction

abstract actionGroup(actionGroup)

Parameters:

actionGroup – ActionGroup

Return type:

QActionGroup

Returns the action group specified by the enumeration value actionGroup.

actionHorizontalLayout()

Return type:

QAction

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

Use action() instead.

See also

QAction

actionLower()

Return type:

QAction

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

Use action() instead.

See also

QAction

actionPaste()

Return type:

QAction

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

Use action() instead.

See also

QAction

actionRaise()

Return type:

QAction

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

Use action() instead.

See also

QAction

actionRedo()

Return type:

QAction

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

Use action() instead.

See also

QAction

actionSelectAll()

Return type:

QAction

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

Use action() instead.

See also

QAction

actionSimplifyLayout()

Return type:

QAction

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

Use action() instead.

See also

QAction

actionSplitHorizontal()

Return type:

QAction

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

Use action() instead.

See also

QAction

actionSplitVertical()

Return type:

QAction

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

Use action() instead.

See also

QAction

actionUndo()

Return type:

QAction

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

Use action() instead.

See also

QAction

actionVerticalLayout()

Return type:

QAction

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

Use action() instead.

See also

QAction

abstract activeFormWindow()

Return type:

QDesignerFormWindowInterface

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

See also

setActiveFormWindow() removeFormWindow()

activeFormWindowChanged(formWindow)

Parameters:

formWindow – QDesignerFormWindowInterface

This signal is emitted when the contents of the currently active form window in Qt Widgets Designer’s workspace changed. A pointer to the currently active formWindow is passed as an argument.

See also

activeFormWindow()

abstract addFormWindow(formWindow)

Parameters:

formWindow – QDesignerFormWindowInterface

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

See also

formWindowAdded()

abstract closeAllPreviews()

Close all currently open previews.

See also

showPreview()

abstract core()

Return type:

QDesignerFormEditorInterface

Returns a pointer to Qt Widgets Designer’s current QDesignerFormEditorInterface object.

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

Parameters:

• parentWidget – QWidget

• flags – Combination of WindowType

Return type:

QDesignerFormWindowInterface

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

See also

addFormWindow()

abstract createPreviewPixmap()

Return type:

QPixmap

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

abstract dragItems(item_list)

Parameters:

item_list – .list of QDesignerDnDItemInterface

abstract formWindow(index)

Parameters:

index – int

Return type:

QDesignerFormWindowInterface

Returns the form window at the given index.

See also

setActiveFormWindow() removeFormWindow()

formWindowAdded(formWindow)

Parameters:

formWindow – QDesignerFormWindowInterface

This signal is emitted when a new form window is added to the collection of windows that Qt Widgets Designer’s form window manager maintains. A pointer to the new formWindow is passed as an argument.

See also

addFormWindow() setActiveFormWindow()

abstract formWindowCount()

Return type:

int

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

formWindowRemoved(formWindow)

Parameters:

formWindow – QDesignerFormWindowInterface

This signal is emitted when a form window is removed from the collection of windows that Qt Widgets Designer’s form window manager maintains. A pointer to the removed formWindow is passed as an argument.

See also

removeFormWindow()

formWindowSettingsChanged(fw)

Parameters:

fw – QDesignerFormWindowInterface

This signal is emitted when the settings of the form window change. It can be used to update window titles, etc. accordingly. A pointer to the formWindow is passed as an argument.

See also

FormWindowSettingsDialogAction

abstract removeFormWindow(formWindow)

Parameters:

formWindow – QDesignerFormWindowInterface

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

See also

formWindow() formWindowRemoved()

abstract setActiveFormWindow(formWindow)

Parameters:

formWindow – QDesignerFormWindowInterface

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

See also

activeFormWindow() activeFormWindowChanged()

abstract showPluginDialog()

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

abstract showPreview()

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

See also

closeAllPreviews()