summaryrefslogtreecommitdiff
path: root/src/lib/elementary/elm_progressbar.h
diff options
context:
space:
mode:
authorCedric BAIL <cedric@osg.samsung.com>2016-03-23 12:56:14 -0700
committerCedric BAIL <cedric@osg.samsung.com>2016-03-23 13:24:41 -0700
commitc2a1c49ab2042f559b28e840e54feb8494888e0e (patch)
treec6eb110b7c479499854eede9d0c3ab0a80c9a11a /src/lib/elementary/elm_progressbar.h
parent9340855597e7e465435c69b6278650346688da14 (diff)
elementary: move all legacy files to their expected new location.
Diffstat (limited to 'src/lib/elementary/elm_progressbar.h')
-rw-r--r--src/lib/elementary/elm_progressbar.h74
1 files changed, 74 insertions, 0 deletions
diff --git a/src/lib/elementary/elm_progressbar.h b/src/lib/elementary/elm_progressbar.h
new file mode 100644
index 0000000..12cd9b3
--- /dev/null
+++ b/src/lib/elementary/elm_progressbar.h
@@ -0,0 +1,74 @@
1/**
2 * @defgroup Elm_Progressbar Progress bar
3 * @ingroup Elementary
4 *
5 * @image html progressbar_inheritance_tree.png
6 * @image latex progressbar_inheritance_tree.eps
7 *
8 * The progress bar is a widget for visually representing the
9 * progress status of a given job/task.
10 *
11 * A progress bar may be horizontal or vertical. It may display an
12 * icon besides it, as well as primary and @b units labels. The
13 * former is meant to label the widget as a whole, while the
14 * latter, which is formatted with floating point values (and thus
15 * accepts a <c>printf</c>-style format string, like <c>"%1.2f
16 * units"</c>), is meant to label the widget's <b>progress
17 * value</b>. Label, icon and unit strings/objects are @b optional
18 * for progress bars.
19 *
20 * A progress bar may be @b inverted, in which case it gets its
21 * values inverted, i.e., high values being on the left or top and
22 * low values on the right or bottom, for horizontal and vertical modes
23 * respectively.
24 *
25 * The @b span of the progress, as set by
26 * elm_progressbar_span_size_set(), is its length (horizontally or
27 * vertically), unless one puts size hints on the widget to expand
28 * on desired directions, by any container. That length will be
29 * scaled by the object or applications scaling factor.
30 * Applications can query the progress bar for its value with
31 * elm_progressbar_value_get().
32 *
33 * This widget inherits from the @ref Layout one, so that all the
34 * functions acting on it also work for progress bar objects.
35 *
36 * This widget emits the following signals, besides the ones sent from
37 * @ref Layout:
38 * @li @c "changed" - when the value is changed (since 1.7)
39 * @li @c "focused" - When the progressbar has received focus. (since 1.8)
40 * @li @c "unfocused" - When the progressbar has lost focus. (since 1.8)
41 * @li @c "language,changed" - the program's language changed (since 1.9)
42 *
43 * This widget has the following styles:
44 * - @c "default"
45 * - @c "wheel" (simple style, no text, no progression, only
46 * "pulse" effect is available)
47 *
48 * Default content parts of the progressbar widget that you can use for are:
49 * @li "icon" - An icon of the progressbar
50 *
51 * Default text parts of the progressbar widget that you can use for are:
52 * @li "default" - A label of the progressbar
53 *
54 * Supported elm_object common APIs.
55 * @li @ref elm_object_part_text_set
56 * @li @ref elm_object_part_text_get
57 * @li @ref elm_object_part_content_set
58 * @li @ref elm_object_part_content_get
59 * @li @ref elm_object_part_content_unset
60 *
61 * Here is an example on its usage:
62 * @li @ref progressbar_example
63 */
64
65#include "elm_progressbar_common.h"
66#ifdef EFL_EO_API_SUPPORT
67#include "elm_progressbar_eo.h"
68#endif
69#ifndef EFL_NOLEGACY_API_SUPPORT
70#include "elm_progressbar_legacy.h"
71#endif
72/**
73 * @}
74 */