1
/*
2
 * Copyright (C) 2011-2012 Jiri Techet <techet@gmail.com>
3
 *
4
 * This library is free software; you can redistribute it and/or
5
 * modify it under the terms of the GNU Lesser General Public
6
 * License as published by the Free Software Foundation; either
7
 * version 2.1 of the License, or (at your option) any later version.
8
 *
9
 * This library is distributed in the hope that it will be useful,
10
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12
 * Lesser General Public License for more details.
13
 *
14
 * You should have received a copy of the GNU Lesser General Public
15
 * License along with this library; if not, write to the Free Software
16
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
17
 */
18
19
#if !defined (__CHAMPLAIN_CHAMPLAIN_H_INSIDE__) && !defined (CHAMPLAIN_COMPILATION)
20
#error "Only <champlain/champlain.h> can be included directly."
21
#endif
22
23
#ifndef CHAMPLAIN_SCALE_H
24
#define CHAMPLAIN_SCALE_H
25
26
#include <champlain/champlain-defines.h>
27
28
#include <glib-object.h>
29
#include <clutter/clutter.h>
30
31
G_BEGIN_DECLS
32
33
#define CHAMPLAIN_TYPE_SCALE champlain_scale_get_type ()
34
35
#define CHAMPLAIN_SCALE(obj) \
36
  (G_TYPE_CHECK_INSTANCE_CAST ((obj), CHAMPLAIN_TYPE_SCALE, ChamplainScale))
37
38
#define CHAMPLAIN_SCALE_CLASS(klass) \
39
  (G_TYPE_CHECK_CLASS_CAST ((klass), CHAMPLAIN_TYPE_SCALE, ChamplainScaleClass))
40
41
#define CHAMPLAIN_IS_SCALE(obj) \
42
  (G_TYPE_CHECK_INSTANCE_TYPE ((obj), CHAMPLAIN_TYPE_SCALE))
43
44
#define CHAMPLAIN_IS_SCALE_CLASS(klass) \
45
  (G_TYPE_CHECK_CLASS_TYPE ((klass), CHAMPLAIN_TYPE_SCALE))
46
47
#define CHAMPLAIN_SCALE_GET_CLASS(obj) \
48
  (G_TYPE_INSTANCE_GET_CLASS ((obj), CHAMPLAIN_TYPE_SCALE, ChamplainScaleClass))
49
50
typedef struct _ChamplainScalePrivate ChamplainScalePrivate;
51
52
typedef struct _ChamplainScale ChamplainScale;
53
typedef struct _ChamplainScaleClass ChamplainScaleClass;
54
55
/**
56
 * ChamplainUnit:
57
 * @CHAMPLAIN_UNIT_KM: kilometers
58
 * @CHAMPLAIN_UNIT_MILES: miles
59
 *
60
 * Units used by the scale.
61
 */
62
typedef enum
63
{
64
  CHAMPLAIN_UNIT_KM,
65
  CHAMPLAIN_UNIT_MILES,
66
} ChamplainUnit;
67
68
/**
69
 * ChamplainScale:
70
 *
71
 * The #ChamplainScale structure contains only private data
72
 * and should be accessed using the provided API
73
 *
74
 * Since: 0.10
75
 */
76
struct _ChamplainScale
77
{
78
  ClutterActor parent;
79
80
  ChamplainScalePrivate *priv;
81
};
82
83
struct _ChamplainScaleClass
84
{
85
  ClutterActorClass parent_class;
86
};
87
88
GType champlain_scale_get_type (void);
89
90
ClutterActor *champlain_scale_new (void);
91
92
93
void champlain_scale_set_max_width (ChamplainScale *scale,
94
    guint value);
95
void champlain_scale_set_unit (ChamplainScale *scale,
96
    ChamplainUnit unit);
97
98
guint champlain_scale_get_max_width (ChamplainScale *scale);
99
ChamplainUnit champlain_scale_get_unit (ChamplainScale *scale);
100
101
void champlain_scale_connect_view (ChamplainScale *scale,
102
    ChamplainView *view);
103
void champlain_scale_disconnect_view (ChamplainScale *scale);
104
105
G_END_DECLS
106
107
#endif