libgweather-3-dev 3.28.1-1 / usr / share / gtk-doc / html / libgweather / GWeatherLocationEntry.html

This file is indexed.

/usr/share/gtk-doc/html/libgweather/GWeatherLocationEntry.html is in libgweather-3-dev 3.28.1-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
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GWeatherLocationEntry: libgweather Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="index.html" title="libgweather Reference Manual">
<link rel="up" href="ch01.html" title="libgweather Reference Manual">
<link rel="prev" href="GWeatherInfo.html" title="GWeatherInfo">
<link rel="next" href="GWeatherTimezoneMenu.html" title="GWeatherTimezoneMenu">
<meta name="generator" content="GTK-Doc V1.27 (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="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
                  <a href="#GWeatherLocationEntry.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span> 
                  <a href="#GWeatherLocationEntry.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_interfaces">  <span class="dim">|</span> 
                  <a href="#GWeatherLocationEntry.implemented-interfaces" class="shortcut">Implemented Interfaces</a></span><span id="nav_properties">  <span class="dim">|</span> 
                  <a href="#GWeatherLocationEntry.properties" class="shortcut">Properties</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="GWeatherInfo.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="GWeatherTimezoneMenu.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="GWeatherLocationEntry"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="GWeatherLocationEntry.top_of_page"></a>GWeatherLocationEntry</span></h2>
<p>GWeatherLocationEntry</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="GWeatherLocationEntry.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<a href="../gtk3/GtkWidget.html#GtkWidget-struct"><span class="returnvalue">GtkWidget</span></a> *
</td>
<td class="function_name">
<a class="link" href="GWeatherLocationEntry.html#gweather-location-entry-new" title="gweather_location_entry_new ()">gweather_location_entry_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="GWeatherLocationEntry.html#gweather-location-entry-set-location" title="gweather_location_entry_set_location ()">gweather_location_entry_set_location</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="GWeatherLocation.html" title="GWeatherLocation"><span class="returnvalue">GWeatherLocation</span></a> *
</td>
<td class="function_name">
<a class="link" href="GWeatherLocationEntry.html#gweather-location-entry-get-location" title="gweather_location_entry_get_location ()">gweather_location_entry_get_location</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="GWeatherLocationEntry.html#gweather-location-entry-has-custom-text" title="gweather_location_entry_has_custom_text ()">gweather_location_entry_has_custom_text</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="GWeatherLocationEntry.html#gweather-location-entry-set-city" title="gweather_location_entry_set_city ()">gweather_location_entry_set_city</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GWeatherLocationEntry.properties"></a><h2>Properties</h2>
<div class="informaltable"><table class="informaltable" border="0">
<colgroup>
<col width="150px" class="properties_type">
<col width="300px" class="properties_name">
<col width="200px" class="properties_flags">
</colgroup>
<tbody>
<tr>
<td class="property_type">
<a class="link" href="GWeatherLocation.html" title="GWeatherLocation"><span class="type">GWeatherLocation</span></a> *</td>
<td class="property_name"><a class="link" href="GWeatherLocationEntry.html#GWeatherLocationEntry--location" title="The “location” property">location</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></td>
<td class="property_name"><a class="link" href="GWeatherLocationEntry.html#GWeatherLocationEntry--show-named-timezones" title="The “show-named-timezones” property">show-named-timezones</a></td>
<td class="property_flags">Read / Write / Construct Only</td>
</tr>
<tr>
<td class="property_type">
<a class="link" href="GWeatherLocation.html" title="GWeatherLocation"><span class="type">GWeatherLocation</span></a> *</td>
<td class="property_name"><a class="link" href="GWeatherLocationEntry.html#GWeatherLocationEntry--top" title="The “top” property">top</a></td>
<td class="property_flags">Write / Construct Only</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GWeatherLocationEntry.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody><tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="GWeatherLocationEntry.html#GWeatherLocationEntry-struct" title="struct GWeatherLocationEntry">GWeatherLocationEntry</a></td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GWeatherLocationEntry.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen">    <a href="../gobject/gobject-The-Base-Object-Type.html#GObject-struct">GObject</a>
    <span class="lineart">╰──</span> <a href="../gobject/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a>
        <span class="lineart">╰──</span> <a href="../gtk3/GtkWidget.html#GtkWidget-struct">GtkWidget</a>
            <span class="lineart">╰──</span> <a href="../gtk3/GtkEntry.html#GtkEntry-struct">GtkEntry</a>
                <span class="lineart">╰──</span> <a href="../gtk3/GtkSearchEntry.html#GtkSearchEntry-struct">GtkSearchEntry</a>
                    <span class="lineart">╰──</span> GWeatherLocationEntry
</pre>
</div>
<div class="refsect1">
<a name="GWeatherLocationEntry.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
GWeatherLocationEntry implements
 AtkImplementorIface,  <a href="../gtk3/GtkBuildable.html#GtkBuildable-struct">GtkBuildable</a>,  <a href="../gtk3/GtkEditable.html#GtkEditable-struct">GtkEditable</a> and  <a href="../gtk3/GtkCellEditable.html#GtkCellEditable-struct">GtkCellEditable</a>.</p>
</div>
<div class="refsect1">
<a name="GWeatherLocationEntry.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include &lt;libgweather/gweather.h&gt;
</pre>
</div>
<div class="refsect1">
<a name="GWeatherLocationEntry.description"></a><h2>Description</h2>
<p>A subclass of <a href="../gtk3/GtkSearchEntry.html#GtkSearchEntry-struct"><span class="type">GtkSearchEntry</span></a> that provides autocompletion on
<a class="link" href="GWeatherLocation.html" title="GWeatherLocation"><span class="type">GWeatherLocation</span></a>s</p>
</div>
<div class="refsect1">
<a name="GWeatherLocationEntry.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="gweather-location-entry-new"></a><h3>gweather_location_entry_new ()</h3>
<pre class="programlisting"><a href="../gtk3/GtkWidget.html#GtkWidget-struct"><span class="returnvalue">GtkWidget</span></a> *
gweather_location_entry_new (<em class="parameter"><code><a class="link" href="GWeatherLocation.html" title="GWeatherLocation"><span class="type">GWeatherLocation</span></a> *top</code></em>);</pre>
<p>Creates a new <a class="link" href="GWeatherLocationEntry.html" title="GWeatherLocationEntry"><span class="type">GWeatherLocationEntry</span></a>.</p>
<p><em class="parameter"><code>top</code></em>
 will normally be the location returned from
<a class="link" href="GWeatherLocation.html#gweather-location-get-world" title="gweather_location_get_world ()"><code class="function">gweather_location_get_world()</code></a>, but you can create an entry that
only accepts a smaller set of locations if you want.</p>
<div class="refsect3">
<a name="gweather-location-entry-new.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>top</p></td>
<td class="parameter_description"><p>the top-level location for the entry.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gweather-location-entry-new.returns"></a><h4>Returns</h4>
<p> the new <a class="link" href="GWeatherLocationEntry.html" title="GWeatherLocationEntry"><span class="type">GWeatherLocationEntry</span></a></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gweather-location-entry-set-location"></a><h3>gweather_location_entry_set_location ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gweather_location_entry_set_location (<em class="parameter"><code><a class="link" href="GWeatherLocationEntry.html" title="GWeatherLocationEntry"><span class="type">GWeatherLocationEntry</span></a> *entry</code></em>,
                                      <em class="parameter"><code><a class="link" href="GWeatherLocation.html" title="GWeatherLocation"><span class="type">GWeatherLocation</span></a> *loc</code></em>);</pre>
<p>Sets <em class="parameter"><code>entry</code></em>
's location to <em class="parameter"><code>loc</code></em>
, and updates the text of the
entry accordingly.
Note that if the database contains a location that compares
equal to <em class="parameter"><code>loc</code></em>
, that will be chosen in place of <em class="parameter"><code>loc</code></em>
.</p>
<div class="refsect3">
<a name="gweather-location-entry-set-location.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>entry</p></td>
<td class="parameter_description"><p>a <a class="link" href="GWeatherLocationEntry.html" title="GWeatherLocationEntry"><span class="type">GWeatherLocationEntry</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>loc</p></td>
<td class="parameter_description"><p>a <a class="link" href="GWeatherLocation.html" title="GWeatherLocation"><span class="type">GWeatherLocation</span></a> in <em class="parameter"><code>entry</code></em>
, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to
clear <em class="parameter"><code>entry</code></em>
. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gweather-location-entry-get-location"></a><h3>gweather_location_entry_get_location ()</h3>
<pre class="programlisting"><a class="link" href="GWeatherLocation.html" title="GWeatherLocation"><span class="returnvalue">GWeatherLocation</span></a> *
gweather_location_entry_get_location (<em class="parameter"><code><a class="link" href="GWeatherLocationEntry.html" title="GWeatherLocationEntry"><span class="type">GWeatherLocationEntry</span></a> *entry</code></em>);</pre>
<p>Gets the location that was set by a previous call to
<a class="link" href="GWeatherLocationEntry.html#gweather-location-entry-set-location" title="gweather_location_entry_set_location ()"><code class="function">gweather_location_entry_set_location()</code></a> or was selected by the user.</p>
<div class="refsect3">
<a name="gweather-location-entry-get-location.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>entry</p></td>
<td class="parameter_description"><p>a <a class="link" href="GWeatherLocationEntry.html" title="GWeatherLocationEntry"><span class="type">GWeatherLocationEntry</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gweather-location-entry-get-location.returns"></a><h4>Returns</h4>
<p>the selected location
(which you must unref when you are done with it), or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if no
location is selected. </p>
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>][<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gweather-location-entry-has-custom-text"></a><h3>gweather_location_entry_has_custom_text ()</h3>
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
gweather_location_entry_has_custom_text
                               (<em class="parameter"><code><a class="link" href="GWeatherLocationEntry.html" title="GWeatherLocationEntry"><span class="type">GWeatherLocationEntry</span></a> *entry</code></em>);</pre>
<p>Checks whether or not <em class="parameter"><code>entry</code></em>
's text has been modified by the user.
Note that this does not mean that no location is associated with <em class="parameter"><code>entry</code></em>
.
<a class="link" href="GWeatherLocationEntry.html#gweather-location-entry-get-location" title="gweather_location_entry_get_location ()"><code class="function">gweather_location_entry_get_location()</code></a> should be used for this.</p>
<div class="refsect3">
<a name="gweather-location-entry-has-custom-text.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>entry</p></td>
<td class="parameter_description"><p>a <a class="link" href="GWeatherLocationEntry.html" title="GWeatherLocationEntry"><span class="type">GWeatherLocationEntry</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gweather-location-entry-has-custom-text.returns"></a><h4>Returns</h4>
<p> <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if <em class="parameter"><code>entry</code></em>
's text was modified by the user, or <a href="../glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> if
it's set to the default text of a location.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gweather-location-entry-set-city"></a><h3>gweather_location_entry_set_city ()</h3>
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
gweather_location_entry_set_city (<em class="parameter"><code><a class="link" href="GWeatherLocationEntry.html" title="GWeatherLocationEntry"><span class="type">GWeatherLocationEntry</span></a> *entry</code></em>,
                                  <em class="parameter"><code>const <span class="type">char</span> *city_name</code></em>,
                                  <em class="parameter"><code>const <span class="type">char</span> *code</code></em>);</pre>
<p>Sets <em class="parameter"><code>entry</code></em>
's location to a city with the given <em class="parameter"><code>code</code></em>
, and given
<em class="parameter"><code>city_name</code></em>
, if non-<a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. If there is no matching city, sets
<em class="parameter"><code>entry</code></em>
's location to <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.</p>
<div class="refsect3">
<a name="gweather-location-entry-set-city.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>entry</p></td>
<td class="parameter_description"><p>a <a class="link" href="GWeatherLocationEntry.html" title="GWeatherLocationEntry"><span class="type">GWeatherLocationEntry</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>city_name</p></td>
<td class="parameter_description"><p>the city name, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>code</p></td>
<td class="parameter_description"><p>the METAR station code</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gweather-location-entry-set-city.returns"></a><h4>Returns</h4>
<p> <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if <em class="parameter"><code>entry</code></em>
's location could be set to a matching city,
<a href="../glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise.</p>
</div>
</div>
</div>
<div class="refsect1">
<a name="GWeatherLocationEntry.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="GWeatherLocationEntry-struct"></a><h3>struct GWeatherLocationEntry</h3>
<pre class="programlisting">struct GWeatherLocationEntry;</pre>
</div>
</div>
<div class="refsect1">
<a name="GWeatherLocationEntry.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="GWeatherLocationEntry--location"></a><h3>The <code class="literal">“location”</code> property</h3>
<pre class="programlisting">  “location”                 <a class="link" href="GWeatherLocation.html" title="GWeatherLocation"><span class="type">GWeatherLocation</span></a> *</pre>
<p>The selected GWeatherLocation.</p>
<p>Flags: Read / Write</p>
</div>
<hr>
<div class="refsect2">
<a name="GWeatherLocationEntry--show-named-timezones"></a><h3>The <code class="literal">“show-named-timezones”</code> property</h3>
<pre class="programlisting">  “show-named-timezones”     <a href="../glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></pre>
<p>Whether UTC and other named timezones are shown in the list of locations.</p>
<p>Flags: Read / Write / Construct Only</p>
<p>Default value: FALSE</p>
</div>
<hr>
<div class="refsect2">
<a name="GWeatherLocationEntry--top"></a><h3>The <code class="literal">“top”</code> property</h3>
<pre class="programlisting">  “top”                      <a class="link" href="GWeatherLocation.html" title="GWeatherLocation"><span class="type">GWeatherLocation</span></a> *</pre>
<p>The GWeatherLocation whose children will be used to fill in the entry.</p>
<p>Flags: Write / Construct Only</p>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.27</div>
</body>
</html>

APT Browse - Built by Thomas Orozco.