summaryrefslogtreecommitdiff
path: root/libedataserver/e-source-autocomplete.c
blob: fe5ad8cc8af30b62f962c5ca582cb8842aca82fe (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
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
/*
 * e-source-autocomplete.c
 *
 * 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.
 *
 * 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/>.
 *
 */

/**
 * SECTION: e-source-autocomplete
 * @include: libedataserver/libedataserver.h
 * @short_description: #ESource extension for autocomplete settings
 *
 * The #ESourceAutocomplete extension tracks contact autocompletion
 * settings for an address book.
 *
 * Access the extension as follows:
 *
 * |[
 *   #include <libedataserver/libedataserver.h>
 *
 *   ESourceAutocomplete *extension;
 *
 *   extension = e_source_get_extension (source, E_SOURCE_EXTENSION_AUTOCOMPLETE);
 * ]|
 **/

#include "e-source-autocomplete.h"

#define E_SOURCE_AUTOCOMPLETE_GET_PRIVATE(obj) \
	(G_TYPE_INSTANCE_GET_PRIVATE \
	((obj), E_TYPE_SOURCE_AUTOCOMPLETE, ESourceAutocompletePrivate))

struct _ESourceAutocompletePrivate {
	gboolean include_me;
};

enum {
	PROP_0,
	PROP_INCLUDE_ME
};

G_DEFINE_TYPE (
	ESourceAutocomplete,
	e_source_autocomplete,
	E_TYPE_SOURCE_EXTENSION)

static void
source_autocomplete_set_property (GObject *object,
                                    guint property_id,
                                    const GValue *value,
                                    GParamSpec *pspec)
{
	switch (property_id) {
		case PROP_INCLUDE_ME:
			e_source_autocomplete_set_include_me (
				E_SOURCE_AUTOCOMPLETE (object),
				g_value_get_boolean (value));
			return;
	}

	G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec);
}

static void
source_autocomplete_get_property (GObject *object,
                                    guint property_id,
                                    GValue *value,
                                    GParamSpec *pspec)
{
	switch (property_id) {
		case PROP_INCLUDE_ME:
			g_value_set_boolean (
				value,
				e_source_autocomplete_get_include_me (
				E_SOURCE_AUTOCOMPLETE (object)));
			return;
	}

	G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec);
}

static void
e_source_autocomplete_class_init (ESourceAutocompleteClass *class)
{
	GObjectClass *object_class;
	ESourceExtensionClass *extension_class;

	g_type_class_add_private (class, sizeof (ESourceAutocompletePrivate));

	object_class = G_OBJECT_CLASS (class);
	object_class->set_property = source_autocomplete_set_property;
	object_class->get_property = source_autocomplete_get_property;

	extension_class = E_SOURCE_EXTENSION_CLASS (class);
	extension_class->name = E_SOURCE_EXTENSION_AUTOCOMPLETE;

	g_object_class_install_property (
		object_class,
		PROP_INCLUDE_ME,
		g_param_spec_boolean (
			"include-me",
			"IncludeMe",
			"Include this source when autocompleting",
			TRUE,
			G_PARAM_READWRITE |
			G_PARAM_CONSTRUCT |
			G_PARAM_STATIC_STRINGS |
			E_SOURCE_PARAM_SETTING));
}

static void
e_source_autocomplete_init (ESourceAutocomplete *extension)
{
	extension->priv = E_SOURCE_AUTOCOMPLETE_GET_PRIVATE (extension);
}

/**
 * e_source_autocomplete_get_include_me:
 * @extension: an #ESourceAutocomplete
 *
 * Returns whether the address book described by the #ESource to which
 * @extension belongs should be queried when the user inputs a partial
 * contact name or email address.
 *
 * Returns: whether to use the autocomplete feature
 *
 * Since: 3.6
 **/
gboolean
e_source_autocomplete_get_include_me (ESourceAutocomplete *extension)
{
	g_return_val_if_fail (E_IS_SOURCE_AUTOCOMPLETE (extension), FALSE);

	return extension->priv->include_me;
}

/**
 * e_source_autocomplete_set_include_me:
 * @extension: an #ESourceAutocomplete
 * @include_me: whether to use the autocomplete feature
 *
 * Sets whether the address book described by the #ESource to which
 * @extension belongs should be queried when the user inputs a partial
 * contact name or email address.
 *
 * Since: 3.6
 **/
void
e_source_autocomplete_set_include_me (ESourceAutocomplete *extension,
                                      gboolean include_me)
{
	g_return_if_fail (E_IS_SOURCE_AUTOCOMPLETE (extension));

	if (extension->priv->include_me == include_me)
		return;

	extension->priv->include_me = include_me;

	g_object_notify (G_OBJECT (extension), "include-me");
}