← 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-image.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-image.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="EmpathyAvatarImage">
7
 
<refmeta>
8
 
<refentrytitle role="top_of_page" id="EmpathyAvatarImage.top_of_page">EmpathyAvatarImage</refentrytitle>
9
 
<manvolnum>3</manvolnum>
10
 
<refmiscinfo>LIBEMPATHY-GTK Library</refmiscinfo>
11
 
</refmeta>
12
 
 
13
 
<refnamediv>
14
 
<refname>EmpathyAvatarImage</refname>
15
 
<refpurpose>A widget to display an avatar</refpurpose>
16
 
</refnamediv>
17
 
 
18
 
<refsynopsisdiv id="EmpathyAvatarImage.synopsis" role="synopsis">
19
 
<title role="synopsis.title">Synopsis</title>
20
 
 
21
 
<synopsis>
22
 
 
23
 
#include &lt;libempathy-gtk/empathy-avatar-image.h&gt;
24
 
 
25
 
                    <link linkend="EmpathyAvatarImage-struct">EmpathyAvatarImage</link>;
26
 
<link linkend="GtkWidget">GtkWidget</link> *         <link linkend="empathy-avatar-image-new">empathy_avatar_image_new</link>            (void);
27
 
<link linkend="void">void</link>                <link linkend="empathy-avatar-image-set">empathy_avatar_image_set</link>            (<link linkend="EmpathyAvatarImage">EmpathyAvatarImage</link> *avatar_image,
28
 
                                                         <link linkend="EmpathyAvatar">EmpathyAvatar</link> *avatar);
29
 
</synopsis>
30
 
</refsynopsisdiv>
31
 
 
32
 
<refsect1 id="EmpathyAvatarImage.object-hierarchy" role="object_hierarchy">
33
 
<title role="object_hierarchy.title">Object Hierarchy</title>
34
 
<synopsis>
35
 
  <link linkend="GObject">GObject</link>
36
 
   +----<link linkend="GInitiallyUnowned">GInitiallyUnowned</link>
37
 
         +----<link linkend="GtkObject">GtkObject</link>
38
 
               +----<link linkend="GtkWidget">GtkWidget</link>
39
 
                     +----<link linkend="GtkContainer">GtkContainer</link>
40
 
                           +----<link linkend="GtkBin">GtkBin</link>
41
 
                                 +----<link linkend="GtkEventBox">GtkEventBox</link>
42
 
                                       +----EmpathyAvatarImage
43
 
</synopsis>
44
 
</refsect1>
45
 
 
46
 
 
47
 
 
48
 
<refsect1 id="EmpathyAvatarImage.implemented-interfaces" role="impl_interfaces">
49
 
<title role="impl_interfaces.title">Implemented Interfaces</title>
50
 
<para>
51
 
EmpathyAvatarImage implements
52
 
 <link linkend="AtkImplementorIface">AtkImplementorIface</link> and  <link linkend="GtkBuildable">GtkBuildable</link>.</para>
53
 
</refsect1>
54
 
 
55
 
 
56
 
 
57
 
 
58
 
 
59
 
<refsect1 id="EmpathyAvatarImage.description" role="desc">
60
 
<title role="desc.title">Description</title>
61
 
<para>
62
 
<link linkend="EmpathyAvatarImage"><type>EmpathyAvatarImage</type></link> is a widget which displays an avatar.</para>
63
 
<para>
64
 
</para>
65
 
</refsect1>
66
 
 
67
 
<refsect1 id="EmpathyAvatarImage.details" role="details">
68
 
<title role="details.title">Details</title>
69
 
<refsect2 id="EmpathyAvatarImage-struct" role="struct">
70
 
<title>EmpathyAvatarImage</title>
71
 
<indexterm zone="EmpathyAvatarImage-struct"><primary sortas="EmpathyAvatarImage">EmpathyAvatarImage</primary></indexterm><programlisting>typedef struct _EmpathyAvatarImage EmpathyAvatarImage;</programlisting>
72
 
<para>
73
 
Widget which displays an avatar.</para>
74
 
<para>
75
 
</para><variablelist role="struct">
76
 
</variablelist></refsect2>
77
 
<refsect2 id="empathy-avatar-image-new" role="function">
78
 
<title>empathy_avatar_image_new ()</title>
79
 
<indexterm zone="empathy-avatar-image-new"><primary sortas="empathy_avatar_image_new">empathy_avatar_image_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link> *         empathy_avatar_image_new            (void);</programlisting>
80
 
<para>
81
 
Creates a new <link linkend="EmpathyAvatarImage"><type>EmpathyAvatarImage</type></link>.</para>
82
 
<para>
83
 
</para><variablelist role="params">
84
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a new <link linkend="EmpathyAvatarImage"><type>EmpathyAvatarImage</type></link>
85
 
</simpara></listitem></varlistentry>
86
 
</variablelist></refsect2>
87
 
<refsect2 id="empathy-avatar-image-set" role="function">
88
 
<title>empathy_avatar_image_set ()</title>
89
 
<indexterm zone="empathy-avatar-image-set"><primary sortas="empathy_avatar_image_set">empathy_avatar_image_set</primary></indexterm><programlisting><link linkend="void">void</link>                empathy_avatar_image_set            (<link linkend="EmpathyAvatarImage">EmpathyAvatarImage</link> *avatar_image,
90
 
                                                         <link linkend="EmpathyAvatar">EmpathyAvatar</link> *avatar);</programlisting>
91
 
<para>
92
 
Sets <parameter>avatar_image</parameter> to display the avatar indicated by <parameter>avatar</parameter>.</para>
93
 
<para>
94
 
</para><variablelist role="params">
95
 
<varlistentry><term><parameter>avatar_image</parameter>&#160;:</term>
96
 
<listitem><simpara> an <link linkend="EmpathyAvatarImage"><type>EmpathyAvatarImage</type></link>
97
 
</simpara></listitem></varlistentry>
98
 
<varlistentry><term><parameter>avatar</parameter>&#160;:</term>
99
 
<listitem><simpara> the <link linkend="EmpathyAvatar"><type>EmpathyAvatar</type></link> to set <parameter>avatar_image</parameter> to
100
 
</simpara></listitem></varlistentry>
101
 
</variablelist></refsect2>
102
 
 
103
 
</refsect1>
104
 
 
105
 
 
106
 
 
107
 
 
108
 
</refentry>