← Back to branch summary

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

« back to all changes in this revision

Viewing changes to docs/reference/xml/champlain-tile.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-tile.xml
48
48
<link linkend="void">void</link>                <link linkend="champlain-tile-set-filename">champlain_tile_set_filename</link>         (<link linkend="ChamplainTile">ChamplainTile</link> *self,
49
49
                                                         const <link linkend="gchar">gchar</link> *filename);
50
50
<link linkend="ClutterActor">ClutterActor</link> *      <link linkend="champlain-tile-get-content">champlain_tile_get_content</link>          (<link linkend="ChamplainTile">ChamplainTile</link> *self);
51
 
const <link linkend="char">char</link> *        <link linkend="champlain-tile-get-etag">champlain_tile_get_etag</link>             (<link linkend="ChamplainTile">ChamplainTile</link> *self);
 
51
const <link linkend="gchar">gchar</link> *       <link linkend="champlain-tile-get-etag">champlain_tile_get_etag</link>             (<link linkend="ChamplainTile">ChamplainTile</link> *self);
52
52
const <link linkend="GTimeVal">GTimeVal</link> *    <link linkend="champlain-tile-get-modified-time">champlain_tile_get_modified_time</link>    (<link linkend="ChamplainTile">ChamplainTile</link> *self);
53
 
<link linkend="char">char</link> *              <link linkend="champlain-tile-get-modified-time-string">champlain_tile_get_modified_time_string</link>
 
53
<link linkend="gchar">gchar</link> *             <link linkend="champlain-tile-get-modified-time-string">champlain_tile_get_modified_time_string</link>
54
54
                                                        (<link linkend="ChamplainTile">ChamplainTile</link> *self);
55
55
<link linkend="void">void</link>                <link linkend="champlain-tile-set-content">champlain_tile_set_content</link>          (<link linkend="ChamplainTile">ChamplainTile</link> *self,
56
56
                                                         <link linkend="ClutterActor">ClutterActor</link> *actor,
58
58
<link linkend="void">void</link>                <link linkend="champlain-tile-set-etag">champlain_tile_set_etag</link>             (<link linkend="ChamplainTile">ChamplainTile</link> *self,
59
59
                                                         const <link linkend="gchar">gchar</link> *etag);
60
60
<link linkend="void">void</link>                <link linkend="champlain-tile-set-modified-time">champlain_tile_set_modified_time</link>    (<link linkend="ChamplainTile">ChamplainTile</link> *self,
61
 
                                                         <link linkend="GTimeVal">GTimeVal</link> *time);
 
61
                                                         const <link linkend="GTimeVal">GTimeVal</link> *time);
62
62
</synopsis>
63
63
</refsynopsisdiv>
64
64
 
114
114
</para>
115
115
<para>
116
116
</para><variablelist role="params">
117
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>a new <link linkend="ChamplainTile"><type>ChamplainTile</type></link>
 
117
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a new <link linkend="ChamplainTile"><type>ChamplainTile</type></link>
118
118
 
119
119
</simpara></listitem></varlistentry>
120
120
</variablelist><para role="since">Since 0.4</para></refsect2>
140
140
<varlistentry><term><parameter>zoom_level</parameter>&#160;:</term>
141
141
<listitem><simpara> the zoom level
142
142
</simpara></listitem></varlistentry>
143
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>a <link linkend="ChamplainTile"><type>ChamplainTile</type></link>
 
143
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a <link linkend="ChamplainTile"><type>ChamplainTile</type></link>
144
144
 
145
145
</simpara></listitem></varlistentry>
146
146
</variablelist><para role="since">Since 0.4</para></refsect2>
154
154
<varlistentry><term><parameter>self</parameter>&#160;:</term>
155
155
<listitem><simpara> the <link linkend="ChamplainTile"><type>ChamplainTile</type></link>
156
156
</simpara></listitem></varlistentry>
157
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>the tile's x position
 
157
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the tile's x position
158
158
 
159
159
</simpara></listitem></varlistentry>
160
160
</variablelist><para role="since">Since 0.4</para></refsect2>
168
168
<varlistentry><term><parameter>self</parameter>&#160;:</term>
169
169
<listitem><simpara> the <link linkend="ChamplainTile"><type>ChamplainTile</type></link>
170
170
</simpara></listitem></varlistentry>
171
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>the tile's y position
 
171
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the tile's y position
172
172
 
173
173
</simpara></listitem></varlistentry>
174
174
</variablelist><para role="since">Since 0.4</para></refsect2>
182
182
<varlistentry><term><parameter>self</parameter>&#160;:</term>
183
183
<listitem><simpara> the <link linkend="ChamplainTile"><type>ChamplainTile</type></link>
184
184
</simpara></listitem></varlistentry>
185
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>the tile's zoom level
 
185
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the tile's zoom level
186
186
 
187
187
</simpara></listitem></varlistentry>
188
188
</variablelist><para role="since">Since 0.4</para></refsect2>
196
196
<varlistentry><term><parameter>self</parameter>&#160;:</term>
197
197
<listitem><simpara> the <link linkend="ChamplainTile"><type>ChamplainTile</type></link>
198
198
</simpara></listitem></varlistentry>
199
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>the tile's size in pixels
 
199
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the tile's size in pixels
200
200
 
201
201
</simpara></listitem></varlistentry>
202
202
</variablelist><para role="since">Since 0.4</para></refsect2>
210
210
<varlistentry><term><parameter>self</parameter>&#160;:</term>
211
211
<listitem><simpara> the <link linkend="ChamplainTile"><type>ChamplainTile</type></link>
212
212
</simpara></listitem></varlistentry>
213
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>the tile's <link linkend="ChamplainState"><type>ChamplainState</type></link>
 
213
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the tile's <link linkend="ChamplainState"><type>ChamplainState</type></link>
214
214
 
215
215
</simpara></listitem></varlistentry>
216
216
</variablelist><para role="since">Since 0.4</para></refsect2>
224
224
<varlistentry><term><parameter>self</parameter>&#160;:</term>
225
225
<listitem><simpara> the <link linkend="ChamplainTile"><type>ChamplainTile</type></link>
226
226
</simpara></listitem></varlistentry>
227
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>the tile's remote uri
 
227
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the tile's remote uri
228
228
 
229
229
</simpara></listitem></varlistentry>
230
230
</variablelist><para role="since">Since 0.4</para></refsect2>
238
238
<varlistentry><term><parameter>self</parameter>&#160;:</term>
239
239
<listitem><simpara> the <link linkend="ChamplainTile"><type>ChamplainTile</type></link>
240
240
</simpara></listitem></varlistentry>
241
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>the tile's local filename
 
241
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the tile's local filename
242
242
 
243
243
</simpara></listitem></varlistentry>
244
244
</variablelist><para role="since">Since 0.4</para></refsect2>
252
252
<varlistentry><term><parameter>self</parameter>&#160;:</term>
253
253
<listitem><simpara> the <link linkend="ChamplainTile"><type>ChamplainTile</type></link>
254
254
</simpara></listitem></varlistentry>
255
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>the tile's actor.  This actor should not change during the tile's
256
 
lifetime.
 
255
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the tile's actor.  This actor should not change during the tile's
 
256
lifetime. You should not unref this actor, it is owned by the tile.
257
257
 
258
258
</simpara></listitem></varlistentry>
259
259
</variablelist><para role="since">Since 0.4</para></refsect2>
307
307
<indexterm zone="champlain-tile-set-size" role="0.4"><primary sortas="champlain_tile_set_size">champlain_tile_set_size</primary></indexterm><programlisting><link linkend="void">void</link>                champlain_tile_set_size             (<link linkend="ChamplainTile">ChamplainTile</link> *self,
308
308
                                                         <link linkend="guint">guint</link> size);</programlisting>
309
309
<para>
310
 
Sets the tile's zoom level</para>
 
310
Sets the tile's size</para>
311
311
<para>
312
312
</para><variablelist role="params">
313
313
<varlistentry><term><parameter>self</parameter>&#160;:</term>
372
372
<varlistentry><term><parameter>self</parameter>&#160;:</term>
373
373
<listitem><simpara>
374
374
</simpara></listitem></varlistentry>
375
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>the tile's content
 
375
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the tile's content, this actor will change each time the tile's content changes.
 
376
You should not unref this content, it is owned by the tile.
376
377
 
377
378
</simpara></listitem></varlistentry>
378
379
</variablelist><para role="since">Since 0.4</para></refsect2>
379
380
<refsect2 id="champlain-tile-get-etag" role="function" condition="since:0.4">
380
381
<title>champlain_tile_get_etag ()</title>
381
 
<indexterm zone="champlain-tile-get-etag" role="0.4"><primary sortas="champlain_tile_get_etag">champlain_tile_get_etag</primary></indexterm><programlisting>const <link linkend="char">char</link> *        champlain_tile_get_etag             (<link linkend="ChamplainTile">ChamplainTile</link> *self);</programlisting>
 
382
<indexterm zone="champlain-tile-get-etag" role="0.4"><primary sortas="champlain_tile_get_etag">champlain_tile_get_etag</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link> *       champlain_tile_get_etag             (<link linkend="ChamplainTile">ChamplainTile</link> *self);</programlisting>
382
383
<para>
383
384
</para>
384
385
<para>
386
387
<varlistentry><term><parameter>self</parameter>&#160;:</term>
387
388
<listitem><simpara> the <link linkend="ChamplainTile"><type>ChamplainTile</type></link>
388
389
</simpara></listitem></varlistentry>
389
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>the tile's ETag
 
390
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the tile's ETag
390
391
 
391
392
</simpara></listitem></varlistentry>
392
393
</variablelist><para role="since">Since 0.4</para></refsect2>
400
401
<varlistentry><term><parameter>self</parameter>&#160;:</term>
401
402
<listitem><simpara> the <link linkend="ChamplainTile"><type>ChamplainTile</type></link>
402
403
</simpara></listitem></varlistentry>
403
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>the tile's last modified time
 
404
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the tile's last modified time
404
405
 
405
406
</simpara></listitem></varlistentry>
406
407
</variablelist><para role="since">Since 0.4</para></refsect2>
407
408
<refsect2 id="champlain-tile-get-modified-time-string" role="function" condition="since:0.4">
408
409
<title>champlain_tile_get_modified_time_string ()</title>
409
 
<indexterm zone="champlain-tile-get-modified-time-string" role="0.4"><primary sortas="champlain_tile_get_modified_time_string">champlain_tile_get_modified_time_string</primary></indexterm><programlisting><link linkend="char">char</link> *              champlain_tile_get_modified_time_string
 
410
<indexterm zone="champlain-tile-get-modified-time-string" role="0.4"><primary sortas="champlain_tile_get_modified_time_string">champlain_tile_get_modified_time_string</primary></indexterm><programlisting><link linkend="gchar">gchar</link> *             champlain_tile_get_modified_time_string
410
411
                                                        (<link linkend="ChamplainTile">ChamplainTile</link> *self);</programlisting>
411
412
<para>
412
413
</para>
415
416
<varlistentry><term><parameter>self</parameter>&#160;:</term>
416
417
<listitem><simpara> the <link linkend="ChamplainTile"><type>ChamplainTile</type></link>
417
418
</simpara></listitem></varlistentry>
418
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>the tile's modified time as a string
 
419
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the tile's modified time as a string (formated as per RFC 1123)
419
420
 
420
421
</simpara></listitem></varlistentry>
421
422
</variablelist><para role="since">Since 0.4</para></refsect2>
425
426
                                                         <link linkend="ClutterActor">ClutterActor</link> *actor,
426
427
                                                         <link linkend="gboolean">gboolean</link> fade_in);</programlisting>
427
428
<para>
428
 
</para>
 
429
Sets the tile's content</para>
429
430
<para>
430
431
</para><variablelist role="params">
431
432
<varlistentry><term><parameter>self</parameter>&#160;:</term>
456
457
<refsect2 id="champlain-tile-set-modified-time" role="function" condition="since:0.4">
457
458
<title>champlain_tile_set_modified_time ()</title>
458
459
<indexterm zone="champlain-tile-set-modified-time" role="0.4"><primary sortas="champlain_tile_set_modified_time">champlain_tile_set_modified_time</primary></indexterm><programlisting><link linkend="void">void</link>                champlain_tile_set_modified_time    (<link linkend="ChamplainTile">ChamplainTile</link> *self,
459
 
                                                         <link linkend="GTimeVal">GTimeVal</link> *time);</programlisting>
 
460
                                                         const <link linkend="GTimeVal">GTimeVal</link> *time);</programlisting>
460
461
<para>
461
462
Sets the tile's modified time</para>
462
463
<para>
465
466
<listitem><simpara> the <link linkend="ChamplainTile"><type>ChamplainTile</type></link>
466
467
</simpara></listitem></varlistentry>
467
468
<varlistentry><term><parameter>time</parameter>&#160;:</term>
468
 
<listitem><simpara> a <link linkend="GTimeVal"><type>GTimeVal</type></link>
 
469
<listitem><simpara> a <link linkend="GTimeVal"><type>GTimeVal</type></link>, the value will be copied
469
470
</simpara></listitem></varlistentry>
470
471
</variablelist><para role="since">Since 0.4</para></refsect2>
471
472