screenshot: document the Screenshot interface
Use gdbus-codegen to generate a docbook for the screenshot interface, and add it to our gtk-doc. https://bugzilla.gnome.org/show_bug.cgi?id=688004
This commit is contained in:
Cosimo Cecchi
parent
57bd43baf3
commit
e96867f757
128
data/org.gnome.Shell.Screenshot.xml
Normal file
128
data/org.gnome.Shell.Screenshot.xml
Normal file
@ -0,0 +1,128 @@
|
|||||||
|
<!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>
|
||||||
|
|
||||||
|
<!--
|
||||||
|
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>
|
||||||
@ -88,11 +88,18 @@ doc-gen-org.gnome.Shell.SearchProvider2.xml: $(top_srcdir)/data/org.gnome.ShellS
|
|||||||
--generate-docbook doc-gen \
|
--generate-docbook doc-gen \
|
||||||
$(top_srcdir)/data/org.gnome.ShellSearchProvider2.xml
|
$(top_srcdir)/data/org.gnome.ShellSearchProvider2.xml
|
||||||
|
|
||||||
|
doc-gen-org.gnome.Shell.Screenshot.xml: $(top_srcdir)/data/org.gnome.Shell.Screenshot.xml
|
||||||
|
gdbus-codegen \
|
||||||
|
--interface-prefix org.gnome.Shell.Screenshot. \
|
||||||
|
--generate-docbook doc-gen \
|
||||||
|
$(top_srcdir)/data/org.gnome.Shell.Screenshot.xml
|
||||||
|
|
||||||
# Extra SGML files that are included by $(DOC_MAIN_SGML_FILE).
|
# Extra SGML files that are included by $(DOC_MAIN_SGML_FILE).
|
||||||
# e.g. content_files=running.sgml building.sgml changes-2.0.sgml
|
# e.g. content_files=running.sgml building.sgml changes-2.0.sgml
|
||||||
content_files= \
|
content_files= \
|
||||||
doc-gen-org.gnome.Shell.SearchProvider.xml \
|
doc-gen-org.gnome.Shell.SearchProvider.xml \
|
||||||
doc-gen-org.gnome.Shell.SearchProvider2.xml
|
doc-gen-org.gnome.Shell.SearchProvider2.xml \
|
||||||
|
doc-gen-org.gnome.Shell.Screenshot.xml
|
||||||
|
|
||||||
# SGML files where gtk-doc abbrevations (#GtkWidget) are expanded
|
# SGML files where gtk-doc abbrevations (#GtkWidget) are expanded
|
||||||
# These files must be listed here *and* in content_files
|
# These files must be listed here *and* in content_files
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user