Author: sh-sh-sh Date: Wed Nov 7 17:34:29 2007 New Revision: 41863 URL: http://svn.opensuse.org/viewcvs/yast?rev=41863&view=rev Log: documentation Modified: branches/tmp/sh/mod-ui/core/libyui/src/YMultiProgressMeter.h Modified: branches/tmp/sh/mod-ui/core/libyui/src/YMultiProgressMeter.h URL: http://svn.opensuse.org/viewcvs/yast/branches/tmp/sh/mod-ui/core/libyui/src/YMultiProgressMeter.h?rev=41863&r1=41862&r2=41863&view=diff ============================================================================== --- branches/tmp/sh/mod-ui/core/libyui/src/YMultiProgressMeter.h (original) +++ branches/tmp/sh/mod-ui/core/libyui/src/YMultiProgressMeter.h Wed Nov 7 17:34:29 2007 @@ -26,6 +26,36 @@ class YMultiProgressMeterPrivate; +/** + * MultiProgressMeter: Progress bar with several segments that can indicate + * progress individually. This is useful to display progress of several + * activities that might not necessarily all be done in sequence. + * + * A common example is installing packages from several CDs: Each CD would get + * a separate segment. Each segment's size would be proportional to the amount + * of data to be installed from that CD. This visualizes at the same time + * (a) how many CDs are involved + * (b) how much in proportion is to be expected from each CD + * (c) whether or not a specific CD is finished. + * + * Visual example (horizontal MultiProgressMeter): + * + * [=============...] [===] [......] [.] + * + * This corresponds to 4 CDs: + * + * CD #1: A lot of packages are to be installed from this CD, and a fair amount + * of those are already installed, but some are still missing. + * CD #2: Some packages were installed from this , but this CD is finished. + * CD #3: Quite some packages are to be installed from this CD. + * CD #4: Very few packages are to be installed from this CD. + * + * As can be seen from this simple example, this widget can visualize a lot of + * complex information at the same time in a very natural way. + * + * + * This is an optional widget, i.e. not all UIs support it. + **/ class YMultiProgressMeter : public YWidget { protected: -- To unsubscribe, e-mail: yast-commit+unsubscribe@opensuse.org For additional commands, e-mail: yast-commit+help@opensuse.org