inc/FUiTouchInfo.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 /**
  19  * @file        FUiTouchInfo.h
  20  * @brief       This is the header file for the %TouchInfo class.
  21  *
  22  * This header file contains the declarations of the %TouchInfo class.
  23  *
  24  */
  25
  26 #ifndef _FUI_TOUCH_INFO_H_
  27 #define _FUI_TOUCH_INFO_H_
  28
  29 #include <FBaseObject.h>
  30 #include <FUiTouchEventInfo.h>
  31
  32 namespace Tizen { namespace Ui
  33 {
  34
  35 class Control;
  36
  37 /**
  38  * @if OSPDEPREC
  39  * @class       TouchInfo
  40  * @brief       <i> [Deprecated] </i> This class stores the information of a touch event.
  41  *
  42  * @deprecated  This class is deprecated because the use of %TouchInfo is no longer recommended. Instead of using this class, use the Tizen::Ui::TouchEventInfo class.
  43  * @since       2.0
  44  *
  45  * @final        This class is not intended for extension.
  46  *
  47  * The %TouchInfo class provides touch-related information to support multi-point touch.
  48  * @endif
  49  */
  50 class _OSP_EXPORT_ TouchInfo
  51         : public Tizen::Base::Object
  52 {
  53 public:
  54         /**
  55          * @if OSPDEPREC
  56          * This is the default constructor for this class.
  57          *
  58          * @brief <i> [Deprecated]  </i>
  59          * @deprecated This method is deprecated because the %TouchInfo class is not supported any more. Instead, use the Tizen::Ui::TouchEventInfo class.
  60          * @since               2.0
  61          * @endif
  62          */
  63         TouchInfo(void)
  64                 : id(0)
  65                 , position(0, 0)
  66                 , status(TOUCH_PRESSED)
  67         {
  68         }
  69
  70         /**
  71         * @if OSPDEPREC
  72         * The ID of the Touch instance.
  73         *
  74         * @brief <i> [Deprecated]  </i>
  75         * @deprecated   This method is deprecated because the %TouchInfo class is not supported any more. Instead, use the Tizen::Ui::TouchEventManager::GetTouchInfoListN()
  76         *                               and use the Tizen::Ui::TouchEventInfo::GetPointId() method.
  77         * @since        2.0
  78         * @endif
  79         */
  80         unsigned long id;
  81
  82         /**
  83         * @if OSPDEPREC
  84         * The position of the Touch instance.
  85         *
  86         * @brief <i> [Deprecated]  </i>
  87         * @deprecated   This method is deprecated because the %TouchInfo class is not supported any more. Instead, use the Tizen::Ui::TouchEventManager::GetTouchInfoListN()
  88         *                               and use the Tizen::Ui::TouchEventInfo::GetCurrentPosition() method.
  89         * @since        2.0
  90         * @endif
  91         */
  92         Tizen::Graphics::Point position;
  93
  94         /**
  95         * @if OSPDEPREC
  96         * The status of the Touch instance, using only the @c TOUCH_PRESSED and @c TOUCH_RELEASED states.
  97         *
  98         * @brief <i> [Deprecated]  </i>
  99         * @deprecated   This method is deprecated because the %TouchInfo class is not supported any more. Instead, use the Tizen::Ui::TouchEventManager::GetTouchInfoListN()
 100         *                               and use the Tizen::Ui::TouchEventInfo::GetTouchStatus() method.
 101         * @since        2.0
 102         * @endif
 103         */
 104         TouchStatus status;
 105 }; // TouchInfo
 106
 107 } } // Tizen::Ui
 108
 109 #endif // _FUI_TOUCH_INFO_H_