X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=dali-toolkit%2Fdevel-api%2Fcontrols%2Fcontrol-devel.h;h=233ef12fdd9bbad9521d1da785fc384ed39fa3b3;hb=eae234c632fe038b114d65c22766bc3069cf8cfe;hp=71071dbc7665c907e67f083e4e3dd4054c488944;hpb=097a9080258eb6e9548ef81f8c4177470e06d267;p=platform%2Fcore%2Fuifw%2Fdali-toolkit.git diff --git a/dali-toolkit/devel-api/controls/control-devel.h b/dali-toolkit/devel-api/controls/control-devel.h index 71071db..233ef12 100644 --- 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) 2016 Samsung Electronics Co., Ltd. + * Copyright (c) 2017 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. @@ -27,9 +27,23 @@ namespace Dali namespace Toolkit { +class TransitionData; + +namespace Visual +{ +class Base; +} + namespace DevelControl { +enum State +{ + NORMAL, + FOCUSED, + DISABLED +}; + namespace Property { @@ -53,10 +67,188 @@ enum * @see Toolkit::Tooltip */ TOOLTIP = BACKGROUND + 1, + + /** + * @brief The current state of the control. + * @details Name "state", type DevelControl::State ( Property::INTEGER ) or Property::STRING + * + * @see DevelControl::State + */ + STATE = BACKGROUND + 2, + + /** + * @brief The current sub state of the control. + * @details Name "subState", type Property::INTEGER or Property::STRING. The enumeration used is dependent on the derived control. + * + * @see DevelControl::State + */ + SUB_STATE = BACKGROUND + 3, + + /** + * @brief The actor ID of the left focusable control. + * @details Name "leftFocusableActorId", type Property::INTEGER. + * + */ + LEFT_FOCUSABLE_ACTOR_ID = BACKGROUND + 4, + + /** + * @brief The actor ID of the right focusable control. + * @details Name "rightFocusableActorId", type Property::INTEGER. + * + */ + RIGHT_FOCUSABLE_ACTOR_ID = BACKGROUND + 5, + + /** + * @brief The actor ID of the up focusable control. + * @details Name "upFocusableActorId", type Property::INTEGER. + * + */ + UP_FOCUSABLE_ACTOR_ID = BACKGROUND + 6, + + /** + * @brief The actor ID of the down focusable control. + * @details Name "downFocusableActorId", type Property::INTEGER. + * + */ + DOWN_FOCUSABLE_ACTOR_ID = BACKGROUND + 7 }; } // 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. + * + * 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 + * + */ +DALI_IMPORT_API bool IsResourceReady( const Control& control ); + +/** + * @brief Register a visual by Property 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 + * + * @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 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] 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, int depthIndex ); + +/** + * @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. + * + * @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_IMPORT_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, 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_IMPORT_API void UnregisterVisual( Internal::Control& control, Dali::Property::Index index ); + +/** + * @brief Retrieve the visual associated with the given property index. + * + * @param[in] control The control + * @param[in] index The Property index of the visual. + * @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 ); + +/** + * @brief Sets the given visual to be displayed or not when parent staged. + * + * @param[in] control The control + * @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 ); + +/** + * @brief Queries if the given visual is to be displayed when parent staged. + * + * @param[in] control The control + * @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 ); + +/** + * @brief Create a transition effect on the control. + * + * Only generates an animation 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] transitionData The transition data describing the effect to create + * @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 ); + } // namespace DevelControl } // namespace Toolkit