The class exposing BrowserAction API to QML. More...

#include <qmlbrowseraction.h>

Inheritance diagram for QmlBrowserAction:

Public Types
enum	Location { NavigationToolBar = 0x1 , StatusBar = 0x2 }
	The Location enum. More...

Signals
void	identityChanged (const QString &identity)
	This signal is emitted when identity property is changed. More...

void	nameChanged (const QString &name)
	This signal is emitted when name property is changed. More...

void	titleChanged (const QString &title)
	This signal is emitted when title property is changed. More...

void	toolTipChanged (const QString &toolTip)
	This signal is emitted when the toolTip property is changed. More...

void	iconChanged (const QString &icon)
	This signal is emitted when the icon property is changed. More...

void	badgeTextChanged (const QString &badgeText)
	This signal is emitted when the badgeText property is changed. More...

void	popupChanged (QQmlComponent *popup)
	This signal is emitted when the popup property is changed. More...

void	locationChanged (const Locations &locations)
	This signal is emitted when the locations property is changed. More...

void	clicked ()
	This signal is emitted when the button is clicked. More...

Public Member Functions
	QmlBrowserAction (QObject *parent=nullptr)

	~QmlBrowserAction () override

void	classBegin () override

void	componentComplete () override

QmlBrowserActionButton *	button () const

Locations	location () const

Properties
QString	identity
	identity for the button. This is a required property. More...

QString	name
	name of the button. This is a required property. More...

QString	title
	title of the button. More...

QString	toolTip
	tool tip of the button. More...

QString	icon
	icon path of button More...

QString	badgeText
	badge text of the button More...

QQmlComponent *	popup
	the popup shown when the button is clicked. This must be a QML Window. More...

Locations	location
	represents locations where the button is to be added. More...

Detailed Description

The class exposing BrowserAction API to QML.

Definition at line 29 of file qmlbrowseraction.h.

Member Enumeration Documentation

◆ Location

enum QmlBrowserAction::Location

The Location enum.

Enumerator
NavigationToolBar	to add the button in navigation tool bar
StatusBar	to add the button in status bar

Definition at line 88 of file qmlbrowseraction.h.

Constructor & Destructor Documentation

◆ QmlBrowserAction()

QmlBrowserAction::QmlBrowserAction ( QObject * parent = nullptr )

explicit

Definition at line 29 of file qmlbrowseraction.cpp.

◆ ~QmlBrowserAction()

QmlBrowserAction::~QmlBrowserAction ( )

override

Definition at line 55 of file qmlbrowseraction.cpp.

Member Function Documentation

◆ badgeTextChanged

void QmlBrowserAction::badgeTextChanged ( const QString & badgeText )

signal

This signal is emitted when the badgeText property is changed.

Parameters

QString representing badgeText

◆ button()

QmlBrowserActionButton * QmlBrowserAction::button ( ) const

Definition at line 63 of file qmlbrowseraction.cpp.

◆ classBegin()

void QmlBrowserAction::classBegin ( )

inlineoverride

Definition at line 97 of file qmlbrowseraction.h.

◆ clicked

void QmlBrowserAction::clicked ( )

signal

This signal is emitted when the button is clicked.

◆ componentComplete()

void QmlBrowserAction::componentComplete ( )

override

Definition at line 47 of file qmlbrowseraction.cpp.

◆ iconChanged

void QmlBrowserAction::iconChanged ( const QString & icon )

signal

This signal is emitted when the icon property is changed.

Parameters

QString representing icon

◆ identityChanged

void QmlBrowserAction::identityChanged ( const QString & identity )

signal

This signal is emitted when identity property is changed.

Parameters

QString representing identity

◆ location()

QmlBrowserAction::Locations QmlBrowserAction::location ( ) const

Definition at line 68 of file qmlbrowseraction.cpp.

◆ locationChanged

void QmlBrowserAction::locationChanged ( const Locations & locations )

signal

This signal is emitted when the locations property is changed.

Parameters

locations

◆ nameChanged

void QmlBrowserAction::nameChanged ( const QString & name )

signal

This signal is emitted when name property is changed.

Parameters

QString representing name

◆ popupChanged

void QmlBrowserAction::popupChanged ( QQmlComponent * popup )

signal

This signal is emitted when the popup property is changed.

Parameters

QQmComponent representing popup

◆ titleChanged

void QmlBrowserAction::titleChanged ( const QString & title )

signal

This signal is emitted when title property is changed.

Parameters

QString representing title

◆ toolTipChanged

void QmlBrowserAction::toolTipChanged ( const QString & toolTip )

signal

This signal is emitted when the toolTip property is changed.

Parameters

QString representing toolTip

Property Documentation

◆ badgeText

QString QmlBrowserAction::badgeText

readwrite

badge text of the button

Definition at line 1 of file qmlbrowseraction.h.

◆ icon

QString QmlBrowserAction::icon

readwrite

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.

Definition at line 1 of file qmlbrowseraction.h.

◆ identity

QString QmlBrowserAction::identity

readwrite

identity for the button. This is a required property.

Definition at line 1 of file qmlbrowseraction.h.

◆ location

Locations QmlBrowserAction::location

readwrite

represents locations where the button is to be added.

Definition at line 1 of file qmlbrowseraction.h.

◆ name

QString QmlBrowserAction::name

readwrite

name of the button. This is a required property.

Definition at line 1 of file qmlbrowseraction.h.

◆ popup

QQmlComponent* QmlBrowserAction::popup

readwrite

the popup shown when the button is clicked. This must be a QML Window.

Definition at line 1 of file qmlbrowseraction.h.

◆ title

QString QmlBrowserAction::title

readwrite

title of the button.

Definition at line 1 of file qmlbrowseraction.h.

◆ toolTip

QString QmlBrowserAction::toolTip

readwrite

tool tip of the button.

Definition at line 1 of file qmlbrowseraction.h.

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

src/lib/plugins/qml/api/browseraction/qmlbrowseraction.h
src/lib/plugins/qml/api/browseraction/qmlbrowseraction.cpp

Public Types

Signals

Public Member Functions

Properties

Detailed Description

Member Enumeration Documentation

◆ Location

Constructor & Destructor Documentation

◆ QmlBrowserAction()

◆ ~QmlBrowserAction()

Member Function Documentation

◆ badgeTextChanged

◆ button()

◆ classBegin()

◆ clicked

◆ componentComplete()

◆ iconChanged

◆ identityChanged

◆ location()

◆ locationChanged

◆ nameChanged

◆ popupChanged

◆ titleChanged

◆ toolTipChanged

Property Documentation

◆ badgeText

◆ icon

◆ identity

◆ location

◆ name

◆ popup

◆ title

◆ toolTip