Falkon Develop
Cross-platform Qt-based web browser
QmlNotifications Class Reference

The class to display notifications. More...

#include <qmlnotifications.h>

Inheritance diagram for QmlNotifications:

Public Member Functions

 QmlNotifications (QObject *parent=nullptr)
 
Q_INVOKABLE void create (const QVariantMap &map)
 Create and display a notification. More...
 
void setPluginPath (const QString &path)
 

Detailed Description

The class to display notifications.

Definition at line 25 of file qmlnotifications.h.

Constructor & Destructor Documentation

◆ QmlNotifications()

QmlNotifications::QmlNotifications ( QObject *  parent = nullptr)
explicit

Definition at line 24 of file qmlnotifications.cpp.

Member Function Documentation

◆ create()

void QmlNotifications::create ( const QVariantMap &  map)

Create and display a notification.

Parameters
JavaScriptobject containing
  • icon: 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: String representing the heading of the notification
  • message: String representing the message of the notification

Definition at line 29 of file qmlnotifications.cpp.

◆ setPluginPath()

void QmlNotifications::setPluginPath ( const QString &  path)

Definition at line 40 of file qmlnotifications.cpp.


The documentation for this class was generated from the following files: