Merge "Add a TextEditor property to limit input to maximum characters" into devel...
[platform/core/uifw/dali-toolkit.git] / dali-toolkit / devel-api / controls / control-devel.h
index 52a0d4a..e749ed1 100755 (executable)
@@ -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.
@@ -23,7 +23,6 @@
 // INTERNAL INCLUDES
 #include <dali-toolkit/public-api/controls/control.h>
 #include <dali-toolkit/devel-api/visual-factory/visual-base.h>
-#include <dali-toolkit/devel-api/layouting/layout-item.h>
 
 namespace Dali
 {
@@ -53,13 +52,11 @@ 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,
+  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.
@@ -116,7 +113,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
@@ -128,7 +131,7 @@ enum
  * @param[in] index The Property index of the visual, used to reference visual
  * @param[in] visual The visual to register
  *
- * @note Derived class should not call visual.SetOnStage(actor). It is the responsibility of the base class to connect/disconnect registered visual to stage.
+ * @note Derived class should not call visual.SetOnScene(actor). It is the responsibility of the base class to connect/disconnect registered visual to stage.
  *       Use below API with enabled set to false if derived class wishes to control when visual is staged.
  * @note If the depth-index is not set on the visual, then it is set to be above the currently registered visuals.
  * @note If replacing a visual, then the depth-index of the visual being replaced is used for the visual.
@@ -143,7 +146,7 @@ DALI_TOOLKIT_API void RegisterVisual( Internal::Control& control, Dali::Property
  * @param[in] visual The visual to register
  * @param[in] depthIndex The visual's depth-index is set to this
  *
- * @note Derived class should not call visual.SetOnStage(actor). It is the responsibility of the base class to connect/disconnect registered visual to stage.
+ * @note Derived class should not call visual.SetOnScene(actor). It is the responsibility of the base class to connect/disconnect registered visual to stage.
  *       Use below API with enabled set to false if derived class wishes to control when visual is staged.
  *
  * @see Visual::Base::GetDepthIndex()
@@ -270,60 +273,21 @@ DALI_TOOLKIT_API void DoAction( Control& control, Dali::Property::Index visualIn
  */
 DALI_TOOLKIT_API void SetInputMethodContext( Internal::Control& control, InputMethodContext& inputMethodContext );
 
-/*
- * @brief Get the layout associated with this control, if any.
- *
- * @return A handle to the layout, or empty.
- */
-DALI_TOOLKIT_API Toolkit::LayoutItem GetLayout( Internal::Control& control );
-
-/*
- * @brief Get the layout associated with a control, if any.
- *
- * @return A handle to the layout, or empty.
- */
-DALI_TOOLKIT_API Toolkit::LayoutItem GetLayout( Control control );
-
 /**
- * @brief Set the layout on this control.
- *
- * @param[in] control The internal Control to set the layout on
- * @param[in] layout Pointer to the layout
- * @note Providing an empty layout will remove the current layout and
- *       replace it with a BinLayout.
- */
-DALI_TOOLKIT_API void SetLayout( Internal::Control& control, Toolkit::LayoutItem layout );
-
-/**
- * @brief Set the layout on a control.
- *
- * @param[in] control The Control to set the layout on
- * @param[in] layout Pointer to the layout
- * @note Providing an empty layout will remove the current layout and
- *       replace it with a BinLayout.
+ * @brief Visual Event signal type
  */
-DALI_TOOLKIT_API void SetLayout( Control control, Toolkit::LayoutItem layout );
+using VisualEventSignalType = Signal< void ( Control, Dali::Property::Index, Dali::Property::Index ) >;
 
 /**
- * @brief Request the control layout.
+ * @brief This signal is emitted when a visual has an event to notify.
  *
- * @param[in] control The internal Control to request the layout of
- */
-DALI_TOOLKIT_API void RequestLayout( Internal::Control& control );
-
-/**
- * @brief Set whether the control should have a layout
- * @param[in] control The Control to set the behaviour on
- * @param[in] layoutingRequired true if the control should have a layout
- */
-DALI_TOOLKIT_API void SetLayoutingRequired( Control control, bool layoutingRequired );
-
-/**
- * @brief Check if the control has been set to require layouting
- * @param[in] control The Control to query
- * @return true if the control needs layouting
+ * 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 bool IsLayoutingRequired( Control control );
+DALI_TOOLKIT_API VisualEventSignalType& VisualEventSignal( Control control );
 
 } // namespace DevelControl