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
|
<?xml version="1.0"?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
"http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd"
[
<!ENTITY % local.common.attrib "xmlns:xi CDATA #FIXED 'http://www.w3.org/2003/XInclude'">
<!ENTITY % gtkdocentities SYSTEM "xml/gtkdocentities.ent">
%gtkdocentities;
]>
<book id="index">
<bookinfo>
<title>&package_name; Reference Manual</title>
<releaseinfo>
<para>
This document is the API reference for for &package_name; &package_version;.
</para>
<para>
If you find any issues in this API reference, please report it using
<ulink type="http" url="&package_bugreport;">the online bug reporting tool</ulink>.
</para>
</releaseinfo>
<legalnotice>
<para> The MIT License (MIT) </para>
<copyright>
<year>2014</year>
<holder>Dennis Blommesteijn</holder>
</copyright>
<copyright>
<year>2019</year>
<holder>Sophie Winter</holder>
</copyright>
<para>
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
</para>
<para>
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
</para>
<para>
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
</para>
</legalnotice>
</bookinfo>
<part id="gtk-layer-shell">
<title>API Reference</title>
<partintro>
<para>
Gtk-layer-shell is a library to write <ulink type ="http" url="https://www.gtk.org/">GTK</ulink>
applications that use <ulink type="https" url="https://github.com/swaywm/wlr-protocols/blob/master/unstable/wlr-layer-shell-unstable-v1.xml">Layer Shell</ulink>.
Layer Shell is a Wayland protocol for desktop shell components,
such as panels, notifications and wallpapers. You can use it to anchor
your windows to a corner or edge of the output, or stretch them across
the entire output.
</para>
<para>
This library only makes sense on Wayland compositors that support Layer
Shell, and will not work on X11. It supports all Layer Shell features
including popups and popovers (GTK popups Just Workâ˘). Please open issues
for any bugs you come across.
</para>
</partintro>
<xi:include href="xml/gtk-layer-shell.xml"/>
</part>
<index id="api-index-full">
<title>API Index</title>
<xi:include href="xml/api-index-full.xml"><xi:fallback /></xi:include>
</index>
<index id="deprecated-api-index" role="deprecated">
<title>Index of deprecated API</title>
<xi:include href="xml/api-index-deprecated.xml"><xi:fallback /></xi:include>
</index>
<!-- <xi:include href="xml/annotation-glossary.xml"><xi:fallback /></xi:include> -->
</book>
|
