← Back to branch summary

~matttbe/ubuntu/raring/geis/lp1077376

« back to all changes in this revision

Viewing changes to libgeis/geis_touch.h

  • Committer: Package Import Robot
  • Author(s): Chase Douglas
  • Date: 2012-07-30 08:51:42 UTC
  • Revision ID: package-import@ubuntu.com-20120730085142-jrc33ygjvt0ob1wl
Tags: upstream-2.2.11
Import upstream version 2.2.11

Show diffs side-by-side

added added

removed removed

Lines of Context:
libgeis/geis_touch.h
 
1
/**
 
2
 * @file geis_touch.h
 
3
 * @brief Geis touch module internal interface
 
4
 *
 
5
 * Copyright 2011 Canonical Ltd.
 
6
 *
 
7
 * This library is free software; you can redistribute it and/or modify it under
 
8
 * the terms of the GNU Lesser General Public License as published by the Free
 
9
 * Software Foundation; either version 3 of the License, or (at your option) any
 
10
 * later version.
 
11
 *
 
12
 * This library is distributed in the hope that it will be useful, but WITHOUT
 
13
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 
14
 * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
 
15
 * details.
 
16
 *
 
17
 * You should have received a copy of the GNU Lesser General Public License
 
18
 * along with this program; if not, write to the Free Software Foundation, Inc.,
 
19
 * 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
 
20
 */
 
21
#ifndef GEIS_TOUCH_H_
 
22
#define GEIS_TOUCH_H_
 
23
 
 
24
#include "geis/geis.h"
 
25
 
 
26
/**
 
27
 * @defgroup geis_touchset A Touch Container
 
28
 * @{
 
29
 */
 
30
 
 
31
/**
 
32
 * Creates a new, empty touch set.
 
33
 */
 
34
GeisTouchSet geis_touchset_new();
 
35
 
 
36
/**
 
37
 * Destroys a touch set and all touches contained in it.
 
38
 *
 
39
 * @param[in] touchset  The touch set to destroy.
 
40
 */
 
41
void geis_touchset_delete(GeisTouchSet touchset);
 
42
 
 
43
/**
 
44
 * Inserts a touch in to a touch set.
 
45
 *
 
46
 * @param[in] touchset  A touch set.
 
47
 * @param[in] touch     A touch.
 
48
 *
 
49
 * The set takes ownership of the touch.
 
50
 */
 
51
GeisStatus geis_touchset_insert(GeisTouchSet touchset, GeisTouch touch);
 
52
 
 
53
/** @} */
 
54
 
 
55
/**
 
56
 * @defgroup geis_touch A Gesture Touch
 
57
 * @{
 
58
 */
 
59
 
 
60
/**
 
61
 * Creates a new touch.
 
62
 *
 
63
 * @param[in] id  Identifier for the new touch.
 
64
 */
 
65
GeisTouch geis_touch_new(GeisTouchId id);
 
66
 
 
67
/**
 
68
 * Destroys a touch.
 
69
 *
 
70
 * @param[in] touch  The touch to destroy.
 
71
 */
 
72
void geis_touch_delete(GeisTouch touch);
 
73
 
 
74
/**
 
75
 * Inserts touch attr.
 
76
 *
 
77
 * @param[in] touch  The touch.
 
78
 * @param[in] attr   The attr.
 
79
 */
 
80
GeisStatus geis_touch_add_attr(GeisTouch touch, GeisAttr attr);
 
81
 
 
82
/** @} */
 
83
 
 
84
#endif /* GEIS_TOUCH_H_ */