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="AwnAppletSimple">
6
<refentrytitle role="top_of_page" id="AwnAppletSimple.top_of_page">AwnAppletSimple</refentrytitle>
7
<manvolnum>3</manvolnum>
8
<refmiscinfo>LIBAWN Library</refmiscinfo>
12
<refname>AwnAppletSimple</refname>
13
<refpurpose></refpurpose>
16
<refsynopsisdiv id="AwnAppletSimple.synopsis" role="synopsis">
17
<title role="synopsis.title">Synopsis</title>
20
<link linkend="AwnAppletSimplePrivate">AwnAppletSimplePrivate</link>;
21
<link linkend="AwnAppletSimple-struct">AwnAppletSimple</link>;
22
<link linkend="GtkWidget">GtkWidget</link> * <link linkend="awn-applet-simple-new">awn_applet_simple_new</link> (const <link linkend="gchar">gchar</link> *uid,
23
<link linkend="gint">gint</link> orient,
24
<link linkend="gint">gint</link> height);
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,
26
<link linkend="GdkPixbuf">GdkPixbuf</link> *pixbuf);
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,
28
<link linkend="GdkPixbuf">GdkPixbuf</link> *pixbuf);
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);
33
<refsect1 id="AwnAppletSimple.object-hierarchy" role="object_hierarchy">
34
<title role="object_hierarchy.title">Object Hierarchy</title>
36
<link linkend="GObject">GObject</link>
37
+----<link linkend="GInitiallyUnowned">GInitiallyUnowned</link>
38
+----<link linkend="GtkObject">GtkObject</link>
39
+----<link linkend="GtkWidget">GtkWidget</link>
40
+----<link linkend="GtkContainer">GtkContainer</link>
41
+----<link linkend="GtkBin">GtkBin</link>
42
+----<link linkend="GtkEventBox">GtkEventBox</link>
43
+----<link linkend="AwnApplet">AwnApplet</link>
50
<refsect1 id="AwnAppletSimple.implemented-interfaces" role="impl_interfaces">
51
<title role="impl_interfaces.title">Implemented Interfaces</title>
53
AwnAppletSimple implements
54
<link linkend="AtkImplementorIface">AtkImplementorIface</link> and <link linkend="GtkBuildable">GtkBuildable</link>.</para>
61
<refsect1 id="AwnAppletSimple.description" role="desc">
62
<title role="desc.title">Description</title>
67
<refsect1 id="AwnAppletSimple.details" role="details">
68
<title role="details.title">Details</title>
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,
82
<link linkend="gint">gint</link> orient,
83
<link linkend="gint">gint</link> height);</programlisting>
85
Creates a new <link linkend="AwnAppletSimple"><type>AwnAppletSimple</type></link> object. This applet will have awn-effects
86
effects applied to its icon automatically if <link linkend="awn-applet-simple-set-icon"><function>awn_applet_simple_set_icon()</function></link> or
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>
89
</para><variablelist role="params">
90
<varlistentry><term><parameter>uid</parameter> :</term>
91
<listitem><simpara> The unique identifier of the instance of the applet on the dock.
92
</simpara></listitem></varlistentry>
93
<varlistentry><term><parameter>orient</parameter> :</term>
94
<listitem><simpara> The orientation of the applet - see <link linkend="AwnOrientation"><type>AwnOrientation</type></link>.
95
</simpara></listitem></varlistentry>
96
<varlistentry><term><parameter>height</parameter> :</term>
97
<listitem><simpara> The height of the applet.
98
</simpara></listitem></varlistentry>
99
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a new instance of an applet.
100
</simpara></listitem></varlistentry>
101
</variablelist></refsect2>
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,
105
<link linkend="GdkPixbuf">GdkPixbuf</link> *pixbuf);</programlisting>
107
Sets the applet icon to the pixbuf provided as an argument. A private copy
108
of the pixbuf argument is made by <link linkend="awn-applet-simple-set-icon"><function>awn_applet_simple_set_icon()</function></link> and the
109
original argument is left unchanged. The caller retains ownership of pixbuf
110
and is required to unref it when it is no longer required.</para>
112
</para><variablelist role="params">
113
<varlistentry><term><parameter>simple</parameter> :</term>
114
<listitem><simpara> The applet whose icon is being set.
115
</simpara></listitem></varlistentry>
116
<varlistentry><term><parameter>pixbuf</parameter> :</term>
117
<listitem><simpara> The pixbuf image to use as the icon.
118
</simpara></listitem></varlistentry>
119
</variablelist></refsect2>
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,
123
<link linkend="GdkPixbuf">GdkPixbuf</link> *pixbuf);</programlisting>
125
A convenience function that sets the applet icon to the pixbuf provided as an
126
argument. A private copy of the pixbuf argument is made by the function, and
127
the argument is unreferenced. The caller should not reference pixbuf after
128
calling this function. If the pixbuf needs to be retained, then
129
<link linkend="awn-applet-simple-set-icon"><function>awn_applet_simple_set_icon()</function></link> should be used.</para>
131
</para><variablelist role="params">
132
<varlistentry><term><parameter>simple</parameter> :</term>
133
<listitem><simpara> The applet whose icon is being set.
134
</simpara></listitem></varlistentry>
135
<varlistentry><term><parameter>pixbuf</parameter> :</term>
136
<listitem><simpara> The pixbuf image to use as the icon.
137
</simpara></listitem></varlistentry>
138
</variablelist></refsect2>
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>
143
Retrieves the <link linkend="AwnEffects"><type>AwnEffects</type></link> object associated with the applet.</para>
145
</para><variablelist role="params">
146
<varlistentry><term><parameter>simple</parameter> :</term>
147
<listitem><simpara> The applet whose properties are being queried.
148
</simpara></listitem></varlistentry>
149
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a pointer to an <link linkend="AwnEffects"><type>AwnEffects</type></link> object associated with the
150
applet. The caller does not own this object.
151
</simpara></listitem></varlistentry>
152
</variablelist></refsect2>
added
removed
doc/reference/xml/awn-applet-simple.xml
