QDesignerFormWindowInterface¶

PyQt5.QtDesigner.QDesignerFormWindowInterface: Inherits from QWidget.

Description¶

The QDesignerFormWindowInterface class allows you to query and manipulate form windows appearing in Qt Designer’s workspace.

QDesignerFormWindowInterface provides information about the associated form window as well as allowing its properties to be altered. The interface is not intended to be instantiated directly, but to provide access to Qt Designer’s current form windows controlled by Qt Designer’s QDesignerFormWindowManagerInterface.

If you are looking for the form window containing a specific widget, you can use the static findFormWindow() function:

#     QDesignerFormWindowInterface *formWindow;
#     formWindow = QDesignerFormWindowInterface::findFormWindow(myWidget);

But in addition, you can access any of the current form windows through Qt Designer’s form window manager: Use the formWindowManager() function to retrieve an interface to the manager. Once you have this interface, you have access to all of Qt Designer’s current form windows through the formWindow() function. For example:

#     QList<QDesignerFormWindowInterface *> forms;
#     QDesignerFormWindowInterface *formWindow;

#     QDesignerFormWindowManagerInterface *manager = formEditor->formWindowManager();

#     for (int i = 0; i < manager->formWindowCount(); i++) {
#         formWindow = manager->formWindow(i);
#         forms.append(formWindow);
#     }

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

Once you have the form window, you can query its properties. For example, a plain custom widget plugin is managed by Qt Designer only at its top level, i.e. none of its child widgets can be resized in Qt Designer’s workspace. But QDesignerFormWindowInterface provides you with functions that enables you to control whether a widget should be managed by Qt Designer, or not:

#         if (formWindow->isManaged(myWidget))
#             formWindow->manageWidget(myWidget->childWidget);

The complete list of functions concerning widget management is: isManaged(), manageWidget() and unmanageWidget(). There is also several associated signals: widgetManaged, widgetRemoved, aboutToUnmanageWidget and widgetUnmanaged.

In addition to controlling the management of widgets, you can control the current selection in the form window using the selectWidget(), clearSelection() and emitSelectionChanged() functions, and the selectionChanged signal.

You can also retrieve information about where the form is stored using absoluteDir(), its include files using includeHints(), and its layout and pixmap functions using layoutDefault(), layoutFunction() and pixmapFunction(). You can find out whether the form window has been modified (but not saved) or not, using the isDirty() function. You can retrieve its author(), its contents(), its fileName(), associated comment() and exportMacro(), its mainContainer(), its features(), its grid() and its resourceFiles().

The interface provides you with functions and slots allowing you to alter most of this information as well. The exception is the directory storing the form window. Finally, there is several signals associated with changes to the information mentioned above and to the form window in general.

Classes¶

Feature

Enums¶

FeatureFlag

This enum describes the features that are available and can be controlled by the form window interface. These values are used when querying the form window to determine which features it supports:

Methods¶

__init__(parent: QWidget = None, flags: Union[WindowFlags, WindowType] = 0): Constructs a form window interface with the given parent and the specified window flags.

absoluteDir() → QDir: TODO

activateResourceFilePaths(Iterable[str]) → (int, str): TODO

activeResourceFilePaths() → List[str]: TODO

addResourceFile(str): TODO

author() → str: TODO

checkContents() → List[str]: TODO

clearSelection(update: bool = True): TODO

comment() → str: TODO

contents() → str: TODO

core() → QDesignerFormEditorInterface: Returns a pointer to Qt Designer’s current QDesignerFormEditorInterface object.

cursor() → QDesignerFormWindowCursorInterface: TODO

emitSelectionChanged(): TODO

exportMacro() → str: TODO

features() → Feature: TODO

fileName() → str: TODO

@staticmethod findFormWindow(QWidget) → QDesignerFormWindowInterface: TODO

@staticmethod findFormWindow(QObject) → QDesignerFormWindowInterface: TODO

formContainer() → QWidget: TODO

grid() → QPoint: TODO

hasFeature(Union[Feature, FeatureFlag]) → bool: TODO

includeHints() → List[str]: TODO

isDirty() → bool: TODO

isManaged(QWidget) → bool: TODO

layoutDefault() → (int, int): TODO

layoutFunction() → (str, str): TODO

mainContainer() → QWidget: TODO

manageWidget(QWidget): TODO

pixmapFunction() → str: TODO

removeResourceFile(str): TODO

resourceFiles() → List[str]: TODO

selectWidget(QWidget, select: bool = True): TODO

setAuthor(str): TODO

setComment(str): TODO

setContents(str) → bool: TODO

setContents(QIODevice, errorMessage: str = '') → bool: TODO

setDirty(bool): TODO

setExportMacro(str): TODO

setFeatures(Union[Feature, FeatureFlag]): TODO

setFileName(str): TODO

setGrid(QPoint): TODO

setIncludeHints(Iterable[str]): TODO

setLayoutDefault(int, int): TODO

setLayoutFunction(str, str): TODO

setMainContainer(QWidget): TODO

setPixmapFunction(str): TODO

unmanageWidget(QWidget): TODO

Signals¶

aboutToUnmanageWidget(QWidget): TODO

activated(QWidget): TODO

changed(): TODO

featureChanged(Union[Feature, FeatureFlag]): TODO

fileNameChanged(str): TODO

geometryChanged(): TODO

mainContainerChanged(QWidget): TODO

objectRemoved(QObject): TODO

resourceFilesChanged(): TODO

selectionChanged(): TODO

widgetManaged(QWidget): TODO

widgetRemoved(QWidget): TODO

widgetUnmanaged(QWidget): TODO

Member	Value	Description
DefaultFeature	EditFeature \| GridFeature	Support for default features (form editing and grid)
EditFeature	0x01	Form editing
GridFeature	0x02	Grid display and snap-to-grid facilities for editing
TabOrderFeature	0x04	Tab order management