AXEvent
ax_event_key_value_set.h
Go to the documentation of this file.
1 
62 #ifndef _AX_EVENT_KEY_VALUE_SET_H_
63 #define _AX_EVENT_KEY_VALUE_SET_H_
64 
65 #ifdef __cplusplus
66 extern "C" {
67 #endif
68 
73 typedef struct _AXEventKeyValueSet AXEventKeyValueSet;
74 
82 
88 void
90 
110 gboolean
112  GError **error,
113  ...);
114 
131 gboolean
133  const gchar *key,
134  const gchar *name_space,
135  gconstpointer value,
136  AXEventValueType value_type,
137  GError **error);
138 
159 gboolean
161  const gchar *key,
162  const gchar *name_space,
163  GError **error);
164 
182 gboolean
184  const gchar *key,
185  const gchar *name_space,
186  GError **error);
187 
201 gboolean
203  const gchar *key,
204  const gchar *name_space,
205  const gchar *user_tag,
206  GError **error);
207 
224 gboolean
226  const gchar *key,
227  const gchar *name_space,
228  const gchar *key_nice_name,
229  const gchar *value_nice_name,
230  GError **error);
231 
245 gboolean
247  const gchar *key,
248  const gchar *name_space,
249  AXEventValueType *value_type,
250  GError **error);
251 
266 gboolean
268  const gchar *key,
269  const gchar *name_space,
270  gint *value,
271  GError **error);
272 
287 gboolean
289  const gchar *key,
290  const gchar *name_space,
291  gboolean *value,
292  GError **error);
293 
308 gboolean
310  const gchar *key,
311  const gchar *name_space,
312  gdouble *value,
313  GError **error);
314 
332 gboolean
334  const gchar *key,
335  const gchar *name_space,
336  gchar **value,
337  GError **error);
338 
356 gboolean
358  const gchar *key,
359  const gchar *name_space,
360  AXEventElementItem **item,
361  GError **error);
362 
375 gboolean
377  const gchar *key,
378  const gchar *name_space,
379  GError **error);
380 
381 #ifdef __cplusplus
382 }
383 #endif
384 
385 #endif /* _AX_EVENT_KEY_VALUE_SET_H_ */
386 
387 
gboolean ax_event_key_value_set_get_element(const AXEventKeyValueSet *key_value_set, const gchar *key, const gchar *name_space, AXEventElementItem **item, GError **error)
Retrieve the element item associated with a key.
gboolean ax_event_key_value_set_get_boolean(const AXEventKeyValueSet *key_value_set, const gchar *key, const gchar *name_space, gboolean *value, GError **error)
Retrieve the boolean value associated with a key.
gboolean ax_event_key_value_set_get_double(const AXEventKeyValueSet *key_value_set, const gchar *key, const gchar *name_space, gdouble *value, GError **error)
Retrieve the double value associated with a key.
gboolean ax_event_key_value_set_get_string(const AXEventKeyValueSet *key_value_set, const gchar *key, const gchar *name_space, gchar **value, GError **error)
Retrieve the string value associated with a key.
struct _AXEventKeyValueSet AXEventKeyValueSet
The AXEventKeyValueSet is an opaque data type required to create event declarations, event subscription and for receiving events.
Definition: ax_event_key_value_set.h:73
gboolean ax_event_key_value_set_get_value_type(const AXEventKeyValueSet *key_value_set, const gchar *key, const gchar *name_space, AXEventValueType *value_type, GError **error)
Retrieve the value type of the value associated with a key.
gboolean ax_event_key_value_set_add_key_values(AXEventKeyValueSet *key_value_set, GError **error,...)
Adds a set of key/value pairs to an AXEventKeyValueSet. The number of arguments is arbitrary and must...
gboolean ax_event_key_value_set_mark_as_source(AXEventKeyValueSet *key_value_set, const gchar *key, const gchar *name_space, GError **error)
Mark a key in the AXEventKeyValueSet as a source. A source key is an identifier used to distinguish b...
AXEventKeyValueSet * ax_event_key_value_set_new(void)
Creates a new AXEventKeyValueSet.
AXEventValueType
Definition: ax_event_types.h:19
void ax_event_key_value_set_free(AXEventKeyValueSet *key_value_set)
Frees an AXEventKeyValueSet.
gboolean ax_event_key_value_set_add_nice_names(AXEventKeyValueSet *key_value_set, const gchar *key, const gchar *name_space, const gchar *key_nice_name, const gchar *value_nice_name, GError **error)
Set the nice names of a key/value pair in the AXEventKeyValueSet. Nice names can be used to display h...
gboolean ax_event_key_value_set_get_integer(const AXEventKeyValueSet *key_value_set, const gchar *key, const gchar *name_space, gint *value, GError **error)
Retrieve the integer value associated with a key.
gboolean ax_event_key_value_set_remove_key(AXEventKeyValueSet *key_value_set, const gchar *key, const gchar *name_space, GError **error)
Removes a key and its associated value from an AXEventKeyValueSet.
gboolean ax_event_key_value_set_mark_as_user_defined(AXEventKeyValueSet *key_value_set, const gchar *key, const gchar *name_space, const gchar *user_tag, GError **error)
Mark a key in AXEventKeyValueSet with an user defined tag.
struct _AXEventElementItem AXEventElementItem
The AXEventElementItem is a n opaque data type representing a node in a tree.
Definition: ax_event_element_item.h:26
gboolean ax_event_key_value_set_mark_as_data(AXEventKeyValueSet *key_value_set, const gchar *key, const gchar *name_space, GError **error)
Mark a key in the AXEventKeyValueSet as data. A data key is a key that represents the state of what t...
gboolean ax_event_key_value_set_add_key_value(AXEventKeyValueSet *key_value_set, const gchar *key, const gchar *name_space, gconstpointer value, AXEventValueType value_type, GError **error)
Add a key/value pair to an AXEventKeyValueSet. If the added key is already in the AXEventKeyValueSet...