#define DALI_TOOLKIT_PROGRESS_BAR_H
/*
- * Copyright (c) 2016 Samsung Electronics Co., Ltd.
+ * Copyright (c) 2017 Samsung Electronics Co., Ltd.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
{
class ProgressBar;
}
+/**
+ * @addtogroup dali_toolkit_controls_progress_bar
+ * @{
+ */
/**
* @brief ProgressBar is a control to give the user an indication of the progress of an operation.
* =============================================
*
* Also progress value percentage is shown as text inside the progress bar.
- *
* Signals
* | %Signal Name | Method |
* |-------------------|-------------------------------|
* | valueChanged | @ref ValueChangedSignal() |
+ *
+ * @SINCE_1_2.60
*/
class DALI_IMPORT_API ProgressBar : public Control
/**
* @brief The start and end property ranges for this control.
+ * @SINCE_1_2.60
*/
enum PropertyRange
{
- PROPERTY_START_INDEX = Control::CONTROL_PROPERTY_END_INDEX + 1, ///< Start Index
- PROPERTY_END_INDEX = PROPERTY_START_INDEX + 1000 ///< Reserve property indices
+ PROPERTY_START_INDEX = Control::CONTROL_PROPERTY_END_INDEX + 1, ///< Start Index. @SINCE_1_2.60
+ PROPERTY_END_INDEX = PROPERTY_START_INDEX + 1000 ///< Reserve property indices. @SINCE_1_2.60
};
/**
* @brief An enumeration of properties belonging to the ProgressBar class.
+ * @SINCE_1_2.60
*/
struct Property
{
enum
{
-
/**
* @brief The progress value of progress bar, progress runs form 0 to 1.
* @details Name "progressValue", type Property::FLOAT.
+ * @SINCE_1_2.60
* @note Optional. If not supplied, the default is 0.
* @note Value should be between 0 to 1.
* @note If Value is set to 0, progress bar will be set to beginning.
/**
* @brief The secondary progress value of progress bar, secondary progress runs form 0 to 1.
* @details Name "secondaryProgressValue", type Property::FLOAT.
+ * @SINCE_1_2.60
* @note Optional. If not supplied, the default is 0.
* @note Value should be between 0 to 1.
* @note If Value is set to 0, progress bar will be set secondary progress to beginning.
/**
* @brief Sets the progress-bar as \e indeterminate state.
- * @details name "indeterminate", type bool
+ * @details name "indeterminate", type Property::BOOLEAN.
+ * @SINCE_1_2.60
*/
INDETERMINATE,
/**
* @brief The track Visual value of progress bar, it's a full progress area and it's shown behind PROGRESS_VISUAL.
- * @details Name "trackVisual", type Property::STRING if it is a url, map otherwise.
+ * @details Name "trackVisual", type Property::MAP or Property::STRING (url to image).
+ * @SINCE_1_2.60
* @note Optional. If not supplied, the default track visual will be shown.
*/
TRACK_VISUAL,
/**
* @brief The progress Visual value of progress bar, size of the progress visual is changed based on PROGRESS_VALUE.
- * @details Name "progressVisual", type Property::STRING if it is a url, map otherwise.
+ * @details Name "progressVisual", type Property::MAP or Property::STRING (url to image).
+ * @SINCE_1_2.60
* @note Optional. If not supplied, the default progress visual will be shown.
*/
PROGRESS_VISUAL,
/**
* @brief The secondary progress visual of progress bar, size of the secondary progress visual is changed based on SECONDARY_PROGRESS_VALUE.
- * @details Name "secondaryProgressVisual", type Property::STRING if it is a url, map otherwise.
+ * @details Name "secondaryProgressVisual", type Property::MAP or Property::STRING (url to image).
+ * @SINCE_1_2.60
* @note Optional. If not supplied, the secondary progress visual will not be shown.
*/
SECONDARY_PROGRESS_VISUAL,
/**
* @brief The indeterminate visual of progress bar.
- * @details Name "inditerminateVisual", type Property::STRING if it is a url, map otherwise.
- * @note Optional. If not supplied, the default inditerminate visual will be shown.
+ * @details Name "inditerminateVisual", type Property::MAP or Property::STRING (url to image).
+ * @SINCE_1_2.60
+ * @note Optional. If not supplied, the default indeterminate visual will be shown.
*/
INDETERMINATE_VISUAL,
/**
* @brief The transition data for indeterminate visual animation.
- * @details Name "indeterminateVisualAnimation", type Property::STRING.
+ * @details Name "indeterminateVisualAnimation", type Property::MAP or Property::ARRAY.
+ * @SINCE_1_2.60
* @note Optional. If not supplied, default animation will be played.
*/
INDETERMINATE_VISUAL_ANIMATION,
/**
* @brief The Label visual of progress bar.
* @details Name "labelVisual", type Property::MAP.
+ * @SINCE_1_2.60
*/
LABEL_VISUAL,
};
/**
* @brief Creates the ProgressBar control.
+ * @SINCE_1_2.60
* @return A handle to the ProgressBar control
*/
static ProgressBar New();
/**
* @brief Creates an empty ProgressBar handle.
+ * @SINCE_1_2.60
*/
ProgressBar();
* @brief Copy constructor.
*
* Creates another handle that points to the same real object.
+ * @SINCE_1_2.60
*/
ProgressBar( const ProgressBar& handle );
* @brief Assignment operator.
*
* Changes this handle to point to another real object.
+ * @SINCE_1_2.60
*/
ProgressBar& operator=( const ProgressBar& handle );
* @brief Destructor.
*
* This is non-virtual since derived Handle types must not contain data or virtual methods.
+ * @SINCE_1_2.60
*/
~ProgressBar();
*
* If handle points to a ProgressBar the
* downcast produces valid handle. If not the returned handle is left uninitialized.
+ * @SINCE_1_2.60
* @param[in] handle Handle to an object
* @return handle to a ProgressBar or an uninitialized handle
*/
/**
* @brief Value changed signal type.
+ * @SINCE_1_2.60
*/
typedef Signal< void ( ProgressBar, float, float ) > ValueChangedSignalType;
* @code
* void YourCallbackName( ProgressBar progressBar, float progressValue, float secondaryProgressValue );
* @endcode
+ * @SINCE_1_2.60
* @return The signal to connect to
*/
ValueChangedSignalType& ValueChangedSignal();
-
public: // Not intended for application developers
/// @cond internal
/// @endcond
};
+/**
+ * @}
+ */
} // namespace Toolkit
} // namespace Dali
projects / platform / core / uifw / dali-toolkit.git / blobdiff