libchamplain-doc 0.12.2-1 / usr / share / gtk-doc / html / libchamplain / ChamplainBoundingBox.html

This file is indexed.

/usr/share/gtk-doc/html/libchamplain/ChamplainBoundingBox.html is in libchamplain-doc 0.12.2-1.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below. 

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>ChamplainBoundingBox</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="index.html" title="libchamplain Reference Manual">
<link rel="up" href="pt06.html" title="Part VI. Others">
<link rel="prev" href="ChamplainTile.html" title="ChamplainTile">
<link rel="next" href="libchamplain-ChamplainVersion.html" title="ChamplainVersion">
<meta name="generator" content="GTK-Doc V1.18 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="ChamplainTile.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="pt06.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">libchamplain Reference Manual</th>
<td><a accesskey="n" href="libchamplain-ChamplainVersion.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#ChamplainBoundingBox.synopsis" class="shortcut">Top</a>
                   | 
                  <a href="#ChamplainBoundingBox.description" class="shortcut">Description</a>
                   | 
                  <a href="#ChamplainBoundingBox.object-hierarchy" class="shortcut">Object Hierarchy</a>
</td></tr>
</table>
<div class="refentry">
<a name="ChamplainBoundingBox"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="ChamplainBoundingBox.top_of_page"></a>ChamplainBoundingBox</span></h2>
<p>ChamplainBoundingBox — A basic struct to describe a bounding box</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="ChamplainBoundingBox.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">struct              <a class="link" href="ChamplainBoundingBox.html#ChamplainBoundingBox-struct" title="struct ChamplainBoundingBox">ChamplainBoundingBox</a>;
<a class="link" href="ChamplainBoundingBox.html" title="ChamplainBoundingBox"><span class="returnvalue">ChamplainBoundingBox</span></a> * <a class="link" href="ChamplainBoundingBox.html#champlain-bounding-box-new" title="champlain_bounding_box_new ()">champlain_bounding_box_new</a>       (<em class="parameter"><code><span class="type">void</span></code></em>);
<a class="link" href="ChamplainBoundingBox.html" title="ChamplainBoundingBox"><span class="returnvalue">ChamplainBoundingBox</span></a> * <a class="link" href="ChamplainBoundingBox.html#champlain-bounding-box-copy" title="champlain_bounding_box_copy ()">champlain_bounding_box_copy</a>      (<em class="parameter"><code>const <a class="link" href="ChamplainBoundingBox.html" title="ChamplainBoundingBox"><span class="type">ChamplainBoundingBox</span></a> *bbox</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="ChamplainBoundingBox.html#champlain-bounding-box-free" title="champlain_bounding_box_free ()">champlain_bounding_box_free</a>         (<em class="parameter"><code><a class="link" href="ChamplainBoundingBox.html" title="ChamplainBoundingBox"><span class="type">ChamplainBoundingBox</span></a> *bbox</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="ChamplainBoundingBox.html#champlain-bounding-box-get-center" title="champlain_bounding_box_get_center ()">champlain_bounding_box_get_center</a>   (<em class="parameter"><code><a class="link" href="ChamplainBoundingBox.html" title="ChamplainBoundingBox"><span class="type">ChamplainBoundingBox</span></a> *bbox</code></em>,
                                                         <em class="parameter"><code><span class="type">gdouble</span> *latitude</code></em>,
                                                         <em class="parameter"><code><span class="type">gdouble</span> *longitude</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="ChamplainBoundingBox.html#champlain-bounding-box-compose" title="champlain_bounding_box_compose ()">champlain_bounding_box_compose</a>      (<em class="parameter"><code><a class="link" href="ChamplainBoundingBox.html" title="ChamplainBoundingBox"><span class="type">ChamplainBoundingBox</span></a> *bbox</code></em>,
                                                         <em class="parameter"><code><a class="link" href="ChamplainBoundingBox.html" title="ChamplainBoundingBox"><span class="type">ChamplainBoundingBox</span></a> *other</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="ChamplainBoundingBox.html#champlain-bounding-box-extend" title="champlain_bounding_box_extend ()">champlain_bounding_box_extend</a>       (<em class="parameter"><code><a class="link" href="ChamplainBoundingBox.html" title="ChamplainBoundingBox"><span class="type">ChamplainBoundingBox</span></a> *bbox</code></em>,
                                                         <em class="parameter"><code><span class="type">gdouble</span> latitude</code></em>,
                                                         <em class="parameter"><code><span class="type">gdouble</span> longitude</code></em>);
<span class="returnvalue">gboolean</span>            <a class="link" href="ChamplainBoundingBox.html#champlain-bounding-box-is-valid" title="champlain_bounding_box_is_valid ()">champlain_bounding_box_is_valid</a>     (<em class="parameter"><code><a class="link" href="ChamplainBoundingBox.html" title="ChamplainBoundingBox"><span class="type">ChamplainBoundingBox</span></a> *bbox</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="ChamplainBoundingBox.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
  GBoxed
   +----ChamplainBoundingBox
</pre>
</div>
<div class="refsect1">
<a name="ChamplainBoundingBox.description"></a><h2>Description</h2>
<p>
A basic struct to describe a bounding box.
</p>
</div>
<div class="refsect1">
<a name="ChamplainBoundingBox.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="ChamplainBoundingBox-struct"></a><h3>struct ChamplainBoundingBox</h3>
<pre class="programlisting">struct ChamplainBoundingBox {
  gdouble left;
  gdouble top;
  gdouble right;
  gdouble bottom;
};
</pre>
<p>
Defines the area of a ChamplainMapDataSource that contains data.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><span class="type">gdouble</span> <em class="structfield"><code><a name="ChamplainBoundingBox-struct.left"></a>left</code></em>;</span></p></td>
<td>left coordinate</td>
</tr>
<tr>
<td><p><span class="term"><span class="type">gdouble</span> <em class="structfield"><code><a name="ChamplainBoundingBox-struct.top"></a>top</code></em>;</span></p></td>
<td>top coordinate</td>
</tr>
<tr>
<td><p><span class="term"><span class="type">gdouble</span> <em class="structfield"><code><a name="ChamplainBoundingBox-struct.right"></a>right</code></em>;</span></p></td>
<td>right coordinate</td>
</tr>
<tr>
<td><p><span class="term"><span class="type">gdouble</span> <em class="structfield"><code><a name="ChamplainBoundingBox-struct.bottom"></a>bottom</code></em>;</span></p></td>
<td>bottom coordinate</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.6</p>
</div>
<hr>
<div class="refsect2">
<a name="champlain-bounding-box-new"></a><h3>champlain_bounding_box_new ()</h3>
<pre class="programlisting"><a class="link" href="ChamplainBoundingBox.html" title="ChamplainBoundingBox"><span class="returnvalue">ChamplainBoundingBox</span></a> * champlain_bounding_box_new       (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
Creates a newly allocated <a class="link" href="ChamplainBoundingBox.html" title="ChamplainBoundingBox"><span class="type">ChamplainBoundingBox</span></a> to be freed
with <a class="link" href="ChamplainBoundingBox.html#champlain-bounding-box-free" title="champlain_bounding_box_free ()"><code class="function">champlain_bounding_box_free()</code></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a <a class="link" href="ChamplainBoundingBox.html" title="ChamplainBoundingBox"><span class="type">ChamplainBoundingBox</span></a>
</td>
</tr></tbody>
</table></div>
<p class="since">Since 0.6</p>
</div>
<hr>
<div class="refsect2">
<a name="champlain-bounding-box-copy"></a><h3>champlain_bounding_box_copy ()</h3>
<pre class="programlisting"><a class="link" href="ChamplainBoundingBox.html" title="ChamplainBoundingBox"><span class="returnvalue">ChamplainBoundingBox</span></a> * champlain_bounding_box_copy      (<em class="parameter"><code>const <a class="link" href="ChamplainBoundingBox.html" title="ChamplainBoundingBox"><span class="type">ChamplainBoundingBox</span></a> *bbox</code></em>);</pre>
<p>
Makes a copy of the bounding box structure. The result must be
freed using <a class="link" href="ChamplainBoundingBox.html#champlain-bounding-box-free" title="champlain_bounding_box_free ()"><code class="function">champlain_bounding_box_free()</code></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>bbox</code></em> :</span></p></td>
<td>a <a class="link" href="ChamplainBoundingBox.html" title="ChamplainBoundingBox"><span class="type">ChamplainBoundingBox</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>an allocated copy of <em class="parameter"><code>bbox</code></em>.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.6</p>
</div>
<hr>
<div class="refsect2">
<a name="champlain-bounding-box-free"></a><h3>champlain_bounding_box_free ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                champlain_bounding_box_free         (<em class="parameter"><code><a class="link" href="ChamplainBoundingBox.html" title="ChamplainBoundingBox"><span class="type">ChamplainBoundingBox</span></a> *bbox</code></em>);</pre>
<p>
Frees a bounding box structure created with <a class="link" href="ChamplainBoundingBox.html#champlain-bounding-box-new" title="champlain_bounding_box_new ()"><code class="function">champlain_bounding_box_new()</code></a> or
<a class="link" href="ChamplainBoundingBox.html#champlain-bounding-box-copy" title="champlain_bounding_box_copy ()"><code class="function">champlain_bounding_box_copy()</code></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>bbox</code></em> :</span></p></td>
<td>a <a class="link" href="ChamplainBoundingBox.html" title="ChamplainBoundingBox"><span class="type">ChamplainBoundingBox</span></a>
</td>
</tr></tbody>
</table></div>
<p class="since">Since 0.6</p>
</div>
<hr>
<div class="refsect2">
<a name="champlain-bounding-box-get-center"></a><h3>champlain_bounding_box_get_center ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                champlain_bounding_box_get_center   (<em class="parameter"><code><a class="link" href="ChamplainBoundingBox.html" title="ChamplainBoundingBox"><span class="type">ChamplainBoundingBox</span></a> *bbox</code></em>,
                                                         <em class="parameter"><code><span class="type">gdouble</span> *latitude</code></em>,
                                                         <em class="parameter"><code><span class="type">gdouble</span> *longitude</code></em>);</pre>
<p>
Sets the latitude and longitude of the box to <em class="parameter"><code>lat</code></em> and <em class="parameter"><code>lon</code></em>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>bbox</code></em> :</span></p></td>
<td>a <a class="link" href="ChamplainBoundingBox.html" title="ChamplainBoundingBox"><span class="type">ChamplainBoundingBox</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>latitude</code></em> :</span></p></td>
<td>the latitude of the box center. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>longitude</code></em> :</span></p></td>
<td>the longitude of the box center. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span>
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.6</p>
</div>
<hr>
<div class="refsect2">
<a name="champlain-bounding-box-compose"></a><h3>champlain_bounding_box_compose ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                champlain_bounding_box_compose      (<em class="parameter"><code><a class="link" href="ChamplainBoundingBox.html" title="ChamplainBoundingBox"><span class="type">ChamplainBoundingBox</span></a> *bbox</code></em>,
                                                         <em class="parameter"><code><a class="link" href="ChamplainBoundingBox.html" title="ChamplainBoundingBox"><span class="type">ChamplainBoundingBox</span></a> *other</code></em>);</pre>
<p>
Sets bbox equal to the bounding box containing both <em class="parameter"><code>bbox</code></em> and <em class="parameter"><code>other</code></em>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>bbox</code></em> :</span></p></td>
<td>a <a class="link" href="ChamplainBoundingBox.html" title="ChamplainBoundingBox"><span class="type">ChamplainBoundingBox</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>other</code></em> :</span></p></td>
<td>a <a class="link" href="ChamplainBoundingBox.html" title="ChamplainBoundingBox"><span class="type">ChamplainBoundingBox</span></a>
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.10</p>
</div>
<hr>
<div class="refsect2">
<a name="champlain-bounding-box-extend"></a><h3>champlain_bounding_box_extend ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                champlain_bounding_box_extend       (<em class="parameter"><code><a class="link" href="ChamplainBoundingBox.html" title="ChamplainBoundingBox"><span class="type">ChamplainBoundingBox</span></a> *bbox</code></em>,
                                                         <em class="parameter"><code><span class="type">gdouble</span> latitude</code></em>,
                                                         <em class="parameter"><code><span class="type">gdouble</span> longitude</code></em>);</pre>
<p>
Extend the bounding box so it contains a point with <em class="parameter"><code>latitude</code></em> and <em class="parameter"><code>longitude</code></em>.
Do nothing if the point is already inside the bounding box.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>bbox</code></em> :</span></p></td>
<td>a <a class="link" href="ChamplainBoundingBox.html" title="ChamplainBoundingBox"><span class="type">ChamplainBoundingBox</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>latitude</code></em> :</span></p></td>
<td>latitude</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>longitude</code></em> :</span></p></td>
<td>longitude</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.10</p>
</div>
<hr>
<div class="refsect2">
<a name="champlain-bounding-box-is-valid"></a><h3>champlain_bounding_box_is_valid ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>            champlain_bounding_box_is_valid     (<em class="parameter"><code><a class="link" href="ChamplainBoundingBox.html" title="ChamplainBoundingBox"><span class="type">ChamplainBoundingBox</span></a> *bbox</code></em>);</pre>
<p>
Checks whether bbox represents a valid bounding box on the map.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>bbox</code></em> :</span></p></td>
<td>a <a class="link" href="ChamplainBoundingBox.html" title="ChamplainBoundingBox"><span class="type">ChamplainBoundingBox</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>TRUE when the bounding box is valid, FALSE otherwise.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.10</p>
</div>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.18</div>
</body>
</html>

APT Browse - Built by Thomas Orozco.