Formatting API
[platform/core/uifw/dali-toolkit.git] / dali-toolkit / devel-api / controls / control-devel.h
old mode 100755 (executable)
new mode 100644 (file)
index e749ed1..da4b730
@@ -2,7 +2,7 @@
 #define DALI_TOOLKIT_CONTROL_DEVEL_H
 
 /*
- * Copyright (c) 2019 Samsung Electronics Co., Ltd.
+ * Copyright (c) 2020 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.
 #include <dali/devel-api/adaptor-framework/input-method-context.h>
 
 // INTERNAL INCLUDES
-#include <dali-toolkit/public-api/controls/control.h>
 #include <dali-toolkit/devel-api/visual-factory/visual-base.h>
+#include <dali-toolkit/public-api/controls/control.h>
 
 namespace Dali
 {
-
 namespace Toolkit
 {
-
 class TransitionData;
 
 namespace Visual
@@ -39,7 +37,6 @@ class Base;
 
 namespace DevelControl
 {
-
 enum State
 {
   NORMAL,
@@ -49,14 +46,13 @@ enum State
 
 namespace Property
 {
-
 enum
 {
-  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,
+  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.
@@ -136,7 +132,7 @@ enum
  * @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.
  */
-DALI_TOOLKIT_API void RegisterVisual( Internal::Control& control, Dali::Property::Index index, Toolkit::Visual::Base& visual );
+DALI_TOOLKIT_API void RegisterVisual(Internal::Control& control, Dali::Property::Index index, Toolkit::Visual::Base& visual);
 
 /**
  * @brief Register a visual by Property Index with a depth index.
@@ -152,7 +148,7 @@ DALI_TOOLKIT_API void RegisterVisual( Internal::Control& control, Dali::Property
  * @see Visual::Base::GetDepthIndex()
  * @see Visual::Base::SetDepthIndex()
  */
-DALI_TOOLKIT_API void RegisterVisual( Internal::Control& control, Dali::Property::Index index, Toolkit::Visual::Base& visual, int depthIndex );
+DALI_TOOLKIT_API void RegisterVisual(Internal::Control& control, Dali::Property::Index index, Toolkit::Visual::Base& visual, int depthIndex);
 
 /**
  * @brief Register a visual by Property Index with the option of enabling/disabling it.
@@ -167,7 +163,7 @@ DALI_TOOLKIT_API void RegisterVisual( Internal::Control& control, Dali::Property
  *
  * @see EnableVisual()
  */
-DALI_TOOLKIT_API void RegisterVisual( Internal::Control& control, Dali::Property::Index index, Toolkit::Visual::Base& visual, bool enabled );
+DALI_TOOLKIT_API void RegisterVisual(Internal::Control& control, Dali::Property::Index index, Toolkit::Visual::Base& visual, bool enabled);
 
 /**
  * @brief Register a visual by Property Index with a depth index with the option of enabling/disabling it.
@@ -182,7 +178,7 @@ DALI_TOOLKIT_API void RegisterVisual( Internal::Control& control, Dali::Property
  * @see Visual::Base::GetDepthIndex()
  * @see Visual::Base::SetDepthIndex()
  */
-DALI_TOOLKIT_API void RegisterVisual( Internal::Control& control, Dali::Property::Index index, Toolkit::Visual::Base& visual, bool enabled, int depthIndex );
+DALI_TOOLKIT_API void RegisterVisual(Internal::Control& control, Dali::Property::Index index, Toolkit::Visual::Base& visual, bool enabled, int depthIndex);
 
 /**
  * @brief Erase the entry matching the given index from the list of registered visuals
@@ -190,7 +186,7 @@ DALI_TOOLKIT_API void RegisterVisual( Internal::Control& control, Dali::Property
  * @param[in] control The control
  * @param[in] index The Property index of the visual, used to reference visual
  */
-DALI_TOOLKIT_API void UnregisterVisual( Internal::Control& control, Dali::Property::Index index );
+DALI_TOOLKIT_API void UnregisterVisual(Internal::Control& control, Dali::Property::Index index);
 
 /**
  * @brief Retrieve the visual associated with the given property index.
@@ -200,7 +196,7 @@ DALI_TOOLKIT_API void UnregisterVisual( Internal::Control& control, Dali::Proper
  * @return The registered visual if exist, otherwise empty handle.
  * @note For managing object life-cycle, do not store the returned visual as a member which increments its reference count.
  */
-DALI_TOOLKIT_API Toolkit::Visual::Base GetVisual( const Internal::Control& control, Dali::Property::Index index );
+DALI_TOOLKIT_API Toolkit::Visual::Base GetVisual(const Internal::Control& control, Dali::Property::Index index);
 
 /**
  * @brief Sets the given visual to be displayed or not when parent staged.
@@ -209,7 +205,7 @@ DALI_TOOLKIT_API Toolkit::Visual::Base GetVisual( const Internal::Control& contr
  * @param[in] index The Property index of the visual
  * @param[in] enable flag to set enabled or disabled.
  */
-DALI_TOOLKIT_API void EnableVisual( Internal::Control& control, Dali::Property::Index index, bool enable );
+DALI_TOOLKIT_API void EnableVisual(Internal::Control& control, Dali::Property::Index index, bool enable);
 
 /**
  * @brief Queries if the given visual is to be displayed when parent staged.
@@ -218,8 +214,7 @@ DALI_TOOLKIT_API void EnableVisual( Internal::Control& control, Dali::Property::
  * @param[in] index The Property index of the visual
  * @return bool whether visual is enabled or not
  */
-DALI_TOOLKIT_API bool IsVisualEnabled( const Internal::Control& control, Dali::Property::Index index );
-
+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
@@ -233,9 +228,9 @@ DALI_TOOLKIT_API bool IsVisualEnabled( const Internal::Control& control, Dali::P
  * @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 );
+DALI_TOOLKIT_API void AddTransitions(Internal::Control&             control,
+                                     Dali::Animation                animation,
+                                     const Toolkit::TransitionData& transitionData);
 
 /**
  * @brief Create a transition effect on the control.
@@ -250,8 +245,8 @@ DALI_TOOLKIT_API void AddTransitions( Internal::Control& control,
  * @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.
@@ -263,7 +258,7 @@ DALI_TOOLKIT_API Dali::Animation CreateTransition( Internal::Control& control,
  * @param[in] actionId The action to perform.  See Visual to find supported actions.
  * @param[in] attributes Optional attributes for the action.
  */
-DALI_TOOLKIT_API void DoAction( Control& control, Dali::Property::Index visualIndex, Dali::Property::Index actionId, const Dali::Property::Value attributes );
+DALI_TOOLKIT_API void DoAction(Control& control, Dali::Property::Index visualIndex, Dali::Property::Index actionId, const Dali::Property::Value attributes);
 
 /**
  * @brief Set input method context.
@@ -271,12 +266,12 @@ DALI_TOOLKIT_API void DoAction( Control& control, Dali::Property::Index visualIn
  * @param[in] control The control.
  * @param[in] inputMethodContext The input method context.
  */
-DALI_TOOLKIT_API void SetInputMethodContext( Internal::Control& control, InputMethodContext& inputMethodContext );
+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 ) >;
+using VisualEventSignalType = Signal<void(Control, Dali::Property::Index, Dali::Property::Index)>;
 
 /**
  * @brief This signal is emitted when a visual has an event to notify.
@@ -287,7 +282,7 @@ using VisualEventSignalType = Signal< void ( Control, Dali::Property::Index, Dal
  * @endcode
  * @return The signal to connect to
  */
-DALI_TOOLKIT_API VisualEventSignalType& VisualEventSignal( Control control );
+DALI_TOOLKIT_API VisualEventSignalType& VisualEventSignal(Control control);
 
 } // namespace DevelControl