← Back to branch summary

~oif-team/geis/geis2-add-device

« back to all changes in this revision

Viewing changes to include/geis/geis.h

  • Committer: Stephen M. Webb
  • Date: 2010-11-29 17:44:11 UTC
  • mfrom: (87.1.17 geis2)
  • Revision ID: stephen.webb@canonical.com-20101129174411-o0gw5pe75bxrb8ax
Added GEIS v2.0 attr and configuration modules.

Show diffs side-by-side

added added

removed removed

Lines of Context:
include/geis/geis.h
267
267
/* @} */
268
268
 
269
269
/**
270
 
 * @defgroup geis_config Configuration and Control
 
270
 * @defgroup geis_config Configuration and Control (GEIS v1.0)
271
271
 * @{
272
272
 */
273
273
 
327
327
 
328
328
/* @} */
329
329
 
 
330
/**
 
331
 * @defgroup geis2_config Configuration (GEIS v2.0)
 
332
 * @{
 
333
 */
 
334
 
 
335
#define GEIS_CONFIGURATION_FD "org.libgeis.configuration.fd"
 
336
 
 
337
/**
 
338
 * Gets a feature configuration value.
 
339
 *
 
340
 * @param[in]  geis                     An opaque GEIS API object.
 
341
 * @param[in]  configuration_item_name  Selects the configuration value to return.
 
342
 * @param[out] configuration_item_value Points to a buffer to contain the output
 
343
 *                                      value.  The actual type of this buffer
 
344
 *                                      depends on the
 
345
 *                                      @p configuration_value_name.
 
346
 *
 
347
 * @retval GEIS_STATUS_BAD_ARGUMENT  an invalid argument value was passed
 
348
 * @retval GEIS_STATUS_NO_SUPPORTED  the configuration value is not supported
 
349
 * @retval GEIS_STATUS_SUCCESS       normal successful completion
 
350
 */
 
351
GEIS_API GeisStatus geis_get_configuration(Geis        geis, 
 
352
                                           GeisString  configuration_item_name,
 
353
                                           void       *configuration_item_value);
 
354
 
 
355
/**
 
356
 * Sets a feature configuration value.
 
357
 *
 
358
 * @param[in]  geis                 An opaque GEIS API object.
 
359
 * @param[in]  configuration_value  Selects the configuration value to return.
 
360
 * @param[in]  configuration_item_name  Selects the configuration value to return.
 
361
 * @param[in] configuration_item_value Points to a buffer to contain the output
 
362
 *                                     configuration value.  The actual type of
 
363
 *                                     this buffer depends on the
 
364
 *                                     @p configuration_value_name.
 
365
 *
 
366
 * @retval GEIS_STATUS_BAD_ARGUMENT  an invalid argument value was passed
 
367
 * @retval GEIS_STATUS_NO_SUPPORTED  the configuration value is not supported
 
368
 * @retval GEIS_STATUS_SUCCESS       normal successful completion
 
369
 */
 
370
GEIS_API GeisStatus geis_set_configuration(Geis        geis,
 
371
                                           GeisString  configuration_item_name, 
 
372
                                           void       *configuration_item_value);
 
373
 
 
374
/* @} */
 
375
 
 
376
/**
 
377
 * @defgroup geis2_attrs Attributes
 
378
 *
 
379
 * Attributes are named values associated with various GEIS entities, including
 
380
 * input devices, gesture types, and gesture events.
 
381
 *
 
382
 * @{
 
383
 */
330
384
typedef enum GeisAttrType
331
385
{
332
386
  GEIS_ATTR_TYPE_UNKNOWN,
337
391
} GeisAttrType;
338
392
 
339
393
/**
 
394
 * An opaque type that encapsulates a GEIS attribute.
 
395
 *
 
396
 * GeisAttr objects may not be created or destroyed by the application, they may
 
397
 * only have their data examined or extracted.
 
398
 */
 
399
typedef struct _GeisAttr *GeisAttr;
 
400
 
 
401
/**
 
402
 * Gets the name of an attribute.
 
403
 *
 
404
 * @param[in] attr  Identifies the attribute.
 
405
 */
 
406
GEIS_API GeisString geis_attr_name(GeisAttr attr);
 
407
 
 
408
/**
 
409
 * Gets the type of an attribute value.
 
410
 *
 
411
 * @param[in] attr  Identifies the attribute.
 
412
 */
 
413
GEIS_API GeisAttrType geis_attr_type(GeisAttr attr);
 
414
 
 
415
/**
 
416
 * Gets the value of an attribute as a GeisBoolean.
 
417
 *
 
418
 * @param[in] attr  Identifies the attribute.
 
419
 */
 
420
GEIS_API GeisBoolean geis_attr_value_to_boolean(GeisAttr attr);
 
421
 
 
422
/**
 
423
 * Gets the value of an attribute as a GeisFloat.
 
424
 *
 
425
 * @param[in] attr  Identifies the attribute.
 
426
 */
 
427
GEIS_API GeisFloat geis_attr_value_to_float(GeisAttr attr);
 
428
 
 
429
/**
 
430
 * Gets the value of an attribute as a GeisInteger.
 
431
 *
 
432
 * @param[in] attr  Identifies the attribute.
 
433
 */
 
434
GEIS_API GeisInteger geis_attr_value_to_integer(GeisAttr attr);
 
435
 
 
436
/**geis_attr_value_to_integer
 
437
 * Gets the value of an attribute as a GeisString.
 
438
 *
 
439
 * @param[in] attr  Identifies the attribute.
 
440
 */
 
441
GEIS_API GeisString geis_attr_value_to_string(GeisAttr attr);
 
442
 
 
443
/* @} */
 
444
 
 
445
/**
340
446
 * @defgroup geis_input Input Devices
341
447
 * @{
342
448
 */