QUiLoader ¶

概要 ¶

详细描述 ¶

In addition, you can customize or create your own user interface by deriving your own loader class.

If you have a custom component or an application that embeds Qt Designer , you can also use the QFormBuilder class provided by the QtDesigner module to create user interfaces from UI files.

QUiLoader class provides a collection of functions allowing you to create widgets based on the information stored in UI files (created with Qt Designer ) or available in the specified plugin paths. The specified plugin paths can be retrieved using the pluginPaths() function. Similarly, the contents of a UI file can be retrieved using the load() function. For example:

MyWidget::MyWidget(QWidget *parent)
    : QWidget(parent)
{
    QUiLoader loader;
    QFile file(":/forms/myform.ui");
    file.open(QFile::ReadOnly);
    QWidget *myWidget = loader.load(&file, this);
    file.close();
    QVBoxLayout *layout = new QVBoxLayout;
    layout->addWidget(myWidget);
    setLayout(layout);
}
											

availableWidgets() function returns a QStringList with the class names of the widgets available in the specified plugin paths. To create these widgets, simply use the createWidget() function. For example:

QWidget *loadCustomWidget(QWidget *parent)
{
    QUiLoader loader;
    QWidget *myWidget;
    QStringList availableWidgets = loader.availableWidgets();
    if (availableWidgets.contains("AnalogClock"))
        myWidget = loader.createWidget("AnalogClock", parent);
    return myWidget;
}
											

To make a custom widget available to the loader, you can use the addPluginPath() function; to remove all available widgets, you can call the clearPluginPaths() 函数。

createAction() , createActionGroup() , createLayout() ，和 createWidget() functions are used internally by the QUiLoader class whenever it has to create an action, action group, layout, or widget respectively. For that reason, you can subclass the QUiLoader class and reimplement these functions to intervene the process of constructing a user interface. For example, you might want to have a list of the actions created when loading a form or creating a custom widget.

For a complete example using the QUiLoader class, see the Calculator Builder Example.

另请参阅

Qt UI Tools QFormBuilder

class QUiLoader ( [ parent=None ] ) ¶

param parent

QObject

Creates a form loader with the given parent .

PySide2.QtUiTools.QUiLoader. addPluginPath ( path ) ¶

参数

path – unicode

添加给定 path to the list of paths in which the loader will search when locating plugins.

另请参阅

pluginPaths() clearPluginPaths()

PySide2.QtUiTools.QUiLoader. availableLayouts ( ) ¶

返回类型

字符串列表

Returns a list naming all available layouts that can be built using the createLayout() function

另请参阅

createLayout()

PySide2.QtUiTools.QUiLoader. availableWidgets ( ) ¶

返回类型

字符串列表

Returns a list naming all available widgets that can be built using the createWidget() function, i.e all the widgets specified within the given plugin paths.

另请参阅

pluginPaths() createWidget()

PySide2.QtUiTools.QUiLoader. clearPluginPaths ( ) ¶

Clears the list of paths in which the loader will search when locating plugins.

另请参阅

addPluginPath() pluginPaths()

PySide2.QtUiTools.QUiLoader. createAction ( [ parent=None [ , name="" ] ] ) ¶

参数

• parent – QObject

• name – unicode

返回类型

QAction

创建新的动作采用给定 parent and name .

The function is also used internally by the QUiLoader class whenever it creates a widget. Hence, you can subclass QUiLoader and reimplement this function to intervene process of constructing a user interface or widget. However, in your implementation, ensure that you call QUiLoader ‘s version first.

另请参阅

createActionGroup() createWidget() load()

PySide2.QtUiTools.QUiLoader. createActionGroup ( [ parent=None [ , name="" ] ] ) ¶

参数

• parent – QObject

• name – unicode

返回类型

QActionGroup

Creates a new action group with the given parent and name .

The function is also used internally by the QUiLoader class whenever it creates a widget. Hence, you can subclass QUiLoader and reimplement this function to intervene process of constructing a user interface or widget. However, in your implementation, ensure that you call QUiLoader ‘s version first.

另请参阅

createAction() createWidget() load()

PySide2.QtUiTools.QUiLoader. createLayout ( className [ , parent=None [ , name="" ] ] ) ¶

参数

• className – unicode

• parent – QObject

• name – unicode

返回类型

QLayout

Creates a new layout with the given parent and name using the class specified by className .

The function is also used internally by the QUiLoader class whenever it creates a widget. Hence, you can subclass QUiLoader and reimplement this function to intervene process of constructing a user interface or widget. However, in your implementation, ensure that you call QUiLoader ‘s version first.

另请参阅

createWidget() load()

PySide2.QtUiTools.QUiLoader. createWidget ( className [ , parent=None [ , name="" ] ] ) ¶

参数

• className – unicode

• parent – QWidget

• name – unicode

返回类型

QWidget

Creates a new widget with the given parent and name using the class specified by className . You can use this function to create any of the widgets returned by the availableWidgets() 函数。

The function is also used internally by the QUiLoader class whenever it creates a widget. Hence, you can subclass QUiLoader and reimplement this function to intervene process of constructing a user interface or widget. However, in your implementation, ensure that you call QUiLoader ‘s version first.

另请参阅

availableWidgets() load()

PySide2.QtUiTools.QUiLoader. errorString ( ) ¶

返回类型

unicode

Returns a human-readable description of the last error occurred in load() .

另请参阅

load()

PySide2.QtUiTools.QUiLoader. isLanguageChangeEnabled ( ) ¶

返回类型

bool

Returns true if dynamic retranslation on language change is enabled; returns false otherwise.

另请参阅

setLanguageChangeEnabled()

PySide2.QtUiTools.QUiLoader. isTranslationEnabled ( ) ¶

返回类型

bool

Returns true if translation is enabled; returns false otherwise.

另请参阅

setTranslationEnabled()

PySide2.QtUiTools.QUiLoader. load ( device [ , parentWidget=None ] ) ¶

参数

• device – QIODevice

• parentWidget – QWidget

返回类型

QWidget

Loads a form from the given device and creates a new widget with the given parentWidget to hold its contents.

另请参阅

createWidget() errorString()

PySide2.QtUiTools.QUiLoader. load ( arg__1 [ , parentWidget=None ] ) ¶

参数

• arg__1 – unicode

• parentWidget – QWidget

返回类型

QWidget

PySide2.QtUiTools.QUiLoader. pluginPaths ( ) ¶

返回类型

字符串列表

Returns a list naming the paths in which the loader will search when locating custom widget plugins.

另请参阅

addPluginPath() clearPluginPaths()

PySide2.QtUiTools.QUiLoader. registerCustomWidget ( customWidgetType ) ¶

参数

customWidgetType – PyObject

Registers a Python created custom widget to QUiLoader, so it can be recognized when

loading a .ui file. The custom widget type is passed via the customWidgetType argument. This is needed when you want to override a virtual method of some widget in the interface, since duck punching will not work with widgets created by QUiLoader based on the contents of the .ui 文件。

(Remember that duck punching virtual methods is an invitation for your own demise! )

Let’s see an obvious example. If you want to create a new widget it’s probable you’ll end up overriding QWidget ’s paintEvent() 方法。

class Circle(QWidget):
    def paintEvent(self, event):
        painter = QPainter(self)
        painter.setPen(self.pen)
        painter.setBrush(QBrush(self.color))
        painter.drawEllipse(event.rect().center(), 20, 20)
# ...
loader = QUiLoader()
loader.registerCustomWidget(Circle)
circle = loader.load('circle.ui')
circle.show()
# ...
													

PySide2.QtUiTools.QUiLoader. setLanguageChangeEnabled ( enabled ) ¶

参数

enabled – bool

若 enabled is true, user interfaces loaded by this loader will automatically retranslate themselves upon receiving a language change event. Otherwise, the user interfaces will not be retranslated.

另请参阅

isLanguageChangeEnabled()

PySide2.QtUiTools.QUiLoader. setTranslationEnabled ( enabled ) ¶

参数

enabled – bool

若 enabled is true, user interfaces loaded by this loader will be translated. Otherwise, the user interfaces will not be translated.

注意

This is orthogonal to languageChangeEnabled.

另请参阅

isLanguageChangeEnabled() setLanguageChangeEnabled()

PySide2.QtUiTools.QUiLoader. setWorkingDirectory ( dir ) ¶

参数

dir – QDir

Sets the working directory of the loader to dir . The loader will look for other resources, such as icons and resource files, in paths relative to this directory.

另请参阅

workingDirectory()

PySide2.QtUiTools.QUiLoader. workingDirectory ( ) ¶

返回类型

QDir

Returns the working directory of the loader.

另请参阅

setWorkingDirectory()