← Back to branch summary

~bcurtiswx/ubuntu/precise/empathy/3.4.2.1-0ubuntu1

« back to all changes in this revision

Viewing changes to docs/libempathy-gtk/xml/empathy-avatar-chooser.xml

  • Committer: Bazaar Package Importer
  • Author(s): Laurent Bigonville
  • Date: 2009-11-16 23:40:52 UTC
  • mfrom: (1.1.39 upstream)
  • mto: (6.3.7 experimental)
  • mto: This revision was merged to the branch mainline in revision 80.
  • Revision ID: james.westby@ubuntu.com-20091116234052-7hhwrpeln4mwdyw7
Tags: upstream-2.29.2
Import upstream version 2.29.2

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/libempathy-gtk/xml/empathy-avatar-chooser.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
 
<!ENTITY version SYSTEM "version.xml">
5
 
]>
6
 
<refentry id="EmpathyAvatarChooser">
7
 
<refmeta>
8
 
<refentrytitle role="top_of_page" id="EmpathyAvatarChooser.top_of_page">EmpathyAvatarChooser</refentrytitle>
9
 
<manvolnum>3</manvolnum>
10
 
<refmiscinfo>LIBEMPATHY-GTK Library</refmiscinfo>
11
 
</refmeta>
12
 
 
13
 
<refnamediv>
14
 
<refname>EmpathyAvatarChooser</refname>
15
 
<refpurpose>A widget used to change avatar</refpurpose>
16
 
</refnamediv>
17
 
 
18
 
<refsynopsisdiv id="EmpathyAvatarChooser.synopsis" role="synopsis">
19
 
<title role="synopsis.title">Synopsis</title>
20
 
 
21
 
<synopsis>
22
 
 
23
 
#include &lt;libempathy-gtk/empathy-avatar-chooser.h&gt;
24
 
 
25
 
                    <link linkend="EmpathyAvatarChooser-struct">EmpathyAvatarChooser</link>;
26
 
<link linkend="GtkWidget">GtkWidget</link> *         <link linkend="empathy-avatar-chooser-new">empathy_avatar_chooser_new</link>          (void);
27
 
<link linkend="void">void</link>                <link linkend="empathy-avatar-chooser-set">empathy_avatar_chooser_set</link>          (<link linkend="EmpathyAvatarChooser">EmpathyAvatarChooser</link> *chooser,
28
 
                                                         <link linkend="EmpathyAvatar">EmpathyAvatar</link> *avatar);
29
 
<link linkend="void">void</link>                <link linkend="empathy-avatar-chooser-get-image-data">empathy_avatar_chooser_get_image_data</link>
30
 
                                                        (<link linkend="EmpathyAvatarChooser">EmpathyAvatarChooser</link> *chooser,
31
 
                                                         const <link linkend="gchar">gchar</link> **data,
32
 
                                                         <link linkend="gsize">gsize</link> *data_size,
33
 
                                                         const <link linkend="gchar">gchar</link> **mime_type);
34
 
</synopsis>
35
 
</refsynopsisdiv>
36
 
 
37
 
<refsect1 id="EmpathyAvatarChooser.object-hierarchy" role="object_hierarchy">
38
 
<title role="object_hierarchy.title">Object Hierarchy</title>
39
 
<synopsis>
40
 
  <link linkend="GObject">GObject</link>
41
 
   +----<link linkend="GInitiallyUnowned">GInitiallyUnowned</link>
42
 
         +----<link linkend="GtkObject">GtkObject</link>
43
 
               +----<link linkend="GtkWidget">GtkWidget</link>
44
 
                     +----<link linkend="GtkContainer">GtkContainer</link>
45
 
                           +----<link linkend="GtkBin">GtkBin</link>
46
 
                                 +----<link linkend="GtkButton">GtkButton</link>
47
 
                                       +----EmpathyAvatarChooser
48
 
</synopsis>
49
 
</refsect1>
50
 
 
51
 
 
52
 
 
53
 
<refsect1 id="EmpathyAvatarChooser.implemented-interfaces" role="impl_interfaces">
54
 
<title role="impl_interfaces.title">Implemented Interfaces</title>
55
 
<para>
56
 
EmpathyAvatarChooser implements
57
 
 <link linkend="GtkActivatable">GtkActivatable</link>,  <link linkend="AtkImplementorIface">AtkImplementorIface</link> and  <link linkend="GtkBuildable">GtkBuildable</link>.</para>
58
 
</refsect1>
59
 
 
60
 
 
61
 
<refsect1 id="EmpathyAvatarChooser.properties" role="properties">
62
 
<title role="properties.title">Properties</title>
63
 
<synopsis>
64
 
  &quot;<link linkend="EmpathyAvatarChooser--connection">connection</link>&quot;               <link linkend="TpConnection">TpConnection</link>*         : Read / Write
65
 
</synopsis>
66
 
</refsect1>
67
 
 
68
 
<refsect1 id="EmpathyAvatarChooser.signals" role="signal_proto">
69
 
<title role="signal_proto.title">Signals</title>
70
 
<synopsis>
71
 
  &quot;<link linkend="EmpathyAvatarChooser-changed">changed</link>&quot;                                        : Run Last
72
 
</synopsis>
73
 
</refsect1>
74
 
 
75
 
 
76
 
<refsect1 id="EmpathyAvatarChooser.description" role="desc">
77
 
<title role="desc.title">Description</title>
78
 
<para>
79
 
<link linkend="EmpathyAvatarChooser"><type>EmpathyAvatarChooser</type></link> is a widget which extends <link linkend="GtkButton"><type>GtkButton</type></link> to
80
 
provide a way of changing avatar.</para>
81
 
<para>
82
 
</para>
83
 
</refsect1>
84
 
 
85
 
<refsect1 id="EmpathyAvatarChooser.details" role="details">
86
 
<title role="details.title">Details</title>
87
 
<refsect2 id="EmpathyAvatarChooser-struct" role="struct">
88
 
<title>EmpathyAvatarChooser</title>
89
 
<indexterm zone="EmpathyAvatarChooser-struct"><primary sortas="EmpathyAvatarChooser">EmpathyAvatarChooser</primary></indexterm><programlisting>typedef struct _EmpathyAvatarChooser EmpathyAvatarChooser;</programlisting>
90
 
<para>
91
 
Widget which extends <link linkend="GtkButton"><type>GtkButton</type></link> to provide a way of changing avatar.</para>
92
 
<para>
93
 
</para><variablelist role="struct">
94
 
</variablelist></refsect2>
95
 
<refsect2 id="empathy-avatar-chooser-new" role="function">
96
 
<title>empathy_avatar_chooser_new ()</title>
97
 
<indexterm zone="empathy-avatar-chooser-new"><primary sortas="empathy_avatar_chooser_new">empathy_avatar_chooser_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link> *         empathy_avatar_chooser_new          (void);</programlisting>
98
 
<para>
99
 
Creates a new <link linkend="EmpathyAvatarChooser"><type>EmpathyAvatarChooser</type></link>.</para>
100
 
<para>
101
 
</para><variablelist role="params">
102
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a new <link linkend="EmpathyAvatarChooser"><type>EmpathyAvatarChooser</type></link>
103
 
</simpara></listitem></varlistentry>
104
 
</variablelist></refsect2>
105
 
<refsect2 id="empathy-avatar-chooser-set" role="function">
106
 
<title>empathy_avatar_chooser_set ()</title>
107
 
<indexterm zone="empathy-avatar-chooser-set"><primary sortas="empathy_avatar_chooser_set">empathy_avatar_chooser_set</primary></indexterm><programlisting><link linkend="void">void</link>                empathy_avatar_chooser_set          (<link linkend="EmpathyAvatarChooser">EmpathyAvatarChooser</link> *chooser,
108
 
                                                         <link linkend="EmpathyAvatar">EmpathyAvatar</link> *avatar);</programlisting>
109
 
<para>
110
 
Sets the <parameter>chooser</parameter> to display the avatar indicated by <parameter>avatar</parameter>.</para>
111
 
<para>
112
 
</para><variablelist role="params">
113
 
<varlistentry><term><parameter>chooser</parameter>&#160;:</term>
114
 
<listitem><simpara> an <link linkend="EmpathyAvatarChooser"><type>EmpathyAvatarChooser</type></link>
115
 
</simpara></listitem></varlistentry>
116
 
<varlistentry><term><parameter>avatar</parameter>&#160;:</term>
117
 
<listitem><simpara> a new <link linkend="EmpathyAvatar"><type>EmpathyAvatar</type></link>
118
 
</simpara></listitem></varlistentry>
119
 
</variablelist></refsect2>
120
 
<refsect2 id="empathy-avatar-chooser-get-image-data" role="function">
121
 
<title>empathy_avatar_chooser_get_image_data ()</title>
122
 
<indexterm zone="empathy-avatar-chooser-get-image-data"><primary sortas="empathy_avatar_chooser_get_image_data">empathy_avatar_chooser_get_image_data</primary></indexterm><programlisting><link linkend="void">void</link>                empathy_avatar_chooser_get_image_data
123
 
                                                        (<link linkend="EmpathyAvatarChooser">EmpathyAvatarChooser</link> *chooser,
124
 
                                                         const <link linkend="gchar">gchar</link> **data,
125
 
                                                         <link linkend="gsize">gsize</link> *data_size,
126
 
                                                         const <link linkend="gchar">gchar</link> **mime_type);</programlisting>
127
 
<para>
128
 
Gets image data about the currently selected avatar.</para>
129
 
<para>
130
 
</para><variablelist role="params">
131
 
<varlistentry><term><parameter>chooser</parameter>&#160;:</term>
132
 
<listitem><simpara> an <link linkend="EmpathyAvatarChooser"><type>EmpathyAvatarChooser</type></link>
133
 
</simpara></listitem></varlistentry>
134
 
<varlistentry><term><parameter>data</parameter>&#160;:</term>
135
 
<listitem><simpara> avatar bytes
136
 
</simpara></listitem></varlistentry>
137
 
<varlistentry><term><parameter>data_size</parameter>&#160;:</term>
138
 
<listitem><simpara> size of <parameter>data</parameter>
139
 
</simpara></listitem></varlistentry>
140
 
<varlistentry><term><parameter>mime_type</parameter>&#160;:</term>
141
 
<listitem><simpara> avatar mime-type
142
 
</simpara></listitem></varlistentry>
143
 
</variablelist></refsect2>
144
 
 
145
 
</refsect1>
146
 
<refsect1 id="EmpathyAvatarChooser.property-details" role="property_details">
147
 
<title role="property_details.title">Property Details</title>
148
 
<refsect2 id="EmpathyAvatarChooser--connection" role="property"><title>The <literal>&quot;connection&quot;</literal> property</title>
149
 
<indexterm zone="EmpathyAvatarChooser--connection"><primary sortas="EmpathyAvatarChooser:connection">EmpathyAvatarChooser:connection</primary></indexterm><programlisting>  &quot;connection&quot;               <link linkend="TpConnection">TpConnection</link>*         : Read / Write</programlisting>
150
 
<para>
151
 
The <link linkend="TpConnection"><type>TpConnection</type></link> whose avatar should be shown and modified by
152
 
the <link linkend="EmpathyAvatarChooser"><type>EmpathyAvatarChooser</type></link> instance.</para>
153
 
<para>
154
 
</para></refsect2>
155
 
</refsect1>
156
 
 
157
 
<refsect1 id="EmpathyAvatarChooser.signal-details" role="signals">
158
 
<title role="signals.title">Signal Details</title>
159
 
<refsect2 id="EmpathyAvatarChooser-changed" role="signal"><title>The <literal>&quot;changed&quot;</literal> signal</title>
160
 
<indexterm zone="EmpathyAvatarChooser-changed"><primary sortas="EmpathyAvatarChooser::changed">EmpathyAvatarChooser::changed</primary></indexterm><programlisting><link linkend="void">void</link>                user_function                      (<link linkend="EmpathyAvatarChooser">EmpathyAvatarChooser</link> *chooser,
161
 
                                                        <link linkend="gpointer">gpointer</link>              user_data)      : Run Last</programlisting>
162
 
<para>
163
 
Emitted when the chosen avatar has changed.</para>
164
 
<para>
165
 
</para><variablelist role="params">
166
 
<varlistentry><term><parameter>chooser</parameter>&#160;:</term>
167
 
<listitem><simpara> an <link linkend="EmpathyAvatarChooser"><type>EmpathyAvatarChooser</type></link>
168
 
</simpara></listitem></varlistentry>
169
 
<varlistentry><term><parameter>user_data</parameter>&#160;:</term>
170
 
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
171
 
</variablelist></refsect2>
172
 
</refsect1>
173
 
 
174
 
 
175
 
 
176
 
</refentry>