← Back to branch summary

~ubuntu-branches/ubuntu/natty/evolution-data-server/natty

« back to all changes in this revision

Viewing changes to docs/reference/libedataserver/xml/e-url.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-url.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-url">
5
 
<refmeta>
6
 
<refentrytitle role="top_of_page" id="libedataserver-e-url.top_of_page">EUrl</refentrytitle>
7
 
<manvolnum>3</manvolnum>
8
 
<refmiscinfo>
9
 
  LIBEDATASERVER Library
10
 
</refmiscinfo>
11
 
</refmeta>
12
 
<refnamediv>
13
 
<refname>EUrl</refname>
14
 
<refpurpose>A URI data structure and associated functions.</refpurpose>
15
 
</refnamediv>
16
 
 
17
 
<refsynopsisdiv id="libedataserver-e-url.synopsis" role="synopsis">
18
 
<title role="synopsis.title">Synopsis</title>
19
 
 
20
 
<synopsis><link linkend="gchar"><returnvalue>gchar</returnvalue></link> *             <link linkend="e-url-shroud">e_url_shroud</link>                        (<parameter>const <link linkend="gchar"><type>gchar</type></link> *url</parameter>);
21
 
<link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            <link linkend="e-url-equal">e_url_equal</link>                         (<parameter>const <link linkend="gchar"><type>gchar</type></link> *url1</parameter>,
22
 
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *url2</parameter>);
23
 
                    <link linkend="EUri">EUri</link>;
24
 
<link linkend="EUri"><returnvalue>EUri</returnvalue></link> *              <link linkend="e-uri-new">e_uri_new</link>                           (<parameter>const <link linkend="gchar"><type>gchar</type></link> *uri_string</parameter>);
25
 
<link linkend="void"><returnvalue>void</returnvalue></link>                <link linkend="e-uri-free">e_uri_free</link>                          (<parameter><link linkend="EUri"><type>EUri</type></link> *uri</parameter>);
26
 
const <link linkend="gchar"><returnvalue>gchar</returnvalue></link> *       <link linkend="e-uri-get-param">e_uri_get_param</link>                     (<parameter><link linkend="EUri"><type>EUri</type></link> *uri</parameter>,
27
 
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *name</parameter>);
28
 
<link linkend="EUri"><returnvalue>EUri</returnvalue></link> *              <link linkend="e-uri-copy">e_uri_copy</link>                          (<parameter><link linkend="EUri"><type>EUri</type></link> *uri</parameter>);
29
 
<link linkend="gchar"><returnvalue>gchar</returnvalue></link> *             <link linkend="e-uri-to-string">e_uri_to_string</link>                     (<parameter><link linkend="EUri"><type>EUri</type></link> *uri</parameter>,
30
 
                                                         <parameter><link linkend="gboolean"><type>gboolean</type></link> show_password</parameter>);
31
 
</synopsis>
32
 
</refsynopsisdiv>
33
 
 
34
 
<refsect1 id="libedataserver-e-url.description" role="desc">
35
 
<title role="desc.title">Description</title>
36
 
<para>
37
 
</para>
38
 
</refsect1>
39
 
<refsect1 id="libedataserver-e-url.details" role="details">
40
 
<title role="details.title">Details</title>
41
 
<refsect2 id="e-url-shroud" role="function">
42
 
<title>e_url_shroud ()</title>
43
 
<indexterm zone="e-url-shroud"><primary>e_url_shroud</primary></indexterm>
44
 
<programlisting><link linkend="gchar"><returnvalue>gchar</returnvalue></link> *             e_url_shroud                        (<parameter>const <link linkend="gchar"><type>gchar</type></link> *url</parameter>);</programlisting>
45
 
<para>
46
 
Removes the moniker (i.e. mailto:) from a url.</para>
47
 
<variablelist role="params">
48
 
<varlistentry><term><parameter>url</parameter>&#160;:</term>
49
 
<listitem><simpara>The url to shroud.
50
 
</simpara></listitem></varlistentry>
51
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> The newly-allocated shrouded url.
52
 
</simpara></listitem></varlistentry>
53
 
</variablelist></refsect2>
54
 
<refsect2 id="e-url-equal" role="function">
55
 
<title>e_url_equal ()</title>
56
 
<indexterm zone="e-url-equal"><primary>e_url_equal</primary></indexterm>
57
 
<programlisting><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            e_url_equal                         (<parameter>const <link linkend="gchar"><type>gchar</type></link> *url1</parameter>,
58
 
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *url2</parameter>);</programlisting>
59
 
<para>
60
 
Checks two urls for equality, after first removing any monikers on
61
 
the urls.</para>
62
 
<variablelist role="params">
63
 
<varlistentry><term><parameter>url1</parameter>&#160;:</term>
64
 
<listitem><simpara>The first url to compare.
65
 
</simpara></listitem></varlistentry>
66
 
<varlistentry><term><parameter>url2</parameter>&#160;:</term>
67
 
<listitem><simpara>The second url to compare.
68
 
</simpara></listitem></varlistentry>
69
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if the urls are equal, <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> if they are not.
70
 
</simpara></listitem></varlistentry>
71
 
</variablelist></refsect2>
72
 
<refsect2 id="EUri" role="struct">
73
 
<title>EUri</title>
74
 
<indexterm zone="EUri"><primary>EUri</primary></indexterm>
75
 
<programlisting>typedef struct {
76
 
        gchar  *protocol;
77
 
        gchar  *user;
78
 
        gchar  *authmech;
79
 
        gchar  *passwd;
80
 
        gchar  *host;
81
 
        gint    port;
82
 
        gchar  *path;
83
 
        GData *params;
84
 
        gchar  *query;
85
 
        gchar  *fragment;
86
 
} EUri;
87
 
</programlisting>
88
 
<para>
89
 
A structure representing a URI.</para>
90
 
<variablelist role="struct">
91
 
<varlistentry><term><link linkend="gchar"><type>gchar</type></link>&#160;*<structfield id="EUri.protocol">protocol</structfield>;</term>
92
 
<listitem><simpara>The protocol to use.
93
 
</simpara></listitem>
94
 
</varlistentry>
95
 
<varlistentry><term><link linkend="gchar"><type>gchar</type></link>&#160;*<structfield id="EUri.user">user</structfield>;</term>
96
 
<listitem><simpara>A user name.
97
 
</simpara></listitem>
98
 
</varlistentry>
99
 
<varlistentry><term><link linkend="gchar"><type>gchar</type></link>&#160;*<structfield id="EUri.authmech">authmech</structfield>;</term>
100
 
<listitem><simpara>The authentication mechanism.
101
 
</simpara></listitem>
102
 
</varlistentry>
103
 
<varlistentry><term><link linkend="gchar"><type>gchar</type></link>&#160;*<structfield id="EUri.passwd">passwd</structfield>;</term>
104
 
<listitem><simpara>The connection password.
105
 
</simpara></listitem>
106
 
</varlistentry>
107
 
<varlistentry><term><link linkend="gchar"><type>gchar</type></link>&#160;*<structfield id="EUri.host">host</structfield>;</term>
108
 
<listitem><simpara>The host name.
109
 
</simpara></listitem>
110
 
</varlistentry>
111
 
<varlistentry><term><link linkend="gint"><type>gint</type></link>&#160;<structfield id="EUri.port">port</structfield>;</term>
112
 
<listitem><simpara>The port number.
113
 
</simpara></listitem>
114
 
</varlistentry>
115
 
<varlistentry><term><link linkend="gchar"><type>gchar</type></link>&#160;*<structfield id="EUri.path">path</structfield>;</term>
116
 
<listitem><simpara>The file path on the host.
117
 
</simpara></listitem>
118
 
</varlistentry>
119
 
<varlistentry><term><link linkend="GData"><type>GData</type></link>&#160;*<structfield id="EUri.params">params</structfield>;</term>
120
 
<listitem><simpara>Additional parameters.
121
 
</simpara></listitem>
122
 
</varlistentry>
123
 
<varlistentry><term><link linkend="gchar"><type>gchar</type></link>&#160;*<structfield id="EUri.query">query</structfield>;</term>
124
 
<listitem><simpara></simpara></listitem>
125
 
</varlistentry>
126
 
<varlistentry><term><link linkend="gchar"><type>gchar</type></link>&#160;*<structfield id="EUri.fragment">fragment</structfield>;</term>
127
 
<listitem><simpara></simpara></listitem>
128
 
</varlistentry>
129
 
</variablelist></refsect2>
130
 
<refsect2 id="e-uri-new" role="function">
131
 
<title>e_uri_new ()</title>
132
 
<indexterm zone="e-uri-new"><primary>e_uri_new</primary></indexterm>
133
 
<programlisting><link linkend="EUri"><returnvalue>EUri</returnvalue></link> *              e_uri_new                           (<parameter>const <link linkend="gchar"><type>gchar</type></link> *uri_string</parameter>);</programlisting>
134
 
<para>
135
 
Creates an <link linkend="EUri"><type>EUri</type></link> representation of the uri given in <parameter>uri_string</parameter>.</para>
136
 
<variablelist role="params">
137
 
<varlistentry><term><parameter>uri_string</parameter>&#160;:</term>
138
 
<listitem><simpara>The uri to represent as an <link linkend="EUri"><type>EUri</type></link>.
139
 
</simpara></listitem></varlistentry>
140
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> The newly-allocated <link linkend="EUri"><type>EUri</type></link> structure.
141
 
</simpara></listitem></varlistentry>
142
 
</variablelist></refsect2>
143
 
<refsect2 id="e-uri-free" role="function">
144
 
<title>e_uri_free ()</title>
145
 
<indexterm zone="e-uri-free"><primary>e_uri_free</primary></indexterm>
146
 
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link>                e_uri_free                          (<parameter><link linkend="EUri"><type>EUri</type></link> *uri</parameter>);</programlisting>
147
 
<para>
148
 
Frees the memory of an <link linkend="EUri"><type>EUri</type></link> structure.</para>
149
 
<variablelist role="params">
150
 
<varlistentry><term><parameter>uri</parameter>&#160;:</term>
151
 
<listitem><simpara>A pointer to the <link linkend="EUri"><type>EUri</type></link> to free.
152
 
</simpara></listitem></varlistentry>
153
 
</variablelist></refsect2>
154
 
<refsect2 id="e-uri-get-param" role="function">
155
 
<title>e_uri_get_param ()</title>
156
 
<indexterm zone="e-uri-get-param"><primary>e_uri_get_param</primary></indexterm>
157
 
<programlisting>const <link linkend="gchar"><returnvalue>gchar</returnvalue></link> *       e_uri_get_param                     (<parameter><link linkend="EUri"><type>EUri</type></link> *uri</parameter>,
158
 
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *name</parameter>);</programlisting>
159
 
<para>
160
 
Retrieves the value of the parameter associated with <parameter>name</parameter> in <parameter>uri</parameter>.</para>
161
 
<variablelist role="params">
162
 
<varlistentry><term><parameter>uri</parameter>&#160;:</term>
163
 
<listitem><simpara>The <link linkend="EUri"><type>EUri</type></link> to get the parameter from.
164
 
</simpara></listitem></varlistentry>
165
 
<varlistentry><term><parameter>name</parameter>&#160;:</term>
166
 
<listitem><simpara>The name of the parameter to get.
167
 
</simpara></listitem></varlistentry>
168
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> The value of the parameter.
169
 
</simpara></listitem></varlistentry>
170
 
</variablelist></refsect2>
171
 
<refsect2 id="e-uri-copy" role="function">
172
 
<title>e_uri_copy ()</title>
173
 
<indexterm zone="e-uri-copy"><primary>e_uri_copy</primary></indexterm>
174
 
<programlisting><link linkend="EUri"><returnvalue>EUri</returnvalue></link> *              e_uri_copy                          (<parameter><link linkend="EUri"><type>EUri</type></link> *uri</parameter>);</programlisting>
175
 
<para>
176
 
Makes a copy of <parameter>uri</parameter>.</para>
177
 
<variablelist role="params">
178
 
<varlistentry><term><parameter>uri</parameter>&#160;:</term>
179
 
<listitem><simpara>The <link linkend="EUri"><type>EUri</type></link> to copy.
180
 
</simpara></listitem></varlistentry>
181
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> The newly-allocated copy of <parameter>uri</parameter>.
182
 
</simpara></listitem></varlistentry>
183
 
</variablelist></refsect2>
184
 
<refsect2 id="e-uri-to-string" role="function">
185
 
<title>e_uri_to_string ()</title>
186
 
<indexterm zone="e-uri-to-string"><primary>e_uri_to_string</primary></indexterm>
187
 
<programlisting><link linkend="gchar"><returnvalue>gchar</returnvalue></link> *             e_uri_to_string                     (<parameter><link linkend="EUri"><type>EUri</type></link> *uri</parameter>,
188
 
                                                         <parameter><link linkend="gboolean"><type>gboolean</type></link> show_password</parameter>);</programlisting>
189
 
<para>
190
 
Creates a string representation of <parameter>uri</parameter>. The password will only be
191
 
included in the string if <parameter>show_password</parameter> is set to <link linkend="TRUE:CAPS"><literal>TRUE</literal></link>.</para>
192
 
<variablelist role="params">
193
 
<varlistentry><term><parameter>uri</parameter>&#160;:</term>
194
 
<listitem><simpara>The <link linkend="EUri"><type>EUri</type></link> to convert to a string.
195
 
</simpara></listitem></varlistentry>
196
 
<varlistentry><term><parameter>show_password</parameter>&#160;:</term>
197
 
<listitem><simpara>Whether or not to show the password in the string.
198
 
</simpara></listitem></varlistentry>
199
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> The string representation of <parameter>uri</parameter>.
200
 
</simpara></listitem></varlistentry>
201
 
</variablelist></refsect2>
202
 
 
203
 
</refsect1>
204
 
 
205
 
</refentry>