QmlWindows Class Reference

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

#include <qmlwindows.h>

Inheritance diagram for QmlWindows:

Signals
void	created (QmlWindow *window)
	The signal emitted when a window is created. More...
void	removed (QmlWindow *window)
	The signal emitted when a window is removed. More...

Public Member Functions
	QmlWindows (QObject *parent=nullptr)
Q_INVOKABLE QmlWindow *	get (int id) const
	Gets a browser window. More...
Q_INVOKABLE QmlWindow *	getCurrent () const
	Gets the current browser window. More...
Q_INVOKABLE QList< QObject * >	getAll () const
	Get all the browser window. More...
Q_INVOKABLE QmlWindow *	create (const QVariantMap &map) const
	Creates a browser window. More...
Q_INVOKABLE void	remove (int windowId) const
	Removes a browser window. More...

Detailed Description

The class exposing Windows API to QML.

Definition at line 26 of file qmlwindows.h.

Constructor & Destructor Documentation

QmlWindows()

QmlWindows::QmlWindows

(

QObject *

parent = nullptr

)

Definition at line 24 of file qmlwindows.cpp.

Member Function Documentation

create()

QmlWindow * QmlWindows::create

(

const QVariantMap &

map

)

const

Creates a browser window.

Parameters

A	JavaScript object containing url: The url of the first tab of the window type: The window type

Returns

Definition at line 59 of file qmlwindows.cpp.

created

void QmlWindows::created ( QmlWindow *  window )

signal

The signal emitted when a window is created.

Parameters

Object

of type QmlWindow

get()

QmlWindow * QmlWindows::get

(

int

id

)

const

Gets a browser window.

Parameters

Integer

representing the browser window

Returns

Object of type QmlWindow

Definition at line 38 of file qmlwindows.cpp.

getAll()

QList< QObject * > QmlWindows::getAll

(

)

const

Get all the browser window.

Returns

List of windows of type QmlWindow

Definition at line 48 of file qmlwindows.cpp.

getCurrent()

QmlWindow * QmlWindows::getCurrent

(

)

const

Gets the current browser window.

Returns

Object of type QmlWindow

Definition at line 43 of file qmlwindows.cpp.

remove()

void QmlWindows::remove

(

int

windowId

)

const

Removes a browser window.

Parameters

Integer

representing the window id

Definition at line 67 of file qmlwindows.cpp.

removed

void QmlWindows::removed ( QmlWindow *  window )

signal

The signal emitted when a window is removed.

Parameters

Object

of type QmlWindow

---

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

• src/lib/plugins/qml/api/windows/qmlwindows.h
• src/lib/plugins/qml/api/windows/qmlwindows.cpp