← Back to branch summary

~ubuntu-branches/ubuntu/natty/avant-window-navigator/natty

« back to all changes in this revision

Viewing changes to doc/reference/xml/awn-overlayable.xml

  • Committer: Bazaar Package Importer
  • Author(s): Julien Lavergne
  • Date: 2010-12-17 13:48:28 UTC
  • mfrom: (1.1.9 upstream)
  • Revision ID: james.westby@ubuntu.com-20101217134828-l394fb03wdkxc3mq
Tags: 0.4.1~bzr803-0ubuntu1
https://launchpad.net/bugs/612144
https://launchpad.net/bugs/568555
* New upstream snapshot.
 - Fix a crash with signal 5 in _XError (LP: #612144)
 - Re-add "move to another workspace" to launcher (LP: #568555)
* debian/patches:
 - 02-ftbfs-python-2.6.patch: Refresh.
 - 03-python-import.patch: Refresh.
 - 04-lda-requierement.patch: New patch, lower desktop-agnostic requierement,
   the version in Natty is enough.
 - Drop all others patches, merged upstream.
* debian/copyright:
 - Update copyright years and upstream authors.
* debian/control:
 - Build-depends on valac-0.10 (>= 0.9.1), to force stable version of Vala.
* debian/libawn1.symbols:
 - Update with new symbols. 

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/reference/xml/awn-overlayable.xml
1
 
<?xml version="1.0"?>
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
 
<refentry id="libawn-awn-overlayable">
5
 
<refmeta>
6
 
<refentrytitle role="top_of_page" id="libawn-awn-overlayable.top_of_page">awn-overlayable</refentrytitle>
7
 
<manvolnum>3</manvolnum>
8
 
<refmiscinfo>LIBAWN Library</refmiscinfo>
9
 
</refmeta>
10
 
 
11
 
<refnamediv>
12
 
<refname>awn-overlayable</refname>
13
 
<refpurpose></refpurpose>
14
 
</refnamediv>
15
 
 
16
 
<refsynopsisdiv id="libawn-awn-overlayable.synopsis" role="synopsis">
17
 
<title role="synopsis.title">Synopsis</title>
18
 
<anchor id="AwnOverlayable"/>
19
 
<synopsis>
20
 
#define             <link linkend="AWN-OVERLAYABLE-GET-INTERFACE--CAPS">AWN_OVERLAYABLE_GET_INTERFACE</link>       (inst)
21
 
                    <link linkend="AwnOverlayable-struct">AwnOverlayable</link>;
22
 
                    <link linkend="AwnOverlayableIface">AwnOverlayableIface</link>;
23
 
<link linkend="AwnEffects">AwnEffects</link>*         <link linkend="awn-overlayable-get-effects">awn_overlayable_get_effects</link>         (<link linkend="AwnOverlayable">AwnOverlayable</link> *self);
24
 
<link linkend="void">void</link>                <link linkend="awn-overlayable-add-overlay">awn_overlayable_add_overlay</link>         (<link linkend="AwnOverlayable">AwnOverlayable</link> *self,
25
 
                                                         <link linkend="AwnOverlay">AwnOverlay</link> *overlay);
26
 
<link linkend="void">void</link>                <link linkend="awn-overlayable-remove-overlay">awn_overlayable_remove_overlay</link>      (<link linkend="AwnOverlayable">AwnOverlayable</link> *self,
27
 
                                                         <link linkend="AwnOverlay">AwnOverlay</link> *overlay);
28
 
<link linkend="GList">GList</link>*              <link linkend="awn-overlayable-get-overlays">awn_overlayable_get_overlays</link>        (<link linkend="AwnOverlayable">AwnOverlayable</link> *self);
29
 
</synopsis>
30
 
</refsynopsisdiv>
31
 
 
32
 
<refsect1 id="libawn-awn-overlayable.object-hierarchy" role="object_hierarchy">
33
 
<title role="object_hierarchy.title">Object Hierarchy</title>
34
 
<synopsis>
35
 
  <link linkend="GInterface">GInterface</link>
36
 
   +----AwnOverlayable
37
 
</synopsis>
38
 
</refsect1>
39
 
 
40
 
 
41
 
 
42
 
 
43
 
<refsect1 id="libawn-awn-overlayable.implementations" role="implementations">
44
 
<title role="implementations.title">Known Implementations</title>
45
 
<para>
46
 
AwnOverlayable is implemented by
47
 
 <link linkend="AwnThemedIcon">AwnThemedIcon</link>,  <link linkend="AwnIcon">AwnIcon</link>,  <link linkend="AwnImage">AwnImage</link> and  <link linkend="AwnAppletSimple">AwnAppletSimple</link>.</para>
48
 
</refsect1>
49
 
 
50
 
 
51
 
 
52
 
 
53
 
<refsect1 id="libawn-awn-overlayable.description" role="desc">
54
 
<title role="desc.title">Description</title>
55
 
<para>
56
 
</para>
57
 
</refsect1>
58
 
 
59
 
<refsect1 id="libawn-awn-overlayable.details" role="details">
60
 
<title role="details.title">Details</title>
61
 
<refsect2 id="AWN-OVERLAYABLE-GET-INTERFACE--CAPS" role="macro">
62
 
<title>AWN_OVERLAYABLE_GET_INTERFACE()</title>
63
 
<indexterm zone="AWN-OVERLAYABLE-GET-INTERFACE--CAPS"><primary sortas="AWN_OVERLAYABLE_GET_INTERFACE">AWN_OVERLAYABLE_GET_INTERFACE</primary></indexterm><programlisting>#define             AWN_OVERLAYABLE_GET_INTERFACE(inst)</programlisting>
64
 
<para>
65
 
</para><variablelist role="params">
66
 
<varlistentry><term><parameter>inst</parameter>&#160;:</term>
67
 
<listitem><simpara>
68
 
</simpara></listitem></varlistentry>
69
 
</variablelist></refsect2>
70
 
<refsect2 id="AwnOverlayable-struct" role="struct">
71
 
<title>AwnOverlayable</title>
72
 
<indexterm zone="AwnOverlayable-struct"><primary sortas="AwnOverlayable">AwnOverlayable</primary></indexterm><programlisting>typedef struct _AwnOverlayable AwnOverlayable;</programlisting>
73
 
<para>
74
 
</para></refsect2>
75
 
<refsect2 id="AwnOverlayableIface" role="struct">
76
 
<title>AwnOverlayableIface</title>
77
 
<indexterm zone="AwnOverlayableIface"><primary sortas="AwnOverlayableIface">AwnOverlayableIface</primary></indexterm><programlisting>typedef struct {
78
 
  GTypeInterface parent;
79
 
 
80
 
  AwnEffects*   (*get_effects)          (AwnOverlayable* self);
81
 
} AwnOverlayableIface;
82
 
</programlisting>
83
 
<para>
84
 
</para></refsect2>
85
 
<refsect2 id="awn-overlayable-get-effects" role="function">
86
 
<title>awn_overlayable_get_effects ()</title>
87
 
<indexterm zone="awn-overlayable-get-effects"><primary sortas="awn_overlayable_get_effects">awn_overlayable_get_effects</primary></indexterm><programlisting><link linkend="AwnEffects">AwnEffects</link>*         awn_overlayable_get_effects         (<link linkend="AwnOverlayable">AwnOverlayable</link> *self);</programlisting>
88
 
<para>
89
 
</para>
90
 
<para>
91
 
</para><variablelist role="params">
92
 
<varlistentry><term><parameter>self</parameter>&#160;:</term>
93
 
<listitem><simpara> <link linkend="AwnOverlayable"><type>AwnOverlayable</type></link> instance.
94
 
</simpara></listitem></varlistentry>
95
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="AwnEffects"><type>AwnEffects</type></link> instance managing animations for this instance.
96
 
</simpara></listitem></varlistentry>
97
 
</variablelist></refsect2>
98
 
<refsect2 id="awn-overlayable-add-overlay" role="function">
99
 
<title>awn_overlayable_add_overlay ()</title>
100
 
<indexterm zone="awn-overlayable-add-overlay"><primary sortas="awn_overlayable_add_overlay">awn_overlayable_add_overlay</primary></indexterm><programlisting><link linkend="void">void</link>                awn_overlayable_add_overlay         (<link linkend="AwnOverlayable">AwnOverlayable</link> *self,
101
 
                                                         <link linkend="AwnOverlay">AwnOverlay</link> *overlay);</programlisting>
102
 
<para>
103
 
Adds an overlay to the list of rendered overlays.</para>
104
 
<para>
105
 
</para><variablelist role="params">
106
 
<varlistentry><term><parameter>self</parameter>&#160;:</term>
107
 
<listitem><simpara> <link linkend="AwnOverlayable"><type>AwnOverlayable</type></link> instance.
108
 
</simpara></listitem></varlistentry>
109
 
<varlistentry><term><parameter>overlay</parameter>&#160;:</term>
110
 
<listitem><simpara> <link linkend="AwnOverlay"><type>AwnOverlay</type></link> instance which should be added.
111
 
</simpara></listitem></varlistentry>
112
 
</variablelist></refsect2>
113
 
<refsect2 id="awn-overlayable-remove-overlay" role="function">
114
 
<title>awn_overlayable_remove_overlay ()</title>
115
 
<indexterm zone="awn-overlayable-remove-overlay"><primary sortas="awn_overlayable_remove_overlay">awn_overlayable_remove_overlay</primary></indexterm><programlisting><link linkend="void">void</link>                awn_overlayable_remove_overlay      (<link linkend="AwnOverlayable">AwnOverlayable</link> *self,
116
 
                                                         <link linkend="AwnOverlay">AwnOverlay</link> *overlay);</programlisting>
117
 
<para>
118
 
Removes overlay from the list of rendered overlays.</para>
119
 
<para>
120
 
</para><variablelist role="params">
121
 
<varlistentry><term><parameter>self</parameter>&#160;:</term>
122
 
<listitem><simpara> <link linkend="AwnOverlayable"><type>AwnOverlayable</type></link> instance.
123
 
</simpara></listitem></varlistentry>
124
 
<varlistentry><term><parameter>overlay</parameter>&#160;:</term>
125
 
<listitem><simpara> <link linkend="AwnOverlay"><type>AwnOverlay</type></link> which was previously added using
126
 
 awn_overlayable_add_overlay.
127
 
</simpara></listitem></varlistentry>
128
 
</variablelist></refsect2>
129
 
<refsect2 id="awn-overlayable-get-overlays" role="function">
130
 
<title>awn_overlayable_get_overlays ()</title>
131
 
<indexterm zone="awn-overlayable-get-overlays"><primary sortas="awn_overlayable_get_overlays">awn_overlayable_get_overlays</primary></indexterm><programlisting><link linkend="GList">GList</link>*              awn_overlayable_get_overlays        (<link linkend="AwnOverlayable">AwnOverlayable</link> *self);</programlisting>
132
 
<para>
133
 
</para>
134
 
<para>
135
 
</para><variablelist role="params">
136
 
<varlistentry><term><parameter>self</parameter>&#160;:</term>
137
 
<listitem><simpara> <link linkend="AwnOverlayable"><type>AwnOverlayable</type></link> instance.
138
 
</simpara></listitem></varlistentry>
139
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a newly-allocated list of the overlays added for this instance.
140
 
</simpara></listitem></varlistentry>
141
 
</variablelist></refsect2>
142
 
 
143
 
</refsect1>
144
 
 
145
 
 
146
 
 
147
 
 
148
 
</refentry>