← Back to branch summary

~darkxst/ubuntu/saucy/gnome-shell/upstart_log

« back to all changes in this revision

Viewing changes to docs/reference/shell/doc-gen-org.gnome.Shell.Screenshot.xml

  • Committer: Package Import Robot
  • Author(s): Jeremy Bicha
  • Date: 2013-05-31 12:01:12 UTC
  • mfrom: (1.1.49) (19.1.36 experimental)
  • Revision ID: package-import@ubuntu.com-20130531120112-ew91khxf051x9i2r
Tags: 3.8.2-1ubuntu1
https://launchpad.net/bugs/1185869
https://launchpad.net/bugs/1185721
https://launchpad.net/bugs/1064584
* Merge with Debian (LP: #1185869, #1185721). Remaining changes:
  - debian/control.in:
    + Build-depend on libsystemd-login-dev & libsystemd-daemon-dev
    + Depend on gdm instead of gdm3
    + Don't recommend gnome-session-fallback
  - debian/patches/40_change-pam-name-to-match-gdm.patch:
  - debian/patches/revert-suspend-break.patch:
    + Disabled, not needed on Ubuntu
  - debian/patches/ubuntu-lightdm-user-switching.patch:
    + Allow user switching when using LightDM. Thanks Gerhard Stein
      for rebasing against gnome-shell 3.8!
  - debian/patches/ubuntu_lock_on_suspend.patch
    + Respect Ubuntu's lock-on-suspend setting.
      Disabled until it can be rewritten.
  - debian/patches/git_relock_screen_after_crash.patch:
    + Add Upstream fix for unlocked session after crash (LP: #1064584)
* Note that the new GNOME Classic mode (which requires installing
  gnome-shell-extensions) won't work until gnome-session 3.8 is
  available in Ubuntu

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/shell/doc-gen-org.gnome.Shell.Screenshot.xml
 
1
<?xml version="1.0" encoding="utf-8"?>
 
2
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
 
3
               "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
 
4
]>
 
5
<refentry id="gdbus-org.gnome.Shell.Screenshot">
 
6
  <refmeta>    <refentrytitle role="top_of_page" id="gdbus-interface-org-gnome-Shell-Screenshot.top_of_page">org.gnome.Shell.Screenshot</refentrytitle>
 
7
  <indexterm zone="gdbus-interface-org-gnome-Shell-Screenshot.top_of_page"><primary sortas="org.gnome.Shell.Screenshot">org.gnome.Shell.Screenshot</primary></indexterm>
 
8
  </refmeta>  <refnamediv>    <refname>org.gnome.Shell.Screenshot</refname>    <refpurpose>Screenshot interface</refpurpose>  </refnamediv>  <refsynopsisdiv role="synopsis">
 
9
    <title role="synopsis.title">Methods</title>
 
10
    <synopsis>
 
11
<link linkend="gdbus-method-org-gnome-Shell-Screenshot.Screenshot">Screenshot</link>       (IN  b include_cursor,
 
12
                  IN  b flash,
 
13
                  IN  s filename,
 
14
                  OUT b success,
 
15
                  OUT s filename_used);
 
16
<link linkend="gdbus-method-org-gnome-Shell-Screenshot.ScreenshotWindow">ScreenshotWindow</link> (IN  b include_frame,
 
17
                  IN  b include_cursor,
 
18
                  IN  b flash,
 
19
                  IN  s filename,
 
20
                  OUT b success,
 
21
                  OUT s filename_used);
 
22
<link linkend="gdbus-method-org-gnome-Shell-Screenshot.ScreenshotArea">ScreenshotArea</link>   (IN  i x,
 
23
                  IN  i y,
 
24
                  IN  i width,
 
25
                  IN  i height,
 
26
                  IN  b flash,
 
27
                  IN  s filename,
 
28
                  OUT b success,
 
29
                  OUT s filename_used);
 
30
<link linkend="gdbus-method-org-gnome-Shell-Screenshot.FlashArea">FlashArea</link>        (IN  i x,
 
31
                  IN  i y,
 
32
                  IN  i width,
 
33
                  IN  i height);
 
34
<link linkend="gdbus-method-org-gnome-Shell-Screenshot.SelectArea">SelectArea</link>       (OUT i x,
 
35
                  OUT i y,
 
36
                  OUT i width,
 
37
                  OUT i height);
 
38
</synopsis>
 
39
  </refsynopsisdiv>
 
40
<refsect1 role="desc" id="gdbus-interface-org-gnome-Shell-Screenshot">
 
41
  <title role="desc.title">Description</title>
 
42
  <para>      The interface used to capture pictures of the screen contents.
 
43
</para>
 
44
</refsect1>
 
45
<refsect1 role="details" id="gdbus-methods-org.gnome.Shell.Screenshot">
 
46
  <title role="details.title">Method Details</title>
 
47
<refsect2 role="method" id="gdbus-method-org-gnome-Shell-Screenshot.Screenshot">
 
48
  <title>The Screenshot() method</title>
 
49
  <indexterm zone="gdbus-method-org-gnome-Shell-Screenshot.Screenshot"><primary sortas="org.gnome.Shell.Screenshot.Screenshot">org.gnome.Shell.Screenshot.Screenshot()</primary></indexterm>
 
50
<programlisting>
 
51
Screenshot (IN  b include_cursor,
 
52
            IN  b flash,
 
53
            IN  s filename,
 
54
            OUT b success,
 
55
            OUT s filename_used);
 
56
</programlisting>
 
57
<para>        Takes a screenshot of the whole screen and saves it
 
58
        in <parameter>filename</parameter> as png image, it returns a boolean
 
59
        indicating whether the operation was successful or not.
 
60
        <parameter>filename</parameter> can either be an absolute path or a basename, in
 
61
        which case the screenshot will be saved in the $XDG_PICTURES_DIR
 
62
        or the home directory if it doesn't exist. The filename used
 
63
        to save the screenshot will be returned in <parameter>filename_used</parameter>.
 
64
</para>
 
65
<variablelist role="params">
 
66
<varlistentry>
 
67
  <term><literal>IN b <parameter>include_cursor</parameter></literal>:</term>
 
68
  <listitem><para>Whether to include the cursor image or not</para></listitem>
 
69
</varlistentry>
 
70
<varlistentry>
 
71
  <term><literal>IN b <parameter>flash</parameter></literal>:</term>
 
72
  <listitem><para>Whether to flash the screen or not</para></listitem>
 
73
</varlistentry>
 
74
<varlistentry>
 
75
  <term><literal>IN s <parameter>filename</parameter></literal>:</term>
 
76
  <listitem><para>The filename for the screenshot</para></listitem>
 
77
</varlistentry>
 
78
<varlistentry>
 
79
  <term><literal>OUT b <parameter>success</parameter></literal>:</term>
 
80
  <listitem><para>whether the screenshot was captured</para></listitem>
 
81
</varlistentry>
 
82
<varlistentry>
 
83
  <term><literal>OUT s <parameter>filename_used</parameter></literal>:</term>
 
84
  <listitem><para>the file where the screenshot was saved</para></listitem>
 
85
</varlistentry>
 
86
</variablelist>
 
87
</refsect2>
 
88
<refsect2 role="method" id="gdbus-method-org-gnome-Shell-Screenshot.ScreenshotWindow">
 
89
  <title>The ScreenshotWindow() method</title>
 
90
  <indexterm zone="gdbus-method-org-gnome-Shell-Screenshot.ScreenshotWindow"><primary sortas="org.gnome.Shell.Screenshot.ScreenshotWindow">org.gnome.Shell.Screenshot.ScreenshotWindow()</primary></indexterm>
 
91
<programlisting>
 
92
ScreenshotWindow (IN  b include_frame,
 
93
                  IN  b include_cursor,
 
94
                  IN  b flash,
 
95
                  IN  s filename,
 
96
                  OUT b success,
 
97
                  OUT s filename_used);
 
98
</programlisting>
 
99
<para>        Takes a screenshot of the focused window (optionally omitting the frame)
 
100
        and saves it in <parameter>filename</parameter> as png image, it returns a boolean
 
101
        indicating whether the operation was successful or not.
 
102
        <parameter>filename</parameter> can either be an absolute path or a basename, in
 
103
        which case the screenshot will be saved in the $XDG_PICTURES_DIR
 
104
        or the home directory if it doesn't exist. The filename used
 
105
        to save the screenshot will be returned in <parameter>filename_used</parameter>.
 
106
</para>
 
107
<variablelist role="params">
 
108
<varlistentry>
 
109
  <term><literal>IN b <parameter>include_frame</parameter></literal>:</term>
 
110
  <listitem><para>Whether to include the frame or not</para></listitem>
 
111
</varlistentry>
 
112
<varlistentry>
 
113
  <term><literal>IN b <parameter>include_cursor</parameter></literal>:</term>
 
114
  <listitem><para>Whether to include the cursor image or not</para></listitem>
 
115
</varlistentry>
 
116
<varlistentry>
 
117
  <term><literal>IN b <parameter>flash</parameter></literal>:</term>
 
118
  <listitem><para>Whether to flash the window area or not</para></listitem>
 
119
</varlistentry>
 
120
<varlistentry>
 
121
  <term><literal>IN s <parameter>filename</parameter></literal>:</term>
 
122
  <listitem><para>The filename for the screenshot</para></listitem>
 
123
</varlistentry>
 
124
<varlistentry>
 
125
  <term><literal>OUT b <parameter>success</parameter></literal>:</term>
 
126
  <listitem><para>whether the screenshot was captured</para></listitem>
 
127
</varlistentry>
 
128
<varlistentry>
 
129
  <term><literal>OUT s <parameter>filename_used</parameter></literal>:</term>
 
130
  <listitem><para>the file where the screenshot was saved</para></listitem>
 
131
</varlistentry>
 
132
</variablelist>
 
133
</refsect2>
 
134
<refsect2 role="method" id="gdbus-method-org-gnome-Shell-Screenshot.ScreenshotArea">
 
135
  <title>The ScreenshotArea() method</title>
 
136
  <indexterm zone="gdbus-method-org-gnome-Shell-Screenshot.ScreenshotArea"><primary sortas="org.gnome.Shell.Screenshot.ScreenshotArea">org.gnome.Shell.Screenshot.ScreenshotArea()</primary></indexterm>
 
137
<programlisting>
 
138
ScreenshotArea (IN  i x,
 
139
                IN  i y,
 
140
                IN  i width,
 
141
                IN  i height,
 
142
                IN  b flash,
 
143
                IN  s filename,
 
144
                OUT b success,
 
145
                OUT s filename_used);
 
146
</programlisting>
 
147
<para>        Takes a screenshot of the passed in area and saves it
 
148
        in <parameter>filename</parameter> as png image, it returns a boolean
 
149
        indicating whether the operation was successful or not.
 
150
        <parameter>filename</parameter> can either be an absolute path or a basename, in
 
151
        which case the screenshot will be saved in the $XDG_PICTURES_DIR
 
152
        or the home directory if it doesn't exist. The filename used
 
153
        to save the screenshot will be returned in <parameter>filename_used</parameter>.
 
154
</para>
 
155
<variablelist role="params">
 
156
<varlistentry>
 
157
  <term><literal>IN i <parameter>x</parameter></literal>:</term>
 
158
  <listitem><para>the X coordinate of the area to capture</para></listitem>
 
159
</varlistentry>
 
160
<varlistentry>
 
161
  <term><literal>IN i <parameter>y</parameter></literal>:</term>
 
162
  <listitem><para>the Y coordinate of the area to capture</para></listitem>
 
163
</varlistentry>
 
164
<varlistentry>
 
165
  <term><literal>IN i <parameter>width</parameter></literal>:</term>
 
166
  <listitem><para>the width of the area to capture</para></listitem>
 
167
</varlistentry>
 
168
<varlistentry>
 
169
  <term><literal>IN i <parameter>height</parameter></literal>:</term>
 
170
  <listitem><para>the height of the area to capture</para></listitem>
 
171
</varlistentry>
 
172
<varlistentry>
 
173
  <term><literal>IN b <parameter>flash</parameter></literal>:</term>
 
174
  <listitem><para>whether to flash the area or not</para></listitem>
 
175
</varlistentry>
 
176
<varlistentry>
 
177
  <term><literal>IN s <parameter>filename</parameter></literal>:</term>
 
178
  <listitem><para>the filename for the screenshot</para></listitem>
 
179
</varlistentry>
 
180
<varlistentry>
 
181
  <term><literal>OUT b <parameter>success</parameter></literal>:</term>
 
182
  <listitem><para>whether the screenshot was captured</para></listitem>
 
183
</varlistentry>
 
184
<varlistentry>
 
185
  <term><literal>OUT s <parameter>filename_used</parameter></literal>:</term>
 
186
  <listitem><para>the file where the screenshot was saved</para></listitem>
 
187
</varlistentry>
 
188
</variablelist>
 
189
</refsect2>
 
190
<refsect2 role="method" id="gdbus-method-org-gnome-Shell-Screenshot.FlashArea">
 
191
  <title>The FlashArea() method</title>
 
192
  <indexterm zone="gdbus-method-org-gnome-Shell-Screenshot.FlashArea"><primary sortas="org.gnome.Shell.Screenshot.FlashArea">org.gnome.Shell.Screenshot.FlashArea()</primary></indexterm>
 
193
<programlisting>
 
194
FlashArea (IN  i x,
 
195
           IN  i y,
 
196
           IN  i width,
 
197
           IN  i height);
 
198
</programlisting>
 
199
<para>        Renders a flash spot effect in the specified rectangle of the screen.
 
200
</para>
 
201
<variablelist role="params">
 
202
<varlistentry>
 
203
  <term><literal>IN i <parameter>x</parameter></literal>:</term>
 
204
  <listitem><para>the X coordinate of the area to flash</para></listitem>
 
205
</varlistentry>
 
206
<varlistentry>
 
207
  <term><literal>IN i <parameter>y</parameter></literal>:</term>
 
208
  <listitem><para>the Y coordinate of the area to flash</para></listitem>
 
209
</varlistentry>
 
210
<varlistentry>
 
211
  <term><literal>IN i <parameter>width</parameter></literal>:</term>
 
212
  <listitem><para>the width of the area to flash</para></listitem>
 
213
</varlistentry>
 
214
<varlistentry>
 
215
  <term><literal>IN i <parameter>height</parameter></literal>:</term>
 
216
  <listitem><para>the height of the area to flash</para></listitem>
 
217
</varlistentry>
 
218
</variablelist>
 
219
</refsect2>
 
220
<refsect2 role="method" id="gdbus-method-org-gnome-Shell-Screenshot.SelectArea">
 
221
  <title>The SelectArea() method</title>
 
222
  <indexterm zone="gdbus-method-org-gnome-Shell-Screenshot.SelectArea"><primary sortas="org.gnome.Shell.Screenshot.SelectArea">org.gnome.Shell.Screenshot.SelectArea()</primary></indexterm>
 
223
<programlisting>
 
224
SelectArea (OUT i x,
 
225
            OUT i y,
 
226
            OUT i width,
 
227
            OUT i height);
 
228
</programlisting>
 
229
<para>        Interactively allows the user to select a rectangular area of
 
230
        the screen, and returns its coordinates.
 
231
</para>
 
232
<variablelist role="params">
 
233
<varlistentry>
 
234
  <term><literal>OUT i <parameter>x</parameter></literal>:</term>
 
235
  <listitem><para>the X coordinate of the selected area</para></listitem>
 
236
</varlistentry>
 
237
<varlistentry>
 
238
  <term><literal>OUT i <parameter>y</parameter></literal>:</term>
 
239
  <listitem><para>the Y coordinate of the selected area</para></listitem>
 
240
</varlistentry>
 
241
<varlistentry>
 
242
  <term><literal>OUT i <parameter>width</parameter></literal>:</term>
 
243
  <listitem><para>the width of the selected area</para></listitem>
 
244
</varlistentry>
 
245
<varlistentry>
 
246
  <term><literal>OUT i <parameter>height</parameter></literal>:</term>
 
247
  <listitem><para>the height of the selected area</para></listitem>
 
248
</varlistentry>
 
249
</variablelist>
 
250
</refsect2>
 
251
</refsect1>
 
252
</refentry>
 
253