Update doxygen comments
[platform/core/uifw/dali-core.git] / dali / public-api / events / point-state.h
1 #ifndef __DALI_POINT_STATE_H__
2 #define __DALI_POINT_STATE_H__
3
4 /*
5  * Copyright (c) 2016 Samsung Electronics Co., Ltd.
6  *
7  * Licensed under the Apache License, Version 2.0 (the "License");
8  * you may not use this file except in compliance with the License.
9  * You may obtain a copy of the License at
10  *
11  * http://www.apache.org/licenses/LICENSE-2.0
12  *
13  * Unless required by applicable law or agreed to in writing, software
14  * distributed under the License is distributed on an "AS IS" BASIS,
15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16  * See the License for the specific language governing permissions and
17  * limitations under the License.
18  *
19  */
20
21 namespace Dali
22 {
23 /**
24  * @addtogroup dali_core_events
25  * @{
26  */
27
28 /**
29  * @brief Point state
30  * @SINCE_1_1.37
31  */
32 namespace PointState
33 {
34
35 /**
36  * @brief Enumeration for point state type.
37  * @SINCE_1_1.37
38  */
39 enum Type
40 {
41   STARTED,        /**< Touch or hover started */
42   FINISHED,       /**< Touch or hover finished */
43   DOWN = STARTED, /**< Screen touched */
44   UP = FINISHED,  /**< Touch stopped */
45   MOTION,         /**< Finger dragged or hovered */
46   LEAVE,          /**< Leave the boundary of an actor */
47   STATIONARY,     /**< No change from last event. Useful when a multi-point event occurs where
48                        all points are sent but indicates that this particular point has not changed
49                        since the last time */
50   INTERRUPTED,    /**< A system event has occurred which has interrupted the touch or hover event sequence. */
51 };
52 }
53
54 /**
55  * @}
56  */
57 } // namespace Dali
58
59 #endif // __DALI_POINT_H__