1 #ifndef DALI_INTERNAL_EVENT_HANDLER_H
2 #define DALI_INTERNAL_EVENT_HANDLER_H
5 * Copyright (c) 2019 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 <cstdint> // uint32_t
23 #include <dali/public-api/common/intrusive-ptr.h>
25 #include <dali/devel-api/adaptor-framework/clipboard.h>
26 #include <dali/devel-api/adaptor-framework/style-monitor.h>
29 #include <dali/internal/accessibility/common/accessibility-adaptor-impl.h>
30 #include <dali/internal/clipboard/common/clipboard-event-notifier-impl.h>
31 #include <dali/internal/window-system/common/damage-observer.h>
32 #include <dali/internal/window-system/common/window-base.h>
53 class WindowRenderSurface;
56 * The Event Handler class is responsible for setting up receiving of Ecore events and then converts them
57 * to TouchEvents when it does receive them.
59 * These TouchEvents are then passed on to Core.
61 class EventHandler : public ConnectionTracker, public Dali::RefObject
66 * The observer can be overridden in order to listen to the events.
73 * Deriving classes should override this to be notified when we receive a touch point event.
74 * @param[in] point The touch point
75 * @param[in] timeStamp The time stamp
77 virtual void OnTouchPoint( Dali::Integration::Point& point, int timeStamp ) = 0;
80 * Deriving classes should override this to be notified when we receive a wheel event.
81 * @param[in] wheelEvent The wheel event
83 virtual void OnWheelEvent( Dali::Integration::WheelEvent& wheelEvent ) = 0;
86 * Deriving classes should override this to be notified when we receive a key event.
87 * @param[in] keyEvent The key event holding the key information.
89 virtual void OnKeyEvent( Dali::Integration::KeyEvent& keyEvent ) = 0;
92 * Deriving classes should override this to be notified when the window is rotated.
93 * @param[in] rotation The rotation event.
95 virtual void OnRotation( const RotationEvent& rotation ) = 0;
100 * Protected Constructor.
105 * Protected virtual destructor.
107 virtual ~Observer() {}
114 * @param[in] surface The render surface of the window.
115 * @param[in] damageObserver The damage observer (to pass damage events to).
117 EventHandler( WindowRenderSurface* surface, DamageObserver& damageObserver );
125 * Called when the adaptor is paused.
130 * Called when the adaptor is resumed (from pause).
135 * Adds an observer so that we can observe the events.
136 * @param[in] observer The observer.
138 void AddObserver( Observer& observer );
141 * Removes the observer from the EventHandler.
142 * @param[in] observer The observer to remove.
143 * @note Observers should remove themselves when they are destroyed.
145 void RemoveObserver( Observer& observer );
150 * Send a style change event to the style monitor.
151 * @param[in] styleChange The style that has changed.
153 void SendEvent( StyleChange::Type styleChange );
156 * Send a window damage event to the observer.
157 * @param[in] area Damaged area.
159 void SendEvent( const DamageArea& area );
162 * Called when a touch event is received.
164 void OnTouchEvent( Integration::Point& point, uint32_t timeStamp );
167 * Called when a mouse wheel is received.
169 void OnWheelEvent( WheelEvent& wheelEvent );
172 * Called when a key event is received.
174 void OnKeyEvent( Integration::KeyEvent& keyEvent );
177 * Called when the window focus is changed.
179 void OnFocusChanged( bool focusIn );
182 * Called when the window is rotated.
183 * @param[in] event The rotation event
185 void OnRotation( const RotationEvent& event );
188 * Called when the window is damaged.
190 void OnWindowDamaged( const DamageArea& area );
193 * Called when the source window notifies us the content in clipboard is selected.
195 void OnSelectionDataSend( void* event );
198 * Called when the source window sends us about the selected content.
200 void OnSelectionDataReceived( void* event );
203 * Called when the style is changed.
205 void OnStyleChanged( StyleChange::Type styleChange );
208 * Called when Ecore ElDBus accessibility event is received.
210 void OnAccessibilityNotification( const WindowBase::AccessibilityInfo& info );
215 EventHandler( const EventHandler& eventHandler );
218 EventHandler& operator=( const EventHandler& eventHandler );
222 Dali::StyleMonitor mStyleMonitor; ///< Handle to the style monitor, set on construction, to send font size and font change events to.
223 DamageObserver& mDamageObserver; ///< Reference to the DamageObserver, set on construction, to sent damage events to.
225 Dali::AccessibilityAdaptor mAccessibilityAdaptor; ///< Pointer to the accessibility adaptor
226 Dali::ClipboardEventNotifier mClipboardEventNotifier; ///< Pointer to the clipboard event notifier
227 Dali::Clipboard mClipboard;///< Pointer to the clipboard
229 using ObserverContainer = std::vector<Observer*>;
230 ObserverContainer mObservers; ///< A list of event observer pointers
232 bool mPaused; ///< The paused state of the adaptor.
235 } // namespace Adaptor
237 } // namespace Internal
241 #endif // DALI_INTERNAL_EVENT_HANDLER_H