← Back to branch summary

~ubuntu-branches/ubuntu/maverick/evolution-data-server/maverick-proposed

« back to all changes in this revision

Viewing changes to docs/reference/calendar/libedata-cal/xml/e-cal-backend-util.xml

  • Committer: Bazaar Package Importer
  • Author(s): Didier Roche
  • Date: 2010-05-17 17:02:06 UTC
  • mfrom: (1.1.79 upstream) (1.6.12 experimental)
  • Revision ID: james.westby@ubuntu.com-20100517170206-4ufr52vwrhh26yh0
Tags: 2.30.1-1ubuntu1
https://launchpad.net/bugs/42199
https://launchpad.net/bugs/229669
https://launchpad.net/bugs/173703
https://launchpad.net/bugs/360344
https://launchpad.net/bugs/508494
* Merge from debian experimental. Remaining change:
  (LP: #42199, #229669, #173703, #360344, #508494)
  + debian/control:
    - add Vcs-Bzr tag
    - don't use libgnome
    - Use Breaks instead of Conflicts against evolution 2.25 and earlier.
  + debian/evolution-data-server.install,
    debian/patches/45_libcamel_providers_version.patch:
    - use the upstream versioning, not a Debian-specific one 
  + debian/libedata-book1.2-dev.install, debian/libebackend-1.2-dev.install,
    debian/libcamel1.2-dev.install, debian/libedataserverui1.2-dev.install:
    - install html documentation
  + debian/rules:
    - don't build documentation it's shipped with the tarball

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/calendar/libedata-cal/xml/e-cal-backend-util.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
 
<refentry id="libedata-cal-e-cal-backend-util">
5
 
<refmeta>
6
 
<refentrytitle role="top_of_page" id="libedata-cal-e-cal-backend-util.top_of_page">e-cal-backend-util</refentrytitle>
7
 
<manvolnum>3</manvolnum>
8
 
<refmiscinfo>
9
 
  LIBEDATA-CAL Library
10
 
</refmiscinfo>
11
 
</refmeta>
12
 
<refnamediv>
13
 
<refname>e-cal-backend-util</refname>
14
 
<refpurpose>Utility functions for backends.</refpurpose>
15
 
</refnamediv>
16
 
 
17
 
<refsynopsisdiv id="libedata-cal-e-cal-backend-util.synopsis" role="synopsis">
18
 
<title role="synopsis.title">Synopsis</title>
19
 
 
20
 
<synopsis><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            <link linkend="e-cal-backend-mail-account-get-default">e_cal_backend_mail_account_get_default</link>
21
 
                                                        (<parameter><link linkend="gchar"><type>gchar</type></link> **address</parameter>,
22
 
                                                         <parameter><link linkend="gchar"><type>gchar</type></link> **name</parameter>);
23
 
<link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            <link linkend="e-cal-backend-mail-account-is-valid">e_cal_backend_mail_account_is_valid</link> (<parameter><link linkend="gchar"><type>gchar</type></link> *user</parameter>,
24
 
                                                         <parameter><link linkend="gchar"><type>gchar</type></link> **name</parameter>);
25
 
const <link linkend="gchar"><returnvalue>gchar</returnvalue></link> *       <link linkend="e-cal-backend-status-to-string">e_cal_backend_status_to_string</link>      (<parameter><link linkend="GNOME-Evolution-Calendar-CallStatus"><type>GNOME_Evolution_Calendar_CallStatus</type></link> status</parameter>);
26
 
<link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            <link linkend="e-cal-backend-user-declined">e_cal_backend_user_declined</link>         (<parameter><link linkend="icalcomponent"><type>icalcomponent</type></link> *icalcomp</parameter>);
27
 
</synopsis>
28
 
</refsynopsisdiv>
29
 
 
30
 
<refsect1 id="libedata-cal-e-cal-backend-util.description" role="desc">
31
 
<title role="desc.title">Description</title>
32
 
<para>
33
 
</para>
34
 
</refsect1>
35
 
<refsect1 id="libedata-cal-e-cal-backend-util.details" role="details">
36
 
<title role="details.title">Details</title>
37
 
<refsect2 id="e-cal-backend-mail-account-get-default" role="function">
38
 
<title>e_cal_backend_mail_account_get_default ()</title>
39
 
<indexterm zone="e-cal-backend-mail-account-get-default"><primary>e_cal_backend_mail_account_get_default</primary></indexterm>
40
 
<programlisting><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            e_cal_backend_mail_account_get_default
41
 
                                                        (<parameter><link linkend="gchar"><type>gchar</type></link> **address</parameter>,
42
 
                                                         <parameter><link linkend="gchar"><type>gchar</type></link> **name</parameter>);</programlisting>
43
 
<para>
44
 
Retrieve the default mail account as stored in Evolution configuration.</para>
45
 
<variablelist role="params">
46
 
<varlistentry><term><parameter>address</parameter>&#160;:</term>
47
 
<listitem><simpara>Placeholder for default address.
48
 
</simpara></listitem></varlistentry>
49
 
<varlistentry><term><parameter>name</parameter>&#160;:</term>
50
 
<listitem><simpara>Placeholder for name.
51
 
</simpara></listitem></varlistentry>
52
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> TRUE if there is a default account, FALSE otherwise.
53
 
</simpara></listitem></varlistentry>
54
 
</variablelist></refsect2>
55
 
<refsect2 id="e-cal-backend-mail-account-is-valid" role="function">
56
 
<title>e_cal_backend_mail_account_is_valid ()</title>
57
 
<indexterm zone="e-cal-backend-mail-account-is-valid"><primary>e_cal_backend_mail_account_is_valid</primary></indexterm>
58
 
<programlisting><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            e_cal_backend_mail_account_is_valid (<parameter><link linkend="gchar"><type>gchar</type></link> *user</parameter>,
59
 
                                                         <parameter><link linkend="gchar"><type>gchar</type></link> **name</parameter>);</programlisting>
60
 
<para>
61
 
Checks that a mail account is valid, and returns its name.</para>
62
 
<variablelist role="params">
63
 
<varlistentry><term><parameter>user</parameter>&#160;:</term>
64
 
<listitem><simpara>User name for the account to check.
65
 
</simpara></listitem></varlistentry>
66
 
<varlistentry><term><parameter>name</parameter>&#160;:</term>
67
 
<listitem><simpara>Placeholder for the account name.
68
 
</simpara></listitem></varlistentry>
69
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> TRUE if the account is valid, FALSE if not.
70
 
</simpara></listitem></varlistentry>
71
 
</variablelist></refsect2>
72
 
<refsect2 id="e-cal-backend-status-to-string" role="function">
73
 
<title>e_cal_backend_status_to_string ()</title>
74
 
<indexterm zone="e-cal-backend-status-to-string"><primary>e_cal_backend_status_to_string</primary></indexterm>
75
 
<programlisting>const <link linkend="gchar"><returnvalue>gchar</returnvalue></link> *       e_cal_backend_status_to_string      (<parameter><link linkend="GNOME-Evolution-Calendar-CallStatus"><type>GNOME_Evolution_Calendar_CallStatus</type></link> status</parameter>);</programlisting>
76
 
<para>
77
 
Converts status code to string.</para>
78
 
<variablelist role="params">
79
 
<varlistentry><term><parameter>status</parameter>&#160;:</term>
80
 
<listitem><simpara>
81
 
</simpara></listitem></varlistentry>
82
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>
83
 
</simpara></listitem></varlistentry>
84
 
</variablelist></refsect2>
85
 
<refsect2 id="e-cal-backend-user-declined" role="function">
86
 
<title>e_cal_backend_user_declined ()</title>
87
 
<indexterm zone="e-cal-backend-user-declined"><primary>e_cal_backend_user_declined</primary></indexterm>
88
 
<programlisting><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            e_cal_backend_user_declined         (<parameter><link linkend="icalcomponent"><type>icalcomponent</type></link> *icalcomp</parameter>);</programlisting>
89
 
<variablelist role="params">
90
 
<varlistentry><term><parameter>icalcomp</parameter>&#160;:</term>
91
 
<listitem><simpara>
92
 
</simpara></listitem></varlistentry>
93
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>
94
 
</simpara></listitem></varlistentry>
95
 
</variablelist></refsect2>
96
 
 
97
 
</refsect1>
98
 
 
99
 
</refentry>