Configuration and Control

Macros
#define	GEIS_CONFIG_UNIX_FD
	Gets the Unix file descriptor for GEIS events. More...

Functions
GeisStatus	geis_configuration_supported (GeisInstance geis_instance, int configuration_item)
	Indicates if a particular feaure is supported. More...
GeisStatus	geis_configuration_get_value (GeisInstance geis_instance, int configuration_item, void *value)
	Gets a feature configuration value. More...
GeisStatus	geis_configuration_set_value (GeisInstance geis_instance, int configuration_item, void *value)
	Sets a feature configuration value. More...
GeisStatus	geis_event_dispatch (GeisInstance geis_instance)
	Dispatches geis events until there are no further events available. More...

Detailed Description

Macro Definition Documentation

#define GEIS_CONFIG_UNIX_FD

Gets the Unix file descriptor for GEIS events.

Applications or toolkits can use this file descriptor to intgerate geis event handling into their main event dispatch loop. When a GEIS event is available for processing, the fd will have a read-available state indicated in select(), poll(), epoll(), etc.

Function Documentation

GeisStatus geis_configuration_get_value	(	GeisInstance	geis_instance,
		int	configuration_item,
		void *	value
	)

Gets a feature configuration value.

Parameters

[in]	geis_instance	An opaque pointer to a geis gesture subscription instance.
[in]	configuration_item	Indicates which configuration item will be get.
[in]	value	A pointer to where the retrieved value will be stored.

Return values

GEIS_BAD_ARGUMENT	an invalid argument value was passed
GEIS_STATUS_SUCCESS	normal successful completion

GeisStatus geis_configuration_set_value	(	GeisInstance	geis_instance,
		int	configuration_item,
		void *	value
	)

Sets a feature configuration value.

Parameters

[in]	geis_instance	An opaque pointer to a geis gesture subscription instance.
[in]	configuration_item	Indicates which configuration item will be set.
[in]	value	A pointer to where the value to be set will be read.

Return values

GEIS_BAD_ARGUMENT	an invalid argument value was passed
GEIS_STATUS_SUCCESS	normal successful completion

GeisStatus geis_configuration_supported	(	GeisInstance	geis_instance,
		int	configuration_item
	)

Indicates if a particular feaure is supported.

Parameters

[in]	geis_instance	An opaque pointer to a geis gesture subscription instance.
[in]	configuration_item	Indicates which configuration item will be checked for support.

Return values

GEIS_BAD_ARGUMENT	an invalid argument value was passed
GEIS_STATUS_SUCCESS	normal successful completion

GeisStatus geis_event_dispatch

(

GeisInstance

geis_instance

)

Dispatches geis events until there are no further events available.

Parameters

[in]

geis_instance

an opaque pointer to a geis gesture subscription instance

This function is used to integrate geis even dispatch into the main event loop of an application or toolkit.

Return values

GEIS_BAD_ARGUMENT	an invalid GeisInstance was passed
GEIS_STATUS_SUCCESS	normal successful completion