[Tizen] Add GetRenderTaskList to SceneHolder

[platform/core/uifw/dali-adaptor.git] / dali / integration-api / adaptor-framework / scene-holder.h

diff --git a/dali/integration-api/adaptor-framework/scene-holder.h b/dali/integration-api/adaptor-framework/scene-holder.h
index abe1634..20c8aba 100644 (file)
--- a/dali/integration-api/adaptor-framework/scene-holder.h
+++ b/dali/integration-api/adaptor-framework/scene-holder.h
@@ -2,7 +2,7 @@
 #define DALI_INTEGRATION_SCENEHOLDER_H
 
 /*
- * Copyright (c) 2020 Samsung Electronics Co., Ltd.
+ * Copyright (c) 2023 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.
@@ -33,6 +33,7 @@ class TouchEvent;
 class WheelEvent;
 struct TouchPoint;
 class KeyEvent;
+class RenderTaskList;
 
 namespace Internal DALI_INTERNAL
 {
@@ -60,6 +61,8 @@ public:
 
   typedef Signal<void(const Dali::WheelEvent&)> WheelEventSignalType; ///< Touched signal type
 
+  typedef Signal<bool(const Dali::WheelEvent&)> WheelEventGeneratedSignalType; ///< Wheel event generated signal type
+
   /**
    * @brief Create an uninitialized SceneHolder handle.
    */
@@ -156,6 +159,12 @@ public:
   void FeedKeyEvent(Dali::KeyEvent& keyEvent);
 
   /**
+   * @brief Retrieves the list of render-tasks.
+   * @return A valid handle to a RenderTaskList
+   */
+  RenderTaskList GetRenderTaskList();
+
+  /**
    * @brief Retrieve the SceneHolder that the given actor is added to.
    *
    * @param[in] actor The actor
@@ -186,6 +195,19 @@ public:
   KeyEventGeneratedSignalType& KeyEventGeneratedSignal();
 
   /**
+   * @brief This signal is emitted when key event is received.
+   * Intercepts KeyEvents in the window before dispatching KeyEvents to the control.
+   * If a KeyEvent is consumed, no KeyEvent is delivered to the control.
+   *
+   * A callback of the following type may be connected:
+   * @code
+   *   bool YourCallbackName(const KeyEvent& event);
+   * @endcode
+   * @return The signal to connect to
+   */
+  KeyEventGeneratedSignalType& InterceptKeyEventSignal();
+
+  /**
    * @brief This signal is emitted when the screen is touched and when the touch ends
    * (i.e. the down & up touch events only).
    *
@@ -212,6 +234,21 @@ public:
    */
   WheelEventSignalType& WheelEventSignal();
 
+  /**
+   * @brief This signal is emitted to KeyboardFocusManager when a custom wheel type event is received.
+   * When a custom wheel event occurs, it need to process the focused actor first.
+   *
+   * Therefore, KeyboardFocusManager first checks whether WheelEvent is generated as WheelEventGeneratedSignal.
+   * This is only valid for custom wheel events.
+   *
+   * A callback of the following type may be connected:
+   * @code
+   *   bool YourCallbackName(const WheelEvent& event);
+   * @endcode
+   * @return The signal to connect to
+   */
+  WheelEventGeneratedSignalType& WheelEventGeneratedSignal();
+
 public: // Not intended for application developers
   /**
    * @brief This constructor is used internally to create additional SceneHolder handles.