src/ui/effects/FUiEffectsEffectTouchInfo.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        FUiEffectsEffectTouchInfo.h
  19  * @brief       This is the header file for the EffectTouchInfo class
  20  */
  21 #ifndef _FUI_EFFECTS_EFFECTTOUCHINFO_H_
  22 #define _FUI_EFFECTS_EFFECTTOUCHINFO_H_
  23
  24 #include <FBaseObject.h>
  25
  26 namespace Tizen { namespace Graphics {
  27         class Point;
  28 } } // Tizen::Graphics
  29
  30 namespace Tizen { namespace Ui { namespace Effects
  31 {
  32
  33 /**
  34 * @class        EffectTouchInfo
  35 * @brief        This class is used for construction touch event extended info
  36 *
  37 * @since 2.0
  38 *
  39 */
  40 class EffectTouchInfo
  41 {
  42 public:
  43         /**
  44         * Constructor
  45         *
  46         * @since 2.0
  47         *
  48         */
  49         EffectTouchInfo(void);
  50
  51         /**
  52         * Constructor
  53         *
  54         * @since 2.0
  55         *
  56         */
  57         EffectTouchInfo(Tizen::Graphics::Point currentPosition,
  58                                         Tizen::Graphics::Point startPosition,
  59                                         unsigned long touchId);
  60
  61         /**
  62         * Destructor
  63         *
  64         * @since 2.0
  65         *
  66         */
  67         virtual ~EffectTouchInfo(void);
  68
  69         /**
  70         * Sets current position of touch
  71         *
  72         * @since 2.0
  73         *
  74         */
  75         void SetCurrentPosition(const Tizen::Graphics::Point& currentPosition);
  76
  77         /**
  78         * Sets start position of touch
  79         *
  80         * @since 2.0
  81         *
  82         */
  83         void SetStartPosition(const Tizen::Graphics::Point& startPosition);
  84
  85         /**
  86         * Gets current position of touch
  87         *
  88         * @since 2.0
  89         *
  90         */
  91         Tizen::Graphics::Point GetCurrentPosition(void) const;
  92
  93         /**
  94         * Returns start position of touch
  95         *
  96         * @since 2.0
  97         *
  98         */
  99         Tizen::Graphics::Point GetStartPosition(void) const;
 100
 101         /**
 102         * Sets touch id
 103         *
 104         * @since 2.0
 105         *
 106         */
 107         void SetTouchId(unsigned long touchId);
 108
 109         /**
 110         * Gets touch id
 111         *
 112         * @since 2.0
 113         *
 114         */
 115         unsigned long GetTouchId(void) const;
 116
 117 protected:
 118
 119 private:
 120
 121         /**
 122         * Hidden copy constructor
 123         *
 124         * @since 2.0
 125         *
 126         */
 127         EffectTouchInfo(const EffectTouchInfo &rhs);
 128
 129         /**
 130         * Hidden assignment operator
 131         *
 132         * @since 2.0
 133         *
 134         */
 135         EffectTouchInfo &operator=(const EffectTouchInfo &rhs);
 136
 137
 138 public:
 139
 140 protected:
 141
 142 private:
 143         Tizen::Graphics::Point __currentPosition;               /**< means the current point of some touch event */
 144         Tizen::Graphics::Point __startPosition;                 /**< means the start (first) point of some touch event */
 145         unsigned long __touchId;
 146 };
 147
 148 } } } // Tizen::Ui::Effects
 149
 150 #endif //_FUI_EFFECTS_EFFECTTOUCHINFO_H_