Remove warning message and Update doxygen
[framework/osp/web.git] / src / controls / FWebCtrl_Web.h
1 //
2 // Open Service Platform
3 // Copyright (c) 2012 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  * @file                FWebCtrl_Web.h
20  * @brief               The file contains the declaration of _Web class.
21  *
22  * The file contains the declaration of _Web class.
23  */
24 #ifndef _FWEB_CTRL_INTERNAL_WEB_H_
25 #define _FWEB_CTRL_INTERNAL_WEB_H_
26
27 #include <unique_ptr.h>
28 #include <EWebKit2.h>
29 #include <FBaseColIListT.h>
30 #include <FUi_Control.h>
31 #include <FUi_ITouchFlickGestureEventListener.h>
32 #include <FUi_ITouchLongPressGestureEventListener.h>
33 #include <FUi_ITouchPinchGestureEventListener.h>
34 #include <FUi_ITouchTapGestureEventListener.h>
35
36 namespace Tizen { namespace Ui
37 {
38 class _AccessibilityElement;
39 class _TouchInfo;
40 }} // Tizen::Ui
41
42 namespace Tizen { namespace Ui { namespace Animations
43 {
44 class VisualElement;
45 }}} // Tizen::Ui::Animations
46
47 namespace Tizen { namespace Graphics
48 {
49 class Canvas;
50 class Dimension;
51 class Point;
52 class FloatRectangle;
53 }} // Tizen::Graphics
54
55 namespace Tizen { namespace Web { namespace Controls
56 {
57 class _EflWebkit;
58 class _WebSettingImpl;
59 class _TapGestureState;
60 class _PanningGestureState;
61 class _FlickGestureState;
62 class _PinchGestureState;
63 class WebSetting;
64
65 enum _WebGestureType
66 {
67         WEB_GESTURE_TYPE_TAP,
68         WEB_GESTURE_TYPE_PANNING,
69         WEB_GESTURE_TYPE_FLICK,
70         WEB_GESTURE_TYPE_PINCH
71 };
72
73 class _Web
74         : public Tizen::Ui::_Control
75         , Tizen::Ui::_ITouchFlickGestureEventListener
76         , Tizen::Ui::_ITouchLongPressGestureEventListener
77         , Tizen::Ui::_ITouchPinchGestureEventListener
78         , Tizen::Ui::_ITouchTapGestureEventListener
79         , virtual public Tizen::Base::Runtime::IEventListener
80         , virtual public Tizen::Ui::_IUiEventListener
81         , virtual public Tizen::Ui::_IUiEventPreviewer
82         , virtual public Tizen::Ui::_ITouchGestureEventListener
83 {
84 public:
85         _Web(void);
86
87         virtual ~_Web(void);
88
89         static _Web* CreateWebN(void);
90
91         result InitializeWebNativeNode(void);
92
93         Evas_Object* GetWebNativeNode(void);
94
95         void ChangeGesture(_WebGestureType type);
96
97         Tizen::Graphics::Point GetAbsoluteCoordinate(Tizen::Graphics::Point relativePoint);
98         Tizen::Graphics::FloatPoint GetAbsoluteCoordinate(Tizen::Graphics::FloatPoint relativePoint);
99
100         Tizen::Graphics::Point GetRelativeCoordinate(Tizen::Graphics::Point absolutePoint);
101         Tizen::Graphics::FloatPoint GetRelativeCoordinate(Tizen::Graphics::FloatPoint absolutePoint);
102
103         WebSetting* GetSetting(void) const;
104
105         virtual result OnAttaching(const _Control* pParent);
106         virtual result OnBoundsChanging(const Tizen::Graphics::Rectangle& bounds);
107
108         virtual bool OnTouchPressed(const Tizen::Ui::_Control& source, const Tizen::Ui::_TouchInfo& touchInfo);
109         virtual bool OnTouchReleased(const Tizen::Ui::_Control& source, const Tizen::Ui::_TouchInfo& touchInfo);
110         virtual bool OnTouchMoved(const Tizen::Ui::_Control& source, const Tizen::Ui::_TouchInfo& touchInfo);
111         virtual bool OnTouchCanceled(const Tizen::Ui::_Control& source, const Tizen::Ui::_TouchInfo& touchInfo);
112
113         virtual void OnTouchPressHandled(const Tizen::Ui::_Control& control);
114         virtual void OnTouchReleaseHandled(const Tizen::Ui::_Control& control);
115         virtual void OnTouchMoveHandled(const Tizen::Ui::_Control& control);
116         virtual void OnTouchCancelHandled(const Tizen::Ui::_Control& control);
117
118         virtual bool OnPinchGestureStarted(Tizen::Ui::_TouchPinchGestureDetector& gesture);
119         virtual bool OnPinchGestureChanged(Tizen::Ui::_TouchPinchGestureDetector& gesture);
120         virtual bool OnPinchGestureFinished(Tizen::Ui::_TouchPinchGestureDetector& gesture);
121         virtual bool OnPinchGestureCanceled(Tizen::Ui::_TouchPinchGestureDetector& gesture);
122
123         virtual bool OnFlickGestureDetected(Tizen::Ui::_TouchFlickGestureDetector& gesture);
124         virtual bool OnFlickGestureCanceled(Tizen::Ui::_TouchFlickGestureDetector& gesture);
125
126         virtual bool OnLongPressGestureDetected(Tizen::Ui::_TouchLongPressGestureDetector& gesture);
127         virtual bool OnLongPressGestureCanceled(Tizen::Ui::_TouchLongPressGestureDetector& gesture);
128
129         virtual bool OnTapGestureDetected(Tizen::Ui::_TouchTapGestureDetector& gesture);
130         virtual bool OnTapGestureCanceled(Tizen::Ui::_TouchTapGestureDetector& gesture);
131
132         virtual Tizen::Graphics::Canvas* OnCanvasRequestedFN(const Tizen::Graphics::FloatRectangle& size);
133         virtual Tizen::Graphics::Bitmap* OnCapturedBitmapRequestedN(void);
134
135 private:
136         _Web(const _Web& value);
137
138         _Web& operator =(const _Web& value);
139
140         result CreateWebkitEvasObject(void);
141
142         result InitializeGestureStates(void);
143         result AddGestureListeners(void);
144         void RemoveGestureListener(void);
145
146         void SendTouchEventForJavaScript(const Tizen::Ui::_TouchInfo& touchInfo);
147         void SendTouchEventForJavaScriptWithTouchInfo(const Tizen::Ui::_TouchInfo& touchInfo);
148
149         Ewk_Touch_Event_Type GetEwkTouchEvent(Tizen::Ui::_TouchStatus touchStatus);
150         Evas_Touch_Point_State GetEvasTouchState(Tizen::Ui::TouchStatus touchStatus);
151
152         void DumpPointList(void* pData);
153
154 private:
155         Tizen::Ui::_ITouchEventListener* __pGestureHandler;
156
157         std::unique_ptr<_EflWebkit> __pEflWebkit;
158
159         std::unique_ptr<WebSetting> __pWebSetting;
160
161         std::unique_ptr<Tizen::Ui::_TouchFlickGestureDetector> __pGestureFlick;
162
163         std::unique_ptr<Tizen::Ui::_TouchLongPressGestureDetector> __pGestureLongPress;
164
165         std::unique_ptr<Tizen::Ui::_TouchPinchGestureDetector> __pGesturePinch;
166
167         std::unique_ptr<Tizen::Ui::_TouchTapGestureDetector> __pGestureDoubleTap;
168
169         std::unique_ptr<Tizen::Base::Collection::IListT<Tizen::Ui::_TouchInfo*> > __pTouchEventInfoList;
170
171         std::unique_ptr<_TapGestureState> __pTapGestureHandler;
172
173         std::unique_ptr<_PanningGestureState> __pPanningGestureHandler;
174
175         std::unique_ptr<_FlickGestureState> __pFlickGestureHandler;
176
177         std::unique_ptr<_PinchGestureState> __pPinchGestureHandler;
178
179         _WebGestureType __gestureType;
180
181         Tizen::Ui::_AccessibilityElement* __pTextElement;
182 }; // _Web
183
184 }}} // Tizen::Web::Controls
185 #endif // _FWEB_CTRL_INTERNAL_WEB_H_