// // "$Id$" // #include #include #include #include #include #include #include ////////////////////// // Fl_Tree_Item.cxx ////////////////////// // // Fl_Tree -- This file is part of the Fl_Tree widget for FLTK // Copyright (C) 2009-2010 by Greg Ercolano. // // This library is free software. Distribution and use rights are outlined in // the file "COPYING" which should have been included with this file. If this // file is missing or damaged, see the license at: // // http://www.fltk.org/COPYING.php // // Please report all bugs and problems on the following page: // // http://www.fltk.org/str.php // /////////////////////////////////////////////////////////////////////////// 80 / // Was the last event inside the specified xywh? static int event_inside(const int xywh[4]) { return(Fl::event_inside(xywh[0],xywh[1],xywh[2],xywh[3])); } /// Constructor. /// Makes a new instance of Fl_Tree_Item using defaults from 'prefs'. /// Fl_Tree_Item::Fl_Tree_Item(const Fl_Tree_Prefs &prefs) { _label = 0; _labelfont = prefs.labelfont(); _labelsize = prefs.labelsize(); _labelfgcolor = prefs.labelfgcolor(); _labelbgcolor = prefs.labelbgcolor(); _widget = 0; #if FLTK_ABI_VERSION >= 10302 _flags = OPEN|VISIBLE|ACTIVE; #else /*FLTK_ABI_VERSION*/ _open = 1; _visible = 1; _active = 1; _selected = 0; #endif /*FLTK_ABI_VERSION*/ _xywh[0] = 0; _xywh[1] = 0; _xywh[2] = 0; _xywh[3] = 0; _collapse_xywh[0] = 0; _collapse_xywh[1] = 0; _collapse_xywh[2] = 0; _collapse_xywh[3] = 0; _label_xywh[0] = 0; _label_xywh[1] = 0; _label_xywh[2] = 0; _label_xywh[3] = 0; _usericon = 0; _userdata = 0; _parent = 0; #if FLTK_ABI_VERSION >= 10302 _prev_sibling = 0; _next_sibling = 0; #endif /*FLTK_ABI_VERSION*/ } // DTOR Fl_Tree_Item::~Fl_Tree_Item() { if ( _label ) { free((void*)_label); _label = 0; } _widget = 0; // Fl_Group will handle destruction _usericon = 0; // user handled allocation //_children.clear(); // array's destructor handles itself } /// Copy constructor. Fl_Tree_Item::Fl_Tree_Item(const Fl_Tree_Item *o) { _label = o->label() ? strdup(o->label()) : 0; _labelfont = o->labelfont(); _labelsize = o->labelsize(); _labelfgcolor = o->labelfgcolor(); _labelbgcolor = o->labelbgcolor(); _widget = o->widget(); #if FLTK_ABI_VERSION >= 10302 _flags = o->_flags; #else /*FLTK_ABI_VERSION*/ _open = o->_open; _visible = o->_visible; _active = o->_active; _selected = o->_selected; #endif /*FLTK_ABI_VERSION*/ _xywh[0] = o->_xywh[0]; _xywh[1] = o->_xywh[1]; _xywh[2] = o->_xywh[2]; _xywh[3] = o->_xywh[3]; _collapse_xywh[0] = o->_collapse_xywh[0]; _collapse_xywh[1] = o->_collapse_xywh[1]; _collapse_xywh[2] = o->_collapse_xywh[2]; _collapse_xywh[3] = o->_collapse_xywh[3]; _label_xywh[0] = o->_label_xywh[0]; _label_xywh[1] = o->_label_xywh[1]; _label_xywh[2] = o->_label_xywh[2]; _label_xywh[3] = o->_label_xywh[3]; _usericon = o->usericon(); _userdata = o->user_data(); _parent = o->_parent; #if FLTK_ABI_VERSION >= 10302 _prev_sibling = 0; // do not copy ptrs! use update_prev_next() _next_sibling = 0; // do not copy ptrs! use update_prev_next() #endif /*FLTK_ABI_VERSION*/ } /// Print the tree as 'ascii art' to stdout. /// Used mainly for debugging. /// void Fl_Tree_Item::show_self(const char *indent) const { if ( label() ) { #if FLTK_ABI_VERSION >= 10302 printf("%s-%s (%d children, this=%p, parent=%p, prev=%p, next=%p, depth=%d)\n", indent,label(),children(),(void*)this, (void*)_parent, _prev_sibling, _next_sibling, depth()); #else /*FLTK_ABI_VERSION*/ printf("%s-%s (%d children, this=%p, parent=%p depth=%d)\n", indent,label(),children(),(void*)this, (void*)_parent, depth()); #endif /*FLTK_ABI_VERSION*/ } if ( children() ) { char *i2 = (char*)malloc(strlen(indent) + 2); strcpy(i2, indent); strcat(i2, " |"); for ( int t=0; tshow_self(i2); } } fflush(stdout); } /// Set the label. Makes a copy of the name. void Fl_Tree_Item::label(const char *name) { if ( _label ) { free((void*)_label); _label = 0; } _label = name ? strdup(name) : 0; } /// Return the label. const char *Fl_Tree_Item::label() const { return(_label); } /// Return child item for the specified 'index'. const Fl_Tree_Item *Fl_Tree_Item::child(int index) const { return(_children[index]); } /// Clear all the children for this item. void Fl_Tree_Item::clear_children() { _children.clear(); } /// Return the index of the immediate child of this item that has the label 'name'. /// /// \returns index of found item, or -1 if not found. /// int Fl_Tree_Item::find_child(const char *name) { if ( name ) { for ( int t=0; tlabel() ) { if ( strcmp(child(t)->label(), name) == 0 ) { return(t); } } } } return(-1); } /// Find child item by descending array of names. Does not include self in search. /// Only Fl_Tree should need this method. /// /// \returns item, or 0 if not found /// const Fl_Tree_Item *Fl_Tree_Item::find_child_item(char **arr) const { for ( int t=0; tlabel() ) { if ( strcmp(child(t)->label(), *arr) == 0 ) { // match? if ( *(arr+1) ) { // more in arr? descend return(_children[t]->find_item(arr+1)); } else { // end of arr? done return(_children[t]); } } } } return(0); } /// Find child item by descending array of names. Does not include self in search. /// Only Fl_Tree should need this method. Use Fl_Tree::find_item() instead. /// /// \returns item, or 0 if not found /// Fl_Tree_Item *Fl_Tree_Item::find_child_item(char **arr) { for ( int t=0; tlabel() ) { if ( strcmp(child(t)->label(), *arr) == 0 ) { // match? if ( *(arr+1) ) { // more in arr? descend return(_children[t]->find_item(arr+1)); } else { // end of arr? done return(_children[t]); } } } } return(0); } /// Find item by descending array of \p names. Includes self in search. /// Only Fl_Tree should need this method. Use Fl_Tree::find_item() instead. /// /// \returns item, or 0 if not found /// const Fl_Tree_Item *Fl_Tree_Item::find_item(char **names) const { if ( label() && strcmp(label(), *names) == 0 ) { // match self? if ( *(names+1) == 0 ) { // end of names, return(this); // found ourself. } } if ( children() ) { // check children.. return(find_child_item(names)); } return(0); } /// Find item by descending array of \p names. Includes self in search. /// Only Fl_Tree should need this method. /// /// \returns item, or 0 if not found /// Fl_Tree_Item *Fl_Tree_Item::find_item(char **names) { if ( label() && strcmp(label(), *names) == 0 ) { // match self? if ( *(names+1) == 0 ) { // end of names, return(this); // found ourself. } } if ( children() ) { // check children.. return(find_child_item(names)); } return(0); } /// Find the index number for the specified 'item' /// in the current item's list of children. /// /// \returns the index, or -1 if not found. /// int Fl_Tree_Item::find_child(Fl_Tree_Item *item) { for ( int t=0; tlabel(new_label); item->_parent = this; switch ( prefs.sortorder() ) { case FL_TREE_SORT_NONE: { _children.add(item); return(item); } case FL_TREE_SORT_ASCENDING: { for ( int t=0; t<_children.total(); t++ ) { Fl_Tree_Item *c = _children[t]; if ( c->label() && strcmp(c->label(), new_label) > 0 ) { _children.insert(t, item); return(item); } } _children.add(item); return(item); } case FL_TREE_SORT_DESCENDING: { for ( int t=0; t<_children.total(); t++ ) { Fl_Tree_Item *c = _children[t]; if ( c->label() && strcmp(c->label(), new_label) < 0 ) { _children.insert(t, item); return(item); } } _children.add(item); return(item); } } return(item); } /// Descend into the path specified by \p arr, and add a new child there. /// Should be used only by Fl_Tree's internals. /// Adds the item based on the value of prefs.sortorder(). /// \returns the item added. /// Fl_Tree_Item *Fl_Tree_Item::add(const Fl_Tree_Prefs &prefs, char **arr) { int t = (*arr && *(arr+1)) ? find_child(*arr) : -1; Fl_Tree_Item *item = 0; if ( t == -1 ) { item = (Fl_Tree_Item*)add(prefs, *arr); } else { item = (Fl_Tree_Item*)child(t); } if ( *(arr+1) ) { // descend? return(item->add(prefs, arr+1)); } else { return(item); // end? done } } /// Insert a new item into current item's children at a specified position. /// \returns the new item inserted. /// Fl_Tree_Item *Fl_Tree_Item::insert(const Fl_Tree_Prefs &prefs, const char *new_label, int pos) { Fl_Tree_Item *item = new Fl_Tree_Item(prefs); item->label(new_label); item->_parent = this; _children.insert(pos, item); return(item); } /// Insert a new item above this item. /// \returns the new item inserted, or 0 if an error occurred. /// Fl_Tree_Item *Fl_Tree_Item::insert_above(const Fl_Tree_Prefs &prefs, const char *new_label) { Fl_Tree_Item *p = _parent; if ( ! p ) return(0); // Walk our parent's children to find ourself for ( int t=0; tchildren(); t++ ) { Fl_Tree_Item *c = p->child(t); if ( this == c ) { return(p->insert(prefs, new_label, t)); } } return(0); } /// Remove child by item. /// \returns 0 if removed, -1 if item not an immediate child. /// int Fl_Tree_Item::remove_child(Fl_Tree_Item *item) { for ( int t=0; tclear_children(); _children.remove(t); return(0); } } return(-1); } /// Remove immediate child (and its children) by its label 'name'. /// \returns 0 if removed, -1 if not found. /// int Fl_Tree_Item::remove_child(const char *name) { for ( int t=0; tlabel() ) { if ( strcmp(child(t)->label(), name) == 0 ) { _children.remove(t); return(0); } } } return(-1); } /// Swap two of our children, given two child index values. /// Use this eg. for sorting. /// /// This method is FAST, and does not involve lookups. /// /// No range checking is done on either index value. /// /// \returns /// - 0 : OK /// - -1 : failed: 'a' or 'b' is not our immediate child /// void Fl_Tree_Item::swap_children(int ax, int bx) { _children.swap(ax, bx); } /// Swap two of our children, given item pointers. /// Use this eg. for sorting. /// /// This method is SLOW because it involves linear lookups. /// For speed, use swap_children(int,int) instead. /// /// \returns /// - 0 : OK /// - -1 : failed: 'a' or 'b' is not our immediate child /// int Fl_Tree_Item::swap_children(Fl_Tree_Item *a, Fl_Tree_Item *b) { int ax = -1, bx = -1; for ( int t=0; tfind_clicked(prefs) ) != NULL) { // check child and its descendents return(item); // found? } } } return(0); } /// Non-const version of the above. /// Find the item that the last event was over. /// /// Returns the item if it is visible, and mouse is over it. /// Works even if widget deactivated. /// Use event_on_collapse_icon() to determine if collapse button was pressed. /// /// \returns the visible item under the event if found, or 0 if none. /// Fl_Tree_Item *Fl_Tree_Item::find_clicked(const Fl_Tree_Prefs &prefs) { if ( ! is_visible() ) return(0); if ( is_root() && !prefs.showroot() ) { // skip event check if we're root but root not being shown } else { // See if event is over us if ( event_inside(_xywh) ) { // event within this item? return(this); // found } } if ( is_open() ) { // open? check children of this item for ( int t=0; tfind_clicked(prefs) ) != NULL ) { // check child and its descendents return(item); // found? } } } return(0); } static void draw_item_focus(Fl_Boxtype B, Fl_Color C, int X, int Y, int W, int H) { if (!Fl::visible_focus()) return; switch (B) { case FL_DOWN_BOX: case FL_DOWN_FRAME: case FL_THIN_DOWN_BOX: case FL_THIN_DOWN_FRAME: X ++; Y ++; default: break; } fl_color(fl_contrast(FL_BLACK, C)); #if defined(USE_X11) || defined(__APPLE_QUARTZ__) fl_line_style(FL_DOT); fl_rect(X + Fl::box_dx(B), Y + Fl::box_dy(B), W - Fl::box_dw(B) - 1, H - Fl::box_dh(B) - 1); fl_line_style(FL_SOLID); #else // Some platforms don't implement dotted line style, so draw // every other pixel around the focus area... // // Also, QuickDraw (MacOS) does not support line styles specifically, // and the hack we use in fl_line_style() will not draw horizontal lines // on odd-numbered rows... int i, xx, yy; X += Fl::box_dx(B); Y += Fl::box_dy(B); W -= Fl::box_dw(B) + 2; H -= Fl::box_dh(B) + 2; for (xx = 0, i = 1; xx < W; xx ++, i ++) if (i & 1) fl_point(X + xx, Y); for (yy = 0; yy < H; yy ++, i ++) if (i & 1) fl_point(X + W, Y + yy); for (xx = W; xx > 0; xx --, i ++) if (i & 1) fl_point(X + xx, Y + H); for (yy = H; yy > 0; yy --, i ++) if (i & 1) fl_point(X, Y + yy); #endif } /// Return the item's 'visible' height. /// Doesn't include linespacing(); prevents affecting eg. height of widget(). /// int Fl_Tree_Item::calc_item_height(const Fl_Tree_Prefs &prefs) const { if ( ! is_visible() ) return(0); int H = 0; if ( _label ) { fl_font(_labelfont, _labelsize); // fl_descent() needs this :/ H = _labelsize + fl_descent() + 1; // at least one pixel space below descender } #if FLTK_ABI_VERSION >= 10302 if ( widget() && (prefs.item_draw_mode() & FL_TREE_ITEM_HEIGHT_FROM_WIDGET) && H < widget()->h()) { H = widget()->h(); } #endif /*FLTK_ABI_VERSION*/ if ( has_children() && prefs.openicon() && Hh() ) H = prefs.openicon()->h(); if ( usericon() && Hh() ) H = usericon()->h(); return(H); } /// Draw this item and its children. void Fl_Tree_Item::draw(int X, int &Y, int W, Fl_Widget *tree, Fl_Tree_Item *itemfocus, const Fl_Tree_Prefs &prefs, int lastchild) { if ( ! is_visible() ) return; int tree_top = tree->y(); int tree_bot = tree_top + tree->h(); int H = calc_item_height(prefs); // height of item int H2 = H + prefs.linespacing(); // height of item with line spacing // Update the xywh of this item _xywh[0] = X; _xywh[1] = Y; _xywh[2] = W; _xywh[3] = H; // Determine collapse icon's xywh // Note: calculate collapse icon's xywh for possible mouse click detection. // We don't care about items clipped off the viewport; they won't get mouse events. // int item_y_center = Y+(H/2); int &icon_w = _collapse_xywh[2] = prefs.openicon()->w(); int &icon_x = _collapse_xywh[0] = X + (icon_w + prefs.connectorwidth())/2 - 3; int &icon_y = _collapse_xywh[1] = item_y_center - (prefs.openicon()->h()/2); _collapse_xywh[3] = prefs.openicon()->h(); // Horizontal connector values // XXX: Must calculate these even if(clipped) because 'draw children' code (below) // needs hconn_x_center value. (Otherwise, these calculations could be 'clipped') // int hconn_x = X+icon_w/2-1; int hconn_x2 = hconn_x + prefs.connectorwidth(); int hconn_x_center = X + icon_w + ((hconn_x2 - (X + icon_w)) / 2); int cw1 = icon_w+prefs.connectorwidth()/2, cw2 = prefs.connectorwidth(); int conn_w = cw1>cw2 ? cw1 : cw2; // Background position int &bg_x = _label_xywh[0] = X+(icon_w/2-1+conn_w); int &bg_y = _label_xywh[1] = Y; int &bg_w = _label_xywh[2] = W-(icon_w/2-1+conn_w); int &bg_h = _label_xywh[3] = H; // Usericon position int uicon_x = bg_x + ( (usericon() || prefs.usericon()) ? prefs.usericonmarginleft() : 0); int uicon_w = usericon() ? usericon()->w() : prefs.usericon() ? prefs.usericon()->w() : 0; // Label position int label_x = uicon_x + uicon_w + (_label ? prefs.labelmarginleft() : 0); // Recalc widget position // Do this whether clipped or not, so that when scrolled, // the widgets move to appropriate 'offscreen' positions // (so that they don't get mouse events, etc) // if ( widget() ) { int wx = label_x; int wy = bg_y; int ww = widget()->w(); // use widget's width #if FLTK_ABI_VERSION >= 10302 int wh = (prefs.item_draw_mode() & FL_TREE_ITEM_HEIGHT_FROM_WIDGET) ? widget()->h() : H; if ( _label && (prefs.item_draw_mode() & FL_TREE_ITEM_DRAW_LABEL_AND_WIDGET) ) { #else /*FLTK_ABI_VERSION*/ int wh = H; // lock widget's height to item height if ( _label && !widget() ) { // back compat: don't draw label if widget() present #endif /*FLTK_ABI_VERSION*/ fl_font(_labelfont, _labelsize); // fldescent() needs this int lw=0, lh=0; fl_measure(_label,lw,lh); // get box around text (including white space) #if FLTK_ABI_VERSION >= 10302 // NEW wx += (lw + prefs.widgetmarginleft()); #else /*FLTK_ABI_VERSION*/ // OLD wx += (lw + 3); #endif /*FLTK_ABI_VERSION*/ } if ( widget()->x() != wx || widget()->y() != wy || widget()->w() != ww || widget()->h() != wh ) { widget()->resize(wx,wy,ww,wh); // we'll handle redraw below } } char clipped = ((Y+H) < tree_top) || (Y>tree_bot) ? 1 : 0; char drawthis = ( is_root() && prefs.showroot() == 0 ) ? 0 : 1; if ( !clipped ) { Fl_Color fg = is_selected() ? fl_contrast(_labelfgcolor, tree->selection_color()) : is_active() ? _labelfgcolor : fl_inactive(_labelfgcolor); Fl_Color bg = is_selected() ? is_active() ? tree->selection_color() : fl_inactive(tree->selection_color()) : _labelbgcolor == 0xffffffff ? tree->color() // transparent bg? : _labelbgcolor; // See if we should draw this item // If this item is root, and showroot() is disabled, don't draw. // 'clipped' is an optimization to prevent drawing anything offscreen. // if ( drawthis ) { // draw this item at all? if ( tree->damage() & ~FL_DAMAGE_CHILD ) { // non-child damage? // Draw connectors if ( prefs.connectorstyle() != FL_TREE_CONNECTOR_NONE ) { // Horiz connector between center of icon and text // if this is root, the connector should not dangle in thin air on the left if (is_root()) draw_horizontal_connector(hconn_x_center, hconn_x2, item_y_center, prefs); else draw_horizontal_connector(hconn_x, hconn_x2, item_y_center, prefs); // Small vertical line down to children if ( has_children() && is_open() ) draw_vertical_connector(hconn_x_center, item_y_center, Y+H2, prefs); // Connectors for last child if ( !is_root() ) { if ( lastchild ) draw_vertical_connector(hconn_x, Y, item_y_center, prefs); else draw_vertical_connector(hconn_x, Y, Y+H2, prefs); } } // Draw collapse icon if ( has_children() && prefs.showcollapse() ) { // Draw icon image if ( is_open() ) { prefs.closeicon()->draw(icon_x,icon_y); } else { prefs.openicon()->draw(icon_x,icon_y); } } // Background for this item // Draw bg only if different from tree's bg if ( bg != tree->color() || is_selected() ) { if ( is_selected() ) { // Selected? Use selectbox() style fl_draw_box(prefs.selectbox(),bg_x,bg_y,bg_w,bg_h,bg); } else { // Not Selected? use plain filled rectangle fl_color(bg); fl_rectf(bg_x,bg_y,bg_w,bg_h); } if ( widget() ) widget()->damage(FL_DAMAGE_ALL); // if there's a child widget, we just damaged it } // Draw user icon (if any) if ( usericon() ) { // Item has user icon? Use it int uicon_y = item_y_center - (usericon()->h() >> 1); usericon()->draw(uicon_x,uicon_y); } else if ( prefs.usericon() ) { // Prefs has user icon? Use it int uicon_y = item_y_center - (prefs.usericon()->h() >> 1); prefs.usericon()->draw(uicon_x,uicon_y); } // Draw label #if FLTK_ABI_VERSION >= 10302 if ( _label && ( !widget() || (prefs.item_draw_mode() & FL_TREE_ITEM_DRAW_LABEL_AND_WIDGET) ) ) #else /*FLTK_ABI_VERSION*/ if ( _label && !widget() ) // back compat: don't draw label if widget() present #endif /*FLTK_ABI_VERSION*/ { fl_color(fg); fl_font(_labelfont, _labelsize); int label_y = Y+(H/2)+(_labelsize/2)-fl_descent()/2; fl_draw(_label, label_x, label_y); } } // end non-child damage // Draw child FLTK widget? if ( widget() ) { ((Fl_Tree*)tree)->draw_child(*widget()); // let group handle drawing child if ( widget()->label() ) ((Fl_Tree*)tree)->draw_outside_label(*widget()); // label too } // Draw focus box around item's bg last if ( this == itemfocus && Fl::visible_focus() && Fl::focus() == tree && prefs.selectmode() != FL_TREE_SELECT_NONE ) { draw_item_focus(FL_NO_BOX,bg,bg_x+1,bg_y+1,bg_w-1,bg_h-1); } } // end drawthis } // end clipped if ( drawthis ) Y += H2; // adjust Y (even if clipped) // Draw child items (if any) if ( has_children() && is_open() ) { int child_x = drawthis ? (hconn_x_center - (icon_w/2) + 1) // offset children to right, : X; // unless didn't drawthis int child_w = W - (child_x-X); int child_y_start = Y; for ( int t=0; tdraw(child_x, Y, child_w, tree, itemfocus, prefs, lastchild); } if ( has_children() && is_open() ) { Y += prefs.openchild_marginbottom(); // offset below open child tree } if ( ! lastchild ) { // Special 'clipped' calculation. (intentional variable shadowing) int clipped = ((child_y_start < tree_top) && (Y < tree_top)) || ((child_y_start > tree_bot) && (Y > tree_bot)); if (!clipped) draw_vertical_connector(hconn_x, child_y_start, Y, prefs); } } } /// Was the event on the 'collapse' button? /// int Fl_Tree_Item::event_on_collapse_icon(const Fl_Tree_Prefs &prefs) const { if ( is_visible() && is_active() && has_children() && prefs.showcollapse() ) { return(event_inside(_collapse_xywh) ? 1 : 0); } else { return(0); } } /// Was event on the label()? /// int Fl_Tree_Item::event_on_label(const Fl_Tree_Prefs &prefs) const { if ( is_visible() && is_active() ) { return(event_inside(_label_xywh) ? 1 : 0); } else { return(0); } } /// Internal: Show the FLTK widget() for this item and all children. /// Used by open() to re-show widgets that were hidden by a previous close() /// void Fl_Tree_Item::show_widgets() { if ( _widget ) _widget->show(); if ( is_open() ) { for ( int t=0; t<_children.total(); t++ ) { _children[t]->show_widgets(); } } } /// Internal: Hide the FLTK widget() for this item and all children. /// Used by close() to hide widgets. /// void Fl_Tree_Item::hide_widgets() { if ( _widget ) _widget->hide(); for ( int t=0; t<_children.total(); t++ ) { _children[t]->hide_widgets(); } } /// Open this item and all its children. void Fl_Tree_Item::open() { set_flag(OPEN,1); // Tell children to show() their widgets for ( int t=0; t<_children.total(); t++ ) { _children[t]->show_widgets(); } } /// Close this item and all its children. void Fl_Tree_Item::close() { set_flag(OPEN,0); // Tell children to hide() their widgets for ( int t=0; t<_children.total(); t++ ) { _children[t]->hide_widgets(); } } /// Returns how many levels deep this item is in the hierarchy. /// /// For instance; root has a depth of zero, and its immediate children /// would have a depth of 1, and so on. /// int Fl_Tree_Item::depth() const { int count = 0; const Fl_Tree_Item *item = parent(); while ( item ) { ++count; item = item->parent(); } return(count); } /// Return the next item in the tree. /// /// This method can be used to walk the tree forward. /// For an example of how to use this method, see Fl_Tree::first(). /// /// \returns the next item in the tree, or 0 if there's no more items. /// Fl_Tree_Item *Fl_Tree_Item::next() { Fl_Tree_Item *p, *c = this; if ( c->has_children() ) { return(c->child(0)); } #if FLTK_ABI_VERSION >= 10302 // NEW while ( ( p = c->parent() ) != NULL ) { // loop upwards through parents if ( c->_next_sibling ) // not last child? return(c->_next_sibling); // return next child c = p; // child becomes parent to move up generation } // loop: moves up to next parent #else /*FLTK_ABI_VERSION*/ // OLD while ( ( p = c->parent() ) != NULL ) { // loop upwards through parents int t = p->find_child(c); // find our position in parent's children[] array if ( ++t < p->children() ) // not last child? return(p->child(t)); // return next child c = p; // child becomes parent to move up generation } // loop: moves up to next parent #endif /*FLTK_ABI_VERSION*/ return(0); // hit root? done } /// Return the previous item in the tree. /// /// This method can be used to walk the tree backwards. /// For an example of how to use this method, see Fl_Tree::last(). /// /// \returns the previous item in the tree, or 0 if there's no item above this one (hit the root). /// Fl_Tree_Item *Fl_Tree_Item::prev() { #if FLTK_ABI_VERSION >= 10302 // NEW if ( !parent() ) return(0); // hit root? done if ( !_prev_sibling ) { // are we first child? return(parent()); // return parent } // Tricky: in the following example our current position // in the tree is 'j', and we need to move "up one" to 'i': // // ROOT // |-- a // b-- c // | d-- e // | | f // | | // | g-- h // | i // j // // We do this via b->g->i: // 1. Find j's prev_sibling (b) _ // 2. Find b's 'last child' (g) |_ while loop // 3. Find g's 'last child' (i) _| // Fl_Tree_Item *p = _prev_sibling; // focus on our prev sibling while ( p->has_children() ) { // item has children? p = p->child(p->children()-1); // descend hierarchy finding deepest 'last child' } return(p); #else /*FLTK_ABI_VERSION*/ // OLD Fl_Tree_Item *p=parent(); // start with parent if ( ! p ) return(0); // hit root? done int t = p->find_child(this); // find our position in parent's children[] array if ( --t == -1 ) { // are we first child? return(p); // return immediate parent } p = p->child(t); // take parent's previous child while ( p->has_children() ) { // has children? p = p->child(p->children()-1); // take last child } return(p); #endif /*FLTK_ABI_VERSION*/ } /// Return this item's next sibling. /// /// Moves to the next item below us at the same level (sibling). /// Use this to move down the tree without moving deeper into the tree, /// effectively skipping over this item's children/descendents. /// /// \returns item's next sibling, or 0 if none. /// Fl_Tree_Item *Fl_Tree_Item::next_sibling() { #if FLTK_ABI_VERSION >= 10302 // NEW return(_next_sibling); #else /*FLTK_ABI_VERSION*/ // OLD if ( !parent() ) return(0); // No parent (root)? We have no siblings int index = parent()->find_child(this); // find our position in parent's child() array if ( index == -1 ) return(0); // parent doesn't know us? weird if ( (index+1) < parent()->children() ) // is there a next child? return(parent()->child(index+1)); // return next child if there's one below us return(0); // no siblings below us #endif /*FLTK_ABI_VERSION*/ } /// Return this item's previous sibling. /// /// Moves to the previous item above us at the same level (sibling). /// Use this to move up the tree without moving deeper into the tree. /// /// \returns This item's previous sibling, or 0 if none. /// Fl_Tree_Item *Fl_Tree_Item::prev_sibling() { #if FLTK_ABI_VERSION >= 10302 // NEW return(_prev_sibling); #else /*FLTK_ABI_VERSION*/ // OLD if ( !parent() ) return(0); // No parent (root)? We have no siblings int index = parent()->find_child(this); // find next position up in parent's child() array if ( index == -1 ) return(0); // parent doesn't know us? weird if ( index > 0 ) return(parent()->child(index-1)); // return previous child if there's one above us return(0); // no siblings above us #endif /*FLTK_ABI_VERSION*/ } /// Update our _prev_sibling and _next_sibling pointers to point to neighbors, /// given \p index as being our current position in the parent's item array. /// Call this whenever items in the array are added/removed/moved/swapped. /// void Fl_Tree_Item::update_prev_next(int index) { #if FLTK_ABI_VERSION >= 10302 // NEW int pchildren = parent() ? parent()->children() : 0; int index_prev = index-1; int index_next = index+1; // Get pointers to prev+next items Fl_Tree_Item *item_prev = (index_prev>=0)&&(index_prevchild(index_prev) : 0; Fl_Tree_Item *item_next = (index_next>=0)&&(index_nextchild(index_next) : 0; // Adjust our prev+next ptrs _prev_sibling = item_prev; _next_sibling = item_next; // Adjust neighbors to point to us if ( item_prev ) item_prev->_next_sibling = this; if ( item_next ) item_next->_prev_sibling = this; #else /*FLTK_ABI_VERSION*/ // OLD // -- does nothing -- #endif /*FLTK_ABI_VERSION*/ } /// Return the next visible item. (If this item has children and is closed, children are skipped) /// /// This method can be used to walk the tree forward, skipping items /// that are not currently visible to the user. /// /// \returns the next visible item below us, or 0 if there's no more items. /// Fl_Tree_Item *Fl_Tree_Item::next_displayed(Fl_Tree_Prefs &prefs) { Fl_Tree_Item *item = this; while ( 1 ) { item = item->next(); if ( !item ) return 0; if ( item->is_root() && !prefs.showroot() ) continue; if ( item->visible_r() ) return(item); } } /// Return the previous visible item. (If this item above us has children and is closed, its children are skipped) /// /// This method can be used to walk the tree backward, /// skipping items that are not currently visible to the user. /// /// \returns the previous visible item above us, or 0 if there's no more items. /// Fl_Tree_Item *Fl_Tree_Item::prev_displayed(Fl_Tree_Prefs &prefs) { Fl_Tree_Item *c = this; while ( c ) { c = c->prev(); // previous item if ( !c ) break; // no more items? done if ( c->is_root() ) // root return((prefs.showroot()&&c->visible()) ? c : 0); // return root if visible if ( !c->visible() ) continue; // item not visible? skip // Check all parents to be sure none are closed. // If closed, move up to that level and repeat until sure none are closed. Fl_Tree_Item *p = c->parent(); while (1) { if ( !p || p->is_root() ) return(c); // hit top? then we're displayed, return c if ( p->is_close() ) c = p; // found closed parent? make it current p = p->parent(); // continue up tree } } return(0); // hit end: no more items } /// Returns if item and all its parents are visible. /// Also takes into consideration if any parent is close()ed. /// \returns /// 1 -- item and its parents are visible/open() /// 0 -- item (or parents) invisible or close()ed. /// int Fl_Tree_Item::visible_r() const { if ( !visible() ) return(0); for (const Fl_Tree_Item *p=parent(); p; p=p->parent())// move up through parents if (!p->visible() || p->is_close()) return(0); // any parent not visible or closed? return(1); } // // End of "$Id$". //