1 #ifndef DALI_TOOLKIT_PROGRESS_BAR_H
2 #define DALI_TOOLKIT_PROGRESS_BAR_H
5 * Copyright (c) 2020 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>
30 namespace Internal DALI_INTERNAL
35 * @addtogroup dali_toolkit_controls_progress_bar
40 * @brief ProgressBar is a control to give the user an indication of the progress of an operation.
43 * | %Signal Name | Method |
44 * |-------------------|-------------------------------|
45 * | valueChanged | @ref ValueChangedSignal() |
50 class DALI_TOOLKIT_API ProgressBar : public Control
57 * @brief The start and end property ranges for this control.
62 PROPERTY_START_INDEX = Control::CONTROL_PROPERTY_END_INDEX + 1, ///< Start Index. @SINCE_1_2.60
63 PROPERTY_END_INDEX = PROPERTY_START_INDEX + 1000 ///< Reserve property indices. @SINCE_1_2.60
67 * @brief Enumeration of properties belonging to the ProgressBar class.
73 * @brief Enumeration for the instance of properties belonging to the ProgressBar class.
79 * @brief The progress value of progress bar, progress runs form 0 to 1.
80 * @details Name "progressValue", type Property::FLOAT.
82 * @note Optional. If not supplied, the default is 0.
83 * @note Value should be between 0 to 1.
84 * @note If Value is set to 0, progress bar will be set to beginning.
85 * @note If Value is set to 1, progress bar will be set to end.
86 * @note Any Value outside of the range is ignored.
88 PROGRESS_VALUE = PROPERTY_START_INDEX,
91 * @brief The secondary progress value of progress bar, secondary progress runs form 0 to 1.
92 * @details Name "secondaryProgressValue", type Property::FLOAT.
94 * @note Optional. If not supplied, the default is 0.
95 * @note Value should be between 0 to 1.
96 * @note If Value is set to 0, progress bar will be set secondary progress to beginning.
97 * @note If Value is set to 1, progress bar will be set secondary progress to end.
98 * @note Any Value outside of the range is ignored.
100 SECONDARY_PROGRESS_VALUE,
103 * @brief Sets the progress-bar as \e indeterminate state.
104 * @details name "indeterminate", type Property::BOOLEAN.
110 * @brief The track Visual value of progress bar, it's a full progress area and it's shown behind PROGRESS_VISUAL.
111 * @details Name "trackVisual", type Property::MAP or Property::STRING (url to image).
113 * @note Optional. If not supplied, the default track visual will be shown.
118 * @brief The progress Visual value of progress bar, size of the progress visual is changed based on PROGRESS_VALUE.
119 * @details Name "progressVisual", type Property::MAP or Property::STRING (url to image).
121 * @note Optional. If not supplied, the default progress visual will be shown.
126 * @brief The secondary progress visual of progress bar, size of the secondary progress visual is changed based on SECONDARY_PROGRESS_VALUE.
127 * @details Name "secondaryProgressVisual", type Property::MAP or Property::STRING (url to image).
129 * @note Optional. If not supplied, the secondary progress visual will not be shown.
131 SECONDARY_PROGRESS_VISUAL,
134 * @brief The indeterminate visual of progress bar.
135 * @details Name "inditerminateVisual", type Property::MAP or Property::STRING (url to image).
137 * @note Optional. If not supplied, the default indeterminate visual will be shown.
139 INDETERMINATE_VISUAL,
142 * @brief The transition data for indeterminate visual animation.
143 * @details Name "indeterminateVisualAnimation", type Property::MAP or Property::ARRAY.
145 * @note Optional. If not supplied, default animation will be played.
147 INDETERMINATE_VISUAL_ANIMATION,
150 * @brief The Label visual of progress bar.
151 * @details Name "labelVisual", type Property::MAP.
161 * @brief Creates the ProgressBar control. It creates a horizontal linear shape of progress bar.
163 * @return A handle to the ProgressBar control
165 static ProgressBar New();
168 * @brief Creates an empty ProgressBar handle.
174 * @brief Copy constructor.
176 * Creates another handle that points to the same real object.
178 * @param[in] handle Handle to an object
180 ProgressBar( const ProgressBar& handle );
183 * @brief Move constructor
186 * @param[in] rhs A reference to the moved handle
188 ProgressBar( ProgressBar&& rhs );
191 * @brief Assignment operator.
193 * Changes this handle to point to another real object.
195 * @param[in] handle Handle to an object
196 * @return A reference to this
198 ProgressBar& operator=( const ProgressBar& handle );
201 * @brief Move assignment
204 * @param[in] rhs A reference to the moved handle
205 * @return A reference to this
207 ProgressBar& operator=( ProgressBar&& rhs );
212 * This is non-virtual since derived Handle types must not contain data or virtual methods.
218 * @brief Downcast an Object handle to ProgressBar.
220 * If handle points to a ProgressBar the
221 * downcast produces valid handle. If not the returned handle is left uninitialized.
223 * @param[in] handle Handle to an object
224 * @return handle to a ProgressBar or an uninitialized handle
226 static ProgressBar DownCast( BaseHandle handle );
231 * @brief Value changed signal type.
234 typedef Signal< void ( ProgressBar, float, float ) > ValueChangedSignalType;
237 * @brief Signal emitted when the ProgressBar value changes.
239 * A callback of the following type may be connected:
241 * void YourCallbackName( ProgressBar progressBar, float progressValue, float secondaryProgressValue );
244 * @return The signal to connect to
246 ValueChangedSignalType& ValueChangedSignal();
248 public: // Not intended for application developers
252 * @brief Creates a handle using the Toolkit::Internal implementation.
253 * @param[in] implementation The Control implementation
255 DALI_INTERNAL ProgressBar(Internal::ProgressBar& implementation);
258 * @brief Allows the creation of this Control from an Internal::CustomActor pointer.
259 * @param[in] internal A pointer to the internal CustomActor
261 explicit DALI_INTERNAL ProgressBar( Dali::Internal::CustomActor* internal );
268 } // namespace Toolkit
272 #endif // DALI_TOOLKIT_PROGRESS_BAR_H