summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorDaniel Willmann <d.willmann@samsung.com>2012-07-03 16:28:06 +0000
committerBruno Dilly <bdilly@profusion.mobi>2012-07-03 16:28:06 +0000
commit50e92abce065c74675caf08d18d81d8f0d2bd033 (patch)
treea3ebead00f6315c01d76fc307c4628237525f7da /doc
parent64484838fb6d459724fd01fdaaa0869f1298ad89 (diff)
Elementary: Update documentation for progressbar example
Explanation of the format function and changed callback. Patch by: Daniel Willmann <d.willmann@samsung.com> SVN revision: 73244
Diffstat (limited to 'doc')
-rw-r--r--doc/examples.dox27
1 files changed, 26 insertions, 1 deletions
diff --git a/doc/examples.dox b/doc/examples.dox
index 390b8367c..0ce4b1319 100644
--- a/doc/examples.dox
+++ b/doc/examples.dox
@@ -5112,7 +5112,7 @@
5112 * @until pb2 5112 * @until pb2
5113 * 5113 *
5114 * Next, comes a progress bar with an @b icon, a primary label and a 5114 * Next, comes a progress bar with an @b icon, a primary label and a
5115 * @b custom unit label set. It's also made to grow its bar in an 5115 * unit label @b function set. It's also made to grow its bar in an
5116 * @b inverted manner, so check that out during the timer's progression: 5116 * @b inverted manner, so check that out during the timer's progression:
5117 * @dontinclude progressbar_example.c 5117 * @dontinclude progressbar_example.c
5118 * @skip ic1 = 5118 * @skip ic1 =
@@ -5123,6 +5123,31 @@
5123 * manually, as you can see in the @ref progressbar_example_c 5123 * manually, as you can see in the @ref progressbar_example_c
5124 * "complete code". 5124 * "complete code".
5125 * 5125 *
5126 * The format callback is a simple function that gets passed the progress value
5127 * and returns a string. A free function should be provided as well, if the
5128 * format callback allocates memory.
5129 * @dontinclude progressbar_example.c
5130 * @skip Format callback
5131 * @until }
5132 * @until }
5133 *
5134 * The last horizontal progress bar has a callback that gets called when its
5135 * value is @b changed. This callback updates a label to provide an estimate
5136 * when the operation finishes.
5137 * @dontinclude progressbar_example.c
5138 * @skip pb3
5139 * @skip changed trigger
5140 * @until pb4
5141 *
5142 * The "changed" signal is emitted every time the progressbar value is updated
5143 * through @ref elm_progressbar_value_set(). This callback calculates and
5144 * displays the ETA based on the progress and time that has passed.
5145 * @dontinclude progressbar_example.c
5146 * @skip Callback for "changed" signal
5147 * @until }
5148 * @until }
5149 * @until }
5150 *
5126 * The next three progress bars are just variants on the ones already 5151 * The next three progress bars are just variants on the ones already
5127 * shown, but now all being @b vertical. Another time we use one of 5152 * shown, but now all being @b vertical. Another time we use one of
5128 * than to give the window a minimum vertical size, with 5153 * than to give the window a minimum vertical size, with