/**
* @defgroup Progressbar Progress bar
+ * @ingroup Elementary
*
* The progress bar is a widget for visually representing the
* progress status of a given job/task.
* value</b>. Label, icon and unit strings/objects are @b optional
* for progress bars.
*
- * A progress bar may be @b inverted, in which state it gets its
- * values inverted, with high values being on the left or top and
- * low values on the right or bottom, as opposed to normally have
- * the low values on the former and high values on the latter,
- * respectively, for horizontal and vertical modes.
+ * A progress bar may be @b inverted, in which case it gets its
+ * values inverted, i.e., high values being on the left or top and
+ * low values on the right or bottom, for horizontal and vertical modes
+ * respectively.
*
* The @b span of the progress, as set by
* elm_progressbar_span_size_set(), is its length (horizontally or
* vertically), unless one puts size hints on the widget to expand
* on desired directions, by any container. That length will be
- * scaled by the object or applications scaling factor. At any
- * point code can query the progress bar for its value with
+ * scaled by the object or applications scaling factor.
+ * Applications can query the progress bar for its value with
* elm_progressbar_value_get().
*
* Available widget styles for progress bars:
* - @c "wheel" (simple style, no text, no progression, only
* "pulse" effect is available)
*
- * Default contents parts of the progressbar widget that you can use for are:
+ * Default text parts of the progressbar widget that you can use for are:
+ * @li "default" - Label of the progressbar
+ *
+ * Default content parts of the progressbar widget that you can use for are:
* @li "icon" - An icon of the progressbar
*
+ * Supported elm_object common APIs.
+ * @li @ref elm_object_part_text_set
+ * @li @ref elm_object_part_text_get
+ * @li @ref elm_object_part_content_set
+ * @li @ref elm_object_part_content_get
+ * @li @ref elm_object_part_content_unset
+ *
* Here is an example on its usage:
* @li @ref progressbar_example
*/
*
* @ingroup Progressbar
*/
-EAPI Evas_Object *elm_progressbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
+EAPI Evas_Object *elm_progressbar_add(Evas_Object *parent);
/**
* Set whether a given progress bar widget is at "pulsing mode" or
*
* By default, progress bars will display values from the low to
* high value boundaries. There are, though, contexts in which the
- * state of progression of a given task is @b unknown. For those,
+ * progress of a given task is @b unknown. For such cases,
* one can set a progress bar widget to a "pulsing state", to give
* the user an idea that some computation is being held, but
- * without exact progress values. In the default theme it will
+ * without exact progress values. In the default theme, it will
* animate its bar with the contents filling in constantly and back
* to non-filled, in a loop. To start and stop this pulsing
* animation, one has to explicitly call elm_progressbar_pulse().
*
* @ingroup Progressbar
*/
-EAPI void elm_progressbar_pulse_set(Evas_Object *obj, Eina_Bool pulse) EINA_ARG_NONNULL(1);
+EAPI void elm_progressbar_pulse_set(Evas_Object *obj, Eina_Bool pulse);
/**
* Get whether a given progress bar widget is at "pulsing mode" or
*
* @ingroup Progressbar
*/
-EAPI Eina_Bool elm_progressbar_pulse_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+EAPI Eina_Bool elm_progressbar_pulse_get(const Evas_Object *obj);
/**
* Start/stop a given progress bar "pulsing" animation, if its
*
* @ingroup Progressbar
*/
-EAPI void elm_progressbar_pulse(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
+EAPI void elm_progressbar_pulse(Evas_Object *obj, Eina_Bool state);
/**
* Set the progress value (in percentage) on a given progress bar
*
* @ingroup Progressbar
*/
-EAPI void elm_progressbar_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
+EAPI void elm_progressbar_value_set(Evas_Object *obj, double val);
/**
* Get the progress value (in percentage) on a given progress bar
*
* @ingroup Progressbar
*/
-EAPI double elm_progressbar_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+EAPI double elm_progressbar_value_get(const Evas_Object *obj);
/**
* Set the (exact) length of the bar region of a given progress bar
*
* @ingroup Progressbar
*/
-EAPI void elm_progressbar_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
+EAPI void elm_progressbar_span_size_set(Evas_Object *obj, Evas_Coord size);
/**
* Get the length set for the bar region of a given progress bar
*
* @ingroup Progressbar
*/
-EAPI Evas_Coord elm_progressbar_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+EAPI Evas_Coord elm_progressbar_span_size_get(const Evas_Object *obj);
/**
* Set the format string for a given progress bar widget's units
* area to be hidden completely. If not, it'll set the <b>format
* string</b> for the units label's @b text. The units label is
* provided a floating point value, so the units text is up display
- * at most one floating point falue. Note that the units label is
+ * at most one floating point value. Note that the units label is
* optional. Use a format string such as "%1.2f meters" for
* example.
*
*
* @ingroup Progressbar
*/
-EAPI void elm_progressbar_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
+EAPI void elm_progressbar_unit_format_set(Evas_Object *obj, const char *format);
/**
* Retrieve the format string set for a given progress bar widget's
*
* @ingroup Progressbar
*/
-EAPI const char *elm_progressbar_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+EAPI const char *elm_progressbar_unit_format_get(const Evas_Object *obj);
/**
* Set the orientation of a given progress bar widget
*
* @ingroup Progressbar
*/
-EAPI void elm_progressbar_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
+EAPI void elm_progressbar_horizontal_set(Evas_Object *obj, Eina_Bool horizontal);
/**
* Retrieve the orientation of a given progress bar widget
*
* @ingroup Progressbar
*/
-EAPI Eina_Bool elm_progressbar_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+EAPI Eina_Bool elm_progressbar_horizontal_get(const Evas_Object *obj);
/**
* Invert a given progress bar widget's displaying values order
*
* @ingroup Progressbar
*/
-EAPI void elm_progressbar_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
+EAPI void elm_progressbar_inverted_set(Evas_Object *obj, Eina_Bool inverted);
/**
* Get whether a given progress bar widget's displaying values are
*
* @ingroup Progressbar
*/
-EAPI Eina_Bool elm_progressbar_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+EAPI Eina_Bool elm_progressbar_inverted_get(const Evas_Object *obj);
/**
* @}
projects / framework / uifw / elementary.git / blobdiff