1 #ifndef DALI_TOOLKIT_PROGRESS_BAR_H
2 #define DALI_TOOLKIT_PROGRESS_BAR_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>
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.
42 * Determinate Progress State
45 * * : Secondary Progress visual
49 * =============================================
50 * = ###############**** 40% =
51 * =============================================
53 * Indeterminate Progress State
55 * / : Indeterminate visual
57 * =============================================
58 * = ///////////////////////////////////////// =
59 * =============================================
61 * Also progress value percentage is shown as text inside the progress bar.
63 * | %Signal Name | Method |
64 * |-------------------|-------------------------------|
65 * | valueChanged | @ref ValueChangedSignal() |
70 class DALI_IMPORT_API ProgressBar : public Control
77 * @brief The start and end property ranges for this control.
82 PROPERTY_START_INDEX = Control::CONTROL_PROPERTY_END_INDEX + 1, ///< Start Index. @SINCE_1_2.60
83 PROPERTY_END_INDEX = PROPERTY_START_INDEX + 1000 ///< Reserve property indices. @SINCE_1_2.60
87 * @brief An enumeration of properties belonging to the ProgressBar class.
95 * @brief The progress value of progress bar, progress runs form 0 to 1.
96 * @details Name "progressValue", type Property::FLOAT.
98 * @note Optional. If not supplied, the default is 0.
99 * @note Value should be between 0 to 1.
100 * @note If Value is set to 0, progress bar will be set to beginning.
101 * @note If Value is set to 1, progress bar will be set to end.
102 * @note Any Value outside of the range is ignored.
104 PROGRESS_VALUE = PROPERTY_START_INDEX,
107 * @brief The secondary progress value of progress bar, secondary progress runs form 0 to 1.
108 * @details Name "secondaryProgressValue", type Property::FLOAT.
110 * @note Optional. If not supplied, the default is 0.
111 * @note Value should be between 0 to 1.
112 * @note If Value is set to 0, progress bar will be set secondary progress to beginning.
113 * @note If Value is set to 1, progress bar will be set secondary progress to end.
114 * @note Any Value outside of the range is ignored.
116 SECONDARY_PROGRESS_VALUE,
119 * @brief Sets the progress-bar as \e indeterminate state.
120 * @details name "indeterminate", type Property::BOOLEAN.
126 * @brief The track Visual value of progress bar, it's a full progress area and it's shown behind PROGRESS_VISUAL.
127 * @details Name "trackVisual", type Property::MAP or Property::STRING (url to image).
129 * @note Optional. If not supplied, the default track visual will be shown.
134 * @brief The progress Visual value of progress bar, size of the progress visual is changed based on PROGRESS_VALUE.
135 * @details Name "progressVisual", type Property::MAP or Property::STRING (url to image).
137 * @note Optional. If not supplied, the default progress visual will be shown.
142 * @brief The secondary progress visual of progress bar, size of the secondary progress visual is changed based on SECONDARY_PROGRESS_VALUE.
143 * @details Name "secondaryProgressVisual", type Property::MAP or Property::STRING (url to image).
145 * @note Optional. If not supplied, the secondary progress visual will not be shown.
147 SECONDARY_PROGRESS_VISUAL,
150 * @brief The indeterminate visual of progress bar.
151 * @details Name "inditerminateVisual", type Property::MAP or Property::STRING (url to image).
153 * @note Optional. If not supplied, the default indeterminate visual will be shown.
155 INDETERMINATE_VISUAL,
158 * @brief The transition data for indeterminate visual animation.
159 * @details Name "indeterminateVisualAnimation", type Property::MAP or Property::ARRAY.
161 * @note Optional. If not supplied, default animation will be played.
163 INDETERMINATE_VISUAL_ANIMATION,
166 * @brief The Label visual of progress bar.
167 * @details Name "labelVisual", type Property::MAP.
177 * @brief Creates the ProgressBar control.
179 * @return A handle to the ProgressBar control
181 static ProgressBar New();
184 * @brief Creates an empty ProgressBar handle.
190 * @brief Copy constructor.
192 * Creates another handle that points to the same real object.
195 ProgressBar( const ProgressBar& handle );
198 * @brief Assignment operator.
200 * Changes this handle to point to another real object.
203 ProgressBar& operator=( const ProgressBar& handle );
208 * This is non-virtual since derived Handle types must not contain data or virtual methods.
214 * @brief Downcast an Object handle to ProgressBar.
216 * If handle points to a ProgressBar the
217 * downcast produces valid handle. If not the returned handle is left uninitialized.
219 * @param[in] handle Handle to an object
220 * @return handle to a ProgressBar or an uninitialized handle
222 static ProgressBar DownCast( BaseHandle handle );
227 * @brief Value changed signal type.
230 typedef Signal< void ( ProgressBar, float, float ) > ValueChangedSignalType;
233 * @brief Signal emitted when the ProgressBar value changes.
235 * A callback of the following type may be connected:
237 * void YourCallbackName( ProgressBar progressBar, float progressValue, float secondaryProgressValue );
240 * @return The signal to connect to
242 ValueChangedSignalType& ValueChangedSignal();
244 public: // Not intended for application developers
248 * @brief Creates a handle using the Toolkit::Internal implementation.
249 * @param[in] implementation The Control implementation
251 DALI_INTERNAL ProgressBar(Internal::ProgressBar& implementation);
254 * @brief Allows the creation of this Control from an Internal::CustomActor pointer.
255 * @param[in] internal A pointer to the internal CustomActor
257 explicit DALI_INTERNAL ProgressBar( Dali::Internal::CustomActor* internal );
264 } // namespace Toolkit
268 #endif // DALI_TOOLKIT_PROGRESS_BAR_H