← Back to branch summary

~ubuntu-branches/ubuntu/karmic/libtinymail/karmic

« back to all changes in this revision

Viewing changes to docs/devel/reference/xml/tny-gnome-account-store.xml

  • Committer: Bazaar Package Importer
  • Author(s): Steve Kowalik
  • Date: 2007-10-12 11:21:12 UTC
  • Revision ID: james.westby@ubuntu.com-20071012112112-fod9fs7yrooxjr7i
Tags: upstream-0.0.2
Import upstream version 0.0.2

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/devel/reference/xml/tny-gnome-account-store.xml
 
1
<refentry id="libtinymail-TnyGnomeAccountStore">
 
2
<refmeta>
 
3
<refentrytitle role="top_of_page">TnyGnomeAccountStore</refentrytitle>
 
4
<manvolnum>3</manvolnum>
 
5
<refmiscinfo>LIBTINYMAIL Library</refmiscinfo>
 
6
</refmeta>
 
7
 
 
8
<refnamediv>
 
9
<refname>TnyGnomeAccountStore</refname>
 
10
<refpurpose>A account store type for GNOME</refpurpose>
 
11
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
 
12
</refnamediv>
 
13
 
 
14
<refsynopsisdiv role="synopsis">
 
15
<title role="synopsis.title">Synopsis</title>
 
16
 
 
17
<synopsis>
 
18
 
 
19
 
 
20
 
 
21
                    <link linkend="TnyGnomeAccountStore">TnyGnomeAccountStore</link>;
 
22
<link linkend="TnyAccountStore">TnyAccountStore</link>*    <link linkend="tny-gnome-account-store-new">tny_gnome_account_store_new</link>         (void);
 
23
<link linkend="TnySessionCamel">TnySessionCamel</link>*    <link linkend="tny-gnome-account-store-get-session">tny_gnome_account_store_get_session</link> (<link linkend="TnyGnomeAccountStore">TnyGnomeAccountStore</link> *self);
 
24
 
 
25
</synopsis>
 
26
</refsynopsisdiv>
 
27
 
 
28
 
 
29
 
 
30
 
 
31
 
 
32
 
 
33
 
 
34
 
 
35
 
 
36
<refsect1 role="desc">
 
37
<title role="desc.title">Description</title>
 
38
<para>
 
39
A <link linkend="TnyAccountStore"><type>TnyAccountStore</type></link> implementation using GNOME's GConf and libtinymail-camel
 
40
</para>
 
41
</refsect1>
 
42
 
 
43
<refsect1 role="details">
 
44
<title role="details.title">Details</title>
 
45
<refsect2>
 
46
<title><anchor id="TnyGnomeAccountStore" role="struct"/>TnyGnomeAccountStore</title>
 
47
<indexterm><primary>TnyGnomeAccountStore</primary></indexterm><programlisting>typedef struct {
 
48
        GObject parent;
 
49
} TnyGnomeAccountStore;
 
50
</programlisting>
 
51
<para>
 
52
 
 
53
</para></refsect2>
 
54
<refsect2>
 
55
<title><anchor id="tny-gnome-account-store-new" role="function"/>tny_gnome_account_store_new ()</title>
 
56
<indexterm><primary>tny_gnome_account_store_new</primary></indexterm><programlisting><link linkend="TnyAccountStore">TnyAccountStore</link>*    tny_gnome_account_store_new         (void);</programlisting>
 
57
<para>
 
58
Create a <link linkend="TnyAccountStore"><type>TnyAccountStore</type></link> for GNOME desktops that uses GConf for storing 
 
59
the account information and detecting changes to that configuration.</para>
 
60
<para>
 
61
 
 
62
</para><variablelist role="params">
 
63
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> A new <link linkend="TnyAccountStore"><type>TnyAccountStore</type></link> instance
 
64
</simpara></listitem></varlistentry>
 
65
</variablelist></refsect2>
 
66
<refsect2>
 
67
<title><anchor id="tny-gnome-account-store-get-session" role="function"/>tny_gnome_account_store_get_session ()</title>
 
68
<indexterm><primary>tny_gnome_account_store_get_session</primary></indexterm><programlisting><link linkend="TnySessionCamel">TnySessionCamel</link>*    tny_gnome_account_store_get_session (<link linkend="TnyGnomeAccountStore">TnyGnomeAccountStore</link> *self);</programlisting>
 
69
<para>
 
70
Get the <link linkend="CamelSession"><type>CamelSession</type></link> being used</para>
 
71
<para>
 
72
 
 
73
</para><variablelist role="params">
 
74
<varlistentry><term><parameter>self</parameter>&nbsp;:</term>
 
75
<listitem><simpara> The <link linkend="TnyGnomeAccountStore"><type>TnyGnomeAccountStore</type></link> instance
 
76
</simpara></listitem></varlistentry>
 
77
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> A <link linkend="TnySessionCamel"><type>TnySessionCamel</type></link> instance
 
78
</simpara></listitem></varlistentry>
 
79
</variablelist></refsect2>
 
80
 
 
81
</refsect1>
 
82
 
 
83
 
 
84
 
 
85
<refsect1>
 
86
<title>See Also</title>
 
87
<para>
 
88
<link linkend="TnyAccountStore"><type>TnyAccountStore</type></link>
 
89
</para>
 
90
</refsect1>
 
91
 
 
92
</refentry>