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=9a824d3130ccd19adc3c9bd41efe55ec803e3bb0;hp=7795df1062e3cc7b6d7768ba504a15f9d372b1d1;hb=0ba4d17563f6d40d65b4d233b1a44a2d0a6fc709;hpb=7845c204ad99f3452a0afb3b2893b941eeb9feb9 diff --git a/dali-toolkit/devel-api/controls/control-devel.h b/dali-toolkit/devel-api/controls/control-devel.h index 7795df1..9a824d3 100644 --- a/dali-toolkit/devel-api/controls/control-devel.h +++ b/dali-toolkit/devel-api/controls/control-devel.h @@ -20,6 +20,7 @@ // INTERNAL INCLUDES #include +#include namespace Dali { @@ -54,6 +55,8 @@ enum 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, /** * @brief Displays a tooltip when the control is hovered over. @@ -66,7 +69,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 +77,7 @@ enum * * @see DevelControl::State */ - STATE = BACKGROUND + 2, + STATE = PADDING + 2, /** * @brief The current sub state of the control. @@ -82,91 +85,100 @@ 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 }; } // 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 + * @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 bool IsResourceReady( const Control& control ); +DALI_IMPORT_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_IMPORT_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. - * - * 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 + * @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 @@ -203,6 +215,15 @@ DALI_IMPORT_API void EnableVisual( Internal::Control& control, Dali::Property::I DALI_IMPORT_API bool IsVisualEnabled( const Internal::Control& control, Dali::Property::Index index ); /** + * @brief Get the loading state of the visual resource. + * + * @param[in] control The control + * @param[in] index The Property index of the visual + * @return Return the loading status (PREPARING, READY and FAILED) of visual resource + */ +DALI_IMPORT_API Toolkit::Visual::ResourceStatus GetVisualResourceStatus( 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 @@ -217,6 +238,18 @@ DALI_IMPORT_API bool IsVisualEnabled( const Internal::Control& control, Dali::Pr */ DALI_IMPORT_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_IMPORT_API void DoAction( Control& control, Dali::Property::Index visualIndex, Dali::Property::Index actionId, const Dali::Property::Value attributes ); + } // namespace DevelControl } // namespace Toolkit