QPlaceIcon¶
The
QPlaceIcon
class represents an icon. More…
Synopsis¶
Functions¶
def
__eq__
(other)def
__ne__
(other)def
isEmpty
()def
manager
()def
parameters
()def
setManager
(manager)def
setParameters
(parameters)def
url
([size=QSize()])
Detailed Description¶
The typical usage of an icon is to use the
url()
function to specify a preferred icon size.QUrl iconSourceUrl = place.icon().url(QSize(32,32)); //A default icon may also be requested like so iconSourceUrl = place.icon().url();The icons are typically backend dependent, if a manager backend does not support a given size, the URL of the icon that most closely matches those parameters is returned.
The icon class also has a key-value set of parameters. The precise key one needs to use depends on the plugin being used. These parameters influence which icon URL is returned by the manager and may also be used to specify icon URL locations when saving icons.
If there is only ever one image for an icon, then QPlaceIcon::SingleUrl can be used as a parameter key with a
QUrl
as the associated value. If this key is set, then theurl()
function will always return the specified URL and not defer to any manager.
- class PySide2.QtLocation.QPlaceIcon¶
PySide2.QtLocation.QPlaceIcon(other)
- param other:
Constructs an icon.
Constructs a copy of
other
.
- PySide2.QtLocation.QPlaceIcon.SingleUrl¶
- PySide2.QtLocation.QPlaceIcon.isEmpty()¶
- Return type:
bool
Returns a boolean indicating whether the all the fields of the icon are empty or not.
- PySide2.QtLocation.QPlaceIcon.manager()¶
- Return type:
Returns the manager that this icon is associated with.
See also
- PySide2.QtLocation.QPlaceIcon.__ne__(other)¶
- Parameters:
other –
PySide2.QtLocation.QPlaceIcon
- Return type:
bool
Returns true if
other
is not equal to this icon, otherwise returns false.
- PySide2.QtLocation.QPlaceIcon.__eq__(other)¶
- Parameters:
other –
PySide2.QtLocation.QPlaceIcon
- Return type:
bool
Returns true if this icon is equal to
other
, otherwise returns false.
- PySide2.QtLocation.QPlaceIcon.parameters()¶
- Return type:
Returns a set of parameters for the icon that are manager/plugin specific. These parameters are used by the manager to return the appropriate URL when
url()
is called and to specify locations to save to when saving icons.Consult the plugin documentation for what parameters are supported and how they should be used.
See also
- PySide2.QtLocation.QPlaceIcon.setManager(manager)¶
- Parameters:
manager –
PySide2.QtLocation.QPlaceManager
Sets the
manager
that this icon is associated with. The icon does not take ownership of the pointer.See also
- PySide2.QtLocation.QPlaceIcon.setParameters(parameters)¶
- Parameters:
parameters –
Sets the parameters of the icon to
parameters
.See also
- PySide2.QtLocation.QPlaceIcon.url([size=QSize()])¶
- Parameters:
size –
PySide2.QtCore.QSize
- Return type:
Returns an icon URL according to the given
size
.If no manager has been assigned to the icon, and the parameters do not contain the QPlaceIcon::SingleUrl key, a default constructed
QUrl
is returned.
© 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.