Author: sh-sh-sh Date: Wed Oct 10 16:47:02 2007 New Revision: 41337 URL: http://svn.opensuse.org/viewcvs/yast?rev=41337&view=rev Log: doc Modified: branches/tmp/sh/mod-ui/core/libyui/src/YTree.h Modified: branches/tmp/sh/mod-ui/core/libyui/src/YTree.h URL: http://svn.opensuse.org/viewcvs/yast/branches/tmp/sh/mod-ui/core/libyui/src/YTree.h?rev=41337&r1=41336&r2=41337&view=diff ============================================================================== --- branches/tmp/sh/mod-ui/core/libyui/src/YTree.h (original) +++ branches/tmp/sh/mod-ui/core/libyui/src/YTree.h Wed Oct 10 16:47:02 2007 @@ -26,6 +26,23 @@ class YTreePrivate; +/** + * Tree: List box that displays a (scrollable) list of hierarchical items from + * which the user can select exactly one. Each item has a label text and an + * optional icon (*). + * + * This is very similar to SelectionBox, but each item can have subitems that + * can be open (expanded) or closed (collapsed). + * + * The tree widget also has a caption label that is displayed above the + * tree. The hotkey displayed in that caption label will move the keyboard + * focus into the tree item list. + * + * + * (*) Not all UIs (in particular not text-based UIs) support displaying icons, + * so an icon should never be an exclusive means to display any kind of + * information. + **/ class YTree : public YSelectionWidget { protected: @@ -59,7 +76,7 @@ /** * Add multiple items. For some UIs, this can be more efficient than * calling addItem() multiple times. This function also automatically calls - * rebuildTree() at the end. + * rebuildTree() at the end. * * Derived classes can overwrite this function, but they should call this * base class function at the end of the new implementation. @@ -96,7 +113,7 @@ * Reimplemented from YWidget. **/ virtual const YPropertySet & propertySet(); - + /** * The name of the widget property that will return user input. * Inherited from YWidget. -- To unsubscribe, e-mail: yast-commit+unsubscribe@opensuse.org For additional commands, e-mail: yast-commit+help@opensuse.org