PySide6.QtDesigner.QDesignerFormWindowInterface¶

class QDesignerFormWindowInterface¶

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

概要¶

注意

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

详细描述¶

警告

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

QDesignerFormWindowInterface 提供了有关关联表单窗口的信息，并允许更改其属性。该接口不打算直接实例化，而是提供对由Qt Widgets Designer的form window manager控制的当前表单窗口的访问。

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

formWindow = QDesignerFormWindowInterface.findFormWindow(myWidget)

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

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

指向Qt Widgets Designer当前的QDesignerFormEditorInterface对象的指针（在上面的示例中为formEditor）由initialize()函数的参数提供。在实现自定义小部件插件时，您必须子类化QDesignerCustomWidgetInterface类，以将您的插件暴露给Qt Widgets Designer。

一旦你有了表单窗口，你就可以查询它的属性。例如，一个普通的自定义小部件插件仅在顶层由Qt Widgets Designer管理，即它的任何子部件都不能在Qt Widgets Designer的工作区中调整大小。但是QDesignerFormWindowInterface为你提供了函数，使你能够控制一个小部件是否应该由Qt Widgets Designer管理：

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

关于小部件管理的完整函数列表是：isManaged()、manageWidget()和unmanageWidget()。还有几个相关的信号：widgetManaged()、widgetRemoved()、aboutToUnmanageWidget()和widgetUnmanaged()。

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

您还可以使用absoluteDir()检索有关表单存储位置的信息，使用includeHints()检索其包含文件，使用layoutDefault()、layoutFunction()和pixmapFunction()检索其布局和图像函数。您可以使用isDirty()函数确定表单窗口是否已被修改（但未保存）。您可以检索其author()、contents()、fileName()、关联的comment()和exportMacro()、其mainContainer()、其features()、其grid()及其resourceFiles()。

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

另请参阅

QDesignerFormWindowCursorInterface QDesignerFormEditorInterface QDesignerFormWindowManagerInterface

class FeatureFlag¶

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

常量

描述

QDesignerFormWindowInterface.EditFeature

表单编辑

QDesignerFormWindowInterface.GridFeature

用于编辑的网格显示和吸附到网格功能

QDesignerFormWindowInterface.TabOrderFeature

Tab键顺序管理

QDesignerFormWindowInterface.DefaultFeature

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

另请参阅

hasFeature() features()

常量	描述
QDesignerFormWindowInterface.EditFeature	表单编辑
QDesignerFormWindowInterface.GridFeature	用于编辑的网格显示和吸附到网格功能
QDesignerFormWindowInterface.TabOrderFeature	Tab键顺序管理
QDesignerFormWindowInterface.DefaultFeature	支持默认功能（表单编辑和网格）

class ResourceFileSaveMode¶

此枚举描述了资源文件的保存方式。

常量

描述

QDesignerFormWindowInterface.SaveAllResourceFiles

保存所有资源文件。

QDesignerFormWindowInterface.SaveOnlyUsedResourceFiles

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

QDesignerFormWindowInterface.DontSaveResourceFiles

不保存资源文件。

常量	描述
QDesignerFormWindowInterface.SaveAllResourceFiles	保存所有资源文件。
QDesignerFormWindowInterface.SaveOnlyUsedResourceFiles	保存表单使用的资源文件。
QDesignerFormWindowInterface.DontSaveResourceFiles	不保存资源文件。

__init__([parent=None[, flags={}]])¶

Parameters:

parent – QWidget
flags – WindowType 的组合

使用给定的parent和指定的窗口flags构建一个表单窗口界面。

aboutToUnmanageWidget(widget)¶

Parameters:: widget – QWidget

每当表单上的小部件即将变为未管理状态时，就会发出此信号。当发出此信号时，指定的widget仍然处于管理状态，随后会发出widgetUnmanaged()信号，指示它不再被管理。

另请参阅

unmanageWidget() isManaged()

abstract absoluteDir()¶

Return type:: QDir

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

activateResourceFilePaths(paths[, errorCount=None[, errorMessages=None]])¶

Parameters:

paths – 字符串列表
errorCount – int
errorMessages – str

激活资源 (.qrc) 文件路径 paths，返回错误计数 errorCount 和错误消息 errorMessages。Qt Widgets Designer 使用 QResource 类加载资源，使其可用于表单编辑。

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

另请参阅

activeResourceFilePaths() QResource

activated(widget)¶

Parameters:: widget – QWidget

每当表单上的小部件被激活时，都会发出此信号。被激活的小部件由 widget 指定。

activeResourceFilePaths()¶

Return type:: 字符串列表

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

另请参阅

activateResourceFilePaths()

abstract addResourceFile(path)¶

Parameters:: 路径 – 字符串

将给定path处的资源文件添加到表单使用的资源文件中。

另请参阅

resourceFiles() resourceFilesChanged()

abstract author()¶

Return type:: 字符串

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

另请参阅

setAuthor()

abstract beginCommand(description)¶

Parameters:: 描述 – str

changed()¶

每当表单发生变化时，都会发出此信号。

abstract checkContents()¶

Return type:: 字符串列表

对当前表单执行检查，并返回一个关于潜在问题的富文本警告列表（例如，未布局表单上的顶级间隔符）。

IDE 集成可以在处理开始保存操作之前调用此功能。

abstract clearSelection([changePropertyDisplay=true])¶

Parameters:: changePropertyDisplay – 布尔值

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

另请参阅

selectWidget()

abstract commandHistory()¶

Return type:: QUndoStack

abstract comment()¶

Return type:: 字符串

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

另请参阅

setComment()

abstract contents()¶

Return type:: 字符串

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

另请参阅

setContents()

core()¶

Return type:: QDesignerFormEditorInterface

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

abstract currentTool()¶

Return type:: 整数

abstract editWidgets()¶

abstract emitSelectionChanged()¶

发出 selectionChanged() 信号。

另请参阅

selectWidget() clearSelection()

abstract endCommand()¶

abstract ensureUniqueObjectName(object)¶

Parameters:: 对象 – QObject

abstract exportMacro()¶

Return type:: 字符串

返回与当前窗口中显示的表单相关联的导出宏。导出宏在表单编译时用于创建小部件插件。

另请参阅

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

featureChanged(f)¶

Parameters:: f – FeatureFlag 的组合

每当表单中的特性发生变化时，都会发出此信号。新特性由feature指定。

另请参阅

setFeatures()

abstract features()¶

Return type:: FeatureFlag的组合

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

另请参阅

setFeatures() hasFeature()

abstract fileName()¶

Return type:: 字符串

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

另请参阅

setFileName()

fileNameChanged(fileName)¶

Parameters:: fileName – str

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

另请参阅

setFileName()

static findFormWindow(obj)¶

Parameters:: obj – QObject
Return type:: QDesignerFormWindowInterface

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

static findFormWindow(w)

Parameters:: w – QWidget
Return type:: QDesignerFormWindowInterface

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

abstract formContainer()¶

Return type:: QWidget

返回包含主容器小部件的表单小部件。

geometryChanged()¶

每当表单的几何形状发生变化时，都会发出此信号。

abstract grid()¶

Return type:: QPoint

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

另请参阅

setGrid()

abstract hasFeature(f)¶

Parameters:: f – FeatureFlag 的组合
Return type:: 布尔

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

另请参阅

features()

abstract includeHints()¶

Return type:: 字符串列表

返回将包含在表单窗口关联的UI文件中的头文件列表。

头文件可能是本地的，即相对于项目的目录，"mywidget.h"，或者是全局的，即Qt或编译器标准库的一部分：。

另请参阅

setIncludeHints()

abstract isDirty()¶

Return type:: 布尔

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

另请参阅

setDirty()

abstract isManaged(widget)¶

Parameters:: widget – QWidget
Return type:: 布尔

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

另请参阅

manageWidget()

abstract layoutDefault(margin, spacing)¶

Parameters:

margin – int
spacing – int

为表单的默认布局填充默认的边距和间距，这些值在指定的margin和spacing变量中。

另请参阅

setLayoutDefault()

abstract layoutFunction(margin, spacing)¶

Parameters:

margin – str
spacing – str

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

另请参阅

setLayoutFunction()

abstract mainContainer()¶

Return type:: QWidget

mainContainerChanged(mainContainer)¶

Parameters:: mainContainer – QWidget

每当主容器发生变化时，都会发出此信号。新的容器由mainContainer指定。

另请参阅

setMainContainer()

abstract manageWidget(widget)¶

Parameters:: widget – QWidget

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

另请参阅

isManaged() unmanageWidget() widgetManaged()

objectRemoved(o)¶

Parameters:: o – QObject

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

abstract pixmapFunction()¶

Return type:: 字符串

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

另请参阅

setPixmapFunction()

abstract registerTool(tool)¶

Parameters:: 工具 – QDesignerFormWindowToolInterface

abstract removeResourceFile(path)¶

Parameters:: 路径 – 字符串

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

另请参阅

resourceFiles() resourceFilesChanged()

abstract resourceFileSaveMode()¶

Return type:: ResourceFileSaveMode

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

另请参阅

setResourceFileSaveMode()

abstract resourceFiles()¶

Return type:: 字符串列表

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

另请参阅

addResourceFile() removeResourceFile()

resourceFilesChanged()¶

每当表单使用的资源文件列表发生变化时，就会发出此信号。

另请参阅

resourceFiles()

abstract selectWidget(w[, select=true])¶

Parameters:

w – QWidget
select – 布尔值

如果 select 为真，则选择给定的 widget；否则取消选择 widget。

另请参阅

clearSelection() selectionChanged()

selectionChanged()¶

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

另请参阅

selectWidget() clearSelection()

abstract setAuthor(author)¶

Parameters:: 作者 – str

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

另请参阅

author()

abstract setComment(comment)¶

Parameters:: 评论 – str

将表单的信息设置到指定的comment。此信息应该是关于表单的人类可读的注释。

另请参阅

comment()

abstract setContents(contents)¶

Parameters:: 内容 – str
Return type:: 布尔

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

另请参阅

contents()

abstract setContents(dev[, errorMessage=None])

Parameters:

dev – QIODevice
errorMessage – str

Return type:

布尔

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

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

abstract setCurrentTool(index)¶

Parameters:: 索引 – int

abstract setDirty(dirty)¶

Parameters:: dirty – 布尔值

如果 dirty 为 true，则表单窗口被标记为脏，意味着它已被修改但未保存。如果 dirty 为 false，则表单窗口被视为未修改。

另请参阅

isDirty()

abstract setExportMacro(exportMacro)¶

Parameters:: exportMacro – 字符串

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

另请参阅

exportMacro()

abstract setFeatures(f)¶

Parameters:: f – FeatureFlag 的组合

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

另请参阅

features() featureChanged()

abstract setFileName(fileName)¶

Parameters:: fileName – str

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

另请参阅

fileName() fileNameChanged()

abstract setGrid(grid)¶

Parameters:: 网格 – QPoint

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

另请参阅

grid()

abstract setIncludeHints(includeHints)¶

Parameters:: includeHints – 字符串列表

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

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

另请参阅

includeHints()

abstract setLayoutDefault(margin, spacing)¶

Parameters:

margin – int
spacing – int

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

另请参阅

layoutDefault()

abstract setLayoutFunction(margin, spacing)¶

Parameters:

margin – str
spacing – str

设置表单布局的margin和spacing。

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

另请参阅

layoutFunction()

abstract setMainContainer(mainContainer)¶

Parameters:: mainContainer – QWidget

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

另请参阅

mainContainerChanged()

abstract setPixmapFunction(pixmapFunction)¶

Parameters:: pixmapFunction – str

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

另请参阅

pixmapFunction()

abstract setResourceFileSaveMode(behaviour)¶

Parameters:: 行为 – ResourceFileSaveMode

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

另请参阅

resourceFileSaveMode()

abstract simplifySelection(widgets)¶

Parameters:: 小部件 – QList

abstract tool(index)¶

Parameters:: 索引 – int
Return type:: QDesignerFormWindowToolInterface

toolChanged(toolIndex)¶

Parameters:: toolIndex – int

abstract toolCount()¶

Return type:: 整数

abstract unmanageWidget(widget)¶

Parameters:: widget – QWidget

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

另请参阅

aboutToUnmanageWidget() widgetUnmanaged()

widgetManaged(widget)¶

Parameters:: widget – QWidget

每当表单上的小部件被管理时，就会发出此信号。新管理的小部件由 widget 指定。

另请参阅

manageWidget()

widgetRemoved(w)¶

Parameters:: w – QWidget

每当从表单中移除一个小部件时，就会发出此信号。被移除的小部件由widget指定。

widgetUnmanaged(widget)¶

Parameters:: widget – QWidget

每当表单上的小部件变为未管理状态时，就会发出此信号。新释放的小部件由 widget 指定。

另请参阅

unmanageWidget() aboutToUnmanageWidget()

PySide6.QtDesigner.QDesignerFormWindowInterface¶

概要¶

方法¶

虚拟方法¶

插槽¶

信号¶

静态函数¶

详细描述¶