1 #ifndef DALI_INTERNAL_EVENT_HANDLER_H
2 #define DALI_INTERNAL_EVENT_HANDLER_H
5 * Copyright (c) 2021 Samsung Electronics Co., Ltd.
7 * Licensed under the Apache License, Version 2.0 (the "License");
8 * you may not use this file except in compliance with the License.
9 * You may obtain a copy of the License at
11 * http://www.apache.org/licenses/LICENSE-2.0
13 * Unless required by applicable law or agreed to in writing, software
14 * distributed under the License is distributed on an "AS IS" BASIS,
15 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 * See the License for the specific language governing permissions and
17 * limitations under the License.
22 #include <dali/public-api/common/intrusive-ptr.h>
23 #include <cstdint> // uint32_t
25 #include <dali/devel-api/adaptor-framework/clipboard.h>
26 #include <dali/devel-api/adaptor-framework/style-monitor.h>
29 #include <dali/internal/clipboard/common/clipboard-event-notifier-impl.h>
30 #include <dali/internal/window-system/common/damage-observer.h>
31 #include <dali/internal/window-system/common/window-base.h>
41 } // namespace Integration
48 class WindowRenderSurface;
51 * The Event Handler class is responsible for setting up receiving of Ecore events and then converts them
52 * to TouchEvents when it does receive them.
54 * These TouchEvents are then passed on to Core.
56 class EventHandler : public ConnectionTracker, public Dali::RefObject
60 * The observer can be overridden in order to listen to the events.
66 * Deriving classes should override this to be notified when we receive a touch point event.
67 * @param[in] point The touch point
68 * @param[in] timeStamp The time stamp
70 virtual void OnTouchPoint(Dali::Integration::Point& point, int timeStamp) = 0;
73 * Deriving classes should override this to be notified when we receive a wheel event.
74 * @param[in] wheelEvent The wheel event
76 virtual void OnWheelEvent(Dali::Integration::WheelEvent& wheelEvent) = 0;
79 * Deriving classes should override this to be notified when we receive a key event.
80 * @param[in] keyEvent The key event holding the key information.
82 virtual void OnKeyEvent(Dali::Integration::KeyEvent& keyEvent) = 0;
85 * Deriving classes should override this to be notified when the window is rotated.
86 * @param[in] rotation The rotation event.
88 virtual void OnRotation(const RotationEvent& rotation) = 0;
92 * Protected Constructor.
99 * Protected virtual destructor.
109 * @param[in] windowBase The window base to be handled
110 * @param[in] damageObserver The damage observer (to pass damage events to).
112 EventHandler(WindowBase* windowBase, DamageObserver& damageObserver);
117 ~EventHandler() override;
120 * Called when the adaptor is paused.
125 * Called when the adaptor is resumed (from pause).
130 * Adds an observer so that we can observe the events.
131 * @param[in] observer The observer.
133 void AddObserver(Observer& observer);
136 * Removes the observer from the EventHandler.
137 * @param[in] observer The observer to remove.
138 * @note Observers should remove themselves when they are destroyed.
140 void RemoveObserver(Observer& observer);
144 * Send a style change event to the style monitor.
145 * @param[in] styleChange The style that has changed.
147 void SendEvent(StyleChange::Type styleChange);
150 * Send a window damage event to the observer.
151 * @param[in] area Damaged area.
153 void SendEvent(const DamageArea& area);
156 * Called when a touch event is received.
158 void OnTouchEvent(Integration::Point& point, uint32_t timeStamp);
161 * Called when a mouse wheel is received.
163 void OnWheelEvent(Integration::WheelEvent& wheelEvent);
166 * Called when a key event is received.
168 void OnKeyEvent(Integration::KeyEvent& keyEvent);
171 * Called when the window focus is changed.
173 void OnFocusChanged(bool focusIn);
176 * Called when the window is rotated.
177 * @param[in] event The rotation event
179 void OnRotation(const RotationEvent& event);
182 * Called when the window is damaged.
184 void OnWindowDamaged(const DamageArea& area);
187 * Called when the source window notifies us the content in clipboard is selected.
189 void OnSelectionDataSend(void* event);
192 * Called when the source window sends us about the selected content.
194 void OnSelectionDataReceived(void* event);
197 * Called when the style is changed.
199 void OnStyleChanged(StyleChange::Type styleChange);
203 EventHandler(const EventHandler& eventHandler);
206 EventHandler& operator=(const EventHandler& eventHandler);
209 Dali::StyleMonitor mStyleMonitor; ///< Handle to the style monitor, set on construction, to send font size and font change events to.
210 DamageObserver& mDamageObserver; ///< Reference to the DamageObserver, set on construction, to sent damage events to.
212 Dali::ClipboardEventNotifier mClipboardEventNotifier; ///< Pointer to the clipboard event notifier
213 Dali::Clipboard mClipboard; ///< Pointer to the clipboard
215 using ObserverContainer = std::vector<Observer*>;
216 ObserverContainer mObservers; ///< A list of event observer pointers
218 bool mPaused; ///< The paused state of the adaptor.
221 } // namespace Adaptor
223 } // namespace Internal
227 #endif // DALI_INTERNAL_EVENT_HANDLER_H