inc/FUiTouchInfo.h

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