2021-07-23 01:30:16 +00:00
|
|
|
<!DOCTYPE node PUBLIC "-//freedesktop//DTD D-BUS Object Introspection 1.0//EN"
|
|
|
|
|
"http://www.freedesktop.org/standards/dbus/1.0/introspect.dtd">
|
|
|
|
|
<!--
|
|
|
|
|
SPDX-FileCopyrightText: 2021 Vlad Zahorodnii <vlad.zahorodnii@kde.org>
|
|
|
|
|
|
|
|
|
|
SPDX-License-Identifier: LGPL-2.1-only OR LGPL-3.0-only OR LicenseRef-KDE-Accepted-LGPL
|
|
|
|
|
-->
|
|
|
|
|
<node name="/org/kde/KWin/ScreenShot2">
|
|
|
|
|
<!--
|
|
|
|
|
org.kde.KWin.ScreenShot2:
|
|
|
|
|
@short_description: Screen shot interface
|
|
|
|
|
|
|
|
|
|
This interface provides a way to request a screenshot of a rectangular area,
|
|
|
|
|
a screen, or a window.
|
|
|
|
|
-->
|
|
|
|
|
<interface name="org.kde.KWin.ScreenShot2">
|
2026-02-18 01:13:35 +00:00
|
|
|
<!--
|
|
|
|
|
Version:
|
|
|
|
|
|
|
|
|
|
API version.
|
|
|
|
|
-->
|
|
|
|
|
<property name="Version" type="u" access="read"/>
|
|
|
|
|
|
2021-07-23 01:30:16 +00:00
|
|
|
<!--
|
|
|
|
|
CaptureWindow:
|
|
|
|
|
@handle: The unique handle that identified the window
|
|
|
|
|
@options: Optional vardict with screenshot options
|
|
|
|
|
@pipe: The pipe file descriptor where the screenshot will be written
|
|
|
|
|
|
|
|
|
|
Take a screenshot of the specified window. The application that
|
|
|
|
|
requests the screenshot must have the org.kde.KWin.ScreenShot2
|
|
|
|
|
interface listed in the X-KDE-DBUS-Restricted-Interfaces desktop
|
|
|
|
|
file entry.
|
|
|
|
|
|
|
|
|
|
Available @options include:
|
|
|
|
|
|
|
|
|
|
* "include-cursor" (b): Whether the cursor should be included.
|
|
|
|
|
Defaults to false
|
|
|
|
|
* "include-decoration" (b): Whether the decoration should be included.
|
|
|
|
|
Defaults to false
|
2026-02-18 01:13:35 +00:00
|
|
|
* "include-shadow" (b): Whether the shadow should be included.
|
|
|
|
|
Defaults to true
|
2021-07-23 01:30:16 +00:00
|
|
|
* "native-resolution" (b): Whether the screenshot should be in
|
|
|
|
|
native size. Defaults to false
|
|
|
|
|
|
|
|
|
|
The following results get returned via the @results vardict:
|
|
|
|
|
|
|
|
|
|
* "type" (s): The type of the image written to the pipe. Currently,
|
|
|
|
|
the only supported type is "raw"
|
|
|
|
|
* "width" (u): The width of the image. Available only if the image
|
|
|
|
|
type is "raw"
|
|
|
|
|
* "height" (u): The height of the image. Available only if the image
|
|
|
|
|
type is "raw"
|
|
|
|
|
* "stride" (u): The number of bytes per row. Available only if the
|
|
|
|
|
image type is "raw"
|
|
|
|
|
* "format" (u): The image format, as defined in QImage::Format.
|
|
|
|
|
Available only if the image type is "raw"
|
2026-02-18 01:13:35 +00:00
|
|
|
* "windowId" (s): The window id of the captured window. Available
|
|
|
|
|
since version 4.
|
|
|
|
|
* "scale" (d): The ratio between the native size and the logical
|
|
|
|
|
size of the contents, corresponds to QImage::devicePixelRatio().
|
|
|
|
|
Available since version 4.
|
2021-07-23 01:30:16 +00:00
|
|
|
-->
|
|
|
|
|
<method name="CaptureWindow">
|
|
|
|
|
<arg name="handle" type="s" direction="in" />
|
|
|
|
|
<annotation name="org.qtproject.QtDBus.QtTypeName.In1" value="QVariantMap" />
|
|
|
|
|
<arg name="options" type="a{sv}" direction="in" />
|
|
|
|
|
<arg name="pipe" type="h" direction="in" />
|
|
|
|
|
<annotation name="org.qtproject.QtDBus.QtTypeName.Out0" value="QVariantMap" />
|
|
|
|
|
<arg name="results" type="a{sv}" direction="out" />
|
|
|
|
|
</method>
|
|
|
|
|
|
2026-02-18 01:13:35 +00:00
|
|
|
<!--
|
|
|
|
|
CaptureActiveWindow:
|
|
|
|
|
@options: Optional vardict with screenshot options
|
|
|
|
|
@pipe: The pipe file descriptor where the screenshot will be written
|
|
|
|
|
|
|
|
|
|
Take a screenshot of the active window. The application that
|
|
|
|
|
requests the screenshot must have the org.kde.KWin.ScreenShot2
|
|
|
|
|
interface listed in the X-KDE-DBUS-Restricted-Interfaces desktop
|
|
|
|
|
file entry.
|
|
|
|
|
|
|
|
|
|
Supported since version 2.
|
|
|
|
|
|
|
|
|
|
Available @options include:
|
|
|
|
|
|
|
|
|
|
* "include-cursor" (b): Whether the cursor should be included.
|
|
|
|
|
Defaults to false
|
|
|
|
|
* "include-decoration" (b): Whether the decoration should be included.
|
|
|
|
|
Defaults to false
|
|
|
|
|
* "include-shadow" (b): Whether the shadow should be included.
|
|
|
|
|
Defaults to true
|
|
|
|
|
* "native-resolution" (b): Whether the screenshot should be in
|
|
|
|
|
native size. Defaults to false
|
|
|
|
|
|
|
|
|
|
The following results get returned via the @results vardict:
|
|
|
|
|
|
|
|
|
|
* "type" (s): The type of the image written to the pipe. Currently,
|
|
|
|
|
the only supported type is "raw"
|
|
|
|
|
* "width" (u): The width of the image. Available only if the image
|
|
|
|
|
type is "raw"
|
|
|
|
|
* "height" (u): The height of the image. Available only if the image
|
|
|
|
|
type is "raw"
|
|
|
|
|
* "stride" (u): The number of bytes per row. Available only if the
|
|
|
|
|
image type is "raw"
|
|
|
|
|
* "format" (u): The image format, as defined in QImage::Format.
|
|
|
|
|
Available only if the image type is "raw"
|
|
|
|
|
* "windowId" (s): The window id of the captured window. Available
|
|
|
|
|
since version 4.
|
|
|
|
|
* "scale" (d): The ratio between the native size and the logical
|
|
|
|
|
size of the contents, corresponds to QImage::devicePixelRatio().
|
|
|
|
|
Available since version 4.
|
|
|
|
|
-->
|
|
|
|
|
<method name="CaptureActiveWindow">
|
|
|
|
|
<annotation name="org.qtproject.QtDBus.QtTypeName.In0" value="QVariantMap" />
|
|
|
|
|
<arg name="options" type="a{sv}" direction="in" />
|
|
|
|
|
<arg name="pipe" type="h" direction="in" />
|
|
|
|
|
<annotation name="org.qtproject.QtDBus.QtTypeName.Out0" value="QVariantMap" />
|
|
|
|
|
<arg name="results" type="a{sv}" direction="out" />
|
|
|
|
|
</method>
|
|
|
|
|
|
2021-07-23 01:30:16 +00:00
|
|
|
<!--
|
|
|
|
|
CaptureArea:
|
|
|
|
|
@x: The x coordinate of the upper left corner of the area
|
|
|
|
|
@y: The y coordinate of the upper left corner of the area
|
|
|
|
|
@width: The width of the screenshot area
|
|
|
|
|
@height: The height of the screenshot area
|
|
|
|
|
@options: Optional vardict with screenshot options
|
|
|
|
|
@pipe: The pipe file descriptor where the screenshot will be written
|
|
|
|
|
|
|
|
|
|
Take a screenshot of the specified rectangular area. The application
|
|
|
|
|
that requests the screenshot must have the org.kde.KWin.ScreenShot2
|
|
|
|
|
interface listed in the X-KDE-DBUS-Restricted-Interfaces desktop file
|
|
|
|
|
entry.
|
|
|
|
|
|
|
|
|
|
Available @options include:
|
|
|
|
|
|
|
|
|
|
* "include-cursor" (b): Whether the cursor should be included.
|
|
|
|
|
Defaults to false
|
|
|
|
|
* "native-resolution" (b): Whether the screenshot should be in
|
|
|
|
|
native size. Defaults to false
|
|
|
|
|
|
|
|
|
|
The following results get returned via the @results vardict:
|
|
|
|
|
|
|
|
|
|
* "type" (s): The type of the image written to the pipe. Currently,
|
|
|
|
|
the only supported type is "raw"
|
|
|
|
|
* "width" (u): The width of the image. Available only if the image
|
|
|
|
|
type is "raw"
|
|
|
|
|
* "height" (u): The height of the image. Available only if the image
|
|
|
|
|
type is "raw"
|
|
|
|
|
* "stride" (u): The number of bytes per row. Available only if the
|
|
|
|
|
image type is "raw"
|
|
|
|
|
* "format" (u): The image format, as defined in QImage::Format.
|
|
|
|
|
Available only if the image type is "raw"
|
2026-02-18 01:13:35 +00:00
|
|
|
* "scale" (d): The ratio between the native size and the logical
|
|
|
|
|
size of the contents, corresponds to QImage::devicePixelRatio().
|
|
|
|
|
Available since version 4.
|
2021-07-23 01:30:16 +00:00
|
|
|
-->
|
|
|
|
|
<method name="CaptureArea">
|
|
|
|
|
<arg name="x" type="i" direction="in" />
|
|
|
|
|
<arg name="y" type="i" direction="in" />
|
|
|
|
|
<arg name="width" type="u" direction="in" />
|
|
|
|
|
<arg name="height" type="u" direction="in" />
|
|
|
|
|
<annotation name="org.qtproject.QtDBus.QtTypeName.In4" value="QVariantMap" />
|
|
|
|
|
<arg name="options" type="a{sv}" direction="in" />
|
|
|
|
|
<arg name="pipe" type="h" direction="in" />
|
|
|
|
|
<annotation name="org.qtproject.QtDBus.QtTypeName.Out0" value="QVariantMap" />
|
|
|
|
|
<arg name="results" type="a{sv}" direction="out" />
|
|
|
|
|
</method>
|
|
|
|
|
|
|
|
|
|
<!--
|
|
|
|
|
CaptureScreen:
|
|
|
|
|
@name: The name of the screen assigned by the compositor
|
|
|
|
|
@options: Optional vardict with screenshot options
|
|
|
|
|
@pipe: The pipe file descriptor where the screenshot will be written
|
|
|
|
|
|
|
|
|
|
Take a screenshot of the specified monitor. The application that
|
|
|
|
|
requests the screenshot must have the org.kde.KWin.ScreenShot2
|
|
|
|
|
interface listed in the X-KDE-DBUS-Restricted-Interfaces desktop file
|
|
|
|
|
entry.
|
|
|
|
|
|
|
|
|
|
Available @options include:
|
|
|
|
|
|
|
|
|
|
* "include-cursor" (b): Whether the cursor should be included.
|
|
|
|
|
Defaults to false
|
|
|
|
|
* "native-resolution" (b): Whether the screenshot should be in
|
|
|
|
|
native size. Defaults to false
|
|
|
|
|
|
|
|
|
|
The following results get returned via the @results vardict:
|
|
|
|
|
|
|
|
|
|
* "type" (s): The type of the image written to the pipe. Currently,
|
|
|
|
|
the only supported type is "raw"
|
|
|
|
|
* "width" (u): The width of the image. Available only if the image
|
|
|
|
|
type is "raw"
|
|
|
|
|
* "height" (u): The height of the image. Available only if the image
|
|
|
|
|
type is "raw"
|
|
|
|
|
* "stride" (u): The number of bytes per row. Available only if the
|
|
|
|
|
image type is "raw"
|
|
|
|
|
* "format" (u): The image format, as defined in QImage::Format.
|
|
|
|
|
Available only if the image type is "raw"
|
2026-02-18 01:13:35 +00:00
|
|
|
* "screen" (s): The name of the captured screen, same as QScreen::name().
|
|
|
|
|
Available since version 4
|
|
|
|
|
* "scale" (d): The ratio between the native size and the logical
|
|
|
|
|
size of the contents, corresponds to QImage::devicePixelRatio().
|
|
|
|
|
Available since version 4.
|
2021-07-23 01:30:16 +00:00
|
|
|
-->
|
|
|
|
|
<method name="CaptureScreen">
|
|
|
|
|
<arg name="name" type="s" direction="in" />
|
|
|
|
|
<annotation name="org.qtproject.QtDBus.QtTypeName.In1" value="QVariantMap" />
|
|
|
|
|
<arg name="options" type="a{sv}" direction="in" />
|
|
|
|
|
<arg name="pipe" type="h" direction="in" />
|
|
|
|
|
<annotation name="org.qtproject.QtDBus.QtTypeName.Out0" value="QVariantMap" />
|
|
|
|
|
<arg name="results" type="a{sv}" direction="out" />
|
|
|
|
|
</method>
|
|
|
|
|
|
2026-02-18 01:13:35 +00:00
|
|
|
<!--
|
|
|
|
|
CaptureActiveScreen:
|
|
|
|
|
@options: Optional vardict with screenshot options
|
|
|
|
|
@pipe: The pipe file descriptor where the screenshot will be written
|
|
|
|
|
|
|
|
|
|
Take a screenshot of the active monitor. The application that
|
|
|
|
|
requests the screenshot must have the org.kde.KWin.ScreenShot2
|
|
|
|
|
interface listed in the X-KDE-DBUS-Restricted-Interfaces desktop file
|
|
|
|
|
entry.
|
|
|
|
|
|
|
|
|
|
Supported since version 2.
|
|
|
|
|
|
|
|
|
|
Available @options include:
|
|
|
|
|
|
|
|
|
|
* "include-cursor" (b): Whether the cursor should be included.
|
|
|
|
|
Defaults to false
|
|
|
|
|
* "native-resolution" (b): Whether the screenshot should be in
|
|
|
|
|
native size. Defaults to false
|
|
|
|
|
|
|
|
|
|
The following results get returned via the @results vardict:
|
|
|
|
|
|
|
|
|
|
* "type" (s): The type of the image written to the pipe. Currently,
|
|
|
|
|
the only supported type is "raw"
|
|
|
|
|
* "width" (u): The width of the image. Available only if the image
|
|
|
|
|
type is "raw"
|
|
|
|
|
* "height" (u): The height of the image. Available only if the image
|
|
|
|
|
type is "raw"
|
|
|
|
|
* "stride" (u): The number of bytes per row. Available only if the
|
|
|
|
|
image type is "raw"
|
|
|
|
|
* "format" (u): The image format, as defined in QImage::Format.
|
|
|
|
|
Available only if the image type is "raw"
|
|
|
|
|
* "screen" (s): The name of the captured screen, same as QScreen::name().
|
|
|
|
|
Available since version 4
|
|
|
|
|
* "scale" (d): The ratio between the native size and the logical
|
|
|
|
|
size of the contents, corresponds to QImage::devicePixelRatio().
|
|
|
|
|
Available since version 4.
|
|
|
|
|
-->
|
|
|
|
|
<method name="CaptureActiveScreen">
|
|
|
|
|
<annotation name="org.qtproject.QtDBus.QtTypeName.In0" value="QVariantMap" />
|
|
|
|
|
<arg name="options" type="a{sv}" direction="in" />
|
|
|
|
|
<arg name="pipe" type="h" direction="in" />
|
|
|
|
|
<annotation name="org.qtproject.QtDBus.QtTypeName.Out0" value="QVariantMap" />
|
|
|
|
|
<arg name="results" type="a{sv}" direction="out" />
|
|
|
|
|
</method>
|
|
|
|
|
|
2021-07-23 01:30:16 +00:00
|
|
|
<!--
|
|
|
|
|
CaptureInteractive:
|
|
|
|
|
@kind: 0 - window, 1 - screen
|
|
|
|
|
@options: Optional vardict with screenshot options
|
|
|
|
|
@pipe: The pipe file descriptor where the screenshot will be written
|
|
|
|
|
|
|
|
|
|
Take a screenshot of a screen or a window as selected by the user.
|
|
|
|
|
|
|
|
|
|
Available @options include:
|
|
|
|
|
|
|
|
|
|
* "include-cursor" (b): Whether the cursor should be included.
|
|
|
|
|
Defaults to false
|
|
|
|
|
* "include-decoration" (b): Whether the decoration should be included.
|
|
|
|
|
Defaults to false
|
2026-02-18 01:13:35 +00:00
|
|
|
* "include-shadow" (b): Whether the shadow should be included.
|
|
|
|
|
Defaults to true
|
2021-07-23 01:30:16 +00:00
|
|
|
* "native-resolution" (b): Whether the screenshot should be in
|
|
|
|
|
native size. Defaults to false
|
|
|
|
|
|
|
|
|
|
The following results get returned via the @results vardict:
|
|
|
|
|
|
|
|
|
|
* "type" (s): The type of the image written to the pipe. Currently,
|
|
|
|
|
the only supported type is "raw"
|
|
|
|
|
* "width" (u): The width of the image. Available only if the image
|
|
|
|
|
type is "raw"
|
|
|
|
|
* "height" (u): The height of the image. Available only if the image
|
|
|
|
|
type is "raw"
|
|
|
|
|
* "stride" (u): The number of bytes per row. Available only if the
|
|
|
|
|
image type is "raw"
|
|
|
|
|
* "format" (u): The image format, as defined in QImage::Format.
|
|
|
|
|
Available only if the image type is "raw"
|
2026-02-18 01:13:35 +00:00
|
|
|
* "scale" (d): The ratio between the native size and the logical
|
|
|
|
|
size of the contents, corresponds to QImage::devicePixelRatio().
|
|
|
|
|
Available since version 4.
|
|
|
|
|
|
|
|
|
|
The following results get returned when taking a window screenshot:
|
|
|
|
|
|
|
|
|
|
* "windowId" (s): The window id of the captured window. Available
|
|
|
|
|
since version 4
|
|
|
|
|
|
|
|
|
|
The following results get returned when taking a monitor screenshot:
|
|
|
|
|
|
|
|
|
|
* "screen" (s): The name of the captured screen, same as QScreen::name().
|
|
|
|
|
Available since version 4
|
2021-07-23 01:30:16 +00:00
|
|
|
-->
|
|
|
|
|
<method name="CaptureInteractive">
|
|
|
|
|
<arg name="kind" type="u" direction="in" />
|
|
|
|
|
<annotation name="org.qtproject.QtDBus.QtTypeName.In1" value="QVariantMap" />
|
|
|
|
|
<arg name="options" type="a{sv}" direction="in" />
|
|
|
|
|
<arg name="pipe" type="h" direction="in" />
|
|
|
|
|
<annotation name="org.qtproject.QtDBus.QtTypeName.Out0" value="QVariantMap" />
|
|
|
|
|
<arg name="results" type="a{sv}" direction="out" />
|
|
|
|
|
</method>
|
2026-02-18 01:13:35 +00:00
|
|
|
|
|
|
|
|
<!--
|
|
|
|
|
CaptureWorkspace:
|
|
|
|
|
@options: Optional vardict with screenshot options
|
|
|
|
|
@pipe: The pipe file descriptor where the screenshot will be written
|
|
|
|
|
|
|
|
|
|
Take a screenshot of the workspace, i.e. all screens united. The
|
|
|
|
|
application that requests the screenshot must have the org.kde.KWin.ScreenShot2
|
|
|
|
|
interface listed in the X-KDE-DBUS-Restricted-Interfaces desktop file
|
|
|
|
|
entry.
|
|
|
|
|
|
|
|
|
|
Supported since version 3.
|
|
|
|
|
|
|
|
|
|
Available @options include:
|
|
|
|
|
|
|
|
|
|
* "include-cursor" (b): Whether the cursor should be included.
|
|
|
|
|
Defaults to false
|
|
|
|
|
* "native-resolution" (b): Whether the screenshot should be in
|
|
|
|
|
native size. Defaults to false
|
|
|
|
|
|
|
|
|
|
The following results get returned via the @results vardict:
|
|
|
|
|
|
|
|
|
|
* "type" (s): The type of the image written to the pipe. Currently,
|
|
|
|
|
the only supported type is "raw"
|
|
|
|
|
* "width" (u): The width of the image. Available only if the image
|
|
|
|
|
type is "raw"
|
|
|
|
|
* "height" (u): The height of the image. Available only if the image
|
|
|
|
|
type is "raw"
|
|
|
|
|
* "stride" (u): The number of bytes per row. Available only if the
|
|
|
|
|
image type is "raw"
|
|
|
|
|
* "format" (u): The image format, as defined in QImage::Format.
|
|
|
|
|
Available only if the image type is "raw"
|
|
|
|
|
* "scale" (d): The ratio between the native size and the logical
|
|
|
|
|
size of the contents, corresponds to QImage::devicePixelRatio().
|
|
|
|
|
Available since version 4.
|
|
|
|
|
-->
|
|
|
|
|
<method name="CaptureWorkspace">
|
|
|
|
|
<annotation name="org.qtproject.QtDBus.QtTypeName.In0" value="QVariantMap" />
|
|
|
|
|
<arg name="options" type="a{sv}" direction="in" />
|
|
|
|
|
<arg name="pipe" type="h" direction="in" />
|
|
|
|
|
<annotation name="org.qtproject.QtDBus.QtTypeName.Out0" value="QVariantMap" />
|
|
|
|
|
<arg name="results" type="a{sv}" direction="out" />
|
|
|
|
|
</method>
|
2021-07-23 01:30:16 +00:00
|
|
|
</interface>
|
|
|
|
|
</node>
|
