<?xml version="1.0"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" 
               "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<refentry id="EContactStore">
<refmeta>
<refentrytitle role="top_of_page">EContactStore</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>LIBEDATASERVERUI Library</refmiscinfo>
</refmeta>

<refnamediv>
<refname>EContactStore</refname>
<refpurpose></refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>

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

<synopsis>



typedef     <link linkend="EContactStore">EContactStore</link>;
<link linkend="EContactStore">EContactStore</link>* <link linkend="e-contact-store-new">e_contact_store_new</link>          (void);
<link linkend="EBook">EBook</link>*      <link linkend="e-contact-store-get-book">e_contact_store_get_book</link>        (<link linkend="EContactStore">EContactStore</link> *contact_store,
                                             <link linkend="GtkTreeIter">GtkTreeIter</link> *iter);
<link linkend="EContact">EContact</link>*   <link linkend="e-contact-store-get-contact">e_contact_store_get_contact</link>     (<link linkend="EContactStore">EContactStore</link> *contact_store,
                                             <link linkend="GtkTreeIter">GtkTreeIter</link> *iter);
<link linkend="gboolean">gboolean</link>    <link linkend="e-contact-store-find-contact">e_contact_store_find_contact</link>    (<link linkend="EContactStore">EContactStore</link> *contact_store,
                                             const <link linkend="gchar">gchar</link> *uid,
                                             <link linkend="GtkTreeIter">GtkTreeIter</link> *iter);
<link linkend="GList">GList</link>*      <link linkend="e-contact-store-get-books">e_contact_store_get_books</link>       (<link linkend="EContactStore">EContactStore</link> *contact_store);
<link linkend="void">void</link>        <link linkend="e-contact-store-add-book">e_contact_store_add_book</link>        (<link linkend="EContactStore">EContactStore</link> *contact_store,
                                             <link linkend="EBook">EBook</link> *book);
<link linkend="void">void</link>        <link linkend="e-contact-store-remove-book">e_contact_store_remove_book</link>     (<link linkend="EContactStore">EContactStore</link> *contact_store,
                                             <link linkend="EBook">EBook</link> *book);
<link linkend="void">void</link>        <link linkend="e-contact-store-set-query">e_contact_store_set_query</link>       (<link linkend="EContactStore">EContactStore</link> *contact_store,
                                             <link linkend="EBookQuery">EBookQuery</link> *book_query);
<link linkend="EBookQuery">EBookQuery</link>* <link linkend="e-contact-store-peek-query">e_contact_store_peek_query</link>      (<link linkend="EContactStore">EContactStore</link> *contact_store);
<link linkend="EBookView">EBookView</link>*  <link linkend="find-contact-source-by-book-return-view">find_contact_source_by_book_return_view</link>
                                            (<link linkend="EContactStore">EContactStore</link> *contact_store,
                                             <link linkend="EBook">EBook</link> *book);


</synopsis>
</refsynopsisdiv>

<refsect1 role="object_hierarchy">
<title role="object_hierarchy.title">Object Hierarchy</title>
<synopsis>

  <link linkend="GObject">GObject</link>
   +----EContactStore
</synopsis>

</refsect1>



<refsect1 role="impl_interfaces">
<title role="impl_interfaces.title">Implemented Interfaces</title>
<para>
EContactStore implements
 <link linkend="GtkTreeModel">GtkTreeModel</link>.</para>

</refsect1>





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

</para>
</refsect1>

<refsect1 role="details">
<title role="details.title">Details</title>
<refsect2>
<title><anchor id="EContactStore" role="typedef"/>EContactStore</title>
<indexterm><primary>EContactStore</primary></indexterm><programlisting>typedef struct EContactStore       EContactStore;
</programlisting>
<para>

</para></refsect2>
<refsect2>
<title><anchor id="e-contact-store-new" role="function"/>e_contact_store_new ()</title>
<indexterm><primary>e_contact_store_new</primary></indexterm><programlisting><link linkend="EContactStore">EContactStore</link>* e_contact_store_new          (void);</programlisting>
<para>
Creates a new <link linkend="EContactStore"><type>EContactStore</type></link>.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> A new <link linkend="EContactStore"><type>EContactStore</type></link>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="e-contact-store-get-book" role="function"/>e_contact_store_get_book ()</title>
<indexterm><primary>e_contact_store_get_book</primary></indexterm><programlisting><link linkend="EBook">EBook</link>*      e_contact_store_get_book        (<link linkend="EContactStore">EContactStore</link> *contact_store,
                                             <link linkend="GtkTreeIter">GtkTreeIter</link> *iter);</programlisting>
<para>
Gets the <link linkend="EBook"><type>EBook</type></link> that provided the contact at <parameter>iter</parameter>.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>contact_store</parameter>&nbsp;:</term>
<listitem><simpara> an <link linkend="EContactStore"><type>EContactStore</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>iter</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="GtkTreeIter"><type>GtkTreeIter</type></link> from <parameter>contact_store</parameter>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> An <link linkend="EBook"><type>EBook</type></link>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="e-contact-store-get-contact" role="function"/>e_contact_store_get_contact ()</title>
<indexterm><primary>e_contact_store_get_contact</primary></indexterm><programlisting><link linkend="EContact">EContact</link>*   e_contact_store_get_contact     (<link linkend="EContactStore">EContactStore</link> *contact_store,
                                             <link linkend="GtkTreeIter">GtkTreeIter</link> *iter);</programlisting>
<para>
Gets the <link linkend="EContact"><type>EContact</type></link> at <parameter>iter</parameter>.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>contact_store</parameter>&nbsp;:</term>
<listitem><simpara> an <link linkend="EContactStore"><type>EContactStore</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>iter</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="GtkTreeIter"><type>GtkTreeIter</type></link> from <parameter>contact_store</parameter>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> An <link linkend="EContact"><type>EContact</type></link>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="e-contact-store-find-contact" role="function"/>e_contact_store_find_contact ()</title>
<indexterm><primary>e_contact_store_find_contact</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    e_contact_store_find_contact    (<link linkend="EContactStore">EContactStore</link> *contact_store,
                                             const <link linkend="gchar">gchar</link> *uid,
                                             <link linkend="GtkTreeIter">GtkTreeIter</link> *iter);</programlisting>
<para>
Sets <parameter>iter</parameter> to point to the contact row matching <parameter>uid</parameter>.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>contact_store</parameter>&nbsp;:</term>
<listitem><simpara> an <link linkend="EContactStore"><type>EContactStore</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>uid</parameter>&nbsp;:</term>
<listitem><simpara> a unique contact identifier
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>iter</parameter>&nbsp;:</term>
<listitem><simpara> a destination <link linkend="GtkTreeIter"><type>GtkTreeIter</type></link> to set
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if the contact was found, and <parameter>iter</parameter> was set. <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> otherwise.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="e-contact-store-get-books" role="function"/>e_contact_store_get_books ()</title>
<indexterm><primary>e_contact_store_get_books</primary></indexterm><programlisting><link linkend="GList">GList</link>*      e_contact_store_get_books       (<link linkend="EContactStore">EContactStore</link> *contact_store);</programlisting>
<para>
Gets the list of books that provide contacts for <parameter>contact_store</parameter>.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>contact_store</parameter>&nbsp;:</term>
<listitem><simpara> an <link linkend="EContactStore"><type>EContactStore</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> A <link linkend="GList"><type>GList</type></link> of pointers to <link linkend="EBook"><type>EBook</type></link>. The caller owns the list,
but not the books.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="e-contact-store-add-book" role="function"/>e_contact_store_add_book ()</title>
<indexterm><primary>e_contact_store_add_book</primary></indexterm><programlisting><link linkend="void">void</link>        e_contact_store_add_book        (<link linkend="EContactStore">EContactStore</link> *contact_store,
                                             <link linkend="EBook">EBook</link> *book);</programlisting>
<para>
Adds <parameter>book</parameter> to the list of books that provide contacts for <parameter>contact_store</parameter>.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>contact_store</parameter>&nbsp;:</term>
<listitem><simpara> an <link linkend="EContactStore"><type>EContactStore</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>book</parameter>&nbsp;:</term>
<listitem><simpara> an <link linkend="EBook"><type>EBook</type></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="e-contact-store-remove-book" role="function"/>e_contact_store_remove_book ()</title>
<indexterm><primary>e_contact_store_remove_book</primary></indexterm><programlisting><link linkend="void">void</link>        e_contact_store_remove_book     (<link linkend="EContactStore">EContactStore</link> *contact_store,
                                             <link linkend="EBook">EBook</link> *book);</programlisting>
<para>
Removes <parameter>book</parameter> from the list of books that provide contacts for <parameter>contact_store</parameter>.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>contact_store</parameter>&nbsp;:</term>
<listitem><simpara> an <link linkend="EContactStore"><type>EContactStore</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>book</parameter>&nbsp;:</term>
<listitem><simpara> an <link linkend="EBook"><type>EBook</type></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="e-contact-store-set-query" role="function"/>e_contact_store_set_query ()</title>
<indexterm><primary>e_contact_store_set_query</primary></indexterm><programlisting><link linkend="void">void</link>        e_contact_store_set_query       (<link linkend="EContactStore">EContactStore</link> *contact_store,
                                             <link linkend="EBookQuery">EBookQuery</link> *book_query);</programlisting>
<para>
Sets <parameter>book_query</parameter> to be the query used to fetch contacts from the books
assigned to <parameter>contact_store</parameter>.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>contact_store</parameter>&nbsp;:</term>
<listitem><simpara> an <link linkend="EContactStore"><type>EContactStore</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>book_query</parameter>&nbsp;:</term>
<listitem><simpara> an <link linkend="EBookQuery"><type>EBookQuery</type></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="e-contact-store-peek-query" role="function"/>e_contact_store_peek_query ()</title>
<indexterm><primary>e_contact_store_peek_query</primary></indexterm><programlisting><link linkend="EBookQuery">EBookQuery</link>* e_contact_store_peek_query      (<link linkend="EContactStore">EContactStore</link> *contact_store);</programlisting>
<para>
Gets the query that's being used to fetch contacts from the books
assigned to <parameter>contact_store</parameter>.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>contact_store</parameter>&nbsp;:</term>
<listitem><simpara> an <link linkend="EContactStore"><type>EContactStore</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> The <link linkend="EBookQuery"><type>EBookQuery</type></link> being used.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="find-contact-source-by-book-return-view" role="function"/>find_contact_source_by_book_return_view ()</title>
<indexterm><primary>find_contact_source_by_book_return_view</primary></indexterm><programlisting><link linkend="EBookView">EBookView</link>*  find_contact_source_by_book_return_view
                                            (<link linkend="EContactStore">EContactStore</link> *contact_store,
                                             <link linkend="EBook">EBook</link> *book);</programlisting>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>contact_store</parameter>&nbsp;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>book</parameter>&nbsp;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>


</simpara></listitem></varlistentry>
</variablelist></refsect2>

</refsect1>




</refentry>
