Falkon/falkonOfficial
Falkon/falkonOfficial
1
Fork 0
mirror of https://invent.kde.org/network/falkon.git synced 2024-12-20 18:56:34 +01:00
Code Releases Activity

Changed documentation for setting icon/pixmap in QML plugins

Browse Source
This commit is contained in:
Anmol Gautam 2018-07-18 18:58:28 +05:30
parent bf684cb7ff
commit 7a0ff29ec4
3 changed files with 29 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
src/lib/plugins/qml/api/browseraction/qmlbrowseraction.h
View File

@ -52,7 +52,17 @@ class QmlBrowserAction : public QObject, public QQmlParserStatus
Q_PROPERTY(QString toolTip READ toolTip WRITE setToolTip NOTIFY toolTipChanged) Q_PROPERTY(QString toolTip READ toolTip WRITE setToolTip NOTIFY toolTipChanged)
/** /**
* @brief Url of the icon of button * @brief icon path of button
*
* The icon path will be search in the following order
* - Theme icon: if the icon is found as a theme icon, then it will
* be used even if the icon file with same name is present
* in the plugin directory
* - Falkon resource: for the icons starting with ":", they are searched in
* falkon resource file
* - Files in plugin directory: All other paths will be resolved relative to
* the plugin directory. If the icon path is outside the
* plugin directory, then it will be resolved as empty path.
*/ */
Q_PROPERTY(QString icon READ icon WRITE setIcon NOTIFY iconChanged) Q_PROPERTY(QString icon READ icon WRITE setIcon NOTIFY iconChanged)

8
src/lib/plugins/qml/api/notifications/qmlnotifications.cpp
View File

@ -30,7 +30,13 @@ QmlNotifications::QmlNotifications(QObject *parent)
* @brief Create and display a notification * @brief Create and display a notification
* @param JavaScript object containing * @param JavaScript object containing
* - icon: * - icon:
* String representing the icon file url * String representing the icon file url. The icon path will be
* search in the following order
* - Falkon resource: for the icons starting with ":", they are searched in
* falkon resource file
* - Files in plugin directory: All other paths will be resolved relative to
* the plugin directory. If the icon path is outside the
* plugin directory, then it will be resolved as empty path.
* - heading: * - heading:
* String representing the heading of the notification * String representing the heading of the notification
* - message: * - message:

12
src/lib/plugins/qml/api/sidebar/qmlsidebar.h
View File

@ -41,7 +41,17 @@ class QmlSideBar : public QObject, public QQmlParserStatus
Q_PROPERTY(QString title READ title WRITE setTitle NOTIFY titleChanged) Q_PROPERTY(QString title READ title WRITE setTitle NOTIFY titleChanged)
/** /**
* @brief icon url of the sidebar action. * @brief icon path of the sidebar action.
*
* The icon path will be search in the following order
* - Theme icon: if the icon is found as a theme icon, then it will
* be used even if the icon file with same name is present
* in the plugin directory
* - Falkon resource: for the icons starting with ":", they are searched in
* falkon resource file
* - Files in plugin directory: All other paths will be resolved relative to
* the plugin directory. If the icon path is outside the
* plugin directory, then it will be resolved as empty path.
*/ */
Q_PROPERTY(QString icon READ icon WRITE setIcon NOTIFY iconChanged) Q_PROPERTY(QString icon READ icon WRITE setIcon NOTIFY iconChanged)