1 #ifndef DALI_TOOLKIT_CONTROL_DEVEL_H
2 #define DALI_TOOLKIT_CONTROL_DEVEL_H
5 * Copyright (c) 2017 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.
22 #include <dali-toolkit/public-api/controls/control.h>
37 namespace DevelControl
52 STYLE_NAME = Control::Property::STYLE_NAME,
53 BACKGROUND_COLOR = Control::Property::BACKGROUND_COLOR,
54 BACKGROUND_IMAGE = Control::Property::BACKGROUND_IMAGE,
55 KEY_INPUT_FOCUS = Control::Property::KEY_INPUT_FOCUS,
56 BACKGROUND = Control::Property::BACKGROUND,
59 * @brief Displays a tooltip when the control is hovered over.
60 * @details Name "tooltip", type Property::STRING, Property::ARRAY or Property::MAP.
61 * If Property::STRING, then the style specified in the stylesheet is used.
62 * If Property::ARRAY of Visuals then all are displayed in one row.
63 * If Property::MAP, then it should be a map of Tooltip properties.
64 * @note The tooltip is only activated if display content is received, i.e. a string (text) or visual to show.
65 * The rest is used to just build up the style of the tooltip (i.e. background, text color/point-size etc.)
66 * @note When retrieved, a Property::MAP is returned.
67 * @see Toolkit::Tooltip
69 TOOLTIP = BACKGROUND + 1,
72 * @brief The current state of the control.
73 * @details Name "state", type DevelControl::State ( Property::INTEGER ) or Property::STRING
75 * @see DevelControl::State
77 STATE = BACKGROUND + 2,
80 * @brief The current sub state of the control.
81 * @details Name "subState", type Property::INTEGER or Property::STRING. The enumeration used is dependent on the derived control.
83 * @see DevelControl::State
85 SUB_STATE = BACKGROUND + 3,
88 * @brief The actor ID of the left focusable control.
89 * @details Name "leftFocusableActorId", type Property::INTEGER.
92 LEFT_FOCUSABLE_ACTOR_ID = BACKGROUND + 4,
95 * @brief The actor ID of the right focusable control.
96 * @details Name "rightFocusableActorId", type Property::INTEGER.
99 RIGHT_FOCUSABLE_ACTOR_ID = BACKGROUND + 5,
102 * @brief The actor ID of the up focusable control.
103 * @details Name "upFocusableActorId", type Property::INTEGER.
106 UP_FOCUSABLE_ACTOR_ID = BACKGROUND + 6,
109 * @brief The actor ID of the down focusable control.
110 * @details Name "downFocusableActorId", type Property::INTEGER.
113 DOWN_FOCUSABLE_ACTOR_ID = BACKGROUND + 7
116 } // namespace Property
118 /// @brief ResourceReady signal type;
119 typedef Signal<void ( Control ) > ResourceReadySignalType;
122 * @brief This signal is emitted after all resources required
123 * by a control are loaded and ready.
124 * Most resources are only loaded when the control is placed on stage.
126 * @note A RelayoutRequest is queued by Control before this signal is emitted
128 * A callback of the following type may be connected:
130 * void YourCallbackName( Control control );
133 DALI_IMPORT_API ResourceReadySignalType& ResourceReadySignal( Control& control );
136 * @brief Query if all resources required by a control are loaded and ready.
137 * Most resources are only loaded when the control is placed on stage.
138 * @return true if the resources are loaded and ready, false otherwise
141 DALI_IMPORT_API bool IsResourceReady( const Control& control );
144 * @brief Register a visual by Property 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
150 * @note Derived class should not call visual.SetOnStage(actor). It is the responsibility of the base class to connect/disconnect registered visual to stage.
151 * Use below API with enabled set to false if derived class wishes to control when visual is staged.
152 * @note If the depth-index is not set on the visual, then it is set to be above the currently registered visuals.
153 * @note If replacing a visual, then the depth-index of the visual being replaced is used for the visual.
155 DALI_IMPORT_API void RegisterVisual( Internal::Control& control, Dali::Property::Index index, Toolkit::Visual::Base& visual );
158 * @brief Register a visual by Property Index with a depth index.
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] depthIndex The visual's depth-index is set to this
165 * @note Derived class should not call visual.SetOnStage(actor). It is the responsibility of the base class to connect/disconnect registered visual to stage.
166 * Use below API with enabled set to false if derived class wishes to control when visual is staged.
168 * @see Visual::Base::GetDepthIndex()
169 * @see Visual::Base::SetDepthIndex()
171 DALI_IMPORT_API void RegisterVisual( Internal::Control& control, Dali::Property::Index index, Toolkit::Visual::Base& visual, int depthIndex );
174 * @brief Register a visual by Property Index with the option of enabling/disabling it.
176 * @param[in] control The control
177 * @param[in] index The Property index of the visual, used to reference visual
178 * @param[in] visual The visual to register
179 * @param[in] enabled false if derived class wants to control when visual is set on stage.
181 * @note If the depth-index is not set on the visual, then it is set to be above the currently registered visuals.
182 * @note If replacing a visual, then the depth-index of the visual being replaced is used for the visual.
184 * @see EnableVisual()
186 DALI_IMPORT_API void RegisterVisual( Internal::Control& control, Dali::Property::Index index, Toolkit::Visual::Base& visual, bool enabled );
189 * @brief Register a visual by Property Index with a depth index with the option of enabling/disabling it.
191 * @param[in] control The control
192 * @param[in] index The Property index of the visual, used to reference visual
193 * @param[in] visual The visual to register
194 * @param[in] enabled false if derived class wants to control when visual is set on stage.
195 * @param[in] depthIndex The visual's depth-index is set to this
197 * @see EnableVisual()
198 * @see Visual::Base::GetDepthIndex()
199 * @see Visual::Base::SetDepthIndex()
201 DALI_IMPORT_API void RegisterVisual( Internal::Control& control, Dali::Property::Index index, Toolkit::Visual::Base& visual, bool enabled, int depthIndex );
204 * @brief Erase the entry matching the given index from the list of registered visuals
206 * @param[in] control The control
207 * @param[in] index The Property index of the visual, used to reference visual
209 DALI_IMPORT_API void UnregisterVisual( Internal::Control& control, Dali::Property::Index index );
212 * @brief Retrieve the visual associated with the given property index.
214 * @param[in] control The control
215 * @param[in] index The Property index of the visual.
216 * @return The registered visual if exist, otherwise empty handle.
217 * @note For managing object life-cycle, do not store the returned visual as a member which increments its reference count.
219 DALI_IMPORT_API Toolkit::Visual::Base GetVisual( const Internal::Control& control, Dali::Property::Index index );
222 * @brief Sets the given visual to be displayed or not when parent staged.
224 * @param[in] control The control
225 * @param[in] index The Property index of the visual
226 * @param[in] enable flag to set enabled or disabled.
228 DALI_IMPORT_API void EnableVisual( Internal::Control& control, Dali::Property::Index index, bool enable );
231 * @brief Queries if the given visual is to be displayed when parent staged.
233 * @param[in] control The control
234 * @param[in] index The Property index of the visual
235 * @return bool whether visual is enabled or not
237 DALI_IMPORT_API bool IsVisualEnabled( const Internal::Control& control, Dali::Property::Index index );
240 * @brief Create a transition effect on the control.
242 * Only generates an animation if the properties described in the transition
243 * data are staged (e.g. the visual is Enabled and the control is on stage).
244 * Otherwise the target values are stored, and will get set onto the properties
245 * when the visual is next staged.
247 * @param[in] control The control
248 * @param[in] transitionData The transition data describing the effect to create
249 * @return A handle to an animation defined with the given effect, or an empty
250 * handle if no properties match.
252 DALI_IMPORT_API Dali::Animation CreateTransition( Internal::Control& control, const Toolkit::TransitionData& transitionData );
254 } // namespace DevelControl
256 } // namespace Toolkit
260 #endif // DALI_TOOLKIT_CONTROL_DEVEL_H