Warning, /plasma/plasma-mobile/quicksettings/screenshot/dbus/org.kde.KWin.ScreenShot2.xml is written in an unsupported language. File is not indexed.
0001 <!DOCTYPE node PUBLIC "-//freedesktop//DTD D-BUS Object Introspection 1.0//EN"
0002 "http://www.freedesktop.org/standards/dbus/1.0/introspect.dtd">
0003 <!--
0004 SPDX-FileCopyrightText: 2021 Vlad Zahorodnii <vlad.zahorodnii@kde.org>
0005
0006 SPDX-License-Identifier: LGPL-2.1-only OR LGPL-3.0-only OR LicenseRef-KDE-Accepted-LGPL
0007 -->
0008 <node name="/org/kde/KWin/ScreenShot2">
0009 <!--
0010 org.kde.KWin.ScreenShot2:
0011 @short_description: Screen shot interface
0012
0013 This interface provides a way to request a screenshot of a rectangular area,
0014 a screen, or a window.
0015 -->
0016 <interface name="org.kde.KWin.ScreenShot2">
0017 <!--
0018 CaptureWindow:
0019 @handle: The unique handle that identified the window
0020 @options: Optional vardict with screenshot options
0021 @pipe: The pipe file descriptor where the screenshot will be written
0022
0023 Take a screenshot of the specified window. The application that
0024 requests the screenshot must have the org.kde.KWin.ScreenShot2
0025 interface listed in the X-KDE-DBUS-Restricted-Interfaces desktop
0026 file entry.
0027
0028 Available @options include:
0029
0030 * "include-cursor" (b): Whether the cursor should be included.
0031 Defaults to false
0032 * "include-decoration" (b): Whether the decoration should be included.
0033 Defaults to false
0034 * "native-resolution" (b): Whether the screenshot should be in
0035 native size. Defaults to false
0036
0037 The following results get returned via the @results vardict:
0038
0039 * "type" (s): The type of the image written to the pipe. Currently,
0040 the only supported type is "raw"
0041 * "width" (u): The width of the image. Available only if the image
0042 type is "raw"
0043 * "height" (u): The height of the image. Available only if the image
0044 type is "raw"
0045 * "stride" (u): The number of bytes per row. Available only if the
0046 image type is "raw"
0047 * "format" (u): The image format, as defined in QImage::Format.
0048 Available only if the image type is "raw"
0049 -->
0050 <method name="CaptureWindow">
0051 <arg name="handle" type="s" direction="in" />
0052 <annotation name="org.qtproject.QtDBus.QtTypeName.In1" value="QVariantMap" />
0053 <arg name="options" type="a{sv}" direction="in" />
0054 <arg name="pipe" type="h" direction="in" />
0055 <annotation name="org.qtproject.QtDBus.QtTypeName.Out0" value="QVariantMap" />
0056 <arg name="results" type="a{sv}" direction="out" />
0057 </method>
0058
0059 <!--
0060 CaptureArea:
0061 @x: The x coordinate of the upper left corner of the area
0062 @y: The y coordinate of the upper left corner of the area
0063 @width: The width of the screenshot area
0064 @height: The height of the screenshot area
0065 @options: Optional vardict with screenshot options
0066 @pipe: The pipe file descriptor where the screenshot will be written
0067
0068 Take a screenshot of the specified rectangular area. The application
0069 that requests the screenshot must have the org.kde.KWin.ScreenShot2
0070 interface listed in the X-KDE-DBUS-Restricted-Interfaces desktop file
0071 entry.
0072
0073 Available @options include:
0074
0075 * "include-cursor" (b): Whether the cursor should be included.
0076 Defaults to false
0077 * "native-resolution" (b): Whether the screenshot should be in
0078 native size. Defaults to false
0079
0080 The following results get returned via the @results vardict:
0081
0082 * "type" (s): The type of the image written to the pipe. Currently,
0083 the only supported type is "raw"
0084 * "width" (u): The width of the image. Available only if the image
0085 type is "raw"
0086 * "height" (u): The height of the image. Available only if the image
0087 type is "raw"
0088 * "stride" (u): The number of bytes per row. Available only if the
0089 image type is "raw"
0090 * "format" (u): The image format, as defined in QImage::Format.
0091 Available only if the image type is "raw"
0092 -->
0093 <method name="CaptureArea">
0094 <arg name="x" type="i" direction="in" />
0095 <arg name="y" type="i" direction="in" />
0096 <arg name="width" type="u" direction="in" />
0097 <arg name="height" type="u" direction="in" />
0098 <annotation name="org.qtproject.QtDBus.QtTypeName.In4" value="QVariantMap" />
0099 <arg name="options" type="a{sv}" direction="in" />
0100 <arg name="pipe" type="h" direction="in" />
0101 <annotation name="org.qtproject.QtDBus.QtTypeName.Out0" value="QVariantMap" />
0102 <arg name="results" type="a{sv}" direction="out" />
0103 </method>
0104
0105 <!--
0106 CaptureScreen:
0107 @name: The name of the screen assigned by the compositor
0108 @options: Optional vardict with screenshot options
0109 @pipe: The pipe file descriptor where the screenshot will be written
0110
0111 Take a screenshot of the specified monitor. The application that
0112 requests the screenshot must have the org.kde.KWin.ScreenShot2
0113 interface listed in the X-KDE-DBUS-Restricted-Interfaces desktop file
0114 entry.
0115
0116 Available @options include:
0117
0118 * "include-cursor" (b): Whether the cursor should be included.
0119 Defaults to false
0120 * "native-resolution" (b): Whether the screenshot should be in
0121 native size. Defaults to false
0122
0123 The following results get returned via the @results vardict:
0124
0125 * "type" (s): The type of the image written to the pipe. Currently,
0126 the only supported type is "raw"
0127 * "width" (u): The width of the image. Available only if the image
0128 type is "raw"
0129 * "height" (u): The height of the image. Available only if the image
0130 type is "raw"
0131 * "stride" (u): The number of bytes per row. Available only if the
0132 image type is "raw"
0133 * "format" (u): The image format, as defined in QImage::Format.
0134 Available only if the image type is "raw"
0135 -->
0136 <method name="CaptureScreen">
0137 <arg name="name" type="s" direction="in" />
0138 <annotation name="org.qtproject.QtDBus.QtTypeName.In1" value="QVariantMap" />
0139 <arg name="options" type="a{sv}" direction="in" />
0140 <arg name="pipe" type="h" direction="in" />
0141 <annotation name="org.qtproject.QtDBus.QtTypeName.Out0" value="QVariantMap" />
0142 <arg name="results" type="a{sv}" direction="out" />
0143 </method>
0144
0145 <!--
0146 CaptureInteractive:
0147 @kind: 0 - window, 1 - screen
0148 @options: Optional vardict with screenshot options
0149 @pipe: The pipe file descriptor where the screenshot will be written
0150
0151 Take a screenshot of a screen or a window as selected by the user.
0152
0153 Available @options include:
0154
0155 * "include-cursor" (b): Whether the cursor should be included.
0156 Defaults to false
0157 * "include-decoration" (b): Whether the decoration should be included.
0158 Defaults to false
0159 * "native-resolution" (b): Whether the screenshot should be in
0160 native size. Defaults to false
0161
0162 The following results get returned via the @results vardict:
0163
0164 * "type" (s): The type of the image written to the pipe. Currently,
0165 the only supported type is "raw"
0166 * "width" (u): The width of the image. Available only if the image
0167 type is "raw"
0168 * "height" (u): The height of the image. Available only if the image
0169 type is "raw"
0170 * "stride" (u): The number of bytes per row. Available only if the
0171 image type is "raw"
0172 * "format" (u): The image format, as defined in QImage::Format.
0173 Available only if the image type is "raw"
0174 -->
0175 <method name="CaptureInteractive">
0176 <arg name="kind" type="u" direction="in" />
0177 <annotation name="org.qtproject.QtDBus.QtTypeName.In1" value="QVariantMap" />
0178 <arg name="options" type="a{sv}" direction="in" />
0179 <arg name="pipe" type="h" direction="in" />
0180 <annotation name="org.qtproject.QtDBus.QtTypeName.Out0" value="QVariantMap" />
0181 <arg name="results" type="a{sv}" direction="out" />
0182 </method>
0183 </interface>
0184 </node>