GEIS 2.0
Gesture Engine Interface Support
Gesture Subscription

Data Structures

class  GeisSubscription
 A gesture recognition subscription. More...

Typedefs

typedef enum GeisSubscriptionFlags GeisSubscriptionFlags

Enumerations

enum  GeisSubscriptionFlags { GEIS_SUBSCRIPTION_NONE, GEIS_SUBSCRIPTION_GRAB, GEIS_SUBSCRIPTION_CONT }
 These flags are used when creating a new subscription and affect the nature of the gestures recognized by the subscription. More...

Functions

GeisSubscription geis_subscription_new (Geis geis, GeisString name, GeisSubscriptionFlags flags)
 Creates a new subscription.
GeisStatus geis_subscription_delete (GeisSubscription subscription)
 Destroys a GEIS v2.0 subscription object.
GeisStatus geis_subscription_activate (GeisSubscription subscription)
 Activates a subscription.
GeisStatus geis_subscription_deactivate (GeisSubscription subscription)
 Deactivates a subscription.
GeisString geis_subscription_name (GeisSubscription subscription)
 Gets the name given to a subscription when it was created.
GeisInteger geis_subscription_id (GeisSubscription subscription)
 Gets the ID assigned to a subscription when it was created.
GeisStatus geis_subscription_add_filter (GeisSubscription subscription, GeisFilter filter)
 Adds a filter to a subscription.
GeisFilter geis_subscription_filter_by_name (GeisSubscription sub, GeisString name)
 Gets an named filter from a subscription.
GeisStatus geis_subscription_remove_filter (GeisSubscription subscription, GeisFilter filter)
 Removes a filter from a subscription.

Enumeration Type Documentation

These flags are used when creating a new subscription and affect the nature of the gestures recognized by the subscription.

They may ORed together.

Enumerator:
GEIS_SUBSCRIPTION_NONE 

No special subscription processing: this is the default.

GEIS_SUBSCRIPTION_GRAB 

The subscription will "grab" all filtered gestures from subwindows.

GEIS_SUBSCRIPTION_CONT 

The gesture engine will return gesture continuations, in which the class of a recognized gestire may change over the lifetime of the gesture.

If this flag is not set, a new gesture will be identified for each change in gesture class.


Function Documentation

GeisStatus geis_subscription_activate ( GeisSubscription  subscription)

Activates a subscription.

Parameters:
[in]subscriptionThe subscription.

Puts the subscription into the active state. Gesture events will be delivered for this subscription.

GeisStatus geis_subscription_add_filter ( GeisSubscription  subscription,
GeisFilter  filter 
)

Adds a filter to a subscription.

Parameters:
[in]subscriptionThe subscription.
[in]filterThe filter to be added to the subscription.

Thye effect of filters are ANDed together so that, for example, a subscription that has a filter for 3-finger gestures and drag gestures will produce events only for 3-finger drag gestures.

The default is no filters: that is, all possible gesture events will be reported.

GeisStatus geis_subscription_deactivate ( GeisSubscription  subscription)

Deactivates a subscription.

Parameters:
[in]subscriptionThe subscription.

Puts the subscription into the inactive state. Gesture events will not be delivered for this subscription.

GeisStatus geis_subscription_delete ( GeisSubscription  subscription)

Destroys a GEIS v2.0 subscription object.

Parameters:
[in]subscriptionThe subscription.
GeisFilter geis_subscription_filter_by_name ( GeisSubscription  sub,
GeisString  name 
)

Gets an named filter from a subscription.

Parameters:
[in]subThe subscription.
[in]nameNames the filter to retrieve.

Returns the first filter with the given name or NULL if no such named filter is found.

GeisInteger geis_subscription_id ( GeisSubscription  subscription)

Gets the ID assigned to a subscription when it was created.

Parameters:
[in]subscriptionThe subscription.
GeisString geis_subscription_name ( GeisSubscription  subscription)

Gets the name given to a subscription when it was created.

Parameters:
[in]subscriptionThe subscription.
GeisSubscription geis_subscription_new ( Geis  geis,
GeisString  name,
GeisSubscriptionFlags  flags 
)

Creates a new subscription.

Parameters:
[in]geisThe GEIS API instance.
[in]nameA name.
[in]flagsSome flags.
Returns:
a GeisSubscription object or NULL on failure.

A gesture subscription is required for any gesture events to be delivered from the GEIS API.

GeisStatus geis_subscription_remove_filter ( GeisSubscription  subscription,
GeisFilter  filter 
)

Removes a filter from a subscription.

Parameters:
[in]subscriptionThe subscription.
[in]filterThe filter to be removed from the subscription.
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Defines