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	~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 \instantiates 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
	\qmlproperty string QtMultimedia::CapturableWindow::isValid
Q_MULTIMEDIA_EXPORT QString	description () const
	\qmlproperty string QtMultimedia::CapturableWindow::description

Properties
QString	description
bool	isValid

Friends
class	QCapturableWindowPrivate
Q_MULTIMEDIA_EXPORT friend bool	operator== (const QCapturableWindow &lhs, const QCapturableWindow &rhs) noexcept
	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, const QCapturableWindow &)

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 19 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 \instantiates 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.

See also

WindowCapture

Constructs a QCapturableWindow by moving from other.

Member Function Documentation

description()

QString QCapturableWindow::description

(

)

const

\qmlproperty string QtMultimedia::CapturableWindow::description

This property holds the description of the reffered window.

Returns a description of the window. In most cases it represents the window title.

Definition at line 129 of file qcapturablewindow.cpp.

References QCapturableWindowPrivate::description, QCapturableWindowPrivate::id, QString::isEmpty(), and QString::number().

Here is the call graph for this function:

isValid()

bool QCapturableWindow::isValid

(

)

const

\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.

Identifies whether a window information is valid.

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

Returns true if the window is valid, and false if it is not.

Definition at line 115 of file qcapturablewindow.cpp.

References QPlatformMediaIntegration::instance().

Here is the call graph for this function:

operator=()

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

default

Moves other into this QCapturableWindow.

Assigns the other window information to this QCapturableWindow.

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 37 of file qcapturablewindow.h.

References other(), and QExplicitlySharedDataPointer< T >::swap().

Here is the call graph for this function:

Friends And Related Symbol Documentation

operator!=

bool QCapturableWindow::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 42 of file qcapturablewindow.h.

operator<<

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

friend

Definition at line 146 of file qcapturablewindow.cpp.

operator==

bool QCapturableWindow::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 95 of file qcapturablewindow.cpp.

QCapturableWindowPrivate

friend class QCapturableWindowPrivate

friend

Definition at line 55 of file qcapturablewindow.h.

Property Documentation

description

QString QCapturableWindow::description

read

Definition at line 22 of file qcapturablewindow.h.

isValid

bool QCapturableWindow::isValid

read

Definition at line 23 of file qcapturablewindow.h.

---

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

• qtmultimedia/src/multimedia/recording/qcapturablewindow.h (2bca3087d2b48bed46e6d959b35ebf34d5d256ac)
• qtmultimedia/src/multimedia/recording/qcapturablewindow.cpp (569bf0b553022603b89e308c76fafa11e0082269)