X-Git-Url: http://review.tizen.org/git/?p=platform%2Fcore%2Fuifw%2Fdali-toolkit.git;a=blobdiff_plain;f=dali-toolkit%2Fdevel-api%2Fcontrols%2Fcontrol-devel.h;h=04e8205d8b68db08eddc476034b756f8076a350b;hp=7795df1062e3cc7b6d7768ba504a15f9d372b1d1;hb=4d3140d11ea9df2cf933d32419f49fc5e63fa4a9;hpb=7845c204ad99f3452a0afb3b2893b941eeb9feb9 diff --git a/dali-toolkit/devel-api/controls/control-devel.h b/dali-toolkit/devel-api/controls/control-devel.h old mode 100644 new mode 100755 index 7795df1..04e8205 --- 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) 2017 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. @@ -17,9 +17,12 @@ * limitations under the License. * */ +// EXTERNAL INCLUDES +#include // INTERNAL INCLUDES #include +#include namespace Dali { @@ -49,11 +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, + 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. @@ -66,7 +71,7 @@ enum * @note When retrieved, a Property::MAP is returned. * @see Toolkit::Tooltip */ - TOOLTIP = BACKGROUND + 1, + TOOLTIP = PADDING + 1, /** * @brief The current state of the control. @@ -74,7 +79,7 @@ enum * * @see DevelControl::State */ - STATE = BACKGROUND + 2, + STATE = PADDING + 2, /** * @brief The current sub state of the control. @@ -82,89 +87,104 @@ enum * * @see DevelControl::State */ - SUB_STATE = BACKGROUND + 3, + SUB_STATE = PADDING + 3, /** * @brief The actor ID of the left focusable control. * @details Name "leftFocusableActorId", type Property::INTEGER. * */ - LEFT_FOCUSABLE_ACTOR_ID = BACKGROUND + 4, + LEFT_FOCUSABLE_ACTOR_ID = PADDING + 4, /** * @brief The actor ID of the right focusable control. * @details Name "rightFocusableActorId", type Property::INTEGER. * */ - RIGHT_FOCUSABLE_ACTOR_ID = BACKGROUND + 5, + RIGHT_FOCUSABLE_ACTOR_ID = PADDING + 5, /** * @brief The actor ID of the up focusable control. * @details Name "upFocusableActorId", type Property::INTEGER. * */ - UP_FOCUSABLE_ACTOR_ID = BACKGROUND + 6, + UP_FOCUSABLE_ACTOR_ID = PADDING + 6, /** * @brief The actor ID of the down focusable control. * @details Name "downFocusableActorId", type Property::INTEGER. * */ - DOWN_FOCUSABLE_ACTOR_ID = BACKGROUND + 7 + DOWN_FOCUSABLE_ACTOR_ID = PADDING + 7, + + /** + * @brief The shadow of the control. + * @details Name "shadow", type Property::MAP. + */ + SHADOW = PADDING + 8 }; } // namespace Property -/// @brief ResourceReady signal type; -typedef Signal ResourceReadySignalType; - /** - * @brief This signal is emitted after all resources required - * by a control are loaded and ready. - * Most resources are only loaded when the control is placed on stage. + * @brief Register a visual by Property Index. * - * A callback of the following type may be connected: - * @code - * void YourCallbackName( Control control ); - * @endcode - */ -DALI_IMPORT_API ResourceReadySignalType& ResourceReadySignal( Control& control ); - -/** - * @brief Query if all resources required by a control are loaded and ready. - * Most resources are only loaded when the control is placed on stage. - * @return true if the resources are loaded and ready, false otherwise + * @param[in] control The control + * @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. + * 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_IMPORT_API bool IsResourceReady( const Control& control ); +DALI_TOOLKIT_API void RegisterVisual( Internal::Control& control, Dali::Property::Index index, Toolkit::Visual::Base& visual ); /** - * @brief Register a visual by Property Index, linking an Actor to visual when required. - * In the case of the visual being an actor or control deeming visual not required then visual should be an empty handle. - * No parenting is done during registration, this should be done by derived class. + * @brief Register a visual by Property Index with a depth index. * * @param[in] control The control * @param[in] index The Property index of the visual, used to reference visual * @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. * 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_IMPORT_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, int depthIndex ); /** - * @brief Register a visual by Property Index, linking an Actor to visual when required. + * @brief Register a visual by Property Index with the option of enabling/disabling it. + * + * @param[in] control The control + * @param[in] index The Property index of the visual, used to reference visual + * @param[in] visual The visual to register + * @param[in] enabled false if derived class wants to control when visual is set on stage. * - * In the case of the visual being an actor or control deeming visual not required then visual should be an empty handle. - * If enabled is false then the visual is not set on stage until enabled by the derived class. - * @see EnableVisual + * @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. + * + * @see EnableVisual() + */ +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. * * @param[in] control The control * @param[in] index The Property index of the visual, used to reference visual * @param[in] visual The visual to register * @param[in] enabled false if derived class wants to control when visual is set on stage. + * @param[in] depthIndex The visual's depth-index is set to this * + * @see EnableVisual() + * @see Visual::Base::GetDepthIndex() + * @see Visual::Base::SetDepthIndex() */ -DALI_IMPORT_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, int depthIndex ); /** * @brief Erase the entry matching the given index from the list of registered visuals @@ -172,7 +192,7 @@ DALI_IMPORT_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_IMPORT_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. @@ -182,7 +202,7 @@ DALI_IMPORT_API void UnregisterVisual( Internal::Control& control, Dali::Propert * @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_IMPORT_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. @@ -191,7 +211,7 @@ DALI_IMPORT_API Toolkit::Visual::Base GetVisual( const Internal::Control& contro * @param[in] index The Property index of the visual * @param[in] enable flag to set enabled or disabled. */ -DALI_IMPORT_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. @@ -200,7 +220,24 @@ DALI_IMPORT_API void EnableVisual( Internal::Control& control, Dali::Property::I * @param[in] index The Property index of the visual * @return bool whether visual is enabled or not */ -DALI_IMPORT_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 + * + * 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. @@ -215,7 +252,44 @@ DALI_IMPORT_API bool IsVisualEnabled( const Internal::Control& control, Dali::Pr * @return A handle to an animation defined with the given effect, or an empty * handle if no properties match. */ -DALI_IMPORT_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. + * + * Visuals will have actions, this API is used to perform one of these actions with the given attributes. + * + * @param[in] control The control. + * @param[in] visualIndex The Property index of the visual. + * @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 ); + +/** + * @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 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