← Back to branch summary

~ubuntu-branches/ubuntu/natty/libchamplain/natty

« back to all changes in this revision

Viewing changes to docs/reference/xml/champlain-network-map-data-source.xml

  • Committer: Bazaar Package Importer
  • Author(s): Sjoerd Simons, Laurent Bigonville, Sjoerd Simons
  • Date: 2009-09-15 00:01:41 UTC
  • mfrom: (1.1.3 upstream) (2.1.3 sid)
  • Revision ID: james.westby@ubuntu.com-20090915000141-i8fg5n1t02zxo79m
Tags: 0.4.0-1
[ Laurent Bigonville ]
* debian/control: Add libchamplain-0.3-dev dependency to
  libchamplain-gtk-0.3-dev

[ Sjoerd Simons ]
* New upstream release (0.4.0)

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/xml/champlain-network-map-data-source.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
<!ENTITY version SYSTEM "version.xml">
 
5
]>
 
6
<refentry id="ChamplainNetworkMapDataSource">
 
7
<refmeta>
 
8
<refentrytitle role="top_of_page" id="ChamplainNetworkMapDataSource.top_of_page">ChamplainNetworkMapDataSource</refentrytitle>
 
9
<manvolnum>3</manvolnum>
 
10
<refmiscinfo>LIBCHAMPLAIN Library</refmiscinfo>
 
11
</refmeta>
 
12
 
 
13
<refnamediv>
 
14
<refname>ChamplainNetworkMapDataSource</refname>
 
15
<refpurpose>Downloads map data for <link linkend="ChamplainMemphisMapSource"><type>ChamplainMemphisMapSource</type></link>.</refpurpose>
 
16
</refnamediv>
 
17
 
 
18
<refsynopsisdiv id="ChamplainNetworkMapDataSource.synopsis" role="synopsis">
 
19
<title role="synopsis.title">Synopsis</title>
 
20
 
 
21
<synopsis>
 
22
                    <link linkend="ChamplainNetworkMapDataSource-struct">ChamplainNetworkMapDataSource</link>;
 
23
<link linkend="ChamplainNetworkMapDataSource">ChamplainNetworkMapDataSource</link>* <link linkend="champlain-network-map-data-source-new">champlain_network_map_data_source_new</link>
 
24
                                                        (void);
 
25
<link linkend="void">void</link>                <link linkend="champlain-network-map-data-source-load-map-data">champlain_network_map_data_source_load_map_data</link>
 
26
                                                        (<link linkend="ChamplainNetworkMapDataSource">ChamplainNetworkMapDataSource</link> *map_data_source,
 
27
                                                         <link linkend="gdouble">gdouble</link> bound_left,
 
28
                                                         <link linkend="gdouble">gdouble</link> bound_bottom,
 
29
                                                         <link linkend="gdouble">gdouble</link> bound_right,
 
30
                                                         <link linkend="gdouble">gdouble</link> bound_top);
 
31
<link linkend="void">void</link>                <link linkend="champlain-network-map-data-source-set-api-uri">champlain_network_map_data_source_set_api_uri</link>
 
32
                                                        (<link linkend="ChamplainNetworkMapDataSource">ChamplainNetworkMapDataSource</link> *map_data_source,
 
33
                                                         const <link linkend="gchar">gchar</link> *api_uri);
 
34
const <link linkend="gchar">gchar</link> *       <link linkend="champlain-network-map-data-source-get-api-uri">champlain_network_map_data_source_get_api_uri</link>
 
35
                                                        (<link linkend="ChamplainNetworkMapDataSource">ChamplainNetworkMapDataSource</link> *map_data_source);
 
36
</synopsis>
 
37
</refsynopsisdiv>
 
38
 
 
39
<refsect1 id="ChamplainNetworkMapDataSource.object-hierarchy" role="object_hierarchy">
 
40
<title role="object_hierarchy.title">Object Hierarchy</title>
 
41
<synopsis>
 
42
  <link linkend="GObject">GObject</link>
 
43
   +----<link linkend="ChamplainMapDataSource">ChamplainMapDataSource</link>
 
44
         +----ChamplainNetworkMapDataSource
 
45
</synopsis>
 
46
</refsect1>
 
47
 
 
48
 
 
49
 
 
50
 
 
51
 
 
52
<refsect1 id="ChamplainNetworkMapDataSource.properties" role="properties">
 
53
<title role="properties.title">Properties</title>
 
54
<synopsis>
 
55
  &quot;<link linkend="ChamplainNetworkMapDataSource--api-uri">api-uri</link>&quot;                  <link linkend="gchar">gchar</link>*                : Read / Write
 
56
  &quot;<link linkend="ChamplainNetworkMapDataSource--proxy-uri">proxy-uri</link>&quot;                <link linkend="gchar">gchar</link>*                : Read / Write
 
57
</synopsis>
 
58
</refsect1>
 
59
 
 
60
 
 
61
 
 
62
<refsect1 id="ChamplainNetworkMapDataSource.description" role="desc">
 
63
<title role="desc.title">Description</title>
 
64
<para>
 
65
This map data source downloads the map data from an OpenStreetMap API
 
66
server. It supports protocol version 0.5 and 0.6.
 
67
</para>
 
68
<para>
 
69
<ulink role="online-location" url="http://wiki.openstreetmap.org/wiki/API">
 
70
http://wiki.openstreetmap.org/wiki/API</ulink></para>
 
71
<para>
 
72
</para>
 
73
</refsect1>
 
74
 
 
75
<refsect1 id="ChamplainNetworkMapDataSource.details" role="details">
 
76
<title role="details.title">Details</title>
 
77
<refsect2 id="ChamplainNetworkMapDataSource-struct" role="struct">
 
78
<title>ChamplainNetworkMapDataSource</title>
 
79
<indexterm zone="ChamplainNetworkMapDataSource-struct"><primary sortas="ChamplainNetworkMapDataSource">ChamplainNetworkMapDataSource</primary></indexterm><programlisting>typedef struct _ChamplainNetworkMapDataSource ChamplainNetworkMapDataSource;</programlisting>
 
80
<para>
 
81
</para></refsect2>
 
82
<refsect2 id="champlain-network-map-data-source-new" role="function" condition="since:0.6">
 
83
<title>champlain_network_map_data_source_new ()</title>
 
84
<indexterm zone="champlain-network-map-data-source-new" role="0.6"><primary sortas="champlain_network_map_data_source_new">champlain_network_map_data_source_new</primary></indexterm><programlisting><link linkend="ChamplainNetworkMapDataSource">ChamplainNetworkMapDataSource</link>* champlain_network_map_data_source_new
 
85
                                                        (void);</programlisting>
 
86
<para>
 
87
</para>
 
88
<para>
 
89
</para><variablelist role="params">
 
90
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>a new <link linkend="ChamplainNetworkMapDataSource"><type>ChamplainNetworkMapDataSource</type></link>
 
91
 
 
92
</simpara></listitem></varlistentry>
 
93
</variablelist><para role="since">Since 0.6</para></refsect2>
 
94
<refsect2 id="champlain-network-map-data-source-load-map-data" role="function" condition="since:0.6">
 
95
<title>champlain_network_map_data_source_load_map_data ()</title>
 
96
<indexterm zone="champlain-network-map-data-source-load-map-data" role="0.6"><primary sortas="champlain_network_map_data_source_load_map_data">champlain_network_map_data_source_load_map_data</primary></indexterm><programlisting><link linkend="void">void</link>                champlain_network_map_data_source_load_map_data
 
97
                                                        (<link linkend="ChamplainNetworkMapDataSource">ChamplainNetworkMapDataSource</link> *map_data_source,
 
98
                                                         <link linkend="gdouble">gdouble</link> bound_left,
 
99
                                                         <link linkend="gdouble">gdouble</link> bound_bottom,
 
100
                                                         <link linkend="gdouble">gdouble</link> bound_right,
 
101
                                                         <link linkend="gdouble">gdouble</link> bound_top);</programlisting>
 
102
<para>
 
103
Asynchronously loads map data within a bounding box from the server.
 
104
The box must not exceed an edge size of 0.25 degree. There are also
 
105
limitations on the maximum number of nodes that can be requested.
 
106
</para>
 
107
<para>
 
108
For details, see: <ulink role="online-location"
 
109
url="http://api.openstreetmap.org/api/capabilities">
 
110
http://api.openstreetmap.org/api/capabilities</ulink></para>
 
111
<para>
 
112
</para><variablelist role="params">
 
113
<varlistentry><term><parameter>map_data_source</parameter>&#160;:</term>
 
114
<listitem><simpara> a <link linkend="ChamplainNetworkMapDataSource"><type>ChamplainNetworkMapDataSource</type></link>
 
115
</simpara></listitem></varlistentry>
 
116
<varlistentry><term><parameter>bound_left</parameter>&#160;:</term>
 
117
<listitem><simpara> the left bound in degree
 
118
</simpara></listitem></varlistentry>
 
119
<varlistentry><term><parameter>bound_bottom</parameter>&#160;:</term>
 
120
<listitem><simpara> the lower bound in degree
 
121
</simpara></listitem></varlistentry>
 
122
<varlistentry><term><parameter>bound_right</parameter>&#160;:</term>
 
123
<listitem><simpara> the right bound in degree
 
124
</simpara></listitem></varlistentry>
 
125
<varlistentry><term><parameter>bound_top</parameter>&#160;:</term>
 
126
<listitem><simpara> the upper bound in degree
 
127
</simpara></listitem></varlistentry>
 
128
</variablelist><para role="since">Since 0.6</para></refsect2>
 
129
<refsect2 id="champlain-network-map-data-source-set-api-uri" role="function" condition="since:0.6">
 
130
<title>champlain_network_map_data_source_set_api_uri ()</title>
 
131
<indexterm zone="champlain-network-map-data-source-set-api-uri" role="0.6"><primary sortas="champlain_network_map_data_source_set_api_uri">champlain_network_map_data_source_set_api_uri</primary></indexterm><programlisting><link linkend="void">void</link>                champlain_network_map_data_source_set_api_uri
 
132
                                                        (<link linkend="ChamplainNetworkMapDataSource">ChamplainNetworkMapDataSource</link> *map_data_source,
 
133
                                                         const <link linkend="gchar">gchar</link> *api_uri);</programlisting>
 
134
<para>
 
135
Sets the URI of the API server.</para>
 
136
<para>
 
137
</para><variablelist role="params">
 
138
<varlistentry><term><parameter>map_data_source</parameter>&#160;:</term>
 
139
<listitem><simpara> a <link linkend="ChamplainNetworkMapDataSource"><type>ChamplainNetworkMapDataSource</type></link>
 
140
</simpara></listitem></varlistentry>
 
141
<varlistentry><term><parameter>api_uri</parameter>&#160;:</term>
 
142
<listitem><simpara> an URI of an API server
 
143
</simpara></listitem></varlistentry>
 
144
</variablelist><para role="since">Since 0.6</para></refsect2>
 
145
<refsect2 id="champlain-network-map-data-source-get-api-uri" role="function" condition="since:0.6">
 
146
<title>champlain_network_map_data_source_get_api_uri ()</title>
 
147
<indexterm zone="champlain-network-map-data-source-get-api-uri" role="0.6"><primary sortas="champlain_network_map_data_source_get_api_uri">champlain_network_map_data_source_get_api_uri</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link> *       champlain_network_map_data_source_get_api_uri
 
148
                                                        (<link linkend="ChamplainNetworkMapDataSource">ChamplainNetworkMapDataSource</link> *map_data_source);</programlisting>
 
149
<para>
 
150
</para>
 
151
<para>
 
152
</para><variablelist role="params">
 
153
<varlistentry><term><parameter>map_data_source</parameter>&#160;:</term>
 
154
<listitem><simpara> a <link linkend="ChamplainNetworkMapDataSource"><type>ChamplainNetworkMapDataSource</type></link>
 
155
</simpara></listitem></varlistentry>
 
156
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>the URI of the API server.
 
157
 
 
158
</simpara></listitem></varlistentry>
 
159
</variablelist><para role="since">Since 0.6</para></refsect2>
 
160
 
 
161
</refsect1>
 
162
<refsect1 id="ChamplainNetworkMapDataSource.property-details" role="property_details">
 
163
<title role="property_details.title">Property Details</title>
 
164
<refsect2 id="ChamplainNetworkMapDataSource--api-uri" role="property"><title>The <literal>&quot;api-uri&quot;</literal> property</title>
 
165
<indexterm zone="ChamplainNetworkMapDataSource--api-uri" role="0.6"><primary sortas="ChamplainNetworkMapDataSource:api-uri">ChamplainNetworkMapDataSource:api-uri</primary></indexterm><programlisting>  &quot;api-uri&quot;                  <link linkend="gchar">gchar</link>*                : Read / Write</programlisting>
 
166
<para>
 
167
The URI of an OpenStreetMap API server</para>
 
168
<para>
 
169
</para><para>Default value: "http://www.informationfreeway.org/api/0.6"</para>
 
170
<para>Since 0.6</para>
 
171
</refsect2>
 
172
<refsect2 id="ChamplainNetworkMapDataSource--proxy-uri" role="property"><title>The <literal>&quot;proxy-uri&quot;</literal> property</title>
 
173
<indexterm zone="ChamplainNetworkMapDataSource--proxy-uri" role="0.6"><primary sortas="ChamplainNetworkMapDataSource:proxy-uri">ChamplainNetworkMapDataSource:proxy-uri</primary></indexterm><programlisting>  &quot;proxy-uri&quot;                <link linkend="gchar">gchar</link>*                : Read / Write</programlisting>
 
174
<para>
 
175
The proxy URI to use to access network</para>
 
176
<para>
 
177
</para><para>Default value: ""</para>
 
178
<para>Since 0.6</para>
 
179
</refsect2>
 
180
</refsect1>
 
181
 
 
182
 
 
183
 
 
184
 
 
185
</refentry>