File: EBookView.html

package info (click to toggle)
evolution-data-server 1.0.4-1
  • links: PTS
  • area: main
  • in suites: sarge
  • size: 39,504 kB
  • ctags: 26,423
  • sloc: ansic: 175,347; tcl: 30,499; sh: 20,699; perl: 11,320; xml: 9,039; java: 7,653; cpp: 6,029; makefile: 4,866; awk: 1,338; yacc: 1,103; sed: 772; cs: 505; lex: 134; asm: 14
file content (110 lines) | stat: -rw-r--r-- 14,436 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>EBookView</title><meta name="generator" content="DocBook XSL Stylesheets V1.64.1"><link rel="home" href="index.html" title="Evolution API Reference: libebook, the Addressbook Library"><link rel="up" href="ch01.html" title="Evolution API Reference: libebook, the Addressbook Library"><link rel="previous" href="EBookListener.html" title="EBookListener"><link rel="next" href="EBookViewListener.html" title="EBookViewListener"><link rel="chapter" href="ch01.html" title="Evolution API Reference: libebook, the Addressbook Library"><link rel="refentry" href="EBook.html" title="EBook"><link rel="refentry" href="libebook-e-book-query.html" title="e-book-query"><link rel="refentry" href="EContact.html" title="EContact"><link rel="refentry" href="EVCard.html" title="EVCard"><link rel="refentry" href="EBookListener.html" title="EBookListener"><link rel="refentry" href="EBookView.html" title="EBookView"><link rel="refentry" href="EBookViewListener.html" title="EBookViewListener"><link rel="refentry" href="libebook-e-book-async.html" title="e-book-async"><link rel="refentry" href="libebook-e-book-types.html" title="e-book-types"><link rel="refentry" href="libebook-EAddressWestern.html" title="e-address-western"><link rel="refentry" href="libebook-ENameWestern.html" title="e-name-western"><link rel="section" href="EBookView.html#id2525221" title="Object Hierarchy"><link rel="section" href="EBookView.html#id2525236" title="Signal Prototypes"><link rel="section" href="EBookView.html#id2566453" title="Description"><link rel="section" href="EBookView.html#id2566476" title="Details"><link rel="section" href="EBookView.html#id2565928" title="Signals"><link rel="section" href="EBookView.html#id2568813" title="See Also"><meta name="generator" content="GTK-Doc V1.2 (XML mode)"><link rel="stylesheet" href="style.css" type="text/css"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><table class="navigation" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"><tr valign="middle"><td><a accesskey="p" href="EBookListener.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td><td><a accesskey="u" href="ch01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td><td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td><th width="100%" align="center">Evolution API Reference: libebook, the Addressbook Library</th><td><a accesskey="n" href="EBookViewListener.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td></tr></table><div class="refentry" lang="en"><a name="EBookView"></a><div class="titlepage"><div></div><div></div></div><div class="refnamediv"><h2><span class="refentrytitle">EBookView</span></h2><p>EBookView &#8212; Represents a search against an EBook.</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><pre class="synopsis">



struct      <a href="EBookView.html#EBookView-struct">EBookView</a>;
<a href="EBookView.html" title="EBookView">EBookView</a>*  <a href="EBookView.html#e-book-view-new">e_book_view_new</a>                 (GNOME_Evolution_Addressbook_BookView corba_book_view,
                                             <a href="EBookViewListener.html" title="EBookViewListener">EBookViewListener</a> *listener);
void        <a href="EBookView.html#e-book-view-set-book">e_book_view_set_book</a>            (<a href="EBookView.html" title="EBookView">EBookView</a> *book_view,
                                             struct <a href="EBook.html" title="EBook">_EBook</a> *book);
void        <a href="EBookView.html#e-book-view-start">e_book_view_start</a>               (<a href="EBookView.html" title="EBookView">EBookView</a> *book_view);
void        <a href="EBookView.html#e-book-view-stop">e_book_view_stop</a>                (<a href="EBookView.html" title="EBookView">EBookView</a> *book_view);


</pre></div><div class="refsect1" lang="en"><a name="id2525221"></a><h2>Object Hierarchy</h2><pre class="synopsis">

  GObject
   +----EBookView
</pre></div><div class="refsect1" lang="en"><a name="id2525236"></a><h2>Signal Prototypes</h2><pre class="synopsis">

"<a href="EBookView.html#EBookView-contacts-added">contacts-added</a>"
            void        user_function      (<a href="EBookView.html" title="EBookView">EBookView</a> *ebookview,
                                            gpointer arg1,
                                            gpointer user_data);
"<a href="EBookView.html#EBookView-contacts-changed">contacts-changed</a>"
            void        user_function      (<a href="EBookView.html" title="EBookView">EBookView</a> *ebookview,
                                            gpointer arg1,
                                            gpointer user_data);
"<a href="EBookView.html#EBookView-contacts-removed">contacts-removed</a>"
            void        user_function      (<a href="EBookView.html" title="EBookView">EBookView</a> *ebookview,
                                            gpointer arg1,
                                            gpointer user_data);
"<a href="EBookView.html#EBookView-sequence-complete">sequence-complete</a>"
            void        user_function      (<a href="EBookView.html" title="EBookView">EBookView</a> *ebookview,
                                            gint arg1,
                                            gpointer user_data);
"<a href="EBookView.html#EBookView-status-message">status-message</a>"
            void        user_function      (<a href="EBookView.html" title="EBookView">EBookView</a> *ebookview,
                                            gchar *arg1,
                                            gpointer user_data);
</pre></div><div class="refsect1" lang="en"><a name="id2566453"></a><h2>Description</h2><p>
Event notifications and callbacks from EBookView go to the
<span class="type">e-book-view-listener</span>. Contrast EBookView with <span class="type">e-book</span>, which represents the
addressbook itself.
</p></div><div class="refsect1" lang="en"><a name="id2566476"></a><h2>Details</h2><div class="refsect2" lang="en"><a name="id2566482"></a><h3><a name="EBookView-struct"></a>struct EBookView</h3><a class="indexterm" name="id2566490"></a><pre class="programlisting">struct EBookView;</pre><p>

</p></div><hr><div class="refsect2" lang="en"><a name="id2566500"></a><h3><a name="e-book-view-new"></a>e_book_view_new ()</h3><a class="indexterm" name="id2565718"></a><pre class="programlisting"><a href="EBookView.html" title="EBookView">EBookView</a>*  e_book_view_new                 (GNOME_Evolution_Addressbook_BookView corba_book_view,
                                             <a href="EBookViewListener.html" title="EBookViewListener">EBookViewListener</a> *listener);</pre><p>

</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>corba_book_view</tt></i>:</span></td><td>
</td></tr><tr><td><span class="term"><i class="parameter"><tt>listener</tt></i>:</span></td><td>
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>


</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2565781"></a><h3><a name="e-book-view-set-book"></a>e_book_view_set_book ()</h3><a class="indexterm" name="id2565789"></a><pre class="programlisting">void        e_book_view_set_book            (<a href="EBookView.html" title="EBookView">EBookView</a> *book_view,
                                             struct <a href="EBook.html" title="EBook">_EBook</a> *book);</pre><p>

</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>book_view</tt></i>:</span></td><td>
</td></tr><tr><td><span class="term"><i class="parameter"><tt>book</tt></i>:</span></td><td>


</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2565841"></a><h3><a name="e-book-view-start"></a>e_book_view_start ()</h3><a class="indexterm" name="id2565849"></a><pre class="programlisting">void        e_book_view_start               (<a href="EBookView.html" title="EBookView">EBookView</a> *book_view);</pre><p>

</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>book_view</tt></i>:</span></td><td>


</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2565884"></a><h3><a name="e-book-view-stop"></a>e_book_view_stop ()</h3><a class="indexterm" name="id2565892"></a><pre class="programlisting">void        e_book_view_stop                (<a href="EBookView.html" title="EBookView">EBookView</a> *book_view);</pre><p>

</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>book_view</tt></i>:</span></td><td>


</td></tr></tbody></table></div></div></div><div class="refsect1" lang="en"><a name="id2565928"></a><h2>Signals</h2><div class="refsect2" lang="en"><a name="id2565933"></a><h3><a name="EBookView-contacts-added"></a>The "contacts-added" signal</h3><pre class="programlisting">void        user_function                  (<a href="EBookView.html" title="EBookView">EBookView</a> *ebookview,
                                            gpointer arg1,
                                            gpointer user_data);</pre><p>
Fired when more contacts are found.  Each contact in the list will be unref'd
when done, and the list freed, so simply reference any contacts you want to
keep.
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>ebookview</tt></i>:</span></td><td>the object which received the signal.
</td></tr><tr><td><span class="term"><i class="parameter"><tt>arg1</tt></i>:</span></td><td>

</td></tr><tr><td><span class="term"><i class="parameter"><tt>user_data</tt></i>:</span></td><td>user data set when the signal handler was connected.</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2528419"></a><h3><a name="EBookView-contacts-changed"></a>The "contacts-changed" signal</h3><pre class="programlisting">void        user_function                  (<a href="EBookView.html" title="EBookView">EBookView</a> *ebookview,
                                            gpointer arg1,
                                            gpointer user_data);</pre><p>

</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>ebookview</tt></i>:</span></td><td>the object which received the signal.
</td></tr><tr><td><span class="term"><i class="parameter"><tt>arg1</tt></i>:</span></td><td>

</td></tr><tr><td><span class="term"><i class="parameter"><tt>user_data</tt></i>:</span></td><td>user data set when the signal handler was connected.</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2528492"></a><h3><a name="EBookView-contacts-removed"></a>The "contacts-removed" signal</h3><pre class="programlisting">void        user_function                  (<a href="EBookView.html" title="EBookView">EBookView</a> *ebookview,
                                            gpointer arg1,
                                            gpointer user_data);</pre><p>

</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>ebookview</tt></i>:</span></td><td>the object which received the signal.
</td></tr><tr><td><span class="term"><i class="parameter"><tt>arg1</tt></i>:</span></td><td>

</td></tr><tr><td><span class="term"><i class="parameter"><tt>user_data</tt></i>:</span></td><td>user data set when the signal handler was connected.</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2528566"></a><h3><a name="EBookView-sequence-complete"></a>The "sequence-complete" signal</h3><pre class="programlisting">void        user_function                  (<a href="EBookView.html" title="EBookView">EBookView</a> *ebookview,
                                            gint arg1,
                                            gpointer user_data);</pre><p>

</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>ebookview</tt></i>:</span></td><td>the object which received the signal.
</td></tr><tr><td><span class="term"><i class="parameter"><tt>arg1</tt></i>:</span></td><td>

</td></tr><tr><td><span class="term"><i class="parameter"><tt>user_data</tt></i>:</span></td><td>user data set when the signal handler was connected.</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2528639"></a><h3><a name="EBookView-status-message"></a>The "status-message" signal</h3><pre class="programlisting">void        user_function                  (<a href="EBookView.html" title="EBookView">EBookView</a> *ebookview,
                                            gchar *arg1,
                                            gpointer user_data);</pre><p>

</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>ebookview</tt></i>:</span></td><td>the object which received the signal.
</td></tr><tr><td><span class="term"><i class="parameter"><tt>arg1</tt></i>:</span></td><td>

</td></tr><tr><td><span class="term"><i class="parameter"><tt>user_data</tt></i>:</span></td><td>user data set when the signal handler was connected.</td></tr></tbody></table></div></div></div><div class="refsect1" lang="en"><a name="id2568813"></a><h2>See Also</h2><p>
<span class="type">e-book-view-listener</span>, <span class="type">e-book</span>
</p></div></div><table class="navigation" width="100%" summary="Navigation footer" cellpadding="2" cellspacing="0"><tr valign="middle"><td align="left"><a accesskey="p" href="EBookListener.html"><b>&lt;&lt;EBookListener</b></a></td><td align="right"><a accesskey="n" href="EBookViewListener.html"><b>EBookViewListener&gt;&gt;</b></a></td></tr></table></body></html>