QmlSideBar Class Reference

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

#include <qmlsidebar.h>

Inheritance diagram for QmlSideBar:

Signals
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	iconChanged (const QString &icon)
	This signal is emitted when icon property is changed. More...
void	shortcutChanged (const QString &shortcut)
	This signal is emitted when shortcut property is changed. More...
void	checkableChanged (bool checkable)
	This signal is emitted when checkable property is changed. More...
void	itemChanged (QQmlComponent *item)

Public Member Functions
	QmlSideBar (QObject *parent=nullptr)
	~QmlSideBar () override
void	classBegin () override
void	componentComplete () override
QString	name () const
SideBarInterface *	sideBar () const

Properties
QString	name
	name of the sidebar. This is required property. More...
QString	title
	title of the sidebar action. More...
QString	icon
	icon path of the sidebar action. More...
QString	shortcut
	shortcut for the sidebar action. More...
bool	checkable
	represents whether the sidebar action is checkable More...
QQmlComponent *	item
	the GUI of the sidebar. This must be provided as QML Window. This is a default property. More...

Detailed Description

The class exposing SideBar API to QML.

Definition at line 28 of file qmlsidebar.h.

Constructor & Destructor Documentation

QmlSideBar()

QmlSideBar::QmlSideBar ( QObject *  parent = nullptr )

explicit

Definition at line 29 of file qmlsidebar.cpp.

~QmlSideBar()

QmlSideBar::~QmlSideBar ( )

override

Definition at line 41 of file qmlsidebar.cpp.

Member Function Documentation

checkableChanged

void QmlSideBar::checkableChanged ( bool  checkable )

signal

This signal is emitted when checkable property is changed.

Parameters

checkable

classBegin()

void QmlSideBar::classBegin ( )

inlineoverride

Definition at line 78 of file qmlsidebar.h.

componentComplete()

void QmlSideBar::componentComplete ( )

override

Definition at line 46 of file qmlsidebar.cpp.

iconChanged

void QmlSideBar::iconChanged ( const QString &  icon )

signal

This signal is emitted when icon property is changed.

Parameters

QString

representing icon path url

itemChanged

void QmlSideBar::itemChanged ( QQmlComponent *  item )

signal

name()

QString QmlSideBar::name

(

)

const

Definition at line 51 of file qmlsidebar.cpp.

nameChanged

void QmlSideBar::nameChanged ( const QString &  name )

signal

This signal is emitted when name property is changed.

Parameters

QString

represening name

shortcutChanged

void QmlSideBar::shortcutChanged ( const QString &  shortcut )

signal

This signal is emitted when shortcut property is changed.

Parameters

QString

representing shortcut

sideBar()

SideBarInterface * QmlSideBar::sideBar

(

)

const

Definition at line 56 of file qmlsidebar.cpp.

titleChanged

void QmlSideBar::titleChanged ( const QString &  title )

signal

This signal is emitted when title property is changed.

Parameters

QString

representing title

Property Documentation

checkable

bool QmlSideBar::checkable

readwrite

represents whether the sidebar action is checkable

Definition at line 1 of file qmlsidebar.h.

icon

QString QmlSideBar::icon

readwrite

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.

Definition at line 1 of file qmlsidebar.h.

item

QQmlComponent* QmlSideBar::item

readwrite

the GUI of the sidebar. This must be provided as QML Window. This is a default property.

Definition at line 1 of file qmlsidebar.h.

name

QString QmlSideBar::name

readwrite

name of the sidebar. This is required property.

Definition at line 1 of file qmlsidebar.h.

shortcut

QString QmlSideBar::shortcut

readwrite

shortcut for the sidebar action.

Definition at line 1 of file qmlsidebar.h.

title

QString QmlSideBar::title

readwrite

title of the sidebar action.

Definition at line 1 of file qmlsidebar.h.

---

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

• src/lib/plugins/qml/api/sidebar/qmlsidebar.h
• src/lib/plugins/qml/api/sidebar/qmlsidebar.cpp