← 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/libedataserver/xml/e-categories.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/libedataserver/xml/e-categories.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="libedataserver-e-categories">
5
 
<refmeta>
6
 
<refentrytitle role="top_of_page" id="libedataserver-e-categories.top_of_page">e-categories</refentrytitle>
7
 
<manvolnum>3</manvolnum>
8
 
<refmiscinfo>
9
 
  LIBEDATASERVER Library
10
 
</refmiscinfo>
11
 
</refmeta>
12
 
<refnamediv>
13
 
<refname>e-categories</refname>
14
 
<refpurpose></refpurpose>
15
 
</refnamediv>
16
 
 
17
 
<refsynopsisdiv id="libedataserver-e-categories.synopsis" role="synopsis">
18
 
<title role="synopsis.title">Synopsis</title>
19
 
 
20
 
<synopsis><link linkend="GList"><returnvalue>GList</returnvalue></link> *             <link linkend="e-categories-get-list">e_categories_get_list</link>               (<parameter><type>void</type></parameter>);
21
 
<link linkend="void"><returnvalue>void</returnvalue></link>                <link linkend="e-categories-add">e_categories_add</link>                    (<parameter>const <link linkend="gchar"><type>gchar</type></link> *category</parameter>,
22
 
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *unused</parameter>,
23
 
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *icon_file</parameter>,
24
 
                                                         <parameter><link linkend="gboolean"><type>gboolean</type></link> searchable</parameter>);
25
 
<link linkend="void"><returnvalue>void</returnvalue></link>                <link linkend="e-categories-remove">e_categories_remove</link>                 (<parameter>const <link linkend="gchar"><type>gchar</type></link> *category</parameter>);
26
 
<link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            <link linkend="e-categories-exist">e_categories_exist</link>                  (<parameter>const <link linkend="gchar"><type>gchar</type></link> *category</parameter>);
27
 
const <link linkend="gchar"><returnvalue>gchar</returnvalue></link> *       <link linkend="e-categories-get-color-for">e_categories_get_color_for</link>          (<parameter>const <link linkend="gchar"><type>gchar</type></link> *category</parameter>);
28
 
<link linkend="void"><returnvalue>void</returnvalue></link>                <link linkend="e-categories-set-color-for">e_categories_set_color_for</link>          (<parameter>const <link linkend="gchar"><type>gchar</type></link> *category</parameter>,
29
 
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *color</parameter>);
30
 
const <link linkend="gchar"><returnvalue>gchar</returnvalue></link> *       <link linkend="e-categories-get-icon-file-for">e_categories_get_icon_file_for</link>      (<parameter>const <link linkend="gchar"><type>gchar</type></link> *category</parameter>);
31
 
<link linkend="void"><returnvalue>void</returnvalue></link>                <link linkend="e-categories-set-icon-file-for">e_categories_set_icon_file_for</link>      (<parameter>const <link linkend="gchar"><type>gchar</type></link> *category</parameter>,
32
 
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *icon_file</parameter>);
33
 
<link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            <link linkend="e-categories-is-searchable">e_categories_is_searchable</link>          (<parameter>const <link linkend="gchar"><type>gchar</type></link> *category</parameter>);
34
 
<link linkend="void"><returnvalue>void</returnvalue></link>                <link linkend="e-categories-register-change-listener">e_categories_register_change_listener</link>
35
 
                                                        (<parameter><link linkend="GCallback"><type>GCallback</type></link> listener</parameter>,
36
 
                                                         <parameter><link linkend="gpointer"><type>gpointer</type></link> user_data</parameter>);
37
 
<link linkend="void"><returnvalue>void</returnvalue></link>                <link linkend="e-categories-unregister-change-listener">e_categories_unregister_change_listener</link>
38
 
                                                        (<parameter><link linkend="GCallback"><type>GCallback</type></link> listener</parameter>,
39
 
                                                         <parameter><link linkend="gpointer"><type>gpointer</type></link> user_data</parameter>);
40
 
</synopsis>
41
 
</refsynopsisdiv>
42
 
 
43
 
<refsect1 id="libedataserver-e-categories.description" role="desc">
44
 
<title role="desc.title">Description</title>
45
 
<para>
46
 
</para>
47
 
</refsect1>
48
 
<refsect1 id="libedataserver-e-categories.details" role="details">
49
 
<title role="details.title">Details</title>
50
 
<refsect2 id="e-categories-get-list" role="function">
51
 
<title>e_categories_get_list ()</title>
52
 
<indexterm zone="e-categories-get-list"><primary>e_categories_get_list</primary></indexterm>
53
 
<programlisting><link linkend="GList"><returnvalue>GList</returnvalue></link> *             e_categories_get_list               (<parameter><type>void</type></parameter>);</programlisting>
54
 
<para>
55
 
Returns a sorted list of all the category names currently configured.</para>
56
 
<variablelist role="params">
57
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a sorted GList containing the names of the categories. The
58
 
list should be freed using g_list_free, but the names of the categories
59
 
should not be touched at all, they are internal strings.
60
 
</simpara></listitem></varlistentry>
61
 
</variablelist></refsect2>
62
 
<refsect2 id="e-categories-add" role="function">
63
 
<title>e_categories_add ()</title>
64
 
<indexterm zone="e-categories-add"><primary>e_categories_add</primary></indexterm>
65
 
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link>                e_categories_add                    (<parameter>const <link linkend="gchar"><type>gchar</type></link> *category</parameter>,
66
 
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *unused</parameter>,
67
 
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *icon_file</parameter>,
68
 
                                                         <parameter><link linkend="gboolean"><type>gboolean</type></link> searchable</parameter>);</programlisting>
69
 
<para>
70
 
Adds a new category, with its corresponding icon, to the
71
 
configuration database.</para>
72
 
<variablelist role="params">
73
 
<varlistentry><term><parameter>category</parameter>&#160;:</term>
74
 
<listitem><simpara>name of category to add.
75
 
</simpara></listitem></varlistentry>
76
 
<varlistentry><term><parameter>unused</parameter>&#160;:</term>
77
 
<listitem><simpara>DEPRECATED! associated color. DEPRECATED!
78
 
</simpara></listitem></varlistentry>
79
 
<varlistentry><term><parameter>icon_file</parameter>&#160;:</term>
80
 
<listitem><simpara>full path of the icon associated to the category.
81
 
</simpara></listitem></varlistentry>
82
 
<varlistentry><term><parameter>searchable</parameter>&#160;:</term>
83
 
<listitem><simpara>whether the category can be used for searching in the GUI.
84
 
</simpara></listitem></varlistentry>
85
 
</variablelist></refsect2>
86
 
<refsect2 id="e-categories-remove" role="function">
87
 
<title>e_categories_remove ()</title>
88
 
<indexterm zone="e-categories-remove"><primary>e_categories_remove</primary></indexterm>
89
 
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link>                e_categories_remove                 (<parameter>const <link linkend="gchar"><type>gchar</type></link> *category</parameter>);</programlisting>
90
 
<para>
91
 
Removes the given category from the configuration.</para>
92
 
<variablelist role="params">
93
 
<varlistentry><term><parameter>category</parameter>&#160;:</term>
94
 
<listitem><simpara>category to be removed.
95
 
</simpara></listitem></varlistentry>
96
 
</variablelist></refsect2>
97
 
<refsect2 id="e-categories-exist" role="function">
98
 
<title>e_categories_exist ()</title>
99
 
<indexterm zone="e-categories-exist"><primary>e_categories_exist</primary></indexterm>
100
 
<programlisting><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            e_categories_exist                  (<parameter>const <link linkend="gchar"><type>gchar</type></link> *category</parameter>);</programlisting>
101
 
<para>
102
 
Checks whether the given category is available in the configuration.</para>
103
 
<variablelist role="params">
104
 
<varlistentry><term><parameter>category</parameter>&#160;:</term>
105
 
<listitem><simpara>category to be searched.
106
 
</simpara></listitem></varlistentry>
107
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if the category is available, <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> otherwise.
108
 
</simpara></listitem></varlistentry>
109
 
</variablelist></refsect2>
110
 
<refsect2 id="e-categories-get-color-for" role="function" condition="deprecated:">
111
 
<title>e_categories_get_color_for ()</title>
112
 
<indexterm zone="e-categories-get-color-for" role="deprecated"><primary>e_categories_get_color_for</primary></indexterm>
113
 
<programlisting>const <link linkend="gchar"><returnvalue>gchar</returnvalue></link> *       e_categories_get_color_for          (<parameter>const <link linkend="gchar"><type>gchar</type></link> *category</parameter>);</programlisting>
114
 
<warning><para><literal>e_categories_get_color_for</literal> is deprecated and should not be used in newly-written code.</para></warning>
115
 
<variablelist role="params">
116
 
<varlistentry><term><parameter>category</parameter>&#160;:</term>
117
 
<listitem><simpara>category to retrieve the color for.
118
 
</simpara></listitem></varlistentry>
119
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="NULL:CAPS"><literal>NULL</literal></link>, always
120
 
 
121
 
DEPRECATED!
122
 
</simpara></listitem></varlistentry>
123
 
</variablelist></refsect2>
124
 
<refsect2 id="e-categories-set-color-for" role="function" condition="deprecated:">
125
 
<title>e_categories_set_color_for ()</title>
126
 
<indexterm zone="e-categories-set-color-for" role="deprecated"><primary>e_categories_set_color_for</primary></indexterm>
127
 
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link>                e_categories_set_color_for          (<parameter>const <link linkend="gchar"><type>gchar</type></link> *category</parameter>,
128
 
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *color</parameter>);</programlisting>
129
 
<warning><para><literal>e_categories_set_color_for</literal> is deprecated and should not be used in newly-written code.</para></warning>
130
 
<para>
131
 
This function does nothing.
132
 
</para>
133
 
<para>
134
 
DEPRECATED!</para>
135
 
<variablelist role="params">
136
 
<varlistentry><term><parameter>category</parameter>&#160;:</term>
137
 
<listitem><simpara>category to set the color for.
138
 
</simpara></listitem></varlistentry>
139
 
<varlistentry><term><parameter>color</parameter>&#160;:</term>
140
 
<listitem><simpara>X color.
141
 
</simpara></listitem></varlistentry>
142
 
</variablelist></refsect2>
143
 
<refsect2 id="e-categories-get-icon-file-for" role="function">
144
 
<title>e_categories_get_icon_file_for ()</title>
145
 
<indexterm zone="e-categories-get-icon-file-for"><primary>e_categories_get_icon_file_for</primary></indexterm>
146
 
<programlisting>const <link linkend="gchar"><returnvalue>gchar</returnvalue></link> *       e_categories_get_icon_file_for      (<parameter>const <link linkend="gchar"><type>gchar</type></link> *category</parameter>);</programlisting>
147
 
<para>
148
 
Gets the icon file associated with the given category.</para>
149
 
<variablelist role="params">
150
 
<varlistentry><term><parameter>category</parameter>&#160;:</term>
151
 
<listitem><simpara>category to retrieve the icon file for.
152
 
</simpara></listitem></varlistentry>
153
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> icon file name.
154
 
</simpara></listitem></varlistentry>
155
 
</variablelist></refsect2>
156
 
<refsect2 id="e-categories-set-icon-file-for" role="function">
157
 
<title>e_categories_set_icon_file_for ()</title>
158
 
<indexterm zone="e-categories-set-icon-file-for"><primary>e_categories_set_icon_file_for</primary></indexterm>
159
 
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link>                e_categories_set_icon_file_for      (<parameter>const <link linkend="gchar"><type>gchar</type></link> *category</parameter>,
160
 
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *icon_file</parameter>);</programlisting>
161
 
<para>
162
 
Sets the icon file associated with the given category.</para>
163
 
<variablelist role="params">
164
 
<varlistentry><term><parameter>category</parameter>&#160;:</term>
165
 
<listitem><simpara>category to set the icon file for.
166
 
</simpara></listitem></varlistentry>
167
 
<varlistentry><term><parameter>icon_file</parameter>&#160;:</term>
168
 
<listitem><simpara>icon file.
169
 
</simpara></listitem></varlistentry>
170
 
</variablelist></refsect2>
171
 
<refsect2 id="e-categories-is-searchable" role="function">
172
 
<title>e_categories_is_searchable ()</title>
173
 
<indexterm zone="e-categories-is-searchable"><primary>e_categories_is_searchable</primary></indexterm>
174
 
<programlisting><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            e_categories_is_searchable          (<parameter>const <link linkend="gchar"><type>gchar</type></link> *category</parameter>);</programlisting>
175
 
<para>
176
 
Gets whether the given calendar is to be used for searches in the GUI.
177
 
</para>
178
 
<para>
179
 
Return value; <link linkend="TRUE:CAPS"><literal>TRUE</literal></link>% if the category is searchable, <link linkend="FALSE:CAPS"><literal>FALSE</literal></link>% if not.</para>
180
 
<variablelist role="params">
181
 
<varlistentry><term><parameter>category</parameter>&#160;:</term>
182
 
<listitem><simpara>category name.
183
 
</simpara></listitem></varlistentry>
184
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>
185
 
</simpara></listitem></varlistentry>
186
 
</variablelist></refsect2>
187
 
<refsect2 id="e-categories-register-change-listener" role="function">
188
 
<title>e_categories_register_change_listener ()</title>
189
 
<indexterm zone="e-categories-register-change-listener"><primary>e_categories_register_change_listener</primary></indexterm>
190
 
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link>                e_categories_register_change_listener
191
 
                                                        (<parameter><link linkend="GCallback"><type>GCallback</type></link> listener</parameter>,
192
 
                                                         <parameter><link linkend="gpointer"><type>gpointer</type></link> user_data</parameter>);</programlisting>
193
 
<para>
194
 
Registers callback to be called on change of any category.
195
 
Pair listener and user_data is used to distinguish between listeners.
196
 
Listeners can be unregistered with <parameter>e_categories_unregister_change_listener</parameter>.</para>
197
 
<variablelist role="params">
198
 
<varlistentry><term><parameter>listener</parameter>&#160;:</term>
199
 
<listitem><simpara>the callback to be called on any category change.
200
 
</simpara></listitem></varlistentry>
201
 
<varlistentry><term><parameter>user_data</parameter>&#160;:</term>
202
 
<listitem><simpara>used data passed to the <parameter>listener</parameter> when called.
203
 
</simpara></listitem></varlistentry>
204
 
</variablelist></refsect2>
205
 
<refsect2 id="e-categories-unregister-change-listener" role="function">
206
 
<title>e_categories_unregister_change_listener ()</title>
207
 
<indexterm zone="e-categories-unregister-change-listener"><primary>e_categories_unregister_change_listener</primary></indexterm>
208
 
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link>                e_categories_unregister_change_listener
209
 
                                                        (<parameter><link linkend="GCallback"><type>GCallback</type></link> listener</parameter>,
210
 
                                                         <parameter><link linkend="gpointer"><type>gpointer</type></link> user_data</parameter>);</programlisting>
211
 
<para>
212
 
Removes previously registered callback from the list of listeners on changes.
213
 
If it was not registered, then does nothing.</para>
214
 
<variablelist role="params">
215
 
<varlistentry><term><parameter>listener</parameter>&#160;:</term>
216
 
<listitem><simpara>Callback to be removed.
217
 
</simpara></listitem></varlistentry>
218
 
<varlistentry><term><parameter>user_data</parameter>&#160;:</term>
219
 
<listitem><simpara>User data as passed with call to <parameter>e_categories_register_change_listener</parameter>.
220
 
</simpara></listitem></varlistentry>
221
 
</variablelist></refsect2>
222
 
 
223
 
</refsect1>
224
 
 
225
 
</refentry>