← Back to branch summary

~ubuntu-branches/ubuntu/maverick/libchamplain/maverick

« back to all changes in this revision

Viewing changes to docs/reference/html/ChamplainTile.html

  • 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/html/ChamplainTile.html
3
3
<head>
4
4
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5
5
<title>ChamplainTile</title>
6
 
<meta name="generator" content="DocBook XSL Stylesheets V1.75.0">
 
6
<meta name="generator" content="DocBook XSL Stylesheets V1.75.1">
7
7
<link rel="home" href="index.html" title="libchamplain Reference Manual">
8
8
<link rel="up" href="ch02.html" title="II. Map Source API Reference">
9
9
<link rel="prev" href="ChamplainNetworkMapSource.html" title="ChamplainNetworkMapSource">
87
87
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
88
88
>gchar</a> *       <a class="link" href="ChamplainTile.html#champlain-tile-get-filename" title="champlain_tile_get_filename ()">champlain_tile_get_filename</a>         (<a class="link" href="ChamplainTile.html" title="ChamplainTile">ChamplainTile</a> *self);
89
89
<a
90
 
href="/usr/share/gtk-doc/html/clutter/ClutterActor.html"
 
90
href="/usr/share/gtk-doc/html/clutter-1.0/clutter/ClutterActor.html"
91
91
>ClutterActor</a> *      <a class="link" href="ChamplainTile.html#champlain-tile-get-actor" title="champlain_tile_get_actor ()">champlain_tile_get_actor</a>            (<a class="link" href="ChamplainTile.html" title="ChamplainTile">ChamplainTile</a> *self);
92
92
void                <a class="link" href="ChamplainTile.html#champlain-tile-set-x" title="champlain_tile_set_x ()">champlain_tile_set_x</a>                (<a class="link" href="ChamplainTile.html" title="ChamplainTile">ChamplainTile</a> *self,
93
93
                                                         <a
116
116
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
117
117
>gchar</a> *filename);
118
118
<a
119
 
href="/usr/share/gtk-doc/html/clutter/ClutterActor.html"
 
119
href="/usr/share/gtk-doc/html/clutter-1.0/clutter/ClutterActor.html"
120
120
>ClutterActor</a> *      <a class="link" href="ChamplainTile.html#champlain-tile-get-content" title="champlain_tile_get_content ()">champlain_tile_get_content</a>          (<a class="link" href="ChamplainTile.html" title="ChamplainTile">ChamplainTile</a> *self);
121
 
const char *        <a class="link" href="ChamplainTile.html#champlain-tile-get-etag" title="champlain_tile_get_etag ()">champlain_tile_get_etag</a>             (<a class="link" href="ChamplainTile.html" title="ChamplainTile">ChamplainTile</a> *self);
 
121
const <a
 
122
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
 
123
>gchar</a> *       <a class="link" href="ChamplainTile.html#champlain-tile-get-etag" title="champlain_tile_get_etag ()">champlain_tile_get_etag</a>             (<a class="link" href="ChamplainTile.html" title="ChamplainTile">ChamplainTile</a> *self);
122
124
const <a
123
125
href="http://library.gnome.org/devel/glib/unstable/glib-Date-and-Time-Functions.html#GTimeVal"
124
126
>GTimeVal</a> *    <a class="link" href="ChamplainTile.html#champlain-tile-get-modified-time" title="champlain_tile_get_modified_time ()">champlain_tile_get_modified_time</a>    (<a class="link" href="ChamplainTile.html" title="ChamplainTile">ChamplainTile</a> *self);
125
 
char *              <a class="link" href="ChamplainTile.html#champlain-tile-get-modified-time-string" title="champlain_tile_get_modified_time_string ()">champlain_tile_get_modified_time_string</a>
 
127
<a
 
128
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
 
129
>gchar</a> *             <a class="link" href="ChamplainTile.html#champlain-tile-get-modified-time-string" title="champlain_tile_get_modified_time_string ()">champlain_tile_get_modified_time_string</a>
126
130
                                                        (<a class="link" href="ChamplainTile.html" title="ChamplainTile">ChamplainTile</a> *self);
127
131
void                <a class="link" href="ChamplainTile.html#champlain-tile-set-content" title="champlain_tile_set_content ()">champlain_tile_set_content</a>          (<a class="link" href="ChamplainTile.html" title="ChamplainTile">ChamplainTile</a> *self,
128
132
                                                         <a
129
 
href="/usr/share/gtk-doc/html/clutter/ClutterActor.html"
 
133
href="/usr/share/gtk-doc/html/clutter-1.0/clutter/ClutterActor.html"
130
134
>ClutterActor</a> *actor,
131
135
                                                         <a
132
136
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
136
140
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
137
141
>gchar</a> *etag);
138
142
void                <a class="link" href="ChamplainTile.html#champlain-tile-set-modified-time" title="champlain_tile_set_modified_time ()">champlain_tile_set_modified_time</a>    (<a class="link" href="ChamplainTile.html" title="ChamplainTile">ChamplainTile</a> *self,
139
 
                                                         <a
 
143
                                                         const <a
140
144
href="http://library.gnome.org/devel/glib/unstable/glib-Date-and-Time-Functions.html#GTimeVal"
141
145
>GTimeVal</a> *time);
142
146
</pre>
154
158
<a name="ChamplainTile.properties"></a><h2>Properties</h2>
155
159
<pre class="synopsis">
156
160
  "<a class="link" href="ChamplainTile.html#ChamplainTile--actor" title='The "actor" property'>actor</a>"                    <a
157
 
href="/usr/share/gtk-doc/html/clutter/ClutterActor.html"
 
161
href="/usr/share/gtk-doc/html/clutter-1.0/clutter/ClutterActor.html"
158
162
>ClutterActor</a>*         : Read
159
163
  "<a class="link" href="ChamplainTile.html#ChamplainTile--content" title='The "content" property'>content</a>"                  <a
160
 
href="/usr/share/gtk-doc/html/clutter/ClutterActor.html"
 
164
href="/usr/share/gtk-doc/html/clutter-1.0/clutter/ClutterActor.html"
161
165
>ClutterActor</a>*         : Read / Write
162
166
  "<a class="link" href="ChamplainTile.html#ChamplainTile--etag" title='The "etag" property'>etag</a>"                     <a
163
167
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
210
214
<col align="left" valign="top">
211
215
<tbody><tr>
212
216
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
213
 
<td>a new <a class="link" href="ChamplainTile.html" title="ChamplainTile"><span class="type">ChamplainTile</span></a>
 
217
<td> a new <a class="link" href="ChamplainTile.html" title="ChamplainTile"><span class="type">ChamplainTile</span></a>
214
218
 
215
219
</td>
216
220
</tr></tbody>
261
265
</tr>
262
266
<tr>
263
267
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
264
 
<td>a <a class="link" href="ChamplainTile.html" title="ChamplainTile"><span class="type">ChamplainTile</span></a>
 
268
<td> a <a class="link" href="ChamplainTile.html" title="ChamplainTile"><span class="type">ChamplainTile</span></a>
265
269
 
266
270
</td>
267
271
</tr>
289
293
</tr>
290
294
<tr>
291
295
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
292
 
<td>the tile's x position
 
296
<td> the tile's x position
293
297
 
294
298
</td>
295
299
</tr>
317
321
</tr>
318
322
<tr>
319
323
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
320
 
<td>the tile's y position
 
324
<td> the tile's y position
321
325
 
322
326
</td>
323
327
</tr>
345
349
</tr>
346
350
<tr>
347
351
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
348
 
<td>the tile's zoom level
 
352
<td> the tile's zoom level
349
353
 
350
354
</td>
351
355
</tr>
373
377
</tr>
374
378
<tr>
375
379
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
376
 
<td>the tile's size in pixels
 
380
<td> the tile's size in pixels
377
381
 
378
382
</td>
379
383
</tr>
399
403
</tr>
400
404
<tr>
401
405
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
402
 
<td>the tile's <span class="type">ChamplainState</span>
 
406
<td> the tile's <span class="type">ChamplainState</span>
403
407
 
404
408
</td>
405
409
</tr>
427
431
</tr>
428
432
<tr>
429
433
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
430
 
<td>the tile's remote uri
 
434
<td> the tile's remote uri
431
435
 
432
436
</td>
433
437
</tr>
455
459
</tr>
456
460
<tr>
457
461
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
458
 
<td>the tile's local filename
 
462
<td> the tile's local filename
459
463
 
460
464
</td>
461
465
</tr>
467
471
<div class="refsect2" title="champlain_tile_get_actor ()">
468
472
<a name="champlain-tile-get-actor"></a><h3>champlain_tile_get_actor ()</h3>
469
473
<pre class="programlisting"><a
470
 
href="/usr/share/gtk-doc/html/clutter/ClutterActor.html"
 
474
href="/usr/share/gtk-doc/html/clutter-1.0/clutter/ClutterActor.html"
471
475
>ClutterActor</a> *      champlain_tile_get_actor            (<a class="link" href="ChamplainTile.html" title="ChamplainTile">ChamplainTile</a> *self);</pre>
472
476
<p>
473
477
</p>
483
487
</tr>
484
488
<tr>
485
489
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
486
 
<td>the tile's actor.  This actor should not change during the tile's
487
 
lifetime.
 
490
<td> the tile's actor.  This actor should not change during the tile's
 
491
lifetime. You should not unref this actor, it is owned by the tile.
488
492
 
489
493
</td>
490
494
</tr>
584
588
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"
585
589
>guint</a> size);</pre>
586
590
<p>
587
 
Sets the tile's zoom level</p>
 
591
Sets the tile's size</p>
588
592
<p>
589
593
</p>
590
594
<div class="variablelist"><table border="0">
690
694
<div class="refsect2" title="champlain_tile_get_content ()">
691
695
<a name="champlain-tile-get-content"></a><h3>champlain_tile_get_content ()</h3>
692
696
<pre class="programlisting"><a
693
 
href="/usr/share/gtk-doc/html/clutter/ClutterActor.html"
 
697
href="/usr/share/gtk-doc/html/clutter-1.0/clutter/ClutterActor.html"
694
698
>ClutterActor</a> *      champlain_tile_get_content          (<a class="link" href="ChamplainTile.html" title="ChamplainTile">ChamplainTile</a> *self);</pre>
695
699
<p>
696
700
</p>
706
710
</tr>
707
711
<tr>
708
712
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
709
 
<td>the tile's content
 
713
<td> the tile's content, this actor will change each time the tile's content changes.
 
714
You should not unref this content, it is owned by the tile.
710
715
 
711
716
</td>
712
717
</tr>
717
722
<hr>
718
723
<div class="refsect2" title="champlain_tile_get_etag ()">
719
724
<a name="champlain-tile-get-etag"></a><h3>champlain_tile_get_etag ()</h3>
720
 
<pre class="programlisting">const char *        champlain_tile_get_etag             (<a class="link" href="ChamplainTile.html" title="ChamplainTile">ChamplainTile</a> *self);</pre>
 
725
<pre class="programlisting">const <a
 
726
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
 
727
>gchar</a> *       champlain_tile_get_etag             (<a class="link" href="ChamplainTile.html" title="ChamplainTile">ChamplainTile</a> *self);</pre>
721
728
<p>
722
729
</p>
723
730
<p>
732
739
</tr>
733
740
<tr>
734
741
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
735
 
<td>the tile's ETag
 
742
<td> the tile's ETag
736
743
 
737
744
</td>
738
745
</tr>
760
767
</tr>
761
768
<tr>
762
769
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
763
 
<td>the tile's last modified time
 
770
<td> the tile's last modified time
764
771
 
765
772
</td>
766
773
</tr>
771
778
<hr>
772
779
<div class="refsect2" title="champlain_tile_get_modified_time_string ()">
773
780
<a name="champlain-tile-get-modified-time-string"></a><h3>champlain_tile_get_modified_time_string ()</h3>
774
 
<pre class="programlisting">char *              champlain_tile_get_modified_time_string
 
781
<pre class="programlisting"><a
 
782
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
 
783
>gchar</a> *             champlain_tile_get_modified_time_string
775
784
                                                        (<a class="link" href="ChamplainTile.html" title="ChamplainTile">ChamplainTile</a> *self);</pre>
776
785
<p>
777
786
</p>
787
796
</tr>
788
797
<tr>
789
798
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
790
 
<td>the tile's modified time as a string
 
799
<td> the tile's modified time as a string (formated as per RFC 1123)
791
800
 
792
801
</td>
793
802
</tr>
800
809
<a name="champlain-tile-set-content"></a><h3>champlain_tile_set_content ()</h3>
801
810
<pre class="programlisting">void                champlain_tile_set_content          (<a class="link" href="ChamplainTile.html" title="ChamplainTile">ChamplainTile</a> *self,
802
811
                                                         <a
803
 
href="/usr/share/gtk-doc/html/clutter/ClutterActor.html"
 
812
href="/usr/share/gtk-doc/html/clutter-1.0/clutter/ClutterActor.html"
804
813
>ClutterActor</a> *actor,
805
814
                                                         <a
806
815
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
807
816
>gboolean</a> fade_in);</pre>
808
817
<p>
809
 
</p>
 
818
Sets the tile's content</p>
810
819
<p>
811
820
</p>
812
821
<div class="variablelist"><table border="0">
863
872
<div class="refsect2" title="champlain_tile_set_modified_time ()">
864
873
<a name="champlain-tile-set-modified-time"></a><h3>champlain_tile_set_modified_time ()</h3>
865
874
<pre class="programlisting">void                champlain_tile_set_modified_time    (<a class="link" href="ChamplainTile.html" title="ChamplainTile">ChamplainTile</a> *self,
866
 
                                                         <a
 
875
                                                         const <a
867
876
href="http://library.gnome.org/devel/glib/unstable/glib-Date-and-Time-Functions.html#GTimeVal"
868
877
>GTimeVal</a> *time);</pre>
869
878
<p>
882
891
<td><p><span class="term"><em class="parameter"><code>time</code></em> :</span></p></td>
883
892
<td> a <a
884
893
href="http://library.gnome.org/devel/glib/unstable/glib-Date-and-Time-Functions.html#GTimeVal"
885
 
><span class="type">GTimeVal</span></a>
 
894
><span class="type">GTimeVal</span></a>, the value will be copied
886
895
</td>
887
896
</tr>
888
897
</tbody>
895
904
<div class="refsect2" title='The "actor" property'>
896
905
<a name="ChamplainTile--actor"></a><h3>The <code class="literal">"actor"</code> property</h3>
897
906
<pre class="programlisting">  "actor"                    <a
898
 
href="/usr/share/gtk-doc/html/clutter/ClutterActor.html"
 
907
href="/usr/share/gtk-doc/html/clutter-1.0/clutter/ClutterActor.html"
899
908
>ClutterActor</a>*         : Read</pre>
900
909
<p>
901
910
The <a
902
 
href="/usr/share/gtk-doc/html/clutter/ClutterActor.html"
 
911
href="/usr/share/gtk-doc/html/clutter-1.0/clutter/ClutterActor.html"
903
912
><span class="type">ClutterActor</span></a> where the tile content is rendered.  Should never change
904
913
during the tile's life.</p>
905
914
<p>
910
919
<div class="refsect2" title='The "content" property'>
911
920
<a name="ChamplainTile--content"></a><h3>The <code class="literal">"content"</code> property</h3>
912
921
<pre class="programlisting">  "content"                  <a
913
 
href="/usr/share/gtk-doc/html/clutter/ClutterActor.html"
 
922
href="/usr/share/gtk-doc/html/clutter-1.0/clutter/ClutterActor.html"
914
923
>ClutterActor</a>*         : Read / Write</pre>
915
924
<p>
916
925
The <a
917
 
href="/usr/share/gtk-doc/html/clutter/ClutterActor.html"
 
926
href="/usr/share/gtk-doc/html/clutter-1.0/clutter/ClutterActor.html"
918
927
><span class="type">ClutterActor</span></a> with the specific image content.  When changing this
919
928
property, the new actor will be faded in.</p>
920
929
<p>