Merge "Changed 'virtual' function override declarations to 'override' in automated...

[platform/core/uifw/dali-adaptor.git] / dali / devel-api / adaptor-framework / window-devel.h

diff --git a/dali/devel-api/adaptor-framework/window-devel.h b/dali/devel-api/adaptor-framework/window-devel.h
old mode 100755 (executable)
new mode 100644 (file)
index 1eb3501..56e6822
--- a/dali/devel-api/adaptor-framework/window-devel.h
+++ b/dali/devel-api/adaptor-framework/window-devel.h
@@ -19,6 +19,7 @@
  */
 
 // EXTERNAL INCLUDES
+#include <memory>
 
 // INTERNAL INCLUDES
 #include <dali/public-api/common/vector-wrapper.h>
@@ -27,7 +28,7 @@
 namespace Dali
 {
 class KeyEvent;
-class TouchData;
+class TouchEvent;
 class WheelEvent;
 class RenderTaskList;
 
@@ -57,7 +58,7 @@ typedef Signal< void () > EventProcessingFinishedSignalType;       ///< Event Pr
 
 typedef Signal< void (const KeyEvent&) > KeyEventSignalType;       ///< Key event signal type
 
-typedef Signal< void (const TouchData&) > TouchSignalType;         ///< Touch signal type
+typedef Signal< void (const TouchEvent&) > TouchEventSignalType;   ///< Touch signal type
 
 typedef Signal< void (const WheelEvent&) > WheelEventSignalType;   ///< Touched signal type
 
@@ -65,6 +66,8 @@ typedef Signal< void ( Window, bool ) > VisibilityChangedSignalType; ///< Visibi
 
 typedef Signal< void (Window, EffectState, EffectType) > TransitionEffectEventSignalType; ///< Effect signal type and state
 
+typedef Signal< void () > KeyboardRepeatSettingsChangedSignalType;  ///< Keyboard repeat settings changed signal type
+
 /**
  * @brief Creates an initialized handle to a new Window.
  *
@@ -99,14 +102,6 @@ DALI_ADAPTOR_API Window New(Any surface, PositionSize windowPosition, const std:
 DALI_ADAPTOR_API void SetPositionSize( Window window, PositionSize positionSize );
 
 /**
- * @brief Retrieves the list of render-tasks in the window.
- *
- * @param[in] window The window instance
- * @return A valid handle to a RenderTaskList
- */
-DALI_ADAPTOR_API Dali::RenderTaskList GetRenderTaskList( Window window );
-
-/**
  * @brief Retrieve the window that the given actor is added to.
  *
  * @param[in] actor The actor
@@ -123,36 +118,6 @@ DALI_ADAPTOR_API Window Get( Actor actor );
 DALI_ADAPTOR_API EventProcessingFinishedSignalType& EventProcessingFinishedSignal( Window window );
 
 /**
- * @brief This signal is emitted when key event is received.
- *
- * A callback of the following type may be connected:
- * @code
- *   void YourCallbackName(const KeyEvent& event);
- * @endcode
- * @param[in] window The window instance
- * @return The signal to connect to
- */
-DALI_ADAPTOR_API KeyEventSignalType& KeyEventSignal( Window window );
-
-/**
- * @brief This signal is emitted when the screen is touched and when the touch ends
- * (i.e. the down & up touch events only).
- *
- * If there are multiple touch points, then this will be emitted when the first touch occurs and
- * then when the last finger is lifted.
- * An interrupted event will also be emitted (if it occurs).
- * A callback of the following type may be connected:
- * @code
- *   void YourCallbackName( TouchData event );
- * @endcode
- *
- * @param[in] window The window instance
- * @return The touch signal to connect to
- * @note Motion events are not emitted.
- */
-DALI_ADAPTOR_API TouchSignalType& TouchSignal( Window window );
-
-/**
  * @brief This signal is emitted when wheel event is received.
  *
  * A callback of the following type may be connected:
@@ -192,6 +157,14 @@ DALI_ADAPTOR_API VisibilityChangedSignalType& VisibilityChangedSignal( Window wi
 DALI_ADAPTOR_API TransitionEffectEventSignalType& TransitionEffectEventSignal( Window window );
 
 /**
+ * @brief This signal is emitted just after the keyboard repeat setting is changed globally.
+ *
+ * @param[in] window The window instance
+ * @return The signal to connect to
+ */
+DALI_ADAPTOR_API KeyboardRepeatSettingsChangedSignalType& KeyboardRepeatSettingsChangedSignal( Window window );
+
+/**
  * @brief Sets parent window of the window.
  *
  * After setting that, these windows do together when raise-up, lower and iconified/deiconified.
@@ -254,14 +227,38 @@ DALI_ADAPTOR_API void SetAvailableOrientations( Window window, const Dali::Vecto
 DALI_ADAPTOR_API int32_t GetNativeId( Window window );
 
 /**
- * @brief Sets damaged areas of the window.
+ * @brief Adds a callback that is called when the frame rendering is done by the graphics driver.
  *
- * This API is for setting static damaged areas of the window for partial update.
+ * @param[in] window The window instance
+ * @param[in] callback The function to call
+ * @param[in] frameId The Id to specify the frame. It will be passed when the callback is called.
+ *
+ * @note A callback of the following type may be used:
+ * @code
+ *   void MyFunction( int frameId );
+ * @endcode
+ * This callback will be deleted once it is called.
+ *
+ * @note Ownership of the callback is passed onto this class.
+ */
+DALI_ADAPTOR_API void AddFrameRenderedCallback( Window window, std::unique_ptr< CallbackBase > callback, int32_t frameId );
+
+/**
+ * @brief Adds a callback that is called when the frame is displayed on the display.
  *
  * @param[in] window The window instance
- * @param[in] areas The damaged areas list to set
+ * @param[in] callback The function to call
+ * @param[in] frameId The Id to specify the frame. It will be passed when the callback is called.
+ *
+ * @note A callback of the following type may be used:
+ * @code
+ *   void MyFunction( int frameId );
+ * @endcode
+ * This callback will be deleted once it is called.
+ *
+ * @note Ownership of the callback is passed onto this class.
  */
-DALI_ADAPTOR_API void SetDamagedAreas(Window window, std::vector<Dali::Rect<int>>& areas);
+DALI_ADAPTOR_API void AddFramePresentedCallback( Window window, std::unique_ptr< CallbackBase > callback, int32_t frameId );
 
 } // namespace DevelWindow