1 #ifndef DALI_TOOLKIT_PROGRESS_BAR_H
2 #define DALI_TOOLKIT_PROGRESS_BAR_H
5 * Copyright (c) 2016 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
36 * @brief ProgressBar is a control to give the user an indication of the progress of an operation.
38 * Determinate Progress State
41 * * : Secondary Progress visual
45 * =============================================
46 * = ###############**** 40% =
47 * =============================================
49 * Indeterminate Progress State
51 * / : Indeterminate visual
53 * =============================================
54 * = ///////////////////////////////////////// =
55 * =============================================
57 * Also progress value percentage is shown as text inside the progress bar.
60 * | %Signal Name | Method |
61 * |-------------------|-------------------------------|
62 * | valueChanged | @ref ValueChangedSignal() |
65 class DALI_IMPORT_API ProgressBar : public Control
72 * @brief The start and end property ranges for this control.
76 PROPERTY_START_INDEX = Control::CONTROL_PROPERTY_END_INDEX + 1, ///< Start Index
77 PROPERTY_END_INDEX = PROPERTY_START_INDEX + 1000 ///< Reserve property indices
81 * @brief An enumeration of properties belonging to the ProgressBar class.
89 * @brief The progress value of progress bar, progress runs form 0 to 1.
90 * @details Name "progressValue", type Property::FLOAT.
91 * @note Optional. If not supplied, the default is 0.
92 * @note Value should be between 0 to 1.
93 * @note If Value is set to 0, progress bar will be set to beginning.
94 * @note If Value is set to 1, progress bar will be set to end.
95 * @note Any Value outside of the range is ignored.
97 PROGRESS_VALUE = PROPERTY_START_INDEX,
100 * @brief The secondary progress value of progress bar, secondary progress runs form 0 to 1.
101 * @details Name "secondaryProgressValue", type Property::FLOAT.
102 * @note Optional. If not supplied, the default is 0.
103 * @note Value should be between 0 to 1.
104 * @note If Value is set to 0, progress bar will be set secondary progress to beginning.
105 * @note If Value is set to 1, progress bar will be set secondary progress to end.
106 * @note Any Value outside of the range is ignored.
108 SECONDARY_PROGRESS_VALUE,
111 * @brief Sets the progress-bar as \e indeterminate state.
112 * @details name "indeterminate", type bool
117 * @brief The track Visual value of progress bar, it's a full progress area and it's shown behind PROGRESS_VISUAL.
118 * @details Name "trackVisual", type Property::STRING if it is a url, map otherwise.
119 * @note Optional. If not supplied, the default track visual will be shown.
124 * @brief The progress Visual value of progress bar, size of the progress visual is changed based on PROGRESS_VALUE.
125 * @details Name "progressVisual", type Property::STRING if it is a url, map otherwise.
126 * @note Optional. If not supplied, the default progress visual will be shown.
131 * @brief The secondary progress visual of progress bar, size of the secondary progress visual is changed based on SECONDARY_PROGRESS_VALUE.
132 * @details Name "secondaryProgressVisual", type Property::STRING if it is a url, map otherwise.
133 * @note Optional. If not supplied, the secondary progress visual will not be shown.
135 SECONDARY_PROGRESS_VISUAL,
138 * @brief The indeterminate visual of progress bar.
139 * @details Name "inditerminateVisual", type Property::STRING if it is a url, map otherwise.
140 * @note Optional. If not supplied, the default inditerminate visual will be shown.
142 INDETERMINATE_VISUAL,
145 * @brief The transition data for indeterminate visual animation.
146 * @details Name "indeterminateVisualAnimation", type Property::STRING.
147 * @note Optional. If not supplied, default animation will be played.
149 INDETERMINATE_VISUAL_ANIMATION,
152 * @brief The Label visual of progress bar.
153 * @details Name "labelVisual", type Property::MAP.
162 * @brief Creates the ProgressBar control.
163 * @return A handle to the ProgressBar control
165 static ProgressBar New();
168 * @brief Creates an empty ProgressBar handle.
173 * @brief Copy constructor.
175 * Creates another handle that points to the same real object.
177 ProgressBar( const ProgressBar& handle );
180 * @brief Assignment operator.
182 * Changes this handle to point to another real object.
184 ProgressBar& operator=( const ProgressBar& handle );
189 * This is non-virtual since derived Handle types must not contain data or virtual methods.
194 * @brief Downcast an Object handle to ProgressBar.
196 * If handle points to a ProgressBar the
197 * downcast produces valid handle. If not the returned handle is left uninitialized.
198 * @param[in] handle Handle to an object
199 * @return handle to a ProgressBar or an uninitialized handle
201 static ProgressBar DownCast( BaseHandle handle );
206 * @brief Value changed signal type.
208 typedef Signal< void ( ProgressBar, float, float ) > ValueChangedSignalType;
211 * @brief Signal emitted when the ProgressBar value changes.
213 * A callback of the following type may be connected:
215 * void YourCallbackName( ProgressBar progressBar, float progressValue, float secondaryProgressValue );
217 * @return The signal to connect to
219 ValueChangedSignalType& ValueChangedSignal();
222 public: // Not intended for application developers
226 * @brief Creates a handle using the Toolkit::Internal implementation.
227 * @param[in] implementation The Control implementation
229 DALI_INTERNAL ProgressBar(Internal::ProgressBar& implementation);
232 * @brief Allows the creation of this Control from an Internal::CustomActor pointer.
233 * @param[in] internal A pointer to the internal CustomActor
235 explicit DALI_INTERNAL ProgressBar( Dali::Internal::CustomActor* internal );
239 } // namespace Toolkit
243 #endif // DALI_TOOLKIT_PROGRESS_BAR_H