class QDesignerFormWindowInterface#

QDesignerFormWindowInterface 类允许您查询和操作在 Qt Designer 工作区中出现的表单窗口。 更多…

Inheritance diagram of PySide6.QtDesigner.QDesignerFormWindowInterface

摘要#

方法#

虚拟方法#

槽函数#

信号#

静态函数#

备注

此文档可能包含从C++自动翻译成Python的代码片段。我们欢迎对代码片段翻译的贡献。如果您发现翻译问题，也可以通过在https:/bugreports.qt.io/projects/PYSIDE上创建工单来告知我们

详细介绍#

警告

本节包含从C++自动翻译成Python的代码片段，可能包含错误。

QDesignerFormWindowInterface 提供有关相关表窗口的信息，并允许更改其属性。该接口不旨在直接实例化，而是为了提供访问由 Qt Designer 的 表窗口 管理器 控制的当前 Qt Designer 表窗口的权限。

如果您正在寻找包含特定小部件的表窗口，可以使用静态的 findFormWindow() 函数

formWindow = QDesignerFormWindowInterface.findFormWindow(myWidget)

但除此之外，您还可以通过Qt Designer的窗体窗口管理器访问任何当前表单窗口：使用formWindowManager()函数来获取到管理器的接口。一旦您有了这个接口，您可以通过formWindow()函数访问Qt Designer的所有当前表单窗口。例如

*> = QList<QDesignerFormWindowInterface()
    manager = formEditor.formWindowManager()
    for i in range(0, manager.formWindowCount()):
        forms.append(manager.formWindow(i))

Qt Designer当前QDesignerFormEditorInterface对象（如上例中的formEditor所示）的引用由initialize()函数的参数提供。当实现自定义小部件插件时，您必须将QDesignerCustomWidgetInterface类作为子类来暴露您的插件到Qt Designer。

一旦有了表单窗口，您可以查询其属性。例如，一个简单的自定义小部件插件在Qt Designer中只被管理和控制在其顶层，也就是说，在Qt Designer的工作空间中，其子小部件都没有可伸缩性。但是QDesignerFormWindowInterface提供了允许您控制小部件是否被Qt Designer管理或不被管理的函数。

if formWindow.isManaged(myWidget):
    formWindow.manageWidget(myWidget.childWidget)

有关小部件管理的函数的完整列表有：isManaged()，manageWidget()，和unmanageWidget()。还有一些相关的信号：widgetManaged()，widgetRemoved()，aboutToUnmanageWidget()，以及widgetUnmanaged()。

除了控制小部件的管理外，您还可以使用selectWidget()、clearSelection()和emitSelectionChanged()函数以及selectionChanged()信号来控制表单窗口中的当前选择，以及使用selectWidget()、clearSelection()和emitSelectionChanged()功能。

您还可以使用absoluteDir()来检索表单存储的位置，使用includeHints()来获取它的包含文件，并使用layoutDefault()、layoutFunction()和pixmapFunction()来获取其布局和 pixmap 函数。您可以使用isDirty()函数来找出表单窗口是否已修改（但尚未保存）。您还可以检索其作者、内容、文件名、相关评论和宏，以及与其相关的主容器、功能、网格和资源文件。

该接口还为您提供了允许您更改大多数此类信息的函数和槽。唯一的例外是存储表单窗口的目录。最后，还有几个与上述信息更改以及表单窗口整体更改相关的信号。

class FeatureFlag#

(继承自 enum.Flag) 此枚举描述了可以通过表单窗口接口控制的功能。这些值在查询表单窗口以确定其支持哪些功能时使用。

常量

描述

QDesignerFormWindowInterface.EditFeature

表单编辑

QDesignerFormWindowInterface.GridFeature

编辑时的网格显示和网格吸附功能

QDesignerFormWindowInterface.TabOrderFeature

制表位顺序管理

QDesignerFormWindowInterface.DefaultFeature

支持默认功能（表单编辑和网格）

另请参阅

hasFeature() features()

class ResourceFileSaveMode#

此枚举描述了资源文件如何保存。

常量

描述

QDesignerFormWindowInterface.SaveAllResourceFiles

保存所有资源文件。

QDesignerFormWindowInterface.SaveOnlyUsedResourceFiles

仅保存表单使用的资源文件。

QDesignerFormWindowInterface.DontSaveResourceFiles

不保存资源文件。
__init__([parent=None[, flags={}]])#
参数：

使用给定的 parent 和指定的窗口 flags 构造一个表单窗口接口。

aboutToUnmanageWidget(widget)#
参数：

widget – QWidget

每当表单上的小部件即将成为非托管状态时，都会发出此信号。当发出此信号时，指定的 widget 仍然是托管状态，之后将跟随一个 widgetUnmanaged() 信号，表示它不再处于托管状态。

abstract absoluteDir()#
返回类型：

QDir

返回表单窗口中显示的表单所包含目录的绝对位置。

activateResourceFilePaths(paths[, errorCount=None[, errorMessages=None]])#
参数：

  • paths – 字符串列表

  • errorCount – int

  • errorMessages – str

激活资源（.qrc）文件路径 paths，返回 errorCount 中的错误计数和 errorMessages 中的错误消息。 Qt Designer 使用 QResource 类加载数据，以便在表单编辑中可用。

在 IDE 集成中，可以激活项目资源（.qrc）文件列表，使它们可用于 Qt Designer。

activated(widget)#
参数：

widget – QWidget

每次在表单上激活小部件时都会发出此信号。激活的小部件通过 widget 指定。

activeResourceFilePaths()#
返回类型：

字符串列表

返回在 Qt Designer 中当前加载的活动资源（.qrc）文件路径。

abstract addResourceFile(path)#
参数：

path – str

将指定路径 path 的资源文件添加到由表单使用的文件中。

抽象author()#
返回类型：

str

返回当前在窗口中显示的表单的作者或创建者的详细信息。

另请参阅

setAuthor()

抽象beginCommand(description)#
参数：

description - str

changed()#

每次表单发生变化时都会触发此信号。

抽象checkContents()#
返回类型：

字符串列表

对当前表单进行检查，并返回有关潜在问题的richtext警告列表（例如，尚未布局的表单上的顶级间隔）。

IDE集成可以在处理保存操作之前调用此方法。

抽象clearSelection([changePropertyDisplay=true])#
参数：

changePropertyDisplay - bool

清除表单窗口中的当前选择。如果 update 为 true，则调用 emitSelectionChanged() 函数，触发 selectionChanged() 信号。

另请参阅

selectWidget()

抽象commandHistory()#
返回类型：

QUndoStack

抽象comment()#
返回类型：

str

返回当前在窗口中显示的表单的评论信息。

另请参阅

setComment()

抽象contents()#
返回类型：

str

返回当前在窗口中显示的表单内容的详细信息。

另请参阅

setContents()

core()#
返回类型：

QDesignerFormEditorInterface

返回指向当前 Qt Designer 的 QDesignerFormEditorInterface 对象的指针。

抽象的currentTool()#
返回类型：

整型

抽象的editWidgets()#
抽象的emitSelectionChanged()#

触发 selectionChanged() 信号。

抽象的endCommand()#
抽象的ensureUniqueObjectName(object)#
参数：

对象 – QObject

抽象的exportMacro()#
返回类型：

str

返回窗口当前显示的表单的导出宏。当表单编译生成小部件插件时使用此导出宏。

另请参阅

setExportMacro() 为 Qt Designer 创建自定义小部件

featureChanged(f)#
参数：

f – FeatureFlag 组合

当表单中的某个特性发生更改时发送此信号。新的特性通过 feature 指定。

另请参阅

setFeatures()

抽象的features()#
返回类型：

FeatureFlag 组合

返回与界面关联表单窗口提供的功能组合。返回的值可以与Feature枚举值进行比较，以确定窗口支持哪些功能。

abstract fileName()#
返回类型：

str

返回当前显示的表单所描述UI文件的文件名。

另请参阅

setFileName()

fileNameChanged(fileName)#
参数：

fileName – str

每当表单的文件名更改时，就会发出此信号。新文件名由fileName指定。

另请参阅

setFileName()

static findFormWindow(obj)#
参数：

obj – QObject

返回类型：

QDesignerFormWindowInterface

返回给定object的表单窗口界面。

static findFormWindow(w)
参数：

w – QWidget

返回类型：

QDesignerFormWindowInterface

返回给定widget的表单窗口界面。

abstract formContainer()#
返回类型：

QWidget

返回包含主要容器窗口的窗口的表单。

geometryChanged()#

每当表单的几何形状更改时，都会发出此信号。

abstract grid()#
返回类型：

QPoint

返回表单窗口使用的格子间距。

另请参阅

setGrid()

abstract hasFeature(f)#
参数：

f – FeatureFlag 组合

返回类型：

bool

如果表单窗口提供了指定的feature，则返回true；否则返回false。

另请参阅

features()

抽象 includeHints()#
返回类型：

字符串列表

返回一个列表，其中包含将包含在表单窗口相关 UI 文件中的头文件。

头文件可以是本地的，例如相对于项目的目录的 "mywidget.h"，也可以是全局的，例如 Qt 或编译器标准库的一部分：<QtGui/QWidget>。

另请参阅

setIncludeHints()

抽象 isDirty()#
返回类型：

bool

如果表单窗口是“未保存的”（已修改但未保存），则返回 true；否则返回 false。

另请参阅

setDirty()

抽象 isManaged(widget)#
参数：

widget – QWidget

返回类型：

bool

如果指定的 widget 由表单窗口管理，则返回 true；否则返回 false。

另请参阅

manageWidget()

抽象 layoutDefault(margin, spacing)#
参数：

  • margin – int

  • spacing – int

将表单默认布局的默认边距和间距填充到指定的 margin 和 spacing 变量中。

另请参阅

setLayoutDefault()

抽象 layoutFunction(margin, spacing)#
参数：

  • margin – str

  • spacing – str

将表单布局的当前边距和间距填充到指定的 margin 和 spacing 变量中。

另请参阅

setLayoutFunction()

抽象 mainContainer()#
返回类型：

QWidget

mainContainerChanged(mainContainer)#
参数：

mainContainer – QWidget

每当主要容器更改时，都会发出此信号。新容器由 mainContainer 指定。

另请参阅

setMainContainer()

抽象 manageWidget(widget)#
参数：

widget – QWidget

指示表单窗口管理指定的 widget。

objectRemoved(o)#
参数：

o – QObject

每当从表单中移除一个对象（例如动作或QButtonGroup）时，都会发出此信号。通过object指定已移除的对象。

abstract pixmapFunction()#
返回类型：

str

返回用于将位图加载到表单窗口中的函数名称。

另请参阅

setPixmapFunction()

abstract registerTool(tool)#
参数：

tool – QDesignerFormWindowToolInterface

abstract removeResourceFile(path)#
参数：

path – str

从表单使用的列表中移除指定path的资源文件。

abstract resourceFileSaveMode()#
返回类型：

ResourceFileSaveMode

返回资源文件保存模式的行为。

abstract resourceFiles()#
返回类型：

字符串列表

返回表单窗口当前正在使用的资源文件路径列表。

resourceFilesChanged()#

当表单使用的资源文件列表更改时，会发出此信号。

另请参阅

resourceFiles()

摘要selectWidget(w[, select=True])<#
参数：

如果 select 为真，则会选择指定的 widget；否则该 widget 将被取消选择。

selectionChanged()<#

每当表单中的选择发生变化时，都会发射此信号。

摘要setAuthor(author)<#
参数：

author – str

将表单的作者或创建者的详细信息设置为指定的 author。

另请参阅

author()

摘要setComment(comment)<#
参数：

comment – str

将表单的信息设置为指定的 comment。此信息应该是对表单的人读评论。

另请参阅

comment()

摘要setContents(dev[, errorMessage=None])<#
参数：
返回类型：

bool

使用从提供的 device 获取的数据设置表单内容，并返回是否加载成功。如果失败，错误消息将返回在 errorMessage 中。

可以从 QFile 对象或任何其他 QIODevice 子类中读取数据。

另请参阅

contents()

摘要setContents(contents)
参数：

contents – str

返回类型：

bool

使用从指定的 contents 字符串读取的数据设置表单内容，并返回操作是否成功。

另请参阅

contents()

抽象 setCurrentTool(index)#
参数：

index – int

抽象 setDirty(dirty)#
参数：

dirty – bool

如果 dirty 为 true，则表单窗口将标记为“脏”，表示它已修改但尚未保存。如果 dirty 为 false，则表单窗口被视为未修改。

另请参阅

isDirty()

抽象 setExportMacro(exportMacro)#
参数：

exportMacro – str

将表单窗口的导出宏设置为 exportMacro。该宏在构建小部件插件以将表单界面导出到其他组件时使用。

另请参阅

exportMacro()

抽象 setFeatures(f)#
参数：

f – FeatureFlag 组合

为表单窗口启用指定的 features。

抽象 setFileName(fileName)#
参数：

fileName – str

将表单的文件名设置为给定的 fileName。

抽象 setGrid(grid)#
参数：

grid – QPoint

将表单窗口的网格大小设置为由 grid 指定的一点。在此函数中，QPoint 中的坐标用于指定网格中矩形的尺寸。

另请参阅

grid()

（抽象） setIncludeHints(includeHints)#
参数：

includeHints – 字符串列表

将表单窗口相关联的 UI 文件中将包含的头文件设置为指定的 includeHints。

头文件可以是本地的，例如相对于项目的目录的 "mywidget.h"，也可以是全局的，例如 Qt 或编译器标准库的一部分：<QtGui/QWidget>。

另请参阅

includeHints()

（抽象） setLayoutDefault(margin, spacing)#
参数：

  • margin – int

  • spacing – int

设置表单布局的默认 margin 和 spacing。

另请参阅

layoutDefault()

（抽象） setLayoutFunction(margin, spacing)#
参数：

  • margin – str

  • spacing – str

设置表单布局的 margin 和 spacing。

当 uic 为表单生成代码时，默认布局属性将被相应的布局函数替换，即如果指定了函数。这在不同环境需要为同一表单不同布局时非常有用。

另请参阅

layoutFunction()

（抽象） setMainContainer(mainContainer)#
参数：

mainContainer – QWidget

将表单上的主要容器小部件设置为指定的 mainContainer。

另请参阅

mainContainerChanged()

（抽象） setPixmapFunction(pixmapFunction)#
参数：

pixmapFunction – 字符串

将用于将位图加载到表单窗口的函数设置为给定的 pixmapFunction。

另请参阅

pixmapFunction()

（抽象） setResourceFileSaveMode(behaviour)#
参数：

behaviour – ResourceFileSaveMode

设置资源文件保存模式 behavior。

另请参阅

resourceFileSaveMode()

（抽象） simplifySelection(widgets)#
参数：

widgets – QList

（抽象） tool(index)#
参数：

index – int

返回类型：

QDesignerFormWindowToolInterface

toolChanged(toolIndex)#
参数：

toolIndex – int

抽象 toolCount()#
返回类型：

整型

抽象 unmanageWidget(widget)#
参数：

widget – QWidget

指导表单窗口不管理指定的 widget。

widgetManaged(widget)#
参数：

widget – QWidget

每当表单上的控件成为受管理状态时，此信号将被发射。新受管理的控件通过 widget 指定。

另请参阅

manageWidget()

widgetRemoved(w)#
参数：

w – QWidget

当控件从表单中移除时，此信号将被发射。被移除的控件通过 widget 指定。

widgetUnmanaged(widget)#
参数：

widget – QWidget

每当表单上的控件变为不受管理状态时，此信号将被发射。新释放的控件通过 widget 指定。