src/ui/inc/FUi_FingerInfo.h

   1 //
   2 // Open Service Platform
   3 // Copyright (c) 2012-2013 Samsung Electronics Co., Ltd.
   4 //
   5 // Licensed under the Flora License, Version 1.0 (the License);
   6 // you may not use this file except in compliance with the License.
   7 // You may obtain a copy of the License at
   8 //
   9 //     http://floralicense.org/license/
  10 //
  11 // Unless required by applicable law or agreed to in writing, software
  12 // distributed under the License is distributed on an AS IS BASIS,
  13 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14 // See the License for the specific language governing permissions and
  15 // limitations under the License.
  16 //
  17 /**
  18  * @file                        FUi_FingerInfo.h
  19  * @brief               This is the header file for the _FingerInfo class.
  20  *
  21  * This header file contains the declarations of the _FingerInfo class. @n
  22  */
  23
  24 #ifndef _FUI_INTERNAL_FINGER_INFO_H
  25 #define _FUI_INTERNAL_FINGER_INFO_H
  26
  27 #include <FGrpPoint.h>
  28 #include "FUi_UiTouchEvent.h"
  29
  30 namespace Tizen { namespace Ui
  31 {
  32 const unsigned int INVALID_POINT_ID = 999;
  33 const unsigned int SINGLE_POINT_ID = 0;
  34
  35 class _OSP_EXPORT_ _FingerInfo
  36 {
  37 public:
  38         /**
  39         * This is the default class constructor.
  40         *
  41         */
  42         _FingerInfo(void);
  43
  44         /**
  45          * This is the default class destructor.
  46          *
  47          */
  48         ~_FingerInfo(void);
  49
  50 public:
  51         /**
  52          * This method sets device Id
  53          *
  54          * @since 2.0
  55          */
  56         void SetDeviceId(unsigned long deviceId);
  57
  58         /**
  59          * This method sets point Id
  60          *
  61          * @since 2.0
  62          */
  63         void SetPointId(unsigned long pointId);
  64
  65         /**
  66          * This method sets current point
  67          *
  68          * @since 2.0
  69          */
  70         void SetPoint(const Tizen::Graphics::Point& screenPoint, const Tizen::Graphics::Point& point);
  71
  72         /**
  73          * This method sets current status
  74          *
  75          * @since 2.0
  76          */
  77         void SetStatus(const _TouchStatus status);
  78
  79         /**
  80          * This method sets start point
  81          *
  82          * @since 2.0
  83          */
  84         void SetStartPoint(const Tizen::Graphics::Point& point);
  85
  86         /**
  87          * This method sets touch move allowance flag
  88          * this flag is used to check move allowance
  89          *
  90          * @since 2.0
  91          */
  92         void    SetMoveReady(bool moveReady);
  93
  94         /**
  95          * This method returns deviceId
  96          *
  97          * @since 2.0
  98          * @return              The deviceId
  99          */
 100         unsigned long GetDeviceId(void) const;
 101
 102         /**
 103          * This method returns converted pointId
 104          *
 105          * @since 2.0
 106          * @return      The touch pointId
 107          */
 108         unsigned long GetPointId(void) const;
 109
 110         /**
 111          * This method returns touch point
 112          *
 113          * @since 2.0
 114          * @return      The touch point
 115          */
 116         Tizen::Graphics::Point GetPoint(void) const;
 117
 118         /**
 119          * This method returns touch point
 120          *
 121          * @since 2.0
 122          * @return      The touch point
 123          */
 124         Tizen::Graphics::Point GetScreenPoint(void) const;
 125
 126         /**
 127          * This method returns current touch status
 128          *
 129          * @since 2.0
 130          * @return      The touch status
 131          */
 132         _TouchStatus GetStatus(void) const;
 133
 134         /**
 135          * This method returns touch start point
 136          *
 137          * @since 2.0
 138          * @return      The touch start point
 139          */
 140         Tizen::Graphics::Point GetStartPoint(void) const;
 141
 142         /**
 143          * This method returns touch move allowance
 144          *
 145          * @since 2.0
 146          * @return      The touch move allowance
 147          */
 148         bool GetMoveReady(void) const;
 149
 150 private:
 151         unsigned long __deviceId;
 152         unsigned long __pointId;
 153         _TouchStatus __status;
 154         Tizen::Graphics::Point __point;
 155         Tizen::Graphics::Point __startPoint;
 156         Tizen::Graphics::Point __screenPoint;
 157         bool __touchMoveReady;
 158 }; // _FingerInfo
 159 } } // Tizen::Ui
 160
 161 #endif // _FUI_INTERNAL_FINGER_INFO_H