3
3
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
4
4
<refentry id="AwnAppletSimple">
6
<refentrytitle role="top_of_page">AwnAppletSimple</refentrytitle>
6
<refentrytitle role="top_of_page" id="AwnAppletSimple.top_of_page">AwnAppletSimple</refentrytitle>
7
7
<manvolnum>3</manvolnum>
8
8
<refmiscinfo>LIBAWN Library</refmiscinfo>
12
12
<refname>AwnAppletSimple</refname>
13
13
<refpurpose></refpurpose>
14
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
17
<refsynopsisdiv role="synopsis">
16
<refsynopsisdiv id="AwnAppletSimple.synopsis" role="synopsis">
18
17
<title role="synopsis.title">Synopsis</title>
24
20
<link linkend="AwnAppletSimplePrivate">AwnAppletSimplePrivate</link>;
25
21
<link linkend="AwnAppletSimple-struct">AwnAppletSimple</link>;
26
<link linkend="GtkWidget">GtkWidget</link>* <link linkend="awn-applet-simple-new">awn_applet_simple_new</link> (const <link linkend="gchar">gchar</link> *uid,
22
<link linkend="GtkWidget">GtkWidget</link> * <link linkend="awn-applet-simple-new">awn_applet_simple_new</link> (const <link linkend="gchar">gchar</link> *uid,
27
23
<link linkend="gint">gint</link> orient,
28
24
<link linkend="gint">gint</link> height);
29
25
<link linkend="void">void</link> <link linkend="awn-applet-simple-set-icon">awn_applet_simple_set_icon</link> (<link linkend="AwnAppletSimple">AwnAppletSimple</link> *simple,
30
26
<link linkend="GdkPixbuf">GdkPixbuf</link> *pixbuf);
31
27
<link linkend="void">void</link> <link linkend="awn-applet-simple-set-temp-icon">awn_applet_simple_set_temp_icon</link> (<link linkend="AwnAppletSimple">AwnAppletSimple</link> *simple,
32
28
<link linkend="GdkPixbuf">GdkPixbuf</link> *pixbuf);
33
<link linkend="AwnEffects">AwnEffects</link>* <link linkend="awn-applet-simple-get-effects">awn_applet_simple_get_effects</link> (<link linkend="AwnAppletSimple">AwnAppletSimple</link> *simple);
29
<link linkend="AwnEffects">AwnEffects</link> * <link linkend="awn-applet-simple-get-effects">awn_applet_simple_get_effects</link> (<link linkend="AwnAppletSimple">AwnAppletSimple</link> *simple);
38
<refsect1 role="object_hierarchy">
33
<refsect1 id="AwnAppletSimple.object-hierarchy" role="object_hierarchy">
39
34
<title role="object_hierarchy.title">Object Hierarchy</title>
42
36
<link linkend="GObject">GObject</link>
43
37
+----<link linkend="GInitiallyUnowned">GInitiallyUnowned</link>
44
38
+----<link linkend="GtkObject">GtkObject</link>
49
43
+----<link linkend="AwnApplet">AwnApplet</link>
50
44
+----AwnAppletSimple
57
<refsect1 role="impl_interfaces">
50
<refsect1 id="AwnAppletSimple.implemented-interfaces" role="impl_interfaces">
58
51
<title role="impl_interfaces.title">Implemented Interfaces</title>
60
53
AwnAppletSimple implements
61
54
<link linkend="AtkImplementorIface">AtkImplementorIface</link> and <link linkend="GtkBuildable">GtkBuildable</link>.</para>
69
<refsect1 role="desc">
61
<refsect1 id="AwnAppletSimple.description" role="desc">
70
62
<title role="desc.title">Description</title>
76
<refsect1 role="details">
67
<refsect1 id="AwnAppletSimple.details" role="details">
77
68
<title role="details.title">Details</title>
79
<title><anchor id="AwnAppletSimplePrivate" role="struct"/>AwnAppletSimplePrivate</title>
80
<indexterm><primary>AwnAppletSimplePrivate</primary></indexterm><programlisting>typedef struct _AwnAppletSimplePrivate AwnAppletSimplePrivate;</programlisting>
85
<title><anchor id="AwnAppletSimple-struct" role="struct"/>AwnAppletSimple</title>
86
<indexterm><primary>AwnAppletSimple</primary></indexterm><programlisting>typedef struct _AwnAppletSimple AwnAppletSimple;</programlisting>
91
<title><anchor id="awn-applet-simple-new" role="function"/>awn_applet_simple_new ()</title>
92
<indexterm><primary>awn_applet_simple_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>* awn_applet_simple_new (const <link linkend="gchar">gchar</link> *uid,
69
<refsect2 id="AwnAppletSimplePrivate" role="struct">
70
<title>AwnAppletSimplePrivate</title>
71
<indexterm zone="AwnAppletSimplePrivate"><primary sortas="AwnAppletSimplePrivate">AwnAppletSimplePrivate</primary></indexterm><programlisting>typedef struct _AwnAppletSimplePrivate AwnAppletSimplePrivate;</programlisting>
74
<refsect2 id="AwnAppletSimple-struct" role="struct">
75
<title>AwnAppletSimple</title>
76
<indexterm zone="AwnAppletSimple-struct"><primary sortas="AwnAppletSimple">AwnAppletSimple</primary></indexterm><programlisting>typedef struct _AwnAppletSimple AwnAppletSimple;</programlisting>
79
<refsect2 id="awn-applet-simple-new" role="function">
80
<title>awn_applet_simple_new ()</title>
81
<indexterm zone="awn-applet-simple-new"><primary sortas="awn_applet_simple_new">awn_applet_simple_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link> * awn_applet_simple_new (const <link linkend="gchar">gchar</link> *uid,
93
82
<link linkend="gint">gint</link> orient,
94
83
<link linkend="gint">gint</link> height);</programlisting>
97
86
effects applied to its icon automatically if <link linkend="awn-applet-simple-set-icon"><function>awn_applet_simple_set_icon()</function></link> or
98
87
<link linkend="awn-applet-simple-set-temp-icon"><function>awn_applet_simple_set_temp_icon()</function></link> are used to specify the applet icon.</para>
101
89
</para><variablelist role="params">
102
<varlistentry><term><parameter>uid</parameter> :</term>
90
<varlistentry><term><parameter>uid</parameter> :</term>
103
91
<listitem><simpara> The unique identifier of the instance of the applet on the dock.
104
92
</simpara></listitem></varlistentry>
105
<varlistentry><term><parameter>orient</parameter> :</term>
93
<varlistentry><term><parameter>orient</parameter> :</term>
106
94
<listitem><simpara> The orientation of the applet - see <link linkend="AwnOrientation"><type>AwnOrientation</type></link>.
107
95
</simpara></listitem></varlistentry>
108
<varlistentry><term><parameter>height</parameter> :</term>
96
<varlistentry><term><parameter>height</parameter> :</term>
109
97
<listitem><simpara> The height of the applet.
110
98
</simpara></listitem></varlistentry>
111
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a new instance of an applet.
99
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a new instance of an applet.
112
100
</simpara></listitem></varlistentry>
113
101
</variablelist></refsect2>
115
<title><anchor id="awn-applet-simple-set-icon" role="function"/>awn_applet_simple_set_icon ()</title>
116
<indexterm><primary>awn_applet_simple_set_icon</primary></indexterm><programlisting><link linkend="void">void</link> awn_applet_simple_set_icon (<link linkend="AwnAppletSimple">AwnAppletSimple</link> *simple,
102
<refsect2 id="awn-applet-simple-set-icon" role="function">
103
<title>awn_applet_simple_set_icon ()</title>
104
<indexterm zone="awn-applet-simple-set-icon"><primary sortas="awn_applet_simple_set_icon">awn_applet_simple_set_icon</primary></indexterm><programlisting><link linkend="void">void</link> awn_applet_simple_set_icon (<link linkend="AwnAppletSimple">AwnAppletSimple</link> *simple,
117
105
<link linkend="GdkPixbuf">GdkPixbuf</link> *pixbuf);</programlisting>
119
107
Sets the applet icon to the pixbuf provided as an argument. A private copy
121
109
original argument is left unchanged. The caller retains ownership of pixbuf
122
110
and is required to unref it when it is no longer required.</para>
125
112
</para><variablelist role="params">
126
<varlistentry><term><parameter>simple</parameter> :</term>
113
<varlistentry><term><parameter>simple</parameter> :</term>
127
114
<listitem><simpara> The applet whose icon is being set.
128
115
</simpara></listitem></varlistentry>
129
<varlistentry><term><parameter>pixbuf</parameter> :</term>
116
<varlistentry><term><parameter>pixbuf</parameter> :</term>
130
117
<listitem><simpara> The pixbuf image to use as the icon.
131
118
</simpara></listitem></varlistentry>
132
119
</variablelist></refsect2>
134
<title><anchor id="awn-applet-simple-set-temp-icon" role="function"/>awn_applet_simple_set_temp_icon ()</title>
135
<indexterm><primary>awn_applet_simple_set_temp_icon</primary></indexterm><programlisting><link linkend="void">void</link> awn_applet_simple_set_temp_icon (<link linkend="AwnAppletSimple">AwnAppletSimple</link> *simple,
120
<refsect2 id="awn-applet-simple-set-temp-icon" role="function">
121
<title>awn_applet_simple_set_temp_icon ()</title>
122
<indexterm zone="awn-applet-simple-set-temp-icon"><primary sortas="awn_applet_simple_set_temp_icon">awn_applet_simple_set_temp_icon</primary></indexterm><programlisting><link linkend="void">void</link> awn_applet_simple_set_temp_icon (<link linkend="AwnAppletSimple">AwnAppletSimple</link> *simple,
136
123
<link linkend="GdkPixbuf">GdkPixbuf</link> *pixbuf);</programlisting>
138
125
A convenience function that sets the applet icon to the pixbuf provided as an
141
128
calling this function. If the pixbuf needs to be retained, then
142
129
<link linkend="awn-applet-simple-set-icon"><function>awn_applet_simple_set_icon()</function></link> should be used.</para>
145
131
</para><variablelist role="params">
146
<varlistentry><term><parameter>simple</parameter> :</term>
132
<varlistentry><term><parameter>simple</parameter> :</term>
147
133
<listitem><simpara> The applet whose icon is being set.
148
134
</simpara></listitem></varlistentry>
149
<varlistentry><term><parameter>pixbuf</parameter> :</term>
135
<varlistentry><term><parameter>pixbuf</parameter> :</term>
150
136
<listitem><simpara> The pixbuf image to use as the icon.
151
137
</simpara></listitem></varlistentry>
152
138
</variablelist></refsect2>
154
<title><anchor id="awn-applet-simple-get-effects" role="function"/>awn_applet_simple_get_effects ()</title>
155
<indexterm><primary>awn_applet_simple_get_effects</primary></indexterm><programlisting><link linkend="AwnEffects">AwnEffects</link>* awn_applet_simple_get_effects (<link linkend="AwnAppletSimple">AwnAppletSimple</link> *simple);</programlisting>
139
<refsect2 id="awn-applet-simple-get-effects" role="function">
140
<title>awn_applet_simple_get_effects ()</title>
141
<indexterm zone="awn-applet-simple-get-effects"><primary sortas="awn_applet_simple_get_effects">awn_applet_simple_get_effects</primary></indexterm><programlisting><link linkend="AwnEffects">AwnEffects</link> * awn_applet_simple_get_effects (<link linkend="AwnAppletSimple">AwnAppletSimple</link> *simple);</programlisting>
157
143
Retrieves the <link linkend="AwnEffects"><type>AwnEffects</type></link> object associated with the applet.</para>
160
145
</para><variablelist role="params">
161
<varlistentry><term><parameter>simple</parameter> :</term>
146
<varlistentry><term><parameter>simple</parameter> :</term>
162
147
<listitem><simpara> The applet whose properties are being queried.
163
148
</simpara></listitem></varlistentry>
164
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a pointer to an <link linkend="AwnEffects"><type>AwnEffects</type></link> object associated with the
149
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a pointer to an <link linkend="AwnEffects"><type>AwnEffects</type></link> object associated with the
165
150
applet. The caller does not own this object.
166
151
</simpara></listitem></varlistentry>
167
152
</variablelist></refsect2>
added
removed
doc/reference/xml/awn-applet-simple.xml
