QCapturableWindow Class

Used for getting the basic information of a capturable window. More...

Header: #include <QCapturableWindow>
CMake: find_package(Qt6 REQUIRED COMPONENTS Multimedia)
target_link_libraries(mytarget PRIVATE Qt6::Multimedia)
qmake: QT += multimedia
Since: Qt 6.6
Instantiated By: CapturableWindow

Public Functions

QCapturableWindow()
QCapturableWindow(const QCapturableWindow &other)
QCapturableWindow(QCapturableWindow &&other)
~QCapturableWindow()
QString description() const
bool isValid() const
void swap(QCapturableWindow &other)
QCapturableWindow &operator=(QCapturableWindow &&other)
QCapturableWindow &operator=(const QCapturableWindow &other)
bool operator!=(const QCapturableWindow &lhs, const QCapturableWindow &rhs)
bool operator==(const QCapturableWindow &lhs, const QCapturableWindow &rhs)

Detailed Description

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.

Member Function Documentation

QCapturableWindow::QCapturableWindow()

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

QCapturableWindow::QCapturableWindow(const QCapturableWindow &other)

Construct a new window information using other QCapturableWindow.

[noexcept] QCapturableWindow::QCapturableWindow(QCapturableWindow &&other)

Constructs a QCapturableWindow by moving from other.

[noexcept] QCapturableWindow::~QCapturableWindow()

Destroys the window information.

QString QCapturableWindow::description() const

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

Note: Getter function for property description.

bool QCapturableWindow::isValid() const

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.

Note: Getter function for property isValid.

[noexcept] void QCapturableWindow::swap(QCapturableWindow &other)

Swaps the current window information with other.

[noexcept] QCapturableWindow &QCapturableWindow::operator=(QCapturableWindow &&other)

Moves other into this QCapturableWindow.

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

Assigns the other window information to this QCapturableWindow.

Related Non-Members

[noexcept] bool operator!=(const QCapturableWindow &lhs, const QCapturableWindow &rhs)

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

[noexcept] bool operator==(const QCapturableWindow &lhs, const QCapturableWindow &rhs)

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

© 2024 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.