summaryrefslogtreecommitdiffstats
path: root/data/dbus-interfaces/org.gnome.Shell.Screenshot.xml
blob: 528b01ecba671db3e1d77f8efe2a3ca450c2400a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
<!DOCTYPE node PUBLIC
'-//freedesktop//DTD D-BUS Object Introspection 1.0//EN'
'http://www.freedesktop.org/standards/dbus/1.0/introspect.dtd'>
<node>

  <!--
      org.gnome.Shell.Screenshot:
      @short_description: Screenshot interface

      The interface used to capture pictures of the screen contents.
  -->
  <interface name="org.gnome.Shell.Screenshot">

    <!--
        Screenshot:
        @filename: The filename for the screenshot
        @include_cursor: Whether to include the cursor image or not
        @flash: Whether to flash the screen or not
        @success: whether the screenshot was captured
        @filename_used: the file where the screenshot was saved

        Takes a screenshot of the whole screen and saves it
        in @filename as png image, it returns a boolean
        indicating whether the operation was successful or not.
        @filename can either be an absolute path or a basename, in
        which case the screenshot will be saved in the $XDG_PICTURES_DIR
        or the home directory if it doesn't exist. The filename used
        to save the screenshot will be returned in @filename_used.
    -->
    <method name="Screenshot">
      <arg type="b" direction="in" name="include_cursor"/>
      <arg type="b" direction="in" name="flash"/>
      <arg type="s" direction="in" name="filename"/>
      <arg type="b" direction="out" name="success"/>
      <arg type="s" direction="out" name="filename_used"/>
    </method>

    <!--
        ScreenshotWindow:
        @include_frame: Whether to include the frame or not
        @include_cursor: Whether to include the cursor image or not
        @flash: Whether to flash the window area or not
        @filename: The filename for the screenshot
        @success: whether the screenshot was captured
        @filename_used: the file where the screenshot was saved

        Takes a screenshot of the focused window (optionally omitting the frame)
        and saves it in @filename as png image, it returns a boolean
        indicating whether the operation was successful or not.
        @filename can either be an absolute path or a basename, in
        which case the screenshot will be saved in the $XDG_PICTURES_DIR
        or the home directory if it doesn't exist. The filename used
        to save the screenshot will be returned in @filename_used.
    -->
    <method name="ScreenshotWindow">
      <arg type="b" direction="in" name="include_frame"/>
      <arg type="b" direction="in" name="include_cursor"/>
      <arg type="b" direction="in" name="flash"/>
      <arg type="s" direction="in" name="filename"/>
      <arg type="b" direction="out" name="success"/>
      <arg type="s" direction="out" name="filename_used"/>
    </method>

    <!--
        ScreenshotArea:
        @x: the X coordinate of the area to capture
        @y: the Y coordinate of the area to capture
        @width: the width of the area to capture
        @height: the height of the area to capture
        @flash: whether to flash the area or not
        @filename: the filename for the screenshot
        @success: whether the screenshot was captured
        @filename_used: the file where the screenshot was saved

        Takes a screenshot of the passed in area and saves it
        in @filename as png image, it returns a boolean
        indicating whether the operation was successful or not.
        @filename can either be an absolute path or a basename, in
        which case the screenshot will be saved in the $XDG_PICTURES_DIR
        or the home directory if it doesn't exist. The filename used
        to save the screenshot will be returned in @filename_used.
    -->
    <method name="ScreenshotArea">
      <arg type="i" direction="in" name="x"/>
      <arg type="i" direction="in" name="y"/>
      <arg type="i" direction="in" name="width"/>
      <arg type="i" direction="in" name="height"/>
      <arg type="b" direction="in" name="flash"/>
      <arg type="s" direction="in" name="filename"/>
      <arg type="b" direction="out" name="success"/>
      <arg type="s" direction="out" name="filename_used"/>
    </method>

    <!--
        PickColor:

        Picks a color and returns the result.

        The @result vardict contains:
        <variablelist>
          <varlistentry>
            <term>color (ddd)</term>
            <listitem><para>The color, RGB values in the range [0,1].</para></listitem>
          </varlistentry>
        </variablelist>
    -->
    <method name="PickColor">
      <arg type="a{sv}" direction="out" name="result"/>
    </method>

    <!--
        FlashArea:
        @x: the X coordinate of the area to flash
        @y: the Y coordinate of the area to flash
        @width: the width of the area to flash
        @height: the height of the area to flash

        Renders a flash spot effect in the specified rectangle of the screen.
    -->
    <method name="FlashArea">
      <arg type="i" direction="in" name="x"/>
      <arg type="i" direction="in" name="y"/>
      <arg type="i" direction="in" name="width"/>
      <arg type="i" direction="in" name="height"/>
    </method>

    <!--
        SelectArea:
        @x: the X coordinate of the selected area
        @y: the Y coordinate of the selected area
        @width: the width of the selected area
        @height: the height of the selected area

        Interactively allows the user to select a rectangular area of
        the screen, and returns its coordinates.
    -->
    <method name="SelectArea">
      <arg type="i" direction="out" name="x"/>
      <arg type="i" direction="out" name="y"/>
      <arg type="i" direction="out" name="width"/>
      <arg type="i" direction="out" name="height"/>
    </method>

  </interface>
</node>