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 RESERVED_PROPERTY_01 = Control::Property::RESERVED_PROPERTY_01,
57 RESERVED_PROPERTY_02 = Control::Property::RESERVED_PROPERTY_02,
58 KEY_INPUT_FOCUS = Control::Property::KEY_INPUT_FOCUS,
59 BACKGROUND = Control::Property::BACKGROUND,
60 MARGIN = Control::Property::MARGIN,
61 PADDING = Control::Property::PADDING,
64 * @brief Displays a tooltip when the control is hovered over.
65 * @details Name "tooltip", type Property::STRING, Property::ARRAY or Property::MAP.
66 * If Property::STRING, then the style specified in the stylesheet is used.
67 * If Property::ARRAY of Visuals then all are displayed in one row.
68 * If Property::MAP, then it should be a map of Tooltip properties.
69 * @note The tooltip is only activated if display content is received, i.e. a string (text) or visual to show.
70 * The rest is used to just build up the style of the tooltip (i.e. background, text color/point-size etc.)
71 * @note When retrieved, a Property::MAP is returned.
72 * @see Toolkit::Tooltip
74 TOOLTIP = PADDING + 1,
77 * @brief The current state of the control.
78 * @details Name "state", type DevelControl::State ( Property::INTEGER ) or Property::STRING
80 * @see DevelControl::State
85 * @brief The current sub state of the control.
86 * @details Name "subState", type Property::INTEGER or Property::STRING. The enumeration used is dependent on the derived control.
88 * @see DevelControl::State
90 SUB_STATE = PADDING + 3,
93 * @brief The actor ID of the left focusable control.
94 * @details Name "leftFocusableActorId", type Property::INTEGER.
97 LEFT_FOCUSABLE_ACTOR_ID = PADDING + 4,
100 * @brief The actor ID of the right focusable control.
101 * @details Name "rightFocusableActorId", type Property::INTEGER.
104 RIGHT_FOCUSABLE_ACTOR_ID = PADDING + 5,
107 * @brief The actor ID of the up focusable control.
108 * @details Name "upFocusableActorId", type Property::INTEGER.
111 UP_FOCUSABLE_ACTOR_ID = PADDING + 6,
114 * @brief The actor ID of the down focusable control.
115 * @details Name "downFocusableActorId", type Property::INTEGER.
118 DOWN_FOCUSABLE_ACTOR_ID = PADDING + 7,
121 * @brief The shadow of the control.
122 * @details Name "shadow", type Property::MAP.
127 } // namespace Property
130 * @brief Register a visual by Property Index.
132 * @param[in] control The control
133 * @param[in] index The Property index of the visual, used to reference visual
134 * @param[in] visual The visual to register
136 * @note Derived class should not call visual.SetOnStage(actor). It is the responsibility of the base class to connect/disconnect registered visual to stage.
137 * Use below API with enabled set to false if derived class wishes to control when visual is staged.
138 * @note If the depth-index is not set on the visual, then it is set to be above the currently registered visuals.
139 * @note If replacing a visual, then the depth-index of the visual being replaced is used for the visual.
141 DALI_TOOLKIT_API void RegisterVisual( Internal::Control& control, Dali::Property::Index index, Toolkit::Visual::Base& visual );
144 * @brief Register a visual by Property Index with a depth index.
146 * @param[in] control The control
147 * @param[in] index The Property index of the visual, used to reference visual
148 * @param[in] visual The visual to register
149 * @param[in] depthIndex The visual's depth-index is set to this
151 * @note Derived class should not call visual.SetOnStage(actor). It is the responsibility of the base class to connect/disconnect registered visual to stage.
152 * Use below API with enabled set to false if derived class wishes to control when visual is staged.
154 * @see Visual::Base::GetDepthIndex()
155 * @see Visual::Base::SetDepthIndex()
157 DALI_TOOLKIT_API void RegisterVisual( Internal::Control& control, Dali::Property::Index index, Toolkit::Visual::Base& visual, int depthIndex );
160 * @brief Register a visual by Property Index with the option of enabling/disabling it.
162 * @param[in] control The control
163 * @param[in] index The Property index of the visual, used to reference visual
164 * @param[in] visual The visual to register
165 * @param[in] enabled false if derived class wants to control when visual is set on stage.
167 * @note If the depth-index is not set on the visual, then it is set to be above the currently registered visuals.
168 * @note If replacing a visual, then the depth-index of the visual being replaced is used for the visual.
170 * @see EnableVisual()
172 DALI_TOOLKIT_API void RegisterVisual( Internal::Control& control, Dali::Property::Index index, Toolkit::Visual::Base& visual, bool enabled );
175 * @brief Register a visual by Property Index with a depth index with the option of enabling/disabling it.
177 * @param[in] control The control
178 * @param[in] index The Property index of the visual, used to reference visual
179 * @param[in] visual The visual to register
180 * @param[in] enabled false if derived class wants to control when visual is set on stage.
181 * @param[in] depthIndex The visual's depth-index is set to this
183 * @see EnableVisual()
184 * @see Visual::Base::GetDepthIndex()
185 * @see Visual::Base::SetDepthIndex()
187 DALI_TOOLKIT_API void RegisterVisual( Internal::Control& control, Dali::Property::Index index, Toolkit::Visual::Base& visual, bool enabled, int depthIndex );
190 * @brief Erase the entry matching the given index from the list of registered visuals
192 * @param[in] control The control
193 * @param[in] index The Property index of the visual, used to reference visual
195 DALI_TOOLKIT_API void UnregisterVisual( Internal::Control& control, Dali::Property::Index index );
198 * @brief Retrieve the visual associated with the given property index.
200 * @param[in] control The control
201 * @param[in] index The Property index of the visual.
202 * @return The registered visual if exist, otherwise empty handle.
203 * @note For managing object life-cycle, do not store the returned visual as a member which increments its reference count.
205 DALI_TOOLKIT_API Toolkit::Visual::Base GetVisual( const Internal::Control& control, Dali::Property::Index index );
208 * @brief Sets the given visual to be displayed or not when parent staged.
210 * @param[in] control The control
211 * @param[in] index The Property index of the visual
212 * @param[in] enable flag to set enabled or disabled.
214 DALI_TOOLKIT_API void EnableVisual( Internal::Control& control, Dali::Property::Index index, bool enable );
217 * @brief Queries if the given visual is to be displayed when parent staged.
219 * @param[in] control The control
220 * @param[in] index The Property index of the visual
221 * @return bool whether visual is enabled or not
223 DALI_TOOLKIT_API bool IsVisualEnabled( const Internal::Control& control, Dali::Property::Index index );
227 * @brief Add a transition effect on the control to the given animation
229 * Only generates an animator if the properties described in the transition
230 * data are staged (e.g. the visual is Enabled and the control is on stage).
231 * Otherwise the target values are stored, and will get set onto the properties
232 * when the visual is next staged.
234 * @param[in] control The control
235 * @param[in] animation The Animation to add valid transitions to
236 * @param[in] transitionData The transition data describing the effect to create
238 DALI_TOOLKIT_API void AddTransitions( Internal::Control& control,
239 Dali::Animation animation,
240 const Toolkit::TransitionData& transitionData );
243 * @brief Create a transition effect on the control.
245 * Only generates an animation if the properties described in the transition
246 * data are staged (e.g. the visual is Enabled and the control is on stage).
247 * Otherwise the target values are stored, and will get set onto the properties
248 * when the visual is next staged.
250 * @param[in] control The control
251 * @param[in] transitionData The transition data describing the effect to create
252 * @return A handle to an animation defined with the given effect, or an empty
253 * handle if no properties match.
255 DALI_TOOLKIT_API Dali::Animation CreateTransition( Internal::Control& control,
256 const Toolkit::TransitionData& transitionData );
259 * @brief Perform an action on a visual registered to this control.
261 * Visuals will have actions, this API is used to perform one of these actions with the given attributes.
263 * @param[in] control The control.
264 * @param[in] visualIndex The Property index of the visual.
265 * @param[in] actionId The action to perform. See Visual to find supported actions.
266 * @param[in] attributes Optional attributes for the action.
268 DALI_TOOLKIT_API void DoAction( Control& control, Dali::Property::Index visualIndex, Dali::Property::Index actionId, const Dali::Property::Value attributes );
271 * @brief Set input method context.
273 * @param[in] control The control.
274 * @param[in] inputMethodContext The input method context.
276 DALI_TOOLKIT_API void SetInputMethodContext( Internal::Control& control, InputMethodContext& inputMethodContext );
279 * @brief Visual Event signal type
281 using VisualEventSignalType = Signal< void ( Control, Dali::Property::Index, Dali::Property::Index ) >;
284 * @brief This signal is emitted when a visual has an event to notify.
286 * A callback of the following type may be connected:
288 * void YourCallbackName( Control control, Dali::Property::Index visualIndex, Dali::Property::Index signalId );
290 * @return The signal to connect to
292 DALI_TOOLKIT_API VisualEventSignalType& VisualEventSignal( Control control );
294 } // namespace DevelControl
296 } // namespace Toolkit
300 #endif // DALI_TOOLKIT_CONTROL_DEVEL_H