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

<refentry id="camel-CamelVeeSummary">

<refmeta>

<refentrytitle role="top_of_page" id="camel-CamelVeeSummary.top_of_page">CamelVeeSummary</refentrytitle>

<manvolnum>3</manvolnum>

<refmiscinfo>CAMEL Library</refmiscinfo>

</refmeta>

 

<refnamediv>

<refname>CamelVeeSummary</refname>

<refpurpose></refpurpose>

</refnamediv>

 

<refsynopsisdiv id="camel-CamelVeeSummary.synopsis" role="synopsis">

<title role="synopsis.title">Synopsis</title>

 

<synopsis>

                    <link linkend="CamelVeeSummary">CamelVeeSummary</link>;

                    <link linkend="CamelVeeMessageInfo">CamelVeeMessageInfo</link>;

<link linkend="CamelFolderSummary">CamelFolderSummary</link> * <link linkend="camel-vee-summary-new">camel_vee_summary_new</link>              (<link linkend="struct--CamelFolder">struct _CamelFolder</link> *parent);

<link linkend="CamelVeeMessageInfo">CamelVeeMessageInfo</link> * <link linkend="camel-vee-summary-add">camel_vee_summary_add</link>             (<link linkend="CamelVeeSummary">CamelVeeSummary</link> *s,

                                                         <link linkend="CamelFolderSummary">CamelFolderSummary</link> *summary,

                                                         const <link linkend="gchar">gchar</link> *uid,

                                                         const <link linkend="gchar">gchar</link> hash[8]);

<link linkend="GPtrArray">GPtrArray</link> *         <link linkend="camel-vee-summary-get-ids">camel_vee_summary_get_ids</link>           (<link linkend="CamelVeeSummary">CamelVeeSummary</link> *summary,

                                                         <link linkend="gchar">gchar</link> hash[8]);

<link linkend="void">void</link>                <link linkend="camel-vee-summary-load-check-unread-vfolder">camel_vee_summary_load_check_unread_vfolder</link>

                                                        (<link linkend="CamelVeeSummary">CamelVeeSummary</link> *vs);

</synopsis>

</refsynopsisdiv>

 

 

 

 

 

 

 

 

 

<refsect1 id="camel-CamelVeeSummary.description" role="desc">

<title role="desc.title">Description</title>

<para>

</para>

</refsect1>

 

<refsect1 id="camel-CamelVeeSummary.details" role="details">

<title role="details.title">Details</title>

<refsect2 id="CamelVeeSummary" role="struct">

<title>CamelVeeSummary</title>

<indexterm zone="CamelVeeSummary"><primary sortas="CamelVeeSummary">CamelVeeSummary</primary></indexterm><programlisting>typedef struct {

        CamelFolderSummary summary;

        gboolean force_counts;

        guint32 fake_visible_count;

} CamelVeeSummary;

</programlisting>

<para>

</para></refsect2>

<refsect2 id="CamelVeeMessageInfo" role="struct">

<title>CamelVeeMessageInfo</title>

<indexterm zone="CamelVeeMessageInfo"><primary sortas="CamelVeeMessageInfo">CamelVeeMessageInfo</primary></indexterm><programlisting>typedef struct {

        CamelMessageInfo info;

        CamelFolderSummary *summary;

        guint32 old_flags;  /* These are just for identifying changed flags */

} CamelVeeMessageInfo;

</programlisting>

<para>

</para></refsect2>

<refsect2 id="camel-vee-summary-new" role="function">

<title>camel_vee_summary_new ()</title>

<indexterm zone="camel-vee-summary-new"><primary sortas="camel_vee_summary_new">camel_vee_summary_new</primary></indexterm><programlisting><link linkend="CamelFolderSummary">CamelFolderSummary</link> * camel_vee_summary_new              (<link linkend="struct--CamelFolder">struct _CamelFolder</link> *parent);</programlisting>

<para>

This will create a new CamelVeeSummary object and read in the

summary data from disk, if it exists.</para>

<para>

</para><variablelist role="params">

<varlistentry><term><parameter>parent</parameter>&#160;:</term>

<listitem><simpara> Folder its attached to.

</simpara></listitem></varlistentry>

<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> A new CamelVeeSummary object.

</simpara></listitem></varlistentry>

</variablelist></refsect2>

<refsect2 id="camel-vee-summary-add" role="function">

<title>camel_vee_summary_add ()</title>

<indexterm zone="camel-vee-summary-add"><primary sortas="camel_vee_summary_add">camel_vee_summary_add</primary></indexterm><programlisting><link linkend="CamelVeeMessageInfo">CamelVeeMessageInfo</link> * camel_vee_summary_add             (<link linkend="CamelVeeSummary">CamelVeeSummary</link> *s,

                                                         <link linkend="CamelFolderSummary">CamelFolderSummary</link> *summary,

                                                         const <link linkend="gchar">gchar</link> *uid,

                                                         const <link linkend="gchar">gchar</link> hash[8]);</programlisting>

<para>

</para><variablelist role="params">

<varlistentry><term><parameter>s</parameter>&#160;:</term>

<listitem><simpara>

</simpara></listitem></varlistentry>

<varlistentry><term><parameter>summary</parameter>&#160;:</term>

<listitem><simpara>

</simpara></listitem></varlistentry>

<varlistentry><term><parameter>uid</parameter>&#160;:</term>

<listitem><simpara>

</simpara></listitem></varlistentry>

<varlistentry><term><parameter>hash</parameter>&#160;:</term>

<listitem><simpara>

</simpara></listitem></varlistentry>

<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>

</simpara></listitem></varlistentry>

</variablelist></refsect2>

<refsect2 id="camel-vee-summary-get-ids" role="function">

<title>camel_vee_summary_get_ids ()</title>

<indexterm zone="camel-vee-summary-get-ids"><primary sortas="camel_vee_summary_get_ids">camel_vee_summary_get_ids</primary></indexterm><programlisting><link linkend="GPtrArray">GPtrArray</link> *         camel_vee_summary_get_ids           (<link linkend="CamelVeeSummary">CamelVeeSummary</link> *summary,

                                                         <link linkend="gchar">gchar</link> hash[8]);</programlisting>

<para>

</para><variablelist role="params">

<varlistentry><term><parameter>summary</parameter>&#160;:</term>

<listitem><simpara>

</simpara></listitem></varlistentry>

<varlistentry><term><parameter>hash</parameter>&#160;:</term>

<listitem><simpara>

</simpara></listitem></varlistentry>

<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>

</simpara></listitem></varlistentry>

</variablelist></refsect2>

<refsect2 id="camel-vee-summary-load-check-unread-vfolder" role="function">

<title>camel_vee_summary_load_check_unread_vfolder ()</title>

<indexterm zone="camel-vee-summary-load-check-unread-vfolder"><primary sortas="camel_vee_summary_load_check_unread_vfolder">camel_vee_summary_load_check_unread_vfolder</primary></indexterm><programlisting><link linkend="void">void</link>                camel_vee_summary_load_check_unread_vfolder

                                                        (<link linkend="CamelVeeSummary">CamelVeeSummary</link> *vs);</programlisting>

<para>

</para><variablelist role="params">

<varlistentry><term><parameter>vs</parameter>&#160;:</term>

<listitem><simpara>

</simpara></listitem></varlistentry>

</variablelist></refsect2>

 

</refsect1>

 

 

 

 

</refentry>