Layout removal support
[platform/core/uifw/dali-toolkit.git] / dali-toolkit / devel-api / controls / control-devel.h
index 4f7a9aa..52a0d4a 100755 (executable)
@@ -23,7 +23,7 @@
 // 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-base.h>
+#include <dali-toolkit/devel-api/layouting/layout-item.h>
 
 namespace Dali
 {
@@ -275,30 +275,55 @@ DALI_TOOLKIT_API void SetInputMethodContext( Internal::Control& control, InputMe
  *
  * @return A handle to the layout, or empty.
  */
-DALI_TOOLKIT_API Toolkit::LayoutBase GetLayout( Internal::Control& control );
+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::LayoutBase GetLayout( Control control );
+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::LayoutBase layout );
+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.
  */
-DALI_TOOLKIT_API void SetLayout( Control control, Toolkit::LayoutBase layout );
+DALI_TOOLKIT_API void SetLayout( Control control, Toolkit::LayoutItem layout );
+
+/**
+ * @brief Request the control layout.
+ *
+ * @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
+ */
+DALI_TOOLKIT_API bool IsLayoutingRequired( Control control );
 
 } // namespace DevelControl