Merge "Add GetBrightness()" into devel/master
[platform/core/uifw/dali-adaptor.git] / dali / internal / window-system / common / event-handler.h
old mode 100755 (executable)
new mode 100644 (file)
index be46842..3158efd
@@ -1,8 +1,8 @@
-#ifndef __DALI_INTERNAL_EVENT_HANDLER_H__
-#define __DALI_INTERNAL_EVENT_HANDLER_H__
+#ifndef DALI_INTERNAL_EVENT_HANDLER_H
+#define DALI_INTERNAL_EVENT_HANDLER_H
 
 /*
- * Copyright (c) 2018 Samsung Electronics Co., Ltd.
+ * Copyright (c) 2021 Samsung Electronics Co., Ltd.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
  */
 
 // EXTERNAL INCLUDES
-#include <dali/integration-api/events/key-event-integ.h>
-#include <dali/integration-api/events/point.h>
-#include <dali/integration-api/events/touch-event-combiner.h>
+#include <dali/public-api/common/intrusive-ptr.h>
+#include <cstdint> // uint32_t
+
+#include <dali/devel-api/adaptor-framework/clipboard.h>
 #include <dali/devel-api/adaptor-framework/style-monitor.h>
 
 // INTERNAL INCLUDES
-#include <dali/internal/window-system/common/damage-observer.h>
-#include <dali/internal/input/common/drag-and-drop-detector-impl.h>
-#include <dali/internal/accessibility/common/accessibility-adaptor-impl.h>
 #include <dali/internal/clipboard/common/clipboard-event-notifier-impl.h>
-#include <dali/internal/window-system/common/rotation-observer.h>
+#include <dali/internal/window-system/common/damage-observer.h>
 #include <dali/internal/window-system/common/window-base.h>
 
 namespace Dali
 {
-
 namespace Integration
 {
+struct Point;
+struct KeyEvent;
+struct WheelEvent;
 
-class RenderSurface;
-
-}
+} // namespace Integration
 
 namespace Internal
 {
-
 namespace Adaptor
 {
-
-class CoreEventInterface;
-class GestureManager;
 class StyleMonitor;
+class WindowRenderSurface;
 
 /**
  * The Event Handler class is responsible for setting up receiving of Ecore events and then converts them
@@ -58,48 +53,68 @@ class StyleMonitor;
  *
  * These TouchEvents are then passed on to Core.
  */
-class EventHandler : public ConnectionTracker
+class EventHandler : public ConnectionTracker, public Dali::RefObject
 {
 public:
+  /**
+   * The observer can be overridden in order to listen to the events.
+   */
+  class Observer
+  {
+  public:
+    /**
+     * Deriving classes should override this to be notified when we receive a touch point event.
+     * @param[in] point The touch point
+     * @param[in] timeStamp The time stamp
+     */
+    virtual void OnTouchPoint(Dali::Integration::Point& point, int timeStamp) = 0;
+
+    /**
+     * Deriving classes should override this to be notified when we receive a wheel event.
+     * @param[in] wheelEvent The wheel event
+     */
+    virtual void OnWheelEvent(Dali::Integration::WheelEvent& wheelEvent) = 0;
+
+    /**
+     * Deriving classes should override this to be notified when we receive a key event.
+     * @param[in] keyEvent The key event holding the key information.
+     */
+    virtual void OnKeyEvent(Dali::Integration::KeyEvent& keyEvent) = 0;
+
+    /**
+     * Deriving classes should override this to be notified when the window is rotated.
+     * @param[in] rotation The rotation event.
+     */
+    virtual void OnRotation(const RotationEvent& rotation) = 0;
+
+  protected:
+    /**
+     * Protected Constructor.
+     */
+    Observer()
+    {
+    }
+
+    /**
+     * Protected virtual destructor.
+     */
+    virtual ~Observer()
+    {
+    }
+  };
 
+public:
   /**
    * Constructor.
-   * @param[in]  surface                  The surface where events will be sent to.
-   * @param[in]  coreEventInterface       Used to send events to Core.
-   * @param[in]  gestureManager           The Gesture Manager.
+   * @param[in]  windowBase               The window base to be handled
    * @param[in]  damageObserver           The damage observer (to pass damage events to).
-   * @param[in]  dndDetector              The Drag & Drop listener (to pass DnD events to).
    */
-  EventHandler( Integration::RenderSurface* surface, CoreEventInterface& coreEventInterface, GestureManager& gestureManager, DamageObserver& damageObserver, DragAndDropDetectorPtr dndDetector );
+  EventHandler(WindowBase* windowBase, DamageObserver& damageObserver);
 
   /**
    * Destructor.
    */
-  ~EventHandler();
-
-  /**
-   * Feed (Send) touch event to core and gesture manager
-   * @param[in] touchEvent  The touch event holding the touch point information.
-   */
-  void FeedTouchPoint( TouchPoint& point, int timeStamp );
-
-  /**
-   * Feed (Send) wheel event to core and gesture manager
-   * @param[in]  wheelEvent The wheel event
-   */
-  void FeedWheelEvent( WheelEvent& wheelEvent );
-
-  /**
-   * Feed (Send) key event to core
-   * @param[in] keyEvent The key event holding the key information.
-   */
-  void FeedKeyEvent( KeyEvent& keyEvent );
-
-  /**
-   * Feed (Send) an event to core
-   * @param[in] event  The event information.
-   */
-  void FeedEvent( Integration::Event& event );
+  ~EventHandler() override;
 
   /**
    * Called when the adaptor is paused.
@@ -112,144 +127,93 @@ public:
   void Resume();
 
   /**
-   * Sets the Drag & Drop detector.
-   * @param[in]  detector  An intrusive pointer to the Drag & Drop listener to set. To unset pass in NULL.
+   * Adds an observer so that we can observe the events.
+   * @param[in] observer The observer.
    */
-  void SetDragAndDropDetector( DragAndDropDetectorPtr detector );
+  void AddObserver(Observer& observer);
 
   /**
-   * Set the rotation observer (note, some adaptors may not have a rotation observer)
-   * @param[in] observer The rotation observer
+   * Removes the observer from the EventHandler.
+   * @param[in] observer The observer to remove.
+   * @note Observers should remove themselves when they are destroyed.
    */
-  void SetRotationObserver( RotationObserver* observer );
+  void RemoveObserver(Observer& observer);
 
 private:
-
-  /**
-   * Send touch event to core.
-   * @param[in]  point      The touch point information.
-   * @param[in]  timeStamp  The time the touch occurred.
-   */
-  void SendEvent(Integration::Point& point, unsigned long timeStamp);
-
-  /**
-   * Send key event to core.
-   * @param[in]  keyEvent The KeyEvent to send.
-   */
-  void SendEvent(Integration::KeyEvent& keyEvent);
-
-  /**
-   * Send wheel event to core.
-   * @param[in]  wheelEvent The wheel event
-   */
-  void SendWheelEvent( WheelEvent& wheelEvent );
-
   /**
    * Send a style change event to the style monitor.
    * @param[in]  styleChange  The style that has changed.
    */
-  void SendEvent( StyleChange::Type styleChange );
+  void SendEvent(StyleChange::Type styleChange);
 
   /**
    * Send a window damage event to the observer.
    * @param[in]  area  Damaged area.
    */
-  void SendEvent( const DamageArea& area );
-
-  /**
-   * Inform rotation observer of rotation prepare event
-   * @param[in] rotation The rotation event
-   */
-  void SendRotationPrepareEvent( const RotationEvent& rotation );
-
-  /**
-   * Inform rotation observer of rotation prepare event
-   */
-  void SendRotationRequestEvent();
-
-  /**
-   * Resets the event handler.
-   * Called when the adaptor is paused or resumed.
-   */
-  void Reset();
+  void SendEvent(const DamageArea& area);
 
   /**
    * Called when a touch event is received.
    */
-  void OnTouchEvent( Integration::Point& point, unsigned long timeStamp );
+  void OnTouchEvent(Integration::Point& point, uint32_t timeStamp);
 
   /**
    * Called when a mouse wheel is received.
    */
-  void OnWheelEvent( WheelEvent& wheelEvent );
+  void OnWheelEvent(Integration::WheelEvent& wheelEvent);
 
   /**
    * Called when a key event is received.
    */
-  void OnKeyEvent( Integration::KeyEvent& keyEvent );
+  void OnKeyEvent(Integration::KeyEvent& keyEvent);
 
   /**
    * Called when the window focus is changed.
    */
-  void OnFocusChanged( bool focusIn );
+  void OnFocusChanged(bool focusIn);
+
+  /**
+   * Called when the window is rotated.
+   * @param[in] event The rotation event
+   */
+  void OnRotation(const RotationEvent& event);
 
   /**
    * Called when the window is damaged.
    */
-  void OnWindowDamaged( const DamageArea& area );
+  void OnWindowDamaged(const DamageArea& area);
 
   /**
    * Called when the source window notifies us the content in clipboard is selected.
    */
-  void OnSelectionDataSend( void* event );
+  void OnSelectionDataSend(void* event);
 
   /**
    * Called when the source window sends us about the selected content.
    */
-  void OnSelectionDataReceived( void* event );
+  void OnSelectionDataReceived(void* event);
 
   /**
    * Called when the style is changed.
    */
-  void OnStyleChanged( StyleChange::Type styleChange );
-
-  /**
-   * Called when Ecore ElDBus accessibility event is received.
-   */
-  void OnAccessibilityNotification( const WindowBase::AccessibilityInfo& info );
+  void OnStyleChanged(StyleChange::Type styleChange);
 
 private:
-
-  /**
-   * Convert touch event position
-   */
-  void ConvertTouchPosition( Integration::Point& point );
-
-private:
-
   // Undefined
-  EventHandler( const EventHandler& eventHandler );
+  EventHandler(const EventHandler& eventHandler);
 
   // Undefined
-  EventHandler& operator=( const EventHandler& eventHandler );
+  EventHandler& operator=(const EventHandler& eventHandler);
 
 private:
+  Dali::StyleMonitor mStyleMonitor;   ///< Handle to the style monitor, set on construction, to send font size and font change events to.
+  DamageObserver&    mDamageObserver; ///< Reference to the DamageObserver, set on construction, to sent damage events to.
 
-  CoreEventInterface& mCoreEventInterface; ///< Used to send events to Core.
-  Dali::Integration::TouchEventCombiner mCombiner; ///< Combines multi-touch events.
-  GestureManager& mGestureManager; ///< Reference to the GestureManager, set on construction, to send touch events to for analysis.
-  Dali::StyleMonitor mStyleMonitor; ///< Handle to the style monitor, set on construction, to send font size and font change events to.
-  DamageObserver& mDamageObserver; ///< Reference to the DamageObserver, set on construction, to sent damage events to.
-  RotationObserver* mRotationObserver; ///< Pointer to rotation observer, if present.
-
-  DragAndDropDetectorPtr mDragAndDropDetector; ///< Pointer to the drag & drop detector, to send Drag & Drop events to.
-  Dali::AccessibilityAdaptor mAccessibilityAdaptor; ///< Pointer to the accessibility adaptor
   Dali::ClipboardEventNotifier mClipboardEventNotifier; ///< Pointer to the clipboard event notifier
-  Dali::Clipboard mClipboard;///< Pointer to the clipboard
+  Dali::Clipboard              mClipboard;              ///< Pointer to the clipboard
 
-  int mRotationAngle;
-  int mWindowWidth;
-  int mWindowHeight;
+  using ObserverContainer = std::vector<Observer*>;
+  ObserverContainer mObservers; ///< A list of event observer pointers
 
   bool mPaused; ///< The paused state of the adaptor.
 };
@@ -260,4 +224,4 @@ private:
 
 } // namespace Dali
 
-#endif // __DALI_INTERNAL_EVENT_HANDLER_H__
+#endif // DALI_INTERNAL_EVENT_HANDLER_H