Qt
Internal/Contributor docs for the Qt SDK. Note: These are NOT official API docs; those are found at https://doc.qt.io/
Loading...
Searching...
No Matches
QCapturableWindow Class Reference

\inmodule QtMultimedia More...

#include <qcapturablewindow.h>

Collaboration diagram for QCapturableWindow:

Public Member Functions

Q_MULTIMEDIA_EXPORT QCapturableWindow ()
 Constructs a null capturable window information that doesn't refer to any window.
Q_MULTIMEDIA_EXPORT Q_INVOKABLE Q_REVISION (6, 10) explicit QCapturableWindow(QWindow *window)
Q_MULTIMEDIA_EXPORT ~QCapturableWindow ()
 Destroys the window information.
Q_MULTIMEDIA_EXPORT QCapturableWindow (const QCapturableWindow &other)
 Construct a new window information using other QCapturableWindow.
 QCapturableWindow (QCapturableWindow &&other) noexcept=default
 \qmlvaluetype CapturableWindow \nativetype QCapturableWindow
Q_MULTIMEDIA_EXPORT QCapturableWindow & operator= (const QCapturableWindow &other)
 Moves other into this QCapturableWindow.
 QT_MOVE_ASSIGNMENT_OPERATOR_IMPL_VIA_PURE_SWAP (QCapturableWindow)
void swap (QCapturableWindow &other) noexcept
 Swaps the current window information with other.
Q_MULTIMEDIA_EXPORT bool isValid () const
Q_MULTIMEDIA_EXPORT QString description () const

Properties

QString description
 \qmlproperty string QtMultimedia::CapturableWindow::description
bool isValid
 \qmlproperty string QtMultimedia::CapturableWindow::isValid

Friends

class QCapturableWindowPrivate
Q_MULTIMEDIA_EXPORT friend bool operator== (const QCapturableWindow &lhs, const QCapturableWindow &rhs)
 Returns true if window information lhs and rhs refer to the same window, otherwise returns false.
bool operator!= (const QCapturableWindow &lhs, const QCapturableWindow &rhs) noexcept
 Returns true if window information lhs and rhs refer to different windows, otherwise returns false.
Q_MULTIMEDIA_EXPORT friend QDebug operator<< (QDebug dbg, const QCapturableWindow &window)

Detailed Description

\inmodule QtMultimedia

Since
6.6

Used for getting the basic information of a capturable window.

The class contains a set of window information, except the method QCapturableWindow::isValid which pulls the current state whenever it's called.

See also
QWindowCapture

Definition at line 20 of file qcapturablewindow.h.

Constructor & Destructor Documentation

◆ QCapturableWindow() [1/3]

QCapturableWindow::QCapturableWindow ( )
default

Constructs a null capturable window information that doesn't refer to any window.

◆ ~QCapturableWindow()

QCapturableWindow::~QCapturableWindow ( )
default

Destroys the window information.

◆ QCapturableWindow() [2/3]

QCapturableWindow::QCapturableWindow ( const QCapturableWindow & other)
default

Construct a new window information using other QCapturableWindow.

◆ QCapturableWindow() [3/3]

QCapturableWindow::QCapturableWindow ( QCapturableWindow && other)
defaultnoexcept

\qmlvaluetype CapturableWindow \nativetype QCapturableWindow

The CapturableWindow type is used getting basic of a window that is available for capturing via WindowCapture.

\inqmlmodule QtMultimedia

Since
6.6

The class contains a dump of window information, except the property 'isValid' which pulls the actual window state every time.

A CapturableWindow instance can be implicitly constructed from a \l [QML] Window. Application developers can utilize this by passing a QML Window into the 'window' property of a \l WindowCapture. See the following example. \qml Window { id: topWindow

WindowCapture { window: topWindow } } \endqml

See also
WindowCapture

Constructs a QCapturableWindow by moving from other.

Member Function Documentation

◆ description()

QString QCapturableWindow::description ( ) const

Definition at line 171 of file qcapturablewindow.cpp.

◆ isValid()

bool QCapturableWindow::isValid ( ) const

Definition at line 153 of file qcapturablewindow.cpp.

◆ operator=()

QCapturableWindow & QCapturableWindow::operator= ( const QCapturableWindow & other)
default

Moves other into this QCapturableWindow.

Assigns the other window information to this QCapturableWindow.

◆ Q_REVISION()

Q_MULTIMEDIA_EXPORT Q_INVOKABLE QCapturableWindow::Q_REVISION ( 6 ,
10  )

◆ QT_MOVE_ASSIGNMENT_OPERATOR_IMPL_VIA_PURE_SWAP()

QCapturableWindow::QT_MOVE_ASSIGNMENT_OPERATOR_IMPL_VIA_PURE_SWAP ( QCapturableWindow )

◆ swap()

void QCapturableWindow::swap ( QCapturableWindow & other)
inlinenoexcept

Swaps the current window information with other.

Definition at line 39 of file qcapturablewindow.h.

◆ operator!=

bool operator!= ( const QCapturableWindow & lhs,
const QCapturableWindow & rhs )
friend

Returns true if window information lhs and rhs refer to different windows, otherwise returns false.

Definition at line 44 of file qcapturablewindow.h.

◆ operator<<

Q_MULTIMEDIA_EXPORT friend QDebug operator<< ( QDebug dbg,
const QCapturableWindow & window )
friend

Definition at line 188 of file qcapturablewindow.cpp.

◆ operator==

Q_MULTIMEDIA_EXPORT friend bool operator== ( const QCapturableWindow & lhs,
const QCapturableWindow & rhs )
friend

Returns true if window information lhs and rhs refer to the same window, otherwise returns false.

Definition at line 134 of file qcapturablewindow.cpp.

◆ QCapturableWindowPrivate

friend class QCapturableWindowPrivate
friend

Definition at line 57 of file qcapturablewindow.h.

Property Documentation

◆ description

QString QCapturableWindow::description
read

\qmlproperty string QtMultimedia::CapturableWindow::description

This property holds the description of the window. In most cases it represents the window title.

a description of the window.

In most cases it represents the window title.

Definition at line 23 of file qcapturablewindow.h.

◆ isValid

bool QCapturableWindow::isValid
read

\qmlproperty string QtMultimedia::CapturableWindow::isValid

This property identifies whether a window information is valid.

An invalid window information refers to non-existing window or doesn't refer to any one.

whether information about the window is valid.

An invalid window information refers to non-existing window or doesn't refer to any one.

Definition at line 24 of file qcapturablewindow.h.

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