#define DALI_TOOLKIT_CONTROL_DEVEL_H
/*
- * Copyright (c) 2018 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/devel-api/layouting/layout-item.h>
+#include <dali-toolkit/public-api/controls/control.h>
namespace Dali
{
-
namespace Toolkit
{
-
class TransitionData;
namespace Visual
namespace DevelControl
{
-
enum State
{
NORMAL,
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.
* @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
* @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.
*/
-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.
* @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()
* @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.
*
* @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.
* @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
* @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.
* @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.
* @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.
* @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
* @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.
* @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.
* @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.
* @param[in] control The control.
* @param[in] inputMethodContext The input method context.
*/
-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.
- * Setting a layout that has already been set will result in the
- * original control becoming a BinLayout. Two Controls can not share
- * the same 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::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 );
+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.
* @endcode
* @return The signal to connect to
*/
-DALI_TOOLKIT_API VisualEventSignalType& VisualEventSignal( Control control );
+DALI_TOOLKIT_API VisualEventSignalType& VisualEventSignal(Control control);
} // namespace DevelControl
projects / platform / core / uifw / dali-toolkit.git / blobdiff