mirrors/fltk
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Small doc improvements for Fl_Tree_Item.

Browse Source
This commit is contained in:
Greg Ercolano 2022-03-09 06:12:42 -08:00
parent f97fbffa7b
commit 6d3071b859
1 changed files with 10 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
src/Fl_Tree_Item.cxx
View File

@ -434,6 +434,7 @@ Fl_Tree_Item *Fl_Tree_Item::insert_above(const Fl_Tree_Prefs &prefs, const char
/// \returns /// \returns
/// - pointer to orphaned item on success /// - pointer to orphaned item on success
/// - NULL on error (could not deparent the item) /// - NULL on error (could not deparent the item)
/// \see reparent()
/// ///
Fl_Tree_Item* Fl_Tree_Item::deparent(int pos) { Fl_Tree_Item* Fl_Tree_Item::deparent(int pos) {
Fl_Tree_Item *orphan = _children[pos]; Fl_Tree_Item *orphan = _children[pos];
@ -442,11 +443,12 @@ Fl_Tree_Item* Fl_Tree_Item::deparent(int pos) {
} }
/// Reparent specified item as a child of ourself at position \p 'pos'. /// Reparent specified item as a child of ourself at position \p 'pos'.
/// Typically 'newchild' was recently orphaned with deparent(). /// Typically \p 'newchild' was recently orphaned with deparent().
/// ///
/// \returns /// \returns
/// - 0: on success /// - 0: on success
/// - -1: on error (e.g. if \p 'pos' out of range) with no changes made. /// - -1: on error (e.g. if \p 'pos' out of range) with no changes made.
/// \see deparent()
/// ///
int Fl_Tree_Item::reparent(Fl_Tree_Item *newchild, int pos) { int Fl_Tree_Item::reparent(Fl_Tree_Item *newchild, int pos) {
int ret; int ret;
@ -455,7 +457,8 @@ int Fl_Tree_Item::reparent(Fl_Tree_Item *newchild, int pos) {
return 0; return 0;
} }
/// Move the item 'from' to sibling position of 'to'. /// Move an item within its parent using index numbers.
/// Item is moved \p 'to' its new position \p 'from' its old position.
/// ///
/// \returns /// \returns
/// - 0: Success /// - 0: Success
@ -467,13 +470,15 @@ int Fl_Tree_Item::move(int to, int from) {
return _children.move(to, from); return _children.move(to, from);
} }
/// Move the current item above/below/into the specified 'item', /// Move the current item above/below/into the specified \p 'item',
/// where \p 'op' determines the type of move: /// where \p 'op' determines the type of move:
/// ///
/// - 0: move above \p 'item' (\p 'pos' ignored) /// - 0: move above \p 'item' (\p 'pos' ignored)
/// - 1: move below \p 'item' (\p 'pos' ignored) /// - 1: move below \p 'item' (\p 'pos' ignored)
/// - 2: move into \p 'item' as a child (at optional position \p 'pos') /// - 2: move into \p 'item' as a child (at optional position \p 'pos')
/// ///
/// ..and \p 'pos' determines an optional index position after the move.
///
/// \returns 0 on success. a negative number on error: /// \returns 0 on success. a negative number on error:
/// - -1: one of the items has no parent /// - -1: one of the items has no parent
/// - -2: item's index could not be determined /// - -2: item's index could not be determined
@ -535,7 +540,7 @@ int Fl_Tree_Item::move(Fl_Tree_Item *item, int op, int pos) {
return 0; return 0;
} }
/// Move the current item above the specified 'item'. /// Move the current item above the specified \p 'item'.
/// This is the equivalent of calling move(item,0,0). /// This is the equivalent of calling move(item,0,0).
/// ///
/// \returns 0 on success.<br> /// \returns 0 on success.<br>
@ -548,7 +553,7 @@ int Fl_Tree_Item::move_above(Fl_Tree_Item *item) {
return move(item, 0, 0); return move(item, 0, 0);
} }
/// Move the current item below the specified 'item'. /// Move the current item below the specified \p 'item'.
/// This is the equivalent of calling move(item,1,0). /// This is the equivalent of calling move(item,1,0).
/// ///
/// \returns 0 on success.<br> /// \returns 0 on success.<br>