PySide6.QtDesigner.QDesignerWidgetBoxInterface¶

class QDesignerWidgetBoxInterface¶

The QDesignerWidgetBoxInterface class allows you to control the contents of Qt Widgets Designer’s widget box. More…

Synopsis¶

Methods¶

def __init__()
def findOrInsertCategory()

Virtual methods¶

def addCategory()
def addWidget()
def category()
def categoryCount()
def dropWidgets()
def fileName()
def load()
def removeCategory()
def removeWidget()
def save()
def setFileName()
def widget()
def widgetCount()

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.

QDesignerWidgetBoxInterface contains a collection of functions that is typically used to manipulate the contents of Qt Widgets Designer’s widget box.

Qt Widgets Designer uses an XML file to populate its widget box. The name of that file is one of the widget box’s properties, and you can retrieve it using the fileName() function.

QDesignerWidgetBoxInterface also provides the save() function that saves the contents of the widget box in the file specified by the widget box’s file name property. If you have made changes to the widget box, for example by dropping a widget into the widget box, without calling the save() function, the original content can be restored by a simple invocation of the load() function:

widgetBox = formEditor.widgetBox()
widgetBox.load()

The QDesignerWidgetBoxInterface class is not intended to be instantiated directly. You can retrieve an interface to Qt Designer’s widget box using the widgetBox() function. A pointer to Qt Widgets Designer’s current QDesignerFormEditorInterface object (formEditor in the example above) is provided by the initialize() function’s parameter. When implementing a custom widget plugin, you must subclass the QDesignerCustomWidgetInterface to expose your plugin to Qt Widgets Designer.

If you want to save your changes, and at the same time preserve the original contents, you can use the save() function combined with the setFileName() function to save your changes into another file. Remember to store the name of the original file first:

originalFile = widgetBox.fileName()
widgetBox.setFileName("myWidgetBox.xml")
widgetBox.save()

Then you can restore the original contents of the widget box by resetting the file name to the original file and calling load() :

widgetBox.setFileName(originalFile)
widgetBox.load()

In a similar way, you can later use your customized XML file:

if widgetBox.filename() != "myWidgetBox.xml":
    widgetBox.setFileName("myWidgetBox.xml")
    widgetBox.load()