← Back to branch summary

~ubuntu-branches/ubuntu/trusty/geis/trusty

« back to all changes in this revision

Viewing changes to libgeis/geis_group.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_group.h
 
1
/**
 
2
 * @file geis_group.h
 
3
 * @brief Geis gesture group 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_GROUP_H_
 
22
#define GEIS_GROUP_H_
 
23
 
 
24
#include "geis/geis.h"
 
25
#include "geis_frame.h"
 
26
 
 
27
/**
 
28
 * @defgroup geis_groupset A Gesture Group Container
 
29
 * @{
 
30
 */
 
31
 
 
32
/**
 
33
 * Creates a new, empty group set.
 
34
 */
 
35
GeisGroupSet geis_groupset_new();
 
36
 
 
37
/**
 
38
 * Destroys a group set and all groups contained in it.
 
39
 *
 
40
 * @param[in] groupset  The group set to destroy.
 
41
 */
 
42
void geis_groupset_delete(GeisGroupSet groupset);
 
43
 
 
44
/**
 
45
 * Inserts a gesture group into a group set.
 
46
 *
 
47
 * @param[in] groupset  A group set.
 
48
 * @param[in] group     A gesture group.
 
49
 *
 
50
 * The set takes ownership of the gesture group.
 
51
 */
 
52
GeisStatus geis_groupset_insert(GeisGroupSet groupset, GeisGroup group);
 
53
 
 
54
/** @} */
 
55
 
 
56
/**
 
57
 * @defgroup geis_group A Gesture Group
 
58
 * @{
 
59
 */
 
60
 
 
61
/**
 
62
 * Creates a new gesture group.
 
63
 *
 
64
 * @param[in] id  Identifier for the new group.
 
65
 */
 
66
GeisGroup geis_group_new(GeisInteger id);
 
67
 
 
68
/**
 
69
 * Destroys a gesture group and all gesture frames contained in it.
 
70
 *
 
71
 * @param[in] group  The gesture group to destroy.
 
72
 */
 
73
void geis_group_delete(GeisGroup group);
 
74
 
 
75
/**
 
76
 * Adds a gesture frame to a gesture group.
 
77
 *
 
78
 * @param[in] group  A gesture group.
 
79
 * @param[in] frame  A gesture frame.
 
80
 *
 
81
 * The group takes ownership of the frame object.
 
82
 */
 
83
GeisStatus geis_group_insert_frame(GeisGroup group, GeisFrame frame);
 
84
 
 
85
/** @} */
 
86
 
 
87
#endif /* GEIS_GROUP_H_ */