Add property SHADOW to Control

[platform/core/uifw/dali-toolkit.git] / dali-toolkit / devel-api / controls / control-devel.h

diff --git a/dali-toolkit/devel-api/controls/control-devel.h b/dali-toolkit/devel-api/controls/control-devel.h
index c56f7ce..04e8205 100755 (executable)
--- a/dali-toolkit/devel-api/controls/control-devel.h
+++ b/dali-toolkit/devel-api/controls/control-devel.h
@@ -2,7 +2,7 @@
 #define DALI_TOOLKIT_CONTROL_DEVEL_H
 
 /*
- * Copyright (c) 2018 Samsung Electronics Co., Ltd.
+ * Copyright (c) 2019 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.
@@ -52,13 +52,13 @@ namespace Property
 
 enum
 {
-  STYLE_NAME        = Control::Property::STYLE_NAME,
-  BACKGROUND_COLOR  = Control::Property::BACKGROUND_COLOR,
-  BACKGROUND_IMAGE  = Control::Property::BACKGROUND_IMAGE,
-  KEY_INPUT_FOCUS   = Control::Property::KEY_INPUT_FOCUS,
-  BACKGROUND        = Control::Property::BACKGROUND,
-  MARGIN            = Control::Property::MARGIN,
-  PADDING           = Control::Property::PADDING,
+  STYLE_NAME            = Control::Property::STYLE_NAME,
+  RESERVED_PROPERTY_01  = Control::Property::RESERVED_PROPERTY_01,
+  RESERVED_PROPERTY_02  = Control::Property::RESERVED_PROPERTY_02,
+  KEY_INPUT_FOCUS       = Control::Property::KEY_INPUT_FOCUS,
+  BACKGROUND            = Control::Property::BACKGROUND,
+  MARGIN                = Control::Property::MARGIN,
+  PADDING               = Control::Property::PADDING,
 
   /**
    * @brief Displays a tooltip when the control is hovered over.
@@ -115,7 +115,13 @@ enum
    * @details Name "downFocusableActorId", type Property::INTEGER.
    *
    */
-  DOWN_FOCUSABLE_ACTOR_ID = PADDING + 7
+  DOWN_FOCUSABLE_ACTOR_ID = PADDING + 7,
+
+  /**
+   * @brief The shadow of the control.
+   * @details Name "shadow", type Property::MAP.
+   */
+  SHADOW = PADDING + 8
 };
 
 } // namespace Property
@@ -216,6 +222,23 @@ DALI_TOOLKIT_API void EnableVisual( Internal::Control& control, Dali::Property::
  */
 DALI_TOOLKIT_API bool IsVisualEnabled( const Internal::Control& control, Dali::Property::Index index );
 
+
+/**
+ * @brief Add a transition effect on the control to the given animation
+ *
+ * Only generates an animator if the properties described in the transition
+ * data are staged (e.g. the visual is Enabled and the control is on stage).
+ * Otherwise the target values are stored, and will get set onto the properties
+ * when the visual is next staged.
+ *
+ * @param[in] control The control
+ * @param[in] animation The Animation to add valid transitions to
+ * @param[in] transitionData The transition data describing the effect to create
+ */
+DALI_TOOLKIT_API void AddTransitions( Internal::Control& control,
+                                      Dali::Animation animation,
+                                      const Toolkit::TransitionData& transitionData );
+
 /**
  * @brief Create a transition effect on the control.
  *
@@ -229,7 +252,8 @@ DALI_TOOLKIT_API bool IsVisualEnabled( const Internal::Control& control, Dali::P
  * @return A handle to an animation defined with the given effect, or an empty
  * handle if no properties match.
  */
-DALI_TOOLKIT_API Dali::Animation CreateTransition( Internal::Control& control, const Toolkit::TransitionData& transitionData );
+DALI_TOOLKIT_API Dali::Animation CreateTransition( Internal::Control& control,
+                                                   const Toolkit::TransitionData& transitionData );
 
 /**
  * @brief Perform an action on a visual registered to this control.
@@ -251,6 +275,22 @@ DALI_TOOLKIT_API void DoAction( Control& control, Dali::Property::Index visualIn
  */
 DALI_TOOLKIT_API void SetInputMethodContext( Internal::Control& control, InputMethodContext& inputMethodContext );
 
+/**
+ * @brief Visual Event signal type
+ */
+using VisualEventSignalType = Signal< void ( Control, Dali::Property::Index, Dali::Property::Index ) >;
+
+/**
+ * @brief This signal is emitted when a visual has an event to notify.
+ *
+ * A callback of the following type may be connected:
+ * @code
+ *   void YourCallbackName( Control control, Dali::Property::Index visualIndex, Dali::Property::Index signalId );
+ * @endcode
+ * @return The signal to connect to
+ */
+DALI_TOOLKIT_API VisualEventSignalType& VisualEventSignal( Control control );
+
 } // namespace DevelControl
 
 } // namespace Toolkit