- Qt 6.10
- Qt Multimedia
- C++ Classes
- QtMultimedia
- QCapturableWindow
- Qt 6.10.3 Reference Documentation

# 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
In QML: | CapturableWindow

- List of all members, including inherited members

## Properties

- description : const QString
- isValid : const bool

## Public Functions

| QCapturableWindow()
`(since 6.10)` | QCapturableWindow(QWindow *window)
| 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)

## Related Non-Members

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.

## Property Documentation

### `[read-only]` description : const QString

This property holds a description of the window.

In most cases it represents the window title.

Access functions:

QString | description() const

### `[read-only]` isValid : const bool

This property holds whether information about the window is valid.

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

Access functions:

bool | isValid() const

## Member Function Documentation

### QCapturableWindow::QCapturableWindow()

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

### `[explicit invokable, since 6.10]` QCapturableWindow::QCapturableWindow(QWindow *window)

Constructs a QCapturableWindow instance that maps to the given window.

The description of the QCapturableWindow will match the title of the given QWindow.

Note, the constructor may create an invalid instance if the specified `QWindow` has not been presented yet. Thus, if the Qt application is not running, an invalid `QCapturableWindow` instance is expected. The validity of the instance can be tracked by querying isValid over time.

If given a nullptr as input, this method will return an instance that will never become valid.

If given a window that is not top-level, this method will return an instance will never become valid.

Note: This function can be invoked via the meta-object system and from QML. See Q_INVOKABLE.

This function was introduced in Qt 6.10.

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

### `[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`.