summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGreg Ercolano <erco@seriss.com>2010-10-12 15:46:30 +0000
committerGreg Ercolano <erco@seriss.com>2010-10-12 15:46:30 +0000
commit0d6987a160695342a5491de37b9859583401e433 (patch)
tree7351cf3513640b0e026479eceef7ef33e692394c
parent430bbb9b271d27a1b1f8a7df81dde2af75490cb1 (diff)
Strengthened doxygen docs for set_item_focus().
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@7722 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
-rw-r--r--src/Fl_Tree.cxx6
1 files changed, 4 insertions, 2 deletions
diff --git a/src/Fl_Tree.cxx b/src/Fl_Tree.cxx
index 3d1143246..65f052da6 100644
--- a/src/Fl_Tree.cxx
+++ b/src/Fl_Tree.cxx
@@ -304,8 +304,10 @@ Fl_Tree_Item *Fl_Tree::next_visible_item(Fl_Tree_Item *item, int dir) {
}
}
-/// Set the item currently in focus. Handles calling redraw()
-/// as needed to update the focus box.
+/// Set the item that currently should have keyboard focus.
+/// Handles calling redraw() to update the focus box (if its visible).
+///
+/// \param[in] item The item that should take focus. If NULL, none will have focus.
///
void Fl_Tree::set_item_focus(Fl_Tree_Item *item) {
if ( _item_focus != item ) { // changed?