1 #ifndef DALI_TOOLKIT_CONTROL_DEVEL_H
2 #define DALI_TOOLKIT_CONTROL_DEVEL_H
5 * Copyright (c) 2019 Samsung Electronics Co., Ltd.
7 * Licensed under the Apache License, Version 2.0 (the "License");
8 * you may not use this file except in compliance with the License.
9 * You may obtain a copy of the License at
11 * http://www.apache.org/licenses/LICENSE-2.0
13 * Unless required by applicable law or agreed to in writing, software
14 * distributed under the License is distributed on an "AS IS" BASIS,
15 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 * See the License for the specific language governing permissions and
17 * limitations under the License.
21 #include <dali/devel-api/adaptor-framework/input-method-context.h>
24 #include <dali-toolkit/public-api/controls/control.h>
25 #include <dali-toolkit/devel-api/visual-factory/visual-base.h>
40 namespace DevelControl
55 STYLE_NAME = Control::Property::STYLE_NAME,
56 KEY_INPUT_FOCUS = Control::Property::KEY_INPUT_FOCUS,
57 BACKGROUND = Control::Property::BACKGROUND,
58 MARGIN = Control::Property::MARGIN,
59 PADDING = Control::Property::PADDING,
62 * @brief Displays a tooltip when the control is hovered over.
63 * @details Name "tooltip", type Property::STRING, Property::ARRAY or Property::MAP.
64 * If Property::STRING, then the style specified in the stylesheet is used.
65 * If Property::ARRAY of Visuals then all are displayed in one row.
66 * If Property::MAP, then it should be a map of Tooltip properties.
67 * @note The tooltip is only activated if display content is received, i.e. a string (text) or visual to show.
68 * The rest is used to just build up the style of the tooltip (i.e. background, text color/point-size etc.)
69 * @note When retrieved, a Property::MAP is returned.
70 * @see Toolkit::Tooltip
72 TOOLTIP = PADDING + 1,
75 * @brief The current state of the control.
76 * @details Name "state", type DevelControl::State ( Property::INTEGER ) or Property::STRING
78 * @see DevelControl::State
83 * @brief The current sub state of the control.
84 * @details Name "subState", type Property::INTEGER or Property::STRING. The enumeration used is dependent on the derived control.
86 * @see DevelControl::State
88 SUB_STATE = PADDING + 3,
91 * @brief The actor ID of the left focusable control.
92 * @details Name "leftFocusableActorId", type Property::INTEGER.
95 LEFT_FOCUSABLE_ACTOR_ID = PADDING + 4,
98 * @brief The actor ID of the right focusable control.
99 * @details Name "rightFocusableActorId", type Property::INTEGER.
102 RIGHT_FOCUSABLE_ACTOR_ID = PADDING + 5,
105 * @brief The actor ID of the up focusable control.
106 * @details Name "upFocusableActorId", type Property::INTEGER.
109 UP_FOCUSABLE_ACTOR_ID = PADDING + 6,
112 * @brief The actor ID of the down focusable control.
113 * @details Name "downFocusableActorId", type Property::INTEGER.
116 DOWN_FOCUSABLE_ACTOR_ID = PADDING + 7,
119 * @brief The shadow of the control.
120 * @details Name "shadow", type Property::MAP.
125 } // namespace Property
128 * @brief Register a visual by Property Index.
130 * @param[in] control The control
131 * @param[in] index The Property index of the visual, used to reference visual
132 * @param[in] visual The visual to register
134 * @note Derived class should not call visual.SetOnScene(actor). It is the responsibility of the base class to connect/disconnect registered visual to stage.
135 * Use below API with enabled set to false if derived class wishes to control when visual is staged.
136 * @note If the depth-index is not set on the visual, then it is set to be above the currently registered visuals.
137 * @note If replacing a visual, then the depth-index of the visual being replaced is used for the visual.
139 DALI_TOOLKIT_API void RegisterVisual( Internal::Control& control, Dali::Property::Index index, Toolkit::Visual::Base& visual );
142 * @brief Register a visual by Property Index with a depth index.
144 * @param[in] control The control
145 * @param[in] index The Property index of the visual, used to reference visual
146 * @param[in] visual The visual to register
147 * @param[in] depthIndex The visual's depth-index is set to this
149 * @note Derived class should not call visual.SetOnScene(actor). It is the responsibility of the base class to connect/disconnect registered visual to stage.
150 * Use below API with enabled set to false if derived class wishes to control when visual is staged.
152 * @see Visual::Base::GetDepthIndex()
153 * @see Visual::Base::SetDepthIndex()
155 DALI_TOOLKIT_API void RegisterVisual( Internal::Control& control, Dali::Property::Index index, Toolkit::Visual::Base& visual, int depthIndex );
158 * @brief Register a visual by Property Index with the option of enabling/disabling it.
160 * @param[in] control The control
161 * @param[in] index The Property index of the visual, used to reference visual
162 * @param[in] visual The visual to register
163 * @param[in] enabled false if derived class wants to control when visual is set on stage.
165 * @note If the depth-index is not set on the visual, then it is set to be above the currently registered visuals.
166 * @note If replacing a visual, then the depth-index of the visual being replaced is used for the visual.
168 * @see EnableVisual()
170 DALI_TOOLKIT_API void RegisterVisual( Internal::Control& control, Dali::Property::Index index, Toolkit::Visual::Base& visual, bool enabled );
173 * @brief Register a visual by Property Index with a depth index with the option of enabling/disabling it.
175 * @param[in] control The control
176 * @param[in] index The Property index of the visual, used to reference visual
177 * @param[in] visual The visual to register
178 * @param[in] enabled false if derived class wants to control when visual is set on stage.
179 * @param[in] depthIndex The visual's depth-index is set to this
181 * @see EnableVisual()
182 * @see Visual::Base::GetDepthIndex()
183 * @see Visual::Base::SetDepthIndex()
185 DALI_TOOLKIT_API void RegisterVisual( Internal::Control& control, Dali::Property::Index index, Toolkit::Visual::Base& visual, bool enabled, int depthIndex );
188 * @brief Erase the entry matching the given index from the list of registered visuals
190 * @param[in] control The control
191 * @param[in] index The Property index of the visual, used to reference visual
193 DALI_TOOLKIT_API void UnregisterVisual( Internal::Control& control, Dali::Property::Index index );
196 * @brief Retrieve the visual associated with the given property index.
198 * @param[in] control The control
199 * @param[in] index The Property index of the visual.
200 * @return The registered visual if exist, otherwise empty handle.
201 * @note For managing object life-cycle, do not store the returned visual as a member which increments its reference count.
203 DALI_TOOLKIT_API Toolkit::Visual::Base GetVisual( const Internal::Control& control, Dali::Property::Index index );
206 * @brief Sets the given visual to be displayed or not when parent staged.
208 * @param[in] control The control
209 * @param[in] index The Property index of the visual
210 * @param[in] enable flag to set enabled or disabled.
212 DALI_TOOLKIT_API void EnableVisual( Internal::Control& control, Dali::Property::Index index, bool enable );
215 * @brief Queries if the given visual is to be displayed when parent staged.
217 * @param[in] control The control
218 * @param[in] index The Property index of the visual
219 * @return bool whether visual is enabled or not
221 DALI_TOOLKIT_API bool IsVisualEnabled( const Internal::Control& control, Dali::Property::Index index );
225 * @brief Add a transition effect on the control to the given animation
227 * Only generates an animator if the properties described in the transition
228 * data are staged (e.g. the visual is Enabled and the control is on stage).
229 * Otherwise the target values are stored, and will get set onto the properties
230 * when the visual is next staged.
232 * @param[in] control The control
233 * @param[in] animation The Animation to add valid transitions to
234 * @param[in] transitionData The transition data describing the effect to create
236 DALI_TOOLKIT_API void AddTransitions( Internal::Control& control,
237 Dali::Animation animation,
238 const Toolkit::TransitionData& transitionData );
241 * @brief Create a transition effect on the control.
243 * Only generates an animation if the properties described in the transition
244 * data are staged (e.g. the visual is Enabled and the control is on stage).
245 * Otherwise the target values are stored, and will get set onto the properties
246 * when the visual is next staged.
248 * @param[in] control The control
249 * @param[in] transitionData The transition data describing the effect to create
250 * @return A handle to an animation defined with the given effect, or an empty
251 * handle if no properties match.
253 DALI_TOOLKIT_API Dali::Animation CreateTransition( Internal::Control& control,
254 const Toolkit::TransitionData& transitionData );
257 * @brief Perform an action on a visual registered to this control.
259 * Visuals will have actions, this API is used to perform one of these actions with the given attributes.
261 * @param[in] control The control.
262 * @param[in] visualIndex The Property index of the visual.
263 * @param[in] actionId The action to perform. See Visual to find supported actions.
264 * @param[in] attributes Optional attributes for the action.
266 DALI_TOOLKIT_API void DoAction( Control& control, Dali::Property::Index visualIndex, Dali::Property::Index actionId, const Dali::Property::Value attributes );
269 * @brief Set input method context.
271 * @param[in] control The control.
272 * @param[in] inputMethodContext The input method context.
274 DALI_TOOLKIT_API void SetInputMethodContext( Internal::Control& control, InputMethodContext& inputMethodContext );
277 * @brief Visual Event signal type
279 using VisualEventSignalType = Signal< void ( Control, Dali::Property::Index, Dali::Property::Index ) >;
282 * @brief This signal is emitted when a visual has an event to notify.
284 * A callback of the following type may be connected:
286 * void YourCallbackName( Control control, Dali::Property::Index visualIndex, Dali::Property::Index signalId );
288 * @return The signal to connect to
290 DALI_TOOLKIT_API VisualEventSignalType& VisualEventSignal( Control control );
292 } // namespace DevelControl
294 } // namespace Toolkit
298 #endif // DALI_TOOLKIT_CONTROL_DEVEL_H