[Tizen] Add screen and client rotation itself function
[platform/core/uifw/dali-core.git] / dali / integration-api / scene.h
index 4e44caf..0d8d044 100755 (executable)
@@ -21,6 +21,7 @@
 // INTERNAL INCLUDES
 #include <dali/public-api/object/handle.h>
 #include <dali/public-api/math/vector2.h>
+#include <dali/public-api/math/vector4.h>
 
 namespace Dali
 {
@@ -61,11 +62,11 @@ public:
   /**
    * @brief Create an initialized Scene handle.
    *
-   * @param[in] size The size of the scene in pixels as a Vector
+   * @param[in] surface Binds this rendering surface to this scene
    *
    * @return a handle to a newly allocated Dali resource.
    */
-  static Scene New( const Size& size );
+  static Scene New( Integration::RenderSurface& surface );
 
   /**
    * @brief Downcast an Object handle to Scene handle.
@@ -150,6 +151,20 @@ public:
   Vector2 GetDpi() const;
 
   /**
+   * @brief Sets the background color.
+   *
+   * @param[in] color The new background color
+   */
+  void SetBackgroundColor( const Vector4& color );
+
+  /**
+   * @brief Gets the background color of the render surface.
+   *
+   * @return The background color
+   */
+  Vector4 GetBackgroundColor() const;
+
+  /**
    * @brief Retrieves the list of render-tasks.
    *
    * @return A valid handle to a RenderTaskList
@@ -188,6 +203,11 @@ public:
   void SetSurface( Integration::RenderSurface& surface );
 
   /**
+   * @brief Informs the scene that the set surface has been resized.
+   */
+  void SurfaceResized( bool forceUpdate );
+
+  /**
    * @brief Gets the rendering surface bound to the scene
    *
    * @return The render surface
@@ -195,6 +215,11 @@ public:
   Integration::RenderSurface* GetSurface() const;
 
   /**
+   * @brief Discards this Scene from the Core.
+   */
+  void Discard();
+
+  /**
    * @brief Retrieve the Scene that the given actor belongs to.
    * @return The Scene.
    */
@@ -232,6 +257,15 @@ public:
   /**
    * @brief The user would connect to this signal to get a KeyEvent when KeyEvent is generated.
    *
+   * If the control already consumed key event, KeyEventProcessor do not need to Emit keyEvent.
+   * Therefore, KeyinputManager first checks whether KeyEvent is generated as KeyEventGeneratedSignal.
+   * After that keyEventProcessor must invoke KeyEvent only if KeyEventGeneratedSignal () is not consumed.
+   *
+   * A callback of the following type may be connected:
+   * @code
+   *   bool YourCallbackName(const KeyEvent& event);
+   * @endcode
+   *
    * @return The return is true if KeyEvent is consumed, otherwise false.
    */
   KeyEventGeneratedSignalType& KeyEventGeneratedSignal();