Back to Qt.io
Contact Us Blog Download Qt

QPlaceIcon Class

The QPlaceIcon class represents an icon. More...

Header: #include <QPlaceIcon>
qmake: QT += location

Public Functions

QPlaceIcon()
QPlaceIcon(const QPlaceIcon &other)
~QPlaceIcon()
bool isEmpty() const
QPlaceManager *manager() const
QVariantMap parameters() const
void setManager(QPlaceManager *manager)
void setParameters(const QVariantMap &parameters)
QUrl url(const QSize &size = QSize()) const
QPlaceIcon &operator=(const QPlaceIcon &other)

Static Public Members

const QString SingleUrl
bool operator!=(const QPlaceIcon &lhs, const QPlaceIcon &rhs)
bool operator==(const QPlaceIcon &lhs, const QPlaceIcon &rhs)

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 the url() function will always return the specified URL and not defer to any manager.

Member Function Documentation

QPlaceIcon::QPlaceIcon()

Constructs an icon.

[noexcept] QPlaceIcon::QPlaceIcon(const QPlaceIcon &other)

Constructs a copy of other.

[noexcept] QPlaceIcon::~QPlaceIcon()

Destroys the icon.

bool QPlaceIcon::isEmpty() const

Returns a boolean indicating whether the all the fields of the icon are empty or not.

QPlaceManager *QPlaceIcon::manager() const

Returns the manager that this icon is associated with.

Note: Getter function for property manager.

See also setManager().

QVariantMap QPlaceIcon::parameters() const

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.

Note: Getter function for property parameters.

See also setParameters().

void QPlaceIcon::setManager(QPlaceManager *manager)

Sets the manager that this icon is associated with. The icon does not take ownership of the pointer.

Note: Setter function for property manager.

See also manager().

void QPlaceIcon::setParameters(const QVariantMap &parameters)

Sets the parameters of the icon to parameters.

Note: Setter function for property parameters.

See also parameters().

[invokable] QUrl QPlaceIcon::url(const QSize &size = QSize()) const

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.

Note: This function can be invoked via the meta-object system and from QML. See Q_INVOKABLE.

[noexcept] QPlaceIcon &QPlaceIcon::operator=(const QPlaceIcon &other)

Assigns other to this icon and returns a reference to this icon.

Member Variable Documentation

const QString QPlaceIcon::SingleUrl

Parameter key for an icon that only has a single image URL.

The parameter value to be used with this key is a QUrl. An icon with this parameter set will always return the specified URL regardless of the requested size when url() is called.

Related Non-Members

[noexcept] bool operator!=(const QPlaceIcon &lhs, const QPlaceIcon &rhs)

Returns true if lhs is not equal to rhs, otherwise returns false.

[noexcept] bool operator==(const QPlaceIcon &lhs, const QPlaceIcon &rhs)

Returns true if lhs is equal to rhs, otherwise returns false.

© 2024 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.