QQmlFileSelector¶
A class for applying a
QFileSelector
to QML file loading. More…
Synopsis¶
Functions¶
def
selector
()def
setExtraSelectors
(strings)def
setExtraSelectors
(strings)def
setSelector
(selector)
Static functions¶
def
get
(arg__1)
Detailed Description¶
QQmlFileSelector
will automatically apply aQFileSelector
to qml file and asset paths.It is used as follows:
QQmlEngine engine; QQmlFileSelector* selector = new QQmlFileSelector(&engine);Then you can swap out files like so:
main.qml Component.qml asset.png +unix/Component.qml +mac/asset.pngIn this example, main.qml will normally use Component.qml for the Component type. However on a unix platform, the unix selector will be present and the +unix/Component.qml version will be used instead. Note that this acts like swapping out Component.qml with +unix/Component.qml, so when using Component.qml you should not need to alter any paths based on which version was selected.
For example, to pass the “asset.png” file path around you would refer to it just as “asset.png” in all of main.qml, Component.qml, and +linux/Component.qml. It will be replaced with +mac/asset.png on Mac platforms in all cases.
For a list of available selectors, see
QFileSelector
.Your platform may also provide additional selectors for you to use. As specified by
QFileSelector
, directories used for selection must start with a ‘+’ character, so you will not accidentally trigger this feature unless you have directories with such names inside your project.If a new
QQmlFileSelector
is set on the engine, the old one will be replaced. Useget()
to query or use the existing instance.
- class PySide2.QtQml.QQmlFileSelector(engine[, parent=None])¶
- param parent:
- param engine:
Creates a new
QQmlFileSelector
with parent objectparent
, which includes its ownQFileSelector
.engine
is theQQmlEngine
you wish to apply file selectors to. It will also take ownership of theQQmlFileSelector
.
- static PySide2.QtQml.QQmlFileSelector.get(arg__1)¶
- Parameters:
arg__1 –
PySide2.QtQml.QQmlEngine
- Return type:
Gets the
QQmlFileSelector
currently active on the targetengine
.
- PySide2.QtQml.QQmlFileSelector.selector()¶
- Return type:
Returns the
QFileSelector
instance used by theQQmlFileSelector
.See also
- PySide2.QtQml.QQmlFileSelector.setExtraSelectors(strings)¶
- Parameters:
strings – list of strings
- PySide2.QtQml.QQmlFileSelector.setExtraSelectors(strings)
- Parameters:
strings – list of strings
- PySide2.QtQml.QQmlFileSelector.setSelector(selector)¶
- Parameters:
selector –
PySide2.QtCore.QFileSelector
Sets the
QFileSelector
instance for use by theQQmlFileSelector
toselector
.QQmlFileSelector
does not take ownership of the newQFileSelector
. To resetQQmlFileSelector
to use its internalQFileSelector
instance, call (None
).See also
© 2022 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.