summaryrefslogtreecommitdiff
path: root/libgweather/gweather-location.h
blob: eeea3dd1f174d8b329b7b613942efd7d89ab6fb8 (plain)
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
/* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 4 -*- */
/* gweather-location.h - Location-handling code
 *
 * Copyright 2008, Red Hat, Inc.
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public License
 * as published by the Free Software Foundation; either version 2.1 of
 * the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, see
 * <http://www.gnu.org/licenses/>.
 */

#ifndef __GWEATHER_LOCATIONS_H__
#define __GWEATHER_LOCATIONS_H__

#if !(defined(IN_GWEATHER_H) || defined(GWEATHER_COMPILATION))
#error "gweather-location.h must not be included individually, include gweather.h instead"
#endif

#include <glib.h>
#include <libgweather/gweather-timezone.h>
#include <gio/gio.h>

G_BEGIN_DECLS

typedef struct _GWeatherLocation GWeatherLocation;
typedef gboolean (* GWeatherFilterFunc) (GWeatherLocation* location, gpointer user_data);

typedef enum { /*< underscore_name=gweather_location_level >*/
    GWEATHER_LOCATION_WORLD,
    GWEATHER_LOCATION_REGION,
    GWEATHER_LOCATION_COUNTRY,
    /* ADM1 = first-order administrative division = state/province, etc */
    GWEATHER_LOCATION_ADM1,
    GWEATHER_LOCATION_CITY,
    GWEATHER_LOCATION_WEATHER_STATION,
    GWEATHER_LOCATION_DETACHED,
    GWEATHER_LOCATION_NAMED_TIMEZONE
} GWeatherLocationLevel;

GWEATHER_EXTERN
GType gweather_location_get_type (void);
#define GWEATHER_TYPE_LOCATION (gweather_location_get_type ())

GWEATHER_EXTERN
GWeatherLocation      *gweather_location_get_world      (void);

GWEATHER_EXTERN
GWeatherLocation      *gweather_location_ref            (GWeatherLocation  *loc);
GWEATHER_EXTERN
void                   gweather_location_unref          (GWeatherLocation  *loc);

GWEATHER_EXTERN
const char            *gweather_location_get_name       (GWeatherLocation  *loc);
GWEATHER_EXTERN
const char            *gweather_location_get_sort_name  (GWeatherLocation  *loc);
GWEATHER_EXTERN
GWeatherLocationLevel  gweather_location_get_level      (GWeatherLocation  *loc);
GWEATHER_EXTERN
GWeatherLocation      *gweather_location_get_parent     (GWeatherLocation  *loc);

GWEATHER_EXTERN
GWeatherLocation     **gweather_location_get_children   (GWeatherLocation  *loc);

GWEATHER_EXTERN
gboolean               gweather_location_has_coords     (GWeatherLocation  *loc);
GWEATHER_EXTERN
void                   gweather_location_get_coords     (GWeatherLocation  *loc,
							 double            *latitude,
							 double            *longitude);
GWEATHER_EXTERN
double                 gweather_location_get_distance   (GWeatherLocation  *loc,
							 GWeatherLocation  *loc2);
GWEATHER_EXTERN
GWeatherLocation      *gweather_location_find_nearest_city (GWeatherLocation *loc,
							    double            lat,
							    double            lon);

GWEATHER_EXTERN
GWeatherLocation      *gweather_location_find_nearest_city_full (GWeatherLocation  *loc,
								 double             lat,
								 double             lon,
								 GWeatherFilterFunc func,
								 gpointer           user_data,
								 GDestroyNotify     destroy);

GWEATHER_EXTERN
void                  gweather_location_detect_nearest_city (GWeatherLocation   *loc,
							     double              lat,
							     double              lon,
							     GCancellable       *cancellable,
							     GAsyncReadyCallback callback,
							     gpointer            user_data);
GWEATHER_EXTERN
GWeatherLocation      *gweather_location_detect_nearest_city_finish (GAsyncResult *result, GError **error);

GWEATHER_EXTERN
const char            *gweather_location_get_country    (GWeatherLocation  *loc);

GWEATHER_EXTERN
GWeatherTimezone      *gweather_location_get_timezone   (GWeatherLocation  *loc);
GWEATHER_EXTERN
const char            *gweather_location_get_timezone_str (GWeatherLocation *loc);
GWEATHER_EXTERN
GWeatherTimezone     **gweather_location_get_timezones  (GWeatherLocation  *loc);
GWEATHER_EXTERN
void                   gweather_location_free_timezones (GWeatherLocation  *loc,
							 GWeatherTimezone **zones);

GWEATHER_EXTERN
const char            *gweather_location_get_code       (GWeatherLocation  *loc);
GWEATHER_EXTERN
char                  *gweather_location_get_city_name  (GWeatherLocation  *loc);
GWEATHER_EXTERN
char                  *gweather_location_get_country_name (GWeatherLocation  *loc);

GWEATHER_EXTERN
GWeatherLocation      *gweather_location_find_by_station_code (GWeatherLocation *world,
							       const gchar      *station_code);
GWEATHER_EXTERN
GWeatherLocation      *gweather_location_find_by_country_code (GWeatherLocation *world,
							       const gchar      *country_code);

GWEATHER_EXTERN
gboolean               gweather_location_equal          (GWeatherLocation  *one,
							 GWeatherLocation  *two);

GWEATHER_EXTERN
GVariant              *gweather_location_serialize      (GWeatherLocation  *loc);
GWEATHER_EXTERN
GWeatherLocation      *gweather_location_deserialize    (GWeatherLocation  *world,
							 GVariant          *serialized);

GWEATHER_EXTERN
GWeatherLocation      *gweather_location_new_detached   (const char        *name,
							 const char        *icao,
							 gdouble            latitude,
							 gdouble            longitude);

GWEATHER_EXTERN
const char            *gweather_location_level_to_string (GWeatherLocationLevel level);

G_END_DECLS

#endif /* __GWEATHER_LOCATIONS_H__ */