blob: be999ae2dfe9e7e02cb08e15db9806f0cce25693 (
plain)
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
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
|
<refentry id="eds-cursor-example" revision="30 Nov 2013">
<refmeta>
<refentrytitle>Contacts Browser Example</refentrytitle>
<refmiscinfo>Contacts Browser Example</refmiscinfo>
</refmeta>
<refnamediv>
<refname>Contacts Browser Example</refname>
<refpurpose>
Explanation of how to create a scrolling window listing contacts in
alphabetical order.
</refpurpose>
</refnamediv>
<refsect1>
<title>Introduction</title>
<para>
This is a fully functional reference application for implementing scrolling contact
browsers using the #EBookClientCursor. With the cursor, the following features are
possible.
</para>
<itemizedlist>
<listitem>
<para>Display contacts in a configurable sort order</para>
<para>
Sort by any #EContactField which conforms to #G_TYPE_STRING, this can be checked
with e_contact_field_type()
</para>
</listitem>
<listitem>
<para>Minimal memory constraints</para>
<para>
Only load into memory the contacts which are currently visible in the list
</para>
</listitem>
<listitem>
<para>Filter search results on the fly</para>
<para>
Set new search expressions generated with #EBookQuery on the fly. Refresh
the contact list at the current position without losing the current cursor
position.
</para>
</listitem>
<listitem>
<para>Display the the user's alphabet</para>
<para>
Using interesting features from ICU libraries allow us to display
the user's alphabet, and implement features such as jumping to
a given letter in the user's alphabet.
</para>
</listitem>
</itemizedlist>
<para>
The actual example code is built into the 'example' subdirectory of the Evolution Data Server
sources. In order to run the example, just launch the program and give it a path to a directory
full of vcards, bearing the .vcf filename extention.
</para>
</refsect1>
<refsect1>
<title>Contact Browser</title>
<para>
Below is an example of the contact browser code itself, the example program is
broken down into a couple of object classes which are also listed below.
</para>
<informalexample>
<programlisting>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
parse="text"
href="@CMAKE_SOURCE_DIR@/src/examples/cursor/cursor-example.c"/>
</programlisting>
</informalexample>
</refsect1>
<refsect1>
<title>The alphabetic navigator</title>
<para>
This is a simple class which implements a vertical scroller and displays
various letters according to the currently active alphabet. The actual
interaction with #EBookClientCursor is done in the main contact browser
and this class is simply configured with the active alphabet.
</para>
<informalexample>
<programlisting>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
parse="text"
href="@CMAKE_SOURCE_DIR@/src/examples/cursor/cursor-navigator.c"/>
</programlisting>
</informalexample>
</refsect1>
<refsect1>
<title>The search entry</title>
<para>
The search entry is placed at the top of the contacts browser,
this class simply implements a drop down box choosing the appropriate
search expression which should be used to filter the contacts
in the browser display window.
</para>
<informalexample>
<programlisting>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
parse="text"
href="@CMAKE_SOURCE_DIR@/src/examples/cursor/cursor-search.c"/>
</programlisting>
</informalexample>
</refsect1>
<refsect1>
<title>The contact slot</title>
<para>
This is a very simple class who's only purpose is to display
contact related data, each entry in the list is a 'slot'
</para>
<informalexample>
<programlisting>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
parse="text"
href="@CMAKE_SOURCE_DIR@/src/examples/cursor/cursor-slot.c"/>
</programlisting>
</informalexample>
</refsect1>
<refsect1>
<title>Creating addressbooks and loading vcards</title>
<para>
This is the messy part of the example, here we take care
of creating a custom addressbook and populating it with
the contacts found in the directory given to the example.
</para>
<informalexample>
<programlisting>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
parse="text"
href="@CMAKE_SOURCE_DIR@/src/examples/cursor/cursor-data.c"/>
</programlisting>
</informalexample>
</refsect1>
</refentry>
|
