~ubuntu-branches/ubuntu/quantal/colord/quantal-proposed

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
/* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*-
 *
 * Copyright (C) 2010-2011 Richard Hughes <richard@hughsie.com>
 *
 * Licensed under the GNU Lesser General Public License Version 2.1
 *
 * 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, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301 USA
 */

#if !defined (__COLORD_H_INSIDE__) && !defined (CD_COMPILATION)
#error "Only <colord.h> can be included directly."
#endif

#ifndef __CD_CLIENT_H
#define __CD_CLIENT_H

#include <glib-object.h>
#include <gio/gio.h>

#include "cd-device.h"
#include "cd-profile.h"
#include "cd-sensor.h"

G_BEGIN_DECLS

#define CD_TYPE_CLIENT		(cd_client_get_type ())
#define CD_CLIENT(o)		(G_TYPE_CHECK_INSTANCE_CAST ((o), CD_TYPE_CLIENT, CdClient))
#define CD_CLIENT_CLASS(k)	(G_TYPE_CHECK_CLASS_CAST((k), CD_TYPE_CLIENT, CdClientClass))
#define CD_IS_CLIENT(o)		(G_TYPE_CHECK_INSTANCE_TYPE ((o), CD_TYPE_CLIENT))
#define CD_IS_CLIENT_CLASS(k)	(G_TYPE_CHECK_CLASS_TYPE ((k), CD_TYPE_CLIENT))
#define CD_CLIENT_GET_CLASS(o)	(G_TYPE_INSTANCE_GET_CLASS ((o), CD_TYPE_CLIENT, CdClientClass))
#define CD_CLIENT_ERROR		(cd_client_error_quark ())
#define CD_CLIENT_TYPE_ERROR	(cd_client_error_get_type ())

typedef struct _CdClientPrivate CdClientPrivate;

typedef struct
{
	 GObject		 parent;
	 CdClientPrivate	*priv;
} CdClient;

typedef struct
{
	GObjectClass		 parent_class;
	void			(*device_added)		(CdClient		*client,
							 CdDevice		*device);
	void			(*device_removed)	(CdClient		*client,
							 CdDevice		*device);
	void			(*device_changed)	(CdClient		*client,
							 CdDevice		*device);
	void			(*profile_added)	(CdClient		*client,
							 CdProfile		*profile);
	void			(*profile_removed)	(CdClient		*client,
							 CdProfile		*profile);
	void			(*profile_changed)	(CdClient		*client,
							 CdProfile		*profile);
	void			(*sensor_added)		(CdClient		*client,
							 CdSensor		*sensor);
	void			(*sensor_removed)	(CdClient		*client,
							 CdSensor		*sensor);
	void			(*sensor_changed)	(CdClient		*client,
							 CdSensor		*sensor);
	void			(*changed)              (CdClient		*client);
	/*< private >*/
	/* Padding for future expansion */
	void (*_cd_client_reserved1) (void);
	void (*_cd_client_reserved2) (void);
	void (*_cd_client_reserved3) (void);
	void (*_cd_client_reserved4) (void);
	void (*_cd_client_reserved5) (void);
	void (*_cd_client_reserved6) (void);
	void (*_cd_client_reserved7) (void);
	void (*_cd_client_reserved8) (void);
} CdClientClass;

/**
 * CdClientError:
 * @CD_CLIENT_ERROR_FAILED: the transaction failed for an unknown reason
 * @CD_CLIENT_ERROR_ALREADY_EXISTS: the device or profile already exists
 *
 * Errors that can be thrown
 */
typedef enum
{
	CD_CLIENT_ERROR_FAILED,
	CD_CLIENT_ERROR_ALREADY_EXISTS,
	CD_CLIENT_ERROR_FILE_INVALID,
	CD_CLIENT_ERROR_LAST
} CdClientError;

GType		 cd_client_get_type			(void);
GQuark		 cd_client_error_quark			(void);
CdClient	*cd_client_new				(void);

/* async */
void		 cd_client_connect			(CdClient	*client,
							 GCancellable	*cancellable,
							 GAsyncReadyCallback callback,
							 gpointer	 user_data);
gboolean	 cd_client_connect_finish		(CdClient	*client,
							 GAsyncResult	*res,
							 GError		**error);
void		cd_client_create_device			(CdClient	*client,
							 const gchar	*id,
							 CdObjectScope	 scope,
							 GHashTable	*properties,
							 GCancellable	*cancellable,
							 GAsyncReadyCallback callback,
							 gpointer	 user_data);
CdDevice	*cd_client_create_device_finish		(CdClient	*client,
							 GAsyncResult	*res,
							 GError		**error);
void		cd_client_create_profile		(CdClient	*client,
							 const gchar	*id,
							 CdObjectScope	 scope,
							 GHashTable	*properties,
							 GCancellable	*cancellable,
							 GAsyncReadyCallback callback,
							 gpointer	 user_data);
CdProfile	*cd_client_create_profile_finish	(CdClient	*client,
							 GAsyncResult	*res,
							 GError		**error);
void		cd_client_import_profile		(CdClient	*client,
							 GFile		*file,
							 GCancellable	*cancellable,
							 GAsyncReadyCallback callback,
							 gpointer	 user_data);
CdProfile	*cd_client_import_profile_finish	(CdClient	*client,
							 GAsyncResult	*res,
							 GError		**error);
void		 cd_client_delete_device		(CdClient	*client,
							 CdDevice	*device,
							 GCancellable	*cancellable,
							 GAsyncReadyCallback callback,
							 gpointer	 user_data);
gboolean	 cd_client_delete_device_finish		(CdClient	*client,
							 GAsyncResult	*res,
							 GError		**error);
void		 cd_client_delete_profile		(CdClient	*client,
							 CdProfile	*profile,
							 GCancellable	*cancellable,
							 GAsyncReadyCallback callback,
							 gpointer	 user_data);
gboolean	 cd_client_delete_profile_finish	(CdClient	*client,
							 GAsyncResult	*res,
							 GError		**error);
void		cd_client_find_device			(CdClient	*client,
							 const gchar	*id,
							 GCancellable	*cancellable,
							 GAsyncReadyCallback callback,
							 gpointer	 user_data);
CdDevice	*cd_client_find_device_finish 		(CdClient	*client,
							 GAsyncResult	*res,
							 GError		**error);
void		cd_client_find_device_by_property	(CdClient	*client,
							 const gchar	*key,
							 const gchar	*value,
							 GCancellable	*cancellable,
							 GAsyncReadyCallback callback,
							 gpointer	 user_data);
CdDevice	*cd_client_find_device_by_property_finish (CdClient	*client,
							 GAsyncResult	*res,
							 GError		**error);
void		cd_client_find_profile			(CdClient	*client,
							 const gchar	*id,
							 GCancellable	*cancellable,
							 GAsyncReadyCallback callback,
							 gpointer	 user_data);
CdProfile	*cd_client_find_profile_finish 		(CdClient	*client,
							 GAsyncResult	*res,
							 GError		**error);

void		cd_client_find_profile_by_filename	(CdClient	*client,
							 const gchar	*filename,
							 GCancellable	*cancellable,
							 GAsyncReadyCallback callback,
							 gpointer	 user_data);
CdProfile	*cd_client_find_profile_by_filename_finish (CdClient	*client,
							 GAsyncResult	*res,
							 GError		**error);
void		cd_client_get_standard_space		(CdClient	*client,
							 CdStandardSpace standard_space,
							 GCancellable	*cancellable,
							 GAsyncReadyCallback callback,
							 gpointer	 user_data);
CdProfile	*cd_client_get_standard_space_finish	(CdClient	*client,
							 GAsyncResult	*res,
							 GError		**error);
void		 cd_client_get_devices			(CdClient	*client,
							 GCancellable	*cancellable,
							 GAsyncReadyCallback callback,
							 gpointer	 user_data);
GPtrArray	*cd_client_get_devices_finish		(CdClient	*client,
							 GAsyncResult	*res,
							 GError		**error);
void		 cd_client_get_devices_by_kind		(CdClient	*client,
							 CdDeviceKind	 kind,
							 GCancellable	*cancellable,
							 GAsyncReadyCallback callback,
							 gpointer	 user_data);
GPtrArray	*cd_client_get_devices_by_kind_finish	(CdClient	*client,
							 GAsyncResult	*res,
							 GError		**error);
void		 cd_client_get_profiles			(CdClient	*client,
							 GCancellable	*cancellable,
							 GAsyncReadyCallback callback,
							 gpointer	 user_data);
GPtrArray	*cd_client_get_profiles_finish		(CdClient	*client,
							 GAsyncResult	*res,
							 GError		**error);
void		 cd_client_get_sensors			(CdClient	*client,
							 GCancellable	*cancellable,
							 GAsyncReadyCallback callback,
							 gpointer	 user_data);
GPtrArray	*cd_client_get_sensors_finish		(CdClient	*client,
							 GAsyncResult	*res,
							 GError		**error);

/* getters */
gboolean	 cd_client_get_connected		(CdClient	*client);
gboolean	 cd_client_get_has_server		(CdClient	*client);
const gchar	*cd_client_get_daemon_version		(CdClient	*client);

G_END_DECLS

#endif /* __CD_CLIENT_H */