Warning, /graphics/spectacle/dbus/org.kde.Spectacle.xml is written in an unsupported language. File is not indexed.
0001 <!DOCTYPE node PUBLIC 0002 "-//freedesktop//DTD D-BUS Object Introspection 1.0//EN" 0003 "http://www.freedesktop.org/standards/dbus/1.0/introspect.dtd"> 0004 0005 <!-- 0006 This file contains the definition for the org.kde.Spectacle D-Bus interface. 0007 Originally written by Boudhayan Gupta <bgupta@kde.org>. It may be copied 0008 freely and modified as needed. 0009 --> 0010 0011 <node xmlns:doc="http://www.freedesktop.org/dbus/1.0/doc.dtd"> 0012 <interface name="org.kde.Spectacle"> 0013 <method name="StartAgent"> 0014 <doc:doc> 0015 <doc:description> 0016 <doc:para>Starts Spectacle and shows the GUI</doc:para> 0017 </doc:description> 0018 </doc:doc> 0019 </method> 0020 0021 <method name="FullScreen"> 0022 <arg name="includeMousePointer" direction="in" type="i"> 0023 <doc:doc> 0024 <doc:summary>Whether to include an image of the mouse pointer. Depends on the user set option 'include mouse pointer' or the parameter sent via dbus.</doc:summary> 0025 <doc:para>Available parameters: -1 - uses the value set in the option 'include mouse pointer', 0 - doesn't include the mouse pointer, 1 - includes the mouse pointer</doc:para> 0026 </doc:doc> 0027 </arg> 0028 <doc:doc> 0029 <doc:description> 0030 <doc:para>Takes a full-screen screenshot.</doc:para> 0031 <doc:para>If Spectacle was started via D-Bus, it takes a screenshot in the background without spawning the GUI and exits after the shot has been taken.</doc:para> 0032 </doc:description> 0033 </doc:doc> 0034 </method> 0035 0036 <method name="CurrentScreen"> 0037 <arg name="includeMousePointer" direction="in" type="i"> 0038 <doc:doc> 0039 <doc:summary>Whether to include an image of the mouse pointer. Depends on the user set option 'include mouse pointer' or the parameter sent via dbus.</doc:summary> 0040 <doc:para>Available parameters: -1 - uses the value set in the option 'include mouse pointer', 0 - doesn't include the mouse pointer, 1 - includes the mouse pointer</doc:para> 0041 </doc:doc> 0042 </arg> 0043 <doc:doc> 0044 <doc:description> 0045 <doc:para>Takes a screenshot of the current screen.</doc:para> 0046 <doc:para>If Spectacle was started via D-Bus, it takes a screenshot in the background without spawning the GUI and exits after the shot has been taken.</doc:para> 0047 </doc:description> 0048 </doc:doc> 0049 </method> 0050 0051 <method name="ActiveWindow"> 0052 <arg name="includeWindowDecorations" direction="in" type="i"> 0053 <doc:doc> 0054 <doc:summary>Whether to include the window titlebars and frames. Depends on the user set option 'include window titlebar and borders' or the parameter sent via dbus.</doc:summary> 0055 <doc:para>Available parameters: -1 - uses the value set in the option 'include window titlebar and borders', 0 - doesn't include window titlebars and frames, 1 - includes window titlebars and frames</doc:para> 0056 </doc:doc> 0057 </arg> 0058 <arg name="includeMousePointer" direction="in" type="i"> 0059 <doc:doc> 0060 <doc:summary>Whether to include an image of the mouse pointer. Depends on the user set option 'include mouse pointer' or the parameter sent via dbus.</doc:summary> 0061 <doc:para>Available parameters: -1 - uses the value set in the option 'include mouse pointer', 0 - doesn't include the mouse pointer, 1 - includes the mouse pointer</doc:para> 0062 </doc:doc> 0063 </arg> 0064 <arg name="includeWindowShadow" direction="in" type="i"> 0065 <doc:doc> 0066 <doc:summary>Whether to include the window shadow. Depends on the user set option 'include window shadow' or the parameter sent via dbus.</doc:summary> 0067 <doc:para>Available parameters: -1 - uses the value set in the option 'include window shadow', 0 - doesn't include window shadow, 1 - includes window shadow</doc:para> 0068 </doc:doc> 0069 </arg> 0070 <doc:doc> 0071 <doc:description> 0072 <doc:para>Takes a screenshot of the window that currently has window focus.</doc:para> 0073 <doc:para>If Spectacle was started via D-Bus, it takes a screenshot in the background without spawning the GUI and exits after the shot has been taken.</doc:para> 0074 </doc:description> 0075 </doc:doc> 0076 </method> 0077 0078 <method name="WindowUnderCursor"> 0079 <arg name="includeWindowDecorations" direction="in" type="i"> 0080 <doc:doc> 0081 <doc:summary>Whether to include the window titlebars and frames. Depends on the user set option 'include window titlebar and borders' or the parameter sent via dbus.</doc:summary> 0082 <doc:para>Available parameters: -1 - uses the value set in the option 'include window titlebar and borders', 0 - doesn't include window titlebars and frames, 1 - includes window titlebars and frames</doc:para> 0083 </doc:doc> 0084 </arg> 0085 <arg name="includeMousePointer" direction="in" type="i"> 0086 <doc:doc> 0087 <doc:summary>Whether to include an image of the mouse pointer. Depends on the user set option 'include mouse pointer' or the parameter sent via dbus.</doc:summary> 0088 <doc:para>Available parameters: -1 - uses the value set in the option 'include mouse pointer', 0 - doesn't include the mouse pointer, 1 - includes the mouse pointer</doc:para> 0089 </doc:doc> 0090 </arg> 0091 <arg name="includeWindowShadow" direction="in" type="i"> 0092 <doc:doc> 0093 <doc:summary>Whether to include the window shadow. Depends on the user set option 'include window shadow' or the parameter sent via dbus.</doc:summary> 0094 <doc:para>Available parameters: -1 - uses the value set in the option 'include window shadow', 0 - doesn't include window shadow, 1 - includes window shadow</doc:para> 0095 </doc:doc> 0096 </arg> 0097 <doc:doc> 0098 <doc:description> 0099 <doc:para>Takes a screenshot of the window that is currently under the mouse cursor.</doc:para> 0100 <doc:para>If Spectacle was started via D-Bus, it takes a screenshot in the background without spawning the GUI and exits after the shot has been taken.</doc:para> 0101 </doc:description> 0102 </doc:doc> 0103 </method> 0104 0105 <method name="RectangularRegion"> 0106 <arg name="includeMousePointer" direction="in" type="i"> 0107 <doc:doc> 0108 <doc:summary>Whether to include an image of the mouse pointer. Depends on the user set option 'include mouse pointer' or the parameter sent via dbus.</doc:summary> 0109 <doc:para>Available parameters: -1 - uses the value set in the option 'include mouse pointer', 0 - doesn't include the mouse pointer, 1 - includes the mouse pointer</doc:para> 0110 </doc:doc> 0111 </arg> 0112 <doc:doc> 0113 <doc:description> 0114 <doc:para>Takes a screenshot of a rectangular region.</doc:para> 0115 <doc:para>The user is prompted to select the region to capture. If Spectacle was started via D-Bus, it exits after the shot has been taken.</doc:para> 0116 </doc:description> 0117 </doc:doc> 0118 </method> 0119 0120 <method name="RecordRegion"> 0121 <arg name="includeMousePointer" direction="in" type="i"> 0122 <doc:doc> 0123 <doc:summary>Whether to include the mouse pointer in the recording. Depends on the user set option 'include mouse pointer' or the parameter sent via dbus.</doc:summary> 0124 <doc:para>Available parameters: -1 - uses the value set in the option 'include mouse pointer', 0 - doesn't include the mouse pointer, 1 - includes the mouse pointer</doc:para> 0125 </doc:doc> 0126 </arg> 0127 <doc:doc> 0128 <doc:description> 0129 <doc:para>Takes a recording of a rectangular region.</doc:para> 0130 <doc:para>The user is prompted to select the region to capture. If Spectacle was started via D-Bus, it exits after the recording has been taken.</doc:para> 0131 </doc:description> 0132 </doc:doc> 0133 </method> 0134 0135 <method name="RecordScreen"> 0136 <arg name="includeMousePointer" direction="in" type="i"> 0137 <doc:doc> 0138 <doc:summary>Whether to include the mouse pointer in the recording. Depends on the user set option 'include mouse pointer' or the parameter sent via dbus.</doc:summary> 0139 <doc:para>Available parameters: -1 - uses the value set in the option 'include mouse pointer', 0 - doesn't include the mouse pointer, 1 - includes the mouse pointer</doc:para> 0140 </doc:doc> 0141 </arg> 0142 <doc:doc> 0143 <doc:description> 0144 <doc:para>Takes a recording of a screen.</doc:para> 0145 <doc:para>The user is prompted to select the screen to capture. If Spectacle was started via D-Bus, it exits after the shot has been taken.</doc:para> 0146 </doc:description> 0147 </doc:doc> 0148 </method> 0149 0150 <method name="RecordWindow"> 0151 <arg name="includeMousePointer" direction="in" type="i"> 0152 <doc:doc> 0153 <doc:summary>Whether to include the mouse pointer in the recording. Depends on the user set option 'include mouse pointer' or the parameter sent via dbus.</doc:summary> 0154 <doc:para>Available parameters: -1 - uses the value set in the option 'include mouse pointer', 0 - doesn't include the mouse pointer, 1 - includes the mouse pointer</doc:para> 0155 </doc:doc> 0156 </arg> 0157 <doc:doc> 0158 <doc:description> 0159 <doc:para>Takes a recording of a window.</doc:para> 0160 <doc:para>The user is prompted to select the window to capture. If Spectacle was started via D-Bus, it exits after the shot has been taken.</doc:para> 0161 </doc:description> 0162 </doc:doc> 0163 </method> 0164 0165 <method name="OpenWithoutScreenshot"> 0166 <doc:doc> 0167 <doc:description> 0168 <doc:para>Launches Spectacle without taking a screenshot.</doc:para> 0169 </doc:description> 0170 </doc:doc> 0171 </method> 0172 0173 <signal name="ScreenshotTaken"> 0174 <arg name="fileName" direction="out" type="s"> 0175 <doc:doc> 0176 <doc:summary>The file name with which the screenshot was saved.</doc:summary> 0177 </doc:doc> 0178 </arg> 0179 <doc:doc> 0180 <doc:description> 0181 <doc:para>Emitted if the screenshot was successfully taken.</doc:para> 0182 </doc:description> 0183 </doc:doc> 0184 </signal> 0185 <signal name="ScreenshotFailed"> 0186 <doc:doc> 0187 <doc:description> 0188 <doc:para>Emitted if the screenshot capture failed.</doc:para> 0189 </doc:description> 0190 </doc:doc> 0191 </signal> 0192 <signal name="RecordingTaken"> 0193 <arg name="fileName" direction="out" type="s"> 0194 <doc:doc> 0195 <doc:summary>The file name with which the recording was saved.</doc:summary> 0196 </doc:doc> 0197 </arg> 0198 <doc:doc> 0199 <doc:description> 0200 <doc:para>Emitted if the recording was successfully taken.</doc:para> 0201 </doc:description> 0202 </doc:doc> 0203 </signal> 0204 <signal name="RecordingFailed"> 0205 <doc:doc> 0206 <doc:description> 0207 <doc:para>Emitted if the recording failed.</doc:para> 0208 </doc:description> 0209 </doc:doc> 0210 </signal> 0211 </interface> 0212 </node>