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=9a9e27ee0d2cf1cc75fd4b15d6a9cc41362db7ca;hp=eb58f9136c9c0bf915e0616ce85c9d73dac764e2;hb=20b42a9bcaba6b874f2271f03a56da6f884c4053;hpb=386634b00f264e667074fa7d956c81bc72233c62 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 eb58f91..9a9e27e --- 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) 2018 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,13 @@ * limitations under the License. * */ +// EXTERNAL INCLUDES +#include // INTERNAL INCLUDES #include +#include +#include namespace Dali { @@ -54,6 +58,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 +72,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 +80,7 @@ enum * * @see DevelControl::State */ - STATE = BACKGROUND + 2, + STATE = PADDING + 2, /** * @brief The current sub state of the control. @@ -82,64 +88,39 @@ 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. - * - * @note A RelayoutRequest is queued by Control before this signal is emitted - * - * 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. * @@ -152,7 +133,7 @@ DALI_IMPORT_API bool IsResourceReady( const Control& control ); * @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 ); +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. @@ -168,7 +149,7 @@ DALI_IMPORT_API void RegisterVisual( Internal::Control& control, Dali::Property: * @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 ); +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. @@ -183,7 +164,7 @@ DALI_IMPORT_API void RegisterVisual( Internal::Control& control, Dali::Property: * * @see EnableVisual() */ -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 ); /** * @brief Register a visual by Property Index with a depth index with the option of enabling/disabling it. @@ -198,7 +179,7 @@ DALI_IMPORT_API void RegisterVisual( Internal::Control& control, Dali::Property: * @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 ); +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 @@ -206,7 +187,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. @@ -216,7 +197,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. @@ -225,7 +206,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. @@ -234,7 +215,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. @@ -249,7 +247,58 @@ 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 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 + */ +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 + */ +DALI_TOOLKIT_API void SetLayout( Control control, Toolkit::LayoutItem layout ); } // namespace DevelControl