Fl_Tree Class Reference

Tree widget. More...

#include <Fl_Tree.H>

Inheritance diagram for Fl_Tree:
Fl_Group Fl_Widget

List of all members.

Public Member Functions

Fl_Tree_Itemadd (Fl_Tree_Item *parent_item, const char *name)
 Add a new child item labeled 'name' to the specified 'parent_item'.
Fl_Tree_Itemadd (const char *path, Fl_Tree_Item *newitem)
 Adds a new item, given a menu style 'path'.
Fl_Tree_Itemadd (const char *path)
 Adds a new item given a menu style 'path'.
Fl_Tree_Itemcallback_item ()
 Gets the item that caused the callback.
void callback_item (Fl_Tree_Item *item)
 Sets the item that was changed for this callback.
Fl_Tree_Reason callback_reason () const
 Gets the reason for this callback.
void callback_reason (Fl_Tree_Reason reason)
 Sets the reason for this callback.
void clear ()
 Clear the entire tree's children, including the root.
void clear_children (Fl_Tree_Item *item)
 Clear all the children for 'item'.
int close (const char *path, int docallback=1)
 Closes the item specified by 'path'.
int close (Fl_Tree_Item *item, int docallback=1)
 Closes the specified 'item'.
void closeicon (Fl_Image *val)
 Sets the icon to be used as the 'close' icon.
Fl_Imagecloseicon () const
 Returns the icon to be used as the 'close' icon.
void connectorcolor (Fl_Color val)
 Set the connector color used for tree connection lines.
Fl_Color connectorcolor () const
 Get the connector color used for tree connection lines.
void connectorstyle (Fl_Tree_Connector val)
 Sets the line drawing style for inter-connecting items.
Fl_Tree_Connector connectorstyle () const
 Returns the line drawing style for inter-connecting items.
void connectorwidth (int val)
 Sets the width of the horizontal connection lines (in pixels) that appear to the left of each tree item's label.
int connectorwidth () const
 Gets the width of the horizontal connection lines (in pixels) that appear to the left of each tree item's label.
int deselect (const char *path, int docallback=1)
 Deselect an item specified by 'path'.
int deselect (Fl_Tree_Item *item, int docallback=1)
 Deselect the specified item.
int deselect_all (Fl_Tree_Item *item=0, int docallback=1)
 Deselect 'item' and all its children.
void display (Fl_Tree_Item *item)
 Displays 'item', scrolling the tree as necessary.
int displayed (Fl_Tree_Item *item)
 See if 'item' is currently displayed on-screen (visible within the widget).
void draw ()
 Standard FLTK draw() method, handles drawing the tree widget.
int extend_selection_dir (Fl_Tree_Item *from, Fl_Tree_Item *to, int dir, int val, bool visible)
 Extend the selection between and including 'from' and 'to' depending on direction 'dir', 'val', and 'visible'.
Fl_Tree_Itemfind_clicked ()
 Non-const version of Fl_Tree::find_clicked() const.
const Fl_Tree_Itemfind_clicked () const
 Find the item that was last clicked on.
const Fl_Tree_Itemfind_item (const char *path) const
 Find the item, given a menu style path, e.g.
Fl_Tree_Itemfind_item (const char *path)
 Non-const version of Fl_Tree::find_item(const char *path) const.
Fl_Tree_Itemfirst ()
 Returns the first item in the tree, or 0 if none.
Fl_Tree_Itemfirst_selected_item ()
 Returns the first selected item in the tree.
Fl_Tree_Itemfirst_visible ()
 Returns the first open(), visible item in the tree, or 0 if none.
Fl_Tree_Itemfirst_visible_item ()
 Returns the first open(), visible item in the tree, or 0 if none.
 Fl_Tree (int X, int Y, int W, int H, const char *L=0)
 Constructor.
Fl_Tree_Itemget_item_focus () const
 Get the item that currently has keyboard focus.
int handle (int e)
 Standard FLTK event handler for this widget.
void hposition (int pos)
 Sets the horizontal scroll offset to position 'pos'.
int hposition () const
 Returns the horizontal scroll position as a pixel offset.
Fl_Tree_Iteminsert (Fl_Tree_Item *item, const char *name, int pos)
 Insert a new item 'name' into 'item's children at position 'pos'.
Fl_Tree_Iteminsert_above (Fl_Tree_Item *above, const char *name)
 Inserts a new item 'name' above the specified Fl_Tree_Item 'above'.
int is_close (const char *path) const
 See if item specified by 'path' is closed.
int is_close (Fl_Tree_Item *item) const
 See if the specified 'item' is closed.
int is_hscroll_visible () const
 See if the horizontal scrollbar is currently visible.
int is_open (const char *path) const
 See if item specified by 'path' is open.
int is_open (Fl_Tree_Item *item) const
 See if 'item' is open.
int is_scrollbar (Fl_Widget *w)
 See if widget 'w' is one of the Fl_Tree widget's scrollbars.
int is_selected (const char *path)
 See if item specified by 'path' is selected.
int is_selected (Fl_Tree_Item *item) const
 See if the specified 'item' is selected.
int is_vscroll_visible () const
 See if the vertical scrollbar is currently visible.
Fl_Tree_Itemitem_clicked ()
 Return the item that was last clicked.
void item_labelbgcolor (Fl_Color val)
 Set the default label background color used for creating new items.
Fl_Color item_labelbgcolor (void) const
 Get the default label background color used for creating new items.
void item_labelfgcolor (Fl_Color val)
 Set the default label foreground color used for creating new items.
Fl_Color item_labelfgcolor (void) const
 Get the default label foreground color used for creating new items.
void item_labelfont (Fl_Font val)
 Set the default font face used for creating new items.
Fl_Font item_labelfont () const
 Get the default font face used for creating new items.
void item_labelsize (Fl_Fontsize val)
 Set the default label font size used for creating new items.
Fl_Fontsize item_labelsize () const
 Get the default label fontsize used for creating new items.
int item_pathname (char *pathname, int pathnamelen, const Fl_Tree_Item *item) const
 Return 'pathname' of size 'pathnamelen' for the specified 'item'.
void labelmarginleft (int val)
 Set the amount of white space (in pixels) that should appear to the left of the label text.
int labelmarginleft () const
 Get the amount of white space (in pixels) that should appear to the left of the label text.
Fl_Tree_Itemlast ()
 Returns the last item in the tree.
Fl_Tree_Itemlast_selected_item ()
 Returns the last selected item in the tree.
Fl_Tree_Itemlast_visible ()
 Returns the last open(), visible item in the tree.
Fl_Tree_Itemlast_visible_item ()
 Returns the last open(), visible item in the tree.
void linespacing (int val)
 Sets the amount of white space (in pixels) that should appear between items in the tree.
int linespacing () const
 Get the amount of white space (in pixels) that should appear between items in the tree.
void load (class Fl_Preferences &)
 Load FLTK preferences.
void marginleft (int val)
 Set the amount of white space (in pixels) that should appear between the widget's left border and the left side of the tree's contents.
int marginleft () const
 Get the amount of white space (in pixels) that should appear between the widget's left border and the tree's contents.
void margintop (int val)
 Sets the amount of white space (in pixels) that should appear between the widget's top border and the top of the tree's contents.
int margintop () const
 Get the amount of white space (in pixels) that should appear between the widget's top border and the top of the tree's contents.
Fl_Tree_Itemnext (Fl_Tree_Item *item=0)
 Return the next item after 'item', or 0 if no more items.
Fl_Tree_Itemnext_item (Fl_Tree_Item *item, int dir=FL_Down, bool visible=false)
 Returns next item after 'item' in direction 'dir' depending on 'visible'.
Fl_Tree_Itemnext_selected_item (Fl_Tree_Item *item, int dir)
 Returns the next selected item above or below 'item', depending on 'dir'.
Fl_Tree_Itemnext_selected_item (Fl_Tree_Item *item=0)
 Returns the next selected item after 'item'.
int open (const char *path, int docallback=1)
 Opens the item specified by 'path'.
int open (Fl_Tree_Item *item, int docallback=1)
 Open the specified 'item'.
void open_toggle (Fl_Tree_Item *item, int docallback=1)
 Toggle the open state of 'item'.
void openchild_marginbottom (int val)
 Set the amount of white space (in pixels) that should appear below an open child tree's contents.
int openchild_marginbottom () const
 Get the amount of white space (in pixels) that should appear below an open child tree's contents.
void openicon (Fl_Image *val)
 Sets the icon to be used as the 'open' icon.
Fl_Imageopenicon () const
 Returns the icon to be used as the 'open' icon.
const Fl_Tree_Prefsprefs () const
Fl_Tree_Itemprev (Fl_Tree_Item *item=0)
 Return the previous item before 'item', or 0 if no more items.
void recalc_tree ()
 Schedule tree to recalc the entire tree size.
int remove (Fl_Tree_Item *item)
 Remove the specified 'item' from the tree.
void resize (int, int, int, int)
 Resizes the Fl_Group widget and all of its children.
void root (Fl_Tree_Item *newitem)
 Sets the root item to 'newitem'.
Fl_Tree_Itemroot ()
 Returns the root item.
void root_label (const char *new_label)
 Set the label for the root item to 'new_label'.
void scrollbar_size (int size)
 Sets the pixel size of the scrollbars' troughs to 'size' for this widget, in pixels.
int scrollbar_size () const
 Gets the default size of scrollbars' troughs for this widget in pixels.
int select (const char *path, int docallback=1)
 Select the item specified by 'path'.
int select (Fl_Tree_Item *item, int docallback=1)
 Select the specified 'item'.
int select_all (Fl_Tree_Item *item=0, int docallback=1)
 Select 'item' and all its children.
int select_only (Fl_Tree_Item *selitem, int docallback=1)
 Select only the specified item, deselecting all others that might be selected.
void select_toggle (Fl_Tree_Item *item, int docallback=1)
 Toggle the select state of the specified 'item'.
void selectbox (Fl_Boxtype val)
 Gets the style of box used to draw selected items.
Fl_Boxtype selectbox () const
 Sets the style of box used to draw selected items.
void selectmode (Fl_Tree_Select val)
 Sets the tree's selection mode.
Fl_Tree_Select selectmode () const
 Gets the tree's current selection mode.
void set_item_focus (Fl_Tree_Item *item)
 Set the item that currently should have keyboard focus.
void show_item (Fl_Tree_Item *item)
 Adjust the vertical scrollbar to show 'item' at the top of the display IF it is currently off-screen (for instance show_item_top()).
void show_item (Fl_Tree_Item *item, int yoff)
 Adjust the vertical scrollbar so that 'item' is visible 'yoff' pixels from the top of the Fl_Tree widget's display.
void show_item_bottom (Fl_Tree_Item *item)
 Adjust the vertical scrollbar so that 'item' is at the bottom of the display.
void show_item_middle (Fl_Tree_Item *item)
 Adjust the vertical scrollbar so that 'item' is in the middle of the display.
void show_item_top (Fl_Tree_Item *item)
 Adjust the vertical scrollbar so that 'item' is at the top of the display.
void show_self ()
 Print the tree as 'ascii art' to stdout.
void showcollapse (int val)
 Set if we should show the collapse icon or not.
int showcollapse () const
 Returns 1 if the collapse icon is enabled, 0 if not.
void showroot (int val)
 Set if the root item should be shown or not.
int showroot () const
 Returns 1 if the root item is to be shown, or 0 if not.
void sortorder (Fl_Tree_Sort val)
 Gets the sort order used to add items to the tree.
Fl_Tree_Sort sortorder () const
 Set the default sort order used when items are added to the tree.
void usericon (Fl_Image *val)
 Sets the Fl_Image to be used as the default user icon for all newly created items.
Fl_Imageusericon () const
 Returns the Fl_Image being used as the default user icon for all newly created items.
void usericonmarginleft (int val)
 Set the amount of white space (in pixels) that should appear to the left of the usericon.
int usericonmarginleft () const
 Get the amount of white space (in pixels) that should appear to the left of the usericon.
void vposition (int pos)
 Sets the vertical scroll offset to position 'pos'.
int vposition () const
 Returns the vertical scroll position as a pixel offset.
 ~Fl_Tree ()
 Destructor.

Protected Member Functions

void do_callback_for_item (Fl_Tree_Item *item, Fl_Tree_Reason reason)
 Do the callback for the specified 'item' using 'reason', setting the callback_item() and callback_reason().
int draw_tree ()
void extend_selection (Fl_Tree_Item *from, Fl_Tree_Item *to)
 Extend a selection between 'from' and 'to'.
void item_clicked (Fl_Tree_Item *val)
 Set the item that was last clicked.
Fl_Tree_Itemnext_visible_item (Fl_Tree_Item *start, int dir)
 Returns next open(), visible item above (dir==FL_Up) or below (dir==FL_Down) the specified 'item', or 0 if no more items.

Protected Attributes

Fl_Scrollbar_vscroll
 Vertical scrollbar.

Friends

class Fl_Tree_Item

Detailed Description

Tree widget.

tree-simple.png

Fl_Tree example program

     Fl_Tree                                         // Top level widget
        |--- Fl_Tree_Item                            // Items in the tree
        |--- Fl_Tree_Prefs                           // Preferences for the tree
                  |--- Fl_Tree_Connector (enum)      // Connection modes
                  |--- Fl_Tree_Select (enum)         // Selection modes
                  |--- Fl_Tree_Sort (enum)           // Sort behavior

Similar to Fl_Browser, Fl_Tree is a browser of Fl_Tree_Item's arranged in a parented hierarchy, or 'tree'. Subtrees can be expanded or closed. Items can be added, deleted, inserted, sorted and re-ordered.

The tree items may also contain other FLTK widgets, like buttons, input fields, or even "custom" widgets.

The callback() is invoked depending on the value of when():

The simple way to define a tree:

    #include <FL/Fl_Tree.H>
    [..]
    Fl_Tree tree(X,Y,W,H);
    tree.begin();
      tree.add("Flintstones/Fred");
      tree.add("Flintstones/Wilma");
      tree.add("Flintstones/Pebbles");
      tree.add("Simpsons/Homer");
      tree.add("Simpsons/Marge");
      tree.add("Simpsons/Bart");
      tree.add("Simpsons/Lisa");
    tree.end();
FEATURES
Items can be added with add(),
removed with remove(),
completely cleared with clear(),
inserted with insert() and insert_above(),
selected/deselected with select() and deselect(),
open/closed with open() and close(),
positioned on the screen with show_item_top(), show_item_middle() and show_item_bottom(),
item children can be swapped around with Fl_Tree_Item::swap_children(),
sorting can be controlled when items are add()ed via sortorder().
You can walk the entire tree with first() and next().
You can walk visible items with first_visible_item() and next_visible_item().
You can walk selected items with first_selected_item() and next_selected_item().
Items can be found by their pathname using find_item(const char*), and an item's pathname can be found with item_pathname().
The selected items' colors are controlled by selection_color() (inherited from Fl_Widget).
A hook is provided to allow you to redefine how item's labels are drawn via Fl_Tree::item_draw_callback().
SELECTION OF ITEMS
The tree can have different selection behaviors controlled by selectmode(). The background color used for selected items is the Fl_Tree::selection_color(). The foreground color for selected items is controlled internally with fl_contrast().
CHILD WIDGETS
FLTK widgets (including custom widgets) can be assigned to tree items via Fl_Tree_Item::widget().
When an Fl_Tree_Item::widget() is defined, the default behavior is for the widget() to be shown in place of the item's label (if it has one). Only the widget()'s width will be used; the widget()'s x() and y() position will be managed by the tree, and the h() will track the item's height. This default behavior can be altered (ABI 1.3.1): Setting Fl_Tree::item_draw_mode()'s FL_TREE_ITEM_DRAW_LABEL_AND_WIDGET flag causes the label + widget to be displayed together in that order, and adding the FL_TREE_ITEM_HEIGHT_FROM_WIDGET flag causes widget's height to define the widget()'s height.
ICONS
The tree's open/close icons can be redefined with Fl_Tree::openicon(), Fl_Tree::closeicon(). User icons can either be changed globally with Fl_Tree::usericon(), or on a per-item basis with Fl_Tree_Item::usericon().
Various default preferences can be globally manipulated via Fl_Tree_Prefs, including colors, margins, icons, connection lines, etc.
FONTS AND COLORS
When adding new items to the tree, the new items get the defaults for fonts and colors from:
Each item (Fl_Tree_Item) inherits a copy of these font/color attributes when created, and each item has its own methods to let the app change these values on a per-item basis using methods of the same name:
CALLBACKS
The tree's callback() will be invoked when items change state or are open/closed. when() controls when mouse/keyboard events invoke the callback. callback_item() and callback_reason() can be used to determine the cause of the callback. e.g.
 void MyTreeCallback(Fl_Widget *w, void *data) {
   Fl_Tree      *tree = (Fl_Tree*)w;
   Fl_Tree_Item *item = (Fl_Tree_Item*)tree->callback_item();   // get selected item
   switch ( tree->callback_reason() ) {
     case FL_TREE_REASON_SELECTED: [..]
     case FL_TREE_REASON_DESELECTED: [..]
     case FL_TREE_REASON_RESELECTED: [..]
     case FL_TREE_REASON_OPENED: [..]
     case FL_TREE_REASON_CLOSED: [..]
   }
SIMPLE EXAMPLES
To find all the selected items:
 for ( Fl_Tree_Item *i=first_selected_item(); i; i=next_selected_item(i) )
   printf("Item %s is selected\n", i->label());
To get an item's full menu pathname, use Fl_Tree::item_pathname(), e.g.
   char pathname[256] = "???";
   tree->item_pathname(pathname, sizeof(pathname), item);               // eg. "Parent/Child/Item"
To walk all the items of the tree from top to bottom:
 // Walk all the items in the tree, and print their labels
 for ( Fl_Tree_Item *item = tree->first(); item; item = tree->next(item) ) {
     printf("Item: %s\n", item->label());
 }
To recursively walk all the children of a particular item, define a function that uses recursion:
 // Find all of the item's children and print an indented report of their labels
 void my_print_all_children(Fl_Tree_Item *item, int indent=0) {
     for ( int t=0; t<item->children(); t++ ) {
         printf("%*s Item: %s\n", indent, "", item->child(t)->label());
         my_print_all_children(item->child(t), indent+4);   // recurse
     }
 }
To change the default label font and color when creating new items:
  tree = new Fl_Tree(..);
  tree->item_labelfont(FL_COURIER);     // Use Courier font for all new items
  tree->item_labelfgcolor(FL_RED);      // Use red color for labels of all new items
  [..]
  // Now create the items in the tree using the above defaults.
  tree->add("Aaa");
  tree->add("Bbb");
  [..]
To change the font and color of all existing items in the tree:
 // Change the font and color of all items currently in the tree
 for ( Fl_Tree_Item *item = tree->first(); item; item = tree->next(item) ) {
     item->labelfont(FL_COURIER);
     item->labelcolor(FL_RED);
 }
DISPLAY DESCRIPTION
The following image shows the tree's various visual elements and the methods that control them:
tree-elements.png
The following shows the protected dimension variables 'tree inner' (tix..) and 'tree outer' (tox..):
tree-dimensions.png

Fl_Tree inner/outer dimensions

KEYBOARD BINDINGS
The following table lists keyboard bindings for navigating the tree:
Keyboard bindings.

Keyboard

FL_TREE_SELECT_MULTI

FL_TREE_SELECT_SINGLE

FL_TREE_SELECT_NONE

Ctrl-A (Linux/Windows)
Command-A (Mac)

Select all items.

N/A

N/A

Space

Selects item.

Selects item.

N/A

Ctrl-Space

Toggle item.

Toggle item.

N/A

Shift-Space

Extends selection
from last item.

Selects item.

N/A

Enter,
Ctrl-Enter,
Shift-Enter

Toggles open/close

Toggles open/close

Toggles open/close

Right / Left

Open/Close item.

Open/Close item.

Open/Close item.

Up / Down

Move focus box up/down.

Move focus box up/down.

N/A

Shift-Up / Shift-Down

Extend selection up/down.

Move focus up/down.

N/A

Home / End

Move to top/bottom of tree.

Move to top/bottom of tree.

Move to top/bottom of tree.

PageUp / PageDown

Page up/down.

Page up/down.

Page up/down.


Member Function Documentation

Fl_Tree_Item * Fl_Tree::add ( Fl_Tree_Item parent_item,
const char *  name 
)

Add a new child item labeled 'name' to the specified 'parent_item'.

Parameters:
[in] parent_item The parent item the new child item will be added to. Must not be NULL.
[in] name The label for the new item
Returns:
The new item added.
Version:
1.3.0 release
Fl_Tree_Item * Fl_Tree::add ( const char *  path,
Fl_Tree_Item item 
)

Adds a new item, given a menu style 'path'.

Any parent nodes that don't already exist are created automatically. Adds the item based on the value of sortorder(). If 'item' is NULL, a new item is created.

To specify items or submenus that contain slashes ('/' or '\') use an escape character to protect them, e.g.

     tree->add("/Holidays/Photos/12\\/25\\/2010");         // Adds item "12/25/2010"
     tree->add("/Pathnames/c:\\\\Program Files\\\\MyApp"); // Adds item "c:\Program Files\MyApp"
Parameters:
[in] path The path to the item, e.g. "Flintstone/Fred".
[in] item The new item to be added. If NULL, a new item is created with a name that is the last element in 'path'.
Returns:
The new item added, or 0 on error.
Version:
1.3.3
Fl_Tree_Item * Fl_Tree::add ( const char *  path  ) 

Adds a new item given a menu style 'path'.

Same as calling add(path, NULL);

Parameters:
[in] path The path to the item to be created, e.g. "Flintstone/Fred".
Returns:
The new item added, or 0 on error.
See also:
add(const char*,Fl_Tree_Item*)
Version:
1.3.0 release
Fl_Tree_Item * Fl_Tree::callback_item (  ) 

Gets the item that caused the callback.

The callback() can use this value to see which item changed.

void Fl_Tree::callback_item ( Fl_Tree_Item item  ) 

Sets the item that was changed for this callback.

Used internally to pass the item that invoked the callback.

Fl_Tree_Reason Fl_Tree::callback_reason (  )  const

Gets the reason for this callback.

The callback() can use this value to see why it was called. Example:

     void MyTreeCallback(Fl_Widget *w, void *userdata) {
         Fl_Tree *tree = (Fl_Tree*)w;
         Fl_Tree_Item *item = tree->callback_item();    // the item changed (can be NULL if more than one item was changed!)
         switch ( tree->callback_reason() ) {           // reason callback was invoked
             case     FL_TREE_REASON_OPENED: ..item was opened..
             case     FL_TREE_REASON_CLOSED: ..item was closed..
             case   FL_TREE_REASON_SELECTED: ..item was selected..
             case FL_TREE_REASON_RESELECTED: ..item was reselected (double-clicked, etc)..
             case FL_TREE_REASON_DESELECTED: ..item was deselected..
         }
     }
See also:
item_reselect_mode() -- enables FL_TREE_REASON_RESELECTED events
void Fl_Tree::callback_reason ( Fl_Tree_Reason  reason  ) 

Sets the reason for this callback.

Used internally to pass the reason the callback was invoked.

void Fl_Tree::clear (  ) 

Clear the entire tree's children, including the root.

The tree will be left completely empty.

Reimplemented from Fl_Group.

void Fl_Tree::clear_children ( Fl_Tree_Item item  ) 

Clear all the children for 'item'.

Item may not be NULL.

int Fl_Tree::close ( const char *  path,
int  docallback = 1 
)

Closes the item specified by 'path'.

Invokes the callback depending on the value of optional parameter 'docallback'.
Handles calling redraw() if anything changed.

Items or submenus that themselves contain slashes ('/' or '\') should be escaped, e.g. close("Holidays/12\\/25\\/2010").

The callback can use callback_item() and callback_reason() respectively to determine the item changed and the reason the callback was called.

Parameters:
[in] path -- the tree item's pathname (e.g. "Flintstones/Fred")
[in] docallback -- A flag that determines if the callback() is invoked or not:

Returns:
  • 1 -- OK: item closed
  • 0 -- OK: item was already closed, no change
  • -1 -- ERROR: item was not found
See also:
open(), close(), is_open(), is_close(), callback_item(), callback_reason()
int Fl_Tree::close ( Fl_Tree_Item item,
int  docallback = 1 
)

Closes the specified 'item'.

Invokes the callback depending on the value of optional parameter 'docallback'.
Handles calling redraw() if anything changed.

The callback can use callback_item() and callback_reason() respectively to determine the item changed and the reason the callback was called.

Parameters:
[in] item -- the item to be closed. Must not be NULL.
[in] docallback -- A flag that determines if the callback() is invoked or not:

Returns:
  • 1 -- item was closed
  • 0 -- item was already closed, no change
See also:
open(), close(), is_open(), is_close(), callback_item(), callback_reason()
void Fl_Tree::closeicon ( Fl_Image val  ) 

Sets the icon to be used as the 'close' icon.

This overrides the built in default '[-]' icon.

Parameters:
[in] val -- The new image, or zero to use the default [-] icon.
Fl_Image * Fl_Tree::closeicon (  )  const

Returns the icon to be used as the 'close' icon.

If none was set, the internal default is returned, a simple '[-]' icon.

void Fl_Tree::connectorstyle ( Fl_Tree_Connector  val  ) 

Sets the line drawing style for inter-connecting items.

See Fl_Tree_Connector for possible values.

int Fl_Tree::deselect ( const char *  path,
int  docallback = 1 
)

Deselect an item specified by 'path'.

Invokes the callback depending on the value of optional parameter 'docallback'.
Handles calling redraw() if anything changed.

Items or submenus that themselves contain slashes ('/' or '\') should be escaped, e.g. deselect("Holidays/12\\/25\\/2010").

The callback can use callback_item() and callback_reason() respectively to determine the item changed and the reason the callback was called.

Parameters:
[in] path -- the tree item's pathname (e.g. "Flintstones/Fred")
[in] docallback -- A flag that determines if the callback() is invoked or not:

Returns:
  • 1 - OK: item's state was changed
  • 0 - OK: item was already deselected, no change was made
  • -1 - ERROR: item was not found
int Fl_Tree::deselect ( Fl_Tree_Item item,
int  docallback = 1 
)

Deselect the specified item.

Invokes the callback depending on the value of optional parameter 'docallback'.
Handles calling redraw() if anything changed.

The callback can use callback_item() and callback_reason() respectively to determine the item changed and the reason the callback was called.

Parameters:
[in] item -- the item to be deselected. Must not be NULL.
[in] docallback -- A flag that determines if the callback() is invoked or not:

Returns:
  • 0 - item was already deselected, no change was made
  • 1 - item's state was changed
int Fl_Tree::deselect_all ( Fl_Tree_Item item = 0,
int  docallback = 1 
)

Deselect 'item' and all its children.

If item is NULL, first() is used.
Invokes the callback depending on the value of optional parameter 'docallback'.
Handles calling redraw() if anything changed.

The callback can use callback_item() and callback_reason() respectively to determine the item changed and the reason the callback was called.

Parameters:
[in] item The item that will be deselected (along with all its children). If NULL, first() is used.
[in] docallback -- A flag that determines if the callback() is invoked or not:

Returns:
Count of how many items were actually changed to the deselected state.
void Fl_Tree::display ( Fl_Tree_Item item  ) 

Displays 'item', scrolling the tree as necessary.

Parameters:
[in] item The item to be displayed. If NULL, first() is used.
int Fl_Tree::displayed ( Fl_Tree_Item item  ) 

See if 'item' is currently displayed on-screen (visible within the widget).

This can be used to detect if the item is scrolled off-screen. Checks to see if the item's vertical position is within the top and bottom edges of the display window. This does NOT take into account the hide() / show() or open() / close() status of the item.

Parameters:
[in] item The item to be checked. If NULL, first() is used.
Returns:
1 if displayed, 0 if scrolled off screen or no items are in tree.
void Fl_Tree::extend_selection ( Fl_Tree_Item from,
Fl_Tree_Item to 
) [protected]

Extend a selection between 'from' and 'to'.

Extends selection for items and all children, visible ('open') or not. Walks entire tree from top to bottom looking for 'from' and 'to'.

Version:
1.3.0
int Fl_Tree::extend_selection_dir ( Fl_Tree_Item from,
Fl_Tree_Item to,
int  dir,
int  val,
bool  visible 
)

Extend the selection between and including 'from' and 'to' depending on direction 'dir', 'val', and 'visible'.

Efficient: does not walk entire tree; starts with 'from' and stops at 'to' while moving in direction 'dir'. Dir must be specified though. Handles calling redraw() if anything changed.

Parameters:
[in] from Starting item
[in] to Ending item
[in] dir Direction to extend selection (FL_Up or FL_Down)
[in] val 0=deselect, 1=select, 2=toggle
[in] visible true=affect only open(), visible items,
false=affect open or closed items (default)
Returns:
The number of items whose selection states were changed, if any.
Version:
1.3.3
Fl_Tree_Item * Fl_Tree::find_clicked (  ) 

Non-const version of Fl_Tree::find_clicked() const.

Version:
1.3.0
const Fl_Tree_Item * Fl_Tree::find_clicked (  )  const

Find the item that was last clicked on.

You should use callback_item() instead, which is fast, and is meant to be used within a callback to determine the item clicked.

This method walks the entire tree looking for the first item that is under the mouse, i.e. at Fl::event_x() / Fl::event_y().

Use this method /only/ if you've subclassed Fl_Tree, and are receiving events before Fl_Tree has been able to process and update callback_item().

Returns:
The item clicked, or NULL if no item was under the current event.
Version:
1.3.0
const Fl_Tree_Item * Fl_Tree::find_item ( const char *  path  )  const

Find the item, given a menu style path, e.g.

"/Parent/Child/item". There is both a const and non-const version of this method. Const version allows pure const methods to use this method to do lookups without causing compiler errors.

To specify items or submenus that contain slashes ('/' or '\') use an escape character to protect them, e.g.

     tree->add("/Holidays/Photos/12\\/25\\/2010");         // Adds item "12/25/2010"
     tree->add("/Pathnames/c:\\\\Program Files\\\\MyApp"); // Adds item "c:\Program Files\MyApp"
Parameters:
[in] path -- the tree item's pathname to be found (e.g. "Flintstones/Fred")
Returns:
The item, or NULL if not found.
See also:
item_pathname()
Fl_Tree_Item * Fl_Tree::first (  ) 

Returns the first item in the tree, or 0 if none.

Use this to walk the tree in the forward direction, e.g.

 for ( Fl_Tree_Item *item = tree->first(); item; item = tree->next(item) )
     printf("Item: %s\n", item->label());
Returns:
First item in tree, or 0 if none (tree empty).
See also:
first(), next(), last(), prev()
Fl_Tree_Item * Fl_Tree::first_selected_item (  ) 

Returns the first selected item in the tree.

Use this to walk the tree from top to bottom looking for all the selected items, e.g.

 // Walk tree forward, from top to bottom
 for ( Fl_Tree_Item *i=tree->first_selected_item(); i; i=tree->next_selected_item(i) )
     printf("Selected item: %s\n", i->label());
Returns:
The first selected item, or 0 if none.
See also:
first_selected_item(), last_selected_item(), next_selected_item()
Fl_Tree_Item * Fl_Tree::first_visible (  ) 

Returns the first open(), visible item in the tree, or 0 if none.

Deprecated:
in 1.3.3 ABI -- use first_visible_item() instead.
Fl_Tree_Item * Fl_Tree::first_visible_item (  ) 

Returns the first open(), visible item in the tree, or 0 if none.

Returns:
First visible item in tree, or 0 if none.
See also:
first_visible_item(), last_visible_item(), next_visible_item()
Version:
1.3.3
int Fl_Tree::handle ( int  e  )  [virtual]

Standard FLTK event handler for this widget.

Todo:
add Fl_Widget_Tracker (see Fl_Browser_.cxx::handle())

Reimplemented from Fl_Group.

void Fl_Tree::hposition ( int  pos  ) 

Sets the horizontal scroll offset to position 'pos'.

The position is how many pixels of the tree are scrolled off the left edge of the screen.

Parameters:
[in] pos The vertical position (in pixels) to scroll the tree to.
See also:
hposition(), vposition(), vposition(int)
Note:
Must be using FLTK ABI 1.3.3 or higher for this to be effective.
int Fl_Tree::hposition (  )  const

Returns the horizontal scroll position as a pixel offset.

The position returned is how many pixels of the tree are scrolled off the left edge of the screen.

See also:
hposition(int), vposition(), vposition(int)
Note:
Must be using FLTK ABI 1.3.3 or higher for this to be effective.
Fl_Tree_Item * Fl_Tree::insert ( Fl_Tree_Item item,
const char *  name,
int  pos 
)

Insert a new item 'name' into 'item's children at position 'pos'.

If pos is out of range the new item is

  • prepended if pos < 0 or
  • appended if pos > item->children().

Note: pos == children() is not considered out of range: the item is appended to the child list. Example:

 tree->add("Aaa/000");       // "000" is index 0 in Aaa's children
 tree->add("Aaa/111");       // "111" is index 1 in Aaa's children
 tree->add("Aaa/222");       // "222" is index 2 in Aaa's children
 ..
 // How to use insert() to insert a new item between Aaa/111 + Aaa/222
 Fl_Tree_Item *item = tree->find_item("Aaa");  // get parent item Aaa
 if (item) tree->insert(item, "New item", 2);  // insert as a child of Aaa at index #2
Parameters:
[in] item The existing item to insert new child into. Must not be NULL.
[in] name The label for the new item
[in] pos The position of the new item in the child list
Returns:
The new item added.
See also:
insert_above()
Fl_Tree_Item * Fl_Tree::insert_above ( Fl_Tree_Item above,
const char *  name 
)

Inserts a new item 'name' above the specified Fl_Tree_Item 'above'.

Example:

 tree->add("Aaa/000");       // "000" is index 0 in Aaa's children
 tree->add("Aaa/111");       // "111" is index 1 in Aaa's children
 tree->add("Aaa/222");       // "222" is index 2 in Aaa's children
 ..
 // How to use insert_above() to insert a new item above Aaa/222
 Fl_Tree_Item *item = tree->find_item("Aaa/222");  // get item Aaa/222
 if (item) tree->insert_above(item, "New item");   // insert new item above it
Parameters:
[in] above -- the item above which to insert the new item. Must not be NULL.
[in] name -- the name of the new item
Returns:
The new item added, or 0 if 'above' could not be found.
See also:
insert()
int Fl_Tree::is_close ( const char *  path  )  const

See if item specified by 'path' is closed.

Items or submenus that themselves contain slashes ('/' or '\') should be escaped, e.g. is_close("Holidays/12\\/25\\/2010").

Parameters:
[in] path -- the tree item's pathname (e.g. "Flintstones/Fred")
Returns:
  • 1 - OK: item is closed
  • 0 - OK: item is open
  • -1 - ERROR: item was not found
int Fl_Tree::is_close ( Fl_Tree_Item item  )  const

See if the specified 'item' is closed.

Parameters:
[in] item -- the item to be tested. Must not be NULL.
Returns:
  • 1 : item is closed
  • 0 : item is open
int Fl_Tree::is_hscroll_visible (  )  const

See if the horizontal scrollbar is currently visible.

Returns:
1 if scrollbar visible, 0 if not.
Note:
Must be using FLTK ABI 1.3.3 or higher for this to be effective.
int Fl_Tree::is_open ( const char *  path  )  const

See if item specified by 'path' is open.

Items or submenus that themselves contain slashes ('/' or '\') should be escaped, e.g. is_open("Holidays/12\\/25\\/2010").

Items that are 'open' are themselves not necessarily visible; one of the item's parents might be closed.

Parameters:
[in] path -- the tree item's pathname (e.g. "Flintstones/Fred")
Returns:
  • 1 - OK: item is open
  • 0 - OK: item is closed
  • -1 - ERROR: item was not found
See also:
Fl_Tree_Item::visible_r()
int Fl_Tree::is_open ( Fl_Tree_Item item  )  const

See if 'item' is open.

Items that are 'open' are themselves not necessarily visible; one of the item's parents might be closed.

Parameters:
[in] item -- the item to be tested. Must not be NULL.
Returns:
  • 1 : item is open
  • 0 : item is closed
int Fl_Tree::is_scrollbar ( Fl_Widget w  ) 

See if widget 'w' is one of the Fl_Tree widget's scrollbars.

Use this to skip over the scrollbars when walking the child() array. Example:

 for ( int i=0; i<tree->children(); i++ ) {    // walk children
     Fl_Widget *w = tree->child(i);
     if ( tree->is_scrollbar(w) ) continue;    // skip scrollbars
     ..do work here..
 }
Parameters:
[in] w Widget to test
Returns:
1 if w is a scrollbar, 0 if not.
Todo:
should be const
int Fl_Tree::is_selected ( const char *  path  ) 

See if item specified by 'path' is selected.

Items or submenus that themselves contain slashes ('/' or '\') should be escaped, e.g. is_selected("Holidays/12\\/25\\/2010").

Parameters:
[in] path -- the tree item's pathname (e.g. "Flintstones/Fred")
Returns:
  • 1 : item selected
  • 0 : item deselected
  • -1 : item was not found
int Fl_Tree::is_selected ( Fl_Tree_Item item  )  const

See if the specified 'item' is selected.

Parameters:
[in] item -- the item to be tested. Must not be NULL.
Returns:
  • 1 : item selected
  • 0 : item deselected
int Fl_Tree::is_vscroll_visible (  )  const

See if the vertical scrollbar is currently visible.

Returns:
1 if scrollbar visible, 0 if not.
Fl_Tree_Item * Fl_Tree::item_clicked (  ) 

Return the item that was last clicked.

Valid only from within the callback().

Returns:
The item clicked, or 0 if none. 0 may also be used to indicate several items were clicked/changed.
Deprecated:
in 1.3.3 ABI -- use callback_item() instead.
void Fl_Tree::item_clicked ( Fl_Tree_Item item  )  [protected]

Set the item that was last clicked.

Should only be used by subclasses needing to change this value. Normally Fl_Tree manages this value.

Deprecated:
in 1.3.3 ABI -- use callback_item() instead.
void Fl_Tree::item_labelbgcolor ( Fl_Color  val  ) 

Set the default label background color used for creating new items.

A special case is made for color 0xffffffff (default) which is treated as 'transparent'. To change the background color on a per-item basis, use Fl_Tree_Item::labelbgcolor(Fl_Color)

Fl_Color Fl_Tree::item_labelbgcolor ( void   )  const

Get the default label background color used for creating new items.

If the color is 0xffffffff, it is 'transparent'.

void Fl_Tree::item_labelfgcolor ( Fl_Color  val  ) 

Set the default label foreground color used for creating new items.

To change the foreground color on a per-item basis, use Fl_Tree_Item::labelfgcolor(Fl_Color)

void Fl_Tree::item_labelfont ( Fl_Font  val  ) 

Set the default font face used for creating new items.

To change the font face on a per-item basis, use Fl_Tree_Item::labelfont(Fl_Font)

void Fl_Tree::item_labelsize ( Fl_Fontsize  val  ) 

Set the default label font size used for creating new items.

To change the font size on a per-item basis, use Fl_Tree_Item::labelsize(Fl_Fontsize)

int Fl_Tree::item_pathname ( char *  pathname,
int  pathnamelen,
const Fl_Tree_Item item 
) const

Return 'pathname' of size 'pathnamelen' for the specified 'item'.

If 'item' is NULL, root() is used.
The tree's root will be included in the pathname if showroot() is on.
Menu items or submenus that contain slashes ('/' or '\') in their names will be escaped with a backslash. This is symmetrical with the add() function which uses the same escape pattern to set names.

Parameters:
[out] pathname The string to use to return the pathname
[in] pathnamelen The maximum length of the string (including NULL). Must not be zero.
[in] item The item whose pathname is to be returned.
Returns:
  • 0 : OK (pathname returns the item's pathname)
  • -1 : item not found (pathname="")
  • -2 : pathname not large enough (pathname="")
See also:
find_item()
void Fl_Tree::labelmarginleft ( int  val  ) 

Set the amount of white space (in pixels) that should appear to the left of the label text.

int Fl_Tree::labelmarginleft (  )  const

Get the amount of white space (in pixels) that should appear to the left of the label text.

Fl_Tree_Item * Fl_Tree::last (  ) 

Returns the last item in the tree.

This can be used to walk the tree in reverse, e.g.

 for ( Fl_Tree_Item *item = tree->last(); item; item = tree->prev() )
     printf("Item: %s\n", item->label());
Returns:
Last item in the tree, or 0 if none (tree empty).
See also:
first(), next(), last(), prev()
Fl_Tree_Item * Fl_Tree::last_selected_item (  ) 

Returns the last selected item in the tree.

Use this to walk the tree in reverse from bottom to top looking for all the selected items, e.g.

 // Walk tree in reverse, from bottom to top
 for ( Fl_Tree_Item *i=tree->last_selected_item(); i; i=tree->next_selected_item(i, FL_Up) )
     printf("Selected item: %s\n", i->label());
Returns:
The last selected item, or 0 if none.
See also:
first_selected_item(), last_selected_item(), next_selected_item()
Version:
1.3.3
Fl_Tree_Item * Fl_Tree::last_visible (  ) 

Returns the last open(), visible item in the tree.

Deprecated:
in 1.3.3 -- use last_visible_item() instead.
Fl_Tree_Item * Fl_Tree::last_visible_item (  ) 

Returns the last open(), visible item in the tree.

Returns:
Last visible item in the tree, or 0 if none.
See also:
first_visible_item(), last_visible_item(), next_visible_item()
Version:
1.3.3
void Fl_Tree::load ( class Fl_Preferences prefs  ) 

Load FLTK preferences.

Read a preferences database into the tree widget.

A preferences database is a hierarchical collection of data which can be directly loaded into the tree view for inspection.

Parameters:
[in] prefs the Fl_Preferences database
Fl_Tree_Item * Fl_Tree::next ( Fl_Tree_Item item = 0  ) 

Return the next item after 'item', or 0 if no more items.

Use this code to walk the entire tree:

 for ( Fl_Tree_Item *i = tree->first(); i; i = tree->next(i) )
     printf("Item: %s\n", i->label());
Parameters:
[in] item The item to use to find the next item. If NULL, returns 0.
Returns:
Next item in tree, or 0 if at last item.
See also:
first(), next(), last(), prev()
Fl_Tree_Item * Fl_Tree::next_item ( Fl_Tree_Item item,
int  dir = FL_Down,
bool  visible = false 
)

Returns next item after 'item' in direction 'dir' depending on 'visible'.

Next item will be above (if dir==FL_Up) or below (if dir==FL_Down). If 'visible' is true, only items whose parents are open() will be returned. If 'visible' is false, even items whose parents are close()ed will be returned.

If item is 0, the return value will be the result of this truth table:

                           visible=true           visible=false
                           -------------------    -------------
             dir=FL_Up:    last_visible_item()    last()
           dir=FL_Down:    first_visible_item()   first()
    
Example use:
 // Walk down the tree showing open(), visible items
 for ( Fl_Tree_Item *i=tree->first_visible_item(); i; i=tree->next_item(i, FL_Down, true) )
     printf("Item: %s\n", i->label());

 // Walk up the tree showing open(), visible items
 for ( Fl_Tree_Item *i=tree->last_visible_item(); i; i=tree->next_item(i, FL_Up, true) )
     printf("Item: %s\n", i->label());

 // Walk down the tree showing all items (open or closed)
 for ( Fl_Tree_Item *i=tree->first(); i; i=tree->next_item(i, FL_Down, false) )
     printf("Item: %s\n", i->label());

 // Walk up the tree showing all items (open or closed)
 for ( Fl_Tree_Item *i=tree->last(); i; i=tree->next_item(i, FL_Up, false) )
     printf("Item: %s\n", i->label());
Parameters:
[in] item The item to use to find the next item. If NULL, returns 0.
[in] dir Can be FL_Up or FL_Down (default=FL_Down or 'next')
[in] visible true=return only open(), visible items,
false=return open or closed items (default)
Returns:
Next item in tree in the direction and visibility specified, or 0 if no more items of specified visibility in that direction.
See also:
first(), last(), next(),
first_visible_item(), last_visible_item(), next_visible_item(),
first_selected_item(), last_selected_item(), next_selected_item()
Version:
1.3.3
Fl_Tree_Item * Fl_Tree::next_selected_item ( Fl_Tree_Item item,
int  dir 
)

Returns the next selected item above or below 'item', depending on 'dir'.

If 'item' is 0, search starts at either first() or last(), depending on 'dir': first() if 'dir' is FL_Down (default), last() if 'dir' is FL_Up.

Use this to walk the tree looking for all the selected items, e.g.

 // Walk down the tree (forwards)
 for ( Fl_Tree_Item *i=tree->first_selected_item(); i; i=tree->next_selected_item(i, FL_Down) )
     printf("Item: %s\n", i->label());

 // Walk up the tree (backwards)
 for ( Fl_Tree_Item *i=tree->last_selected_item(); i; i=tree->next_selected_item(i, FL_Up) )
     printf("Item: %s\n", i->label());
Parameters:
[in] item The item above or below which we'll find the next selected item. If NULL, first() is used if FL_Down, last() if FL_Up. (default=NULL)
[in] dir The direction to go. FL_Up for moving up the tree, FL_Down for down the tree (default)
Returns:
The next selected item, or 0 if there are no more selected items.
See also:
first_selected_item(), last_selected_item(), next_selected_item()
Version:
1.3.3
Fl_Tree_Item * Fl_Tree::next_selected_item ( Fl_Tree_Item item = 0  ) 

Returns the next selected item after 'item'.

If item is 0, search starts at the first item (root).

This is a convenience method; equivalent to next_selected_item(item, FL_Down);

Use this to walk the tree forward (downward) looking for all the selected items, e.g.

 for ( Fl_Tree_Item *i = tree->first_selected_item(); i; i = tree->next_selected_item(i) )
     printf("Selected item: %s\n", i->label());
Parameters:
[in] item The item to use to find the next selected item. If NULL, first() is used.
Returns:
The next selected item, or 0 if there are no more selected items.
See also:
first_selected_item(), last_selected_item(), next_selected_item()
Fl_Tree_Item * Fl_Tree::next_visible_item ( Fl_Tree_Item item,
int  dir 
) [protected]

Returns next open(), visible item above (dir==FL_Up) or below (dir==FL_Down) the specified 'item', or 0 if no more items.

If 'item' is 0, returns last() if 'dir' is FL_Up, or first() if dir is FL_Down.

 // Walk down the tree (forwards)
 for ( Fl_Tree_Item *i=tree->first_visible_item(); i; i=tree->next_visible_item(i, FL_Down) )
     printf("Item: %s\n", i->label());

 // Walk up the tree (backwards)
 for ( Fl_Tree_Item *i=tree->last_visible_item(); i; i=tree->next_visible_item(i, FL_Up) )
     printf("Item: %s\n", i->label());
Parameters:
[in] item The item above/below which we'll find the next visible item
[in] dir The direction to search. Can be FL_Up or FL_Down.
Returns:
The item found, or 0 if there's no visible items above/below the specified item.
Version:
1.3.3
int Fl_Tree::open ( const char *  path,
int  docallback = 1 
)

Opens the item specified by 'path'.

This causes the item's children (if any) to be shown.
Invokes the callback depending on the value of optional parameter 'docallback'.
Handles calling redraw() if anything changed.

Items or submenus that themselves contain slashes ('/' or '\') should be escaped, e.g. open("Holidays/12\\/25\\/2010").

The callback can use callback_item() and callback_reason() respectively to determine the item changed and the reason the callback was called.

Parameters:
[in] path -- the tree item's pathname (e.g. "Flintstones/Fred")
[in] docallback -- A flag that determines if the callback() is invoked or not:

Returns:
  • 1 -- OK: item opened
  • 0 -- OK: item was already open, no change
  • -1 -- ERROR: item was not found
See also:
open(), close(), is_open(), is_close(), callback_item(), callback_reason()
int Fl_Tree::open ( Fl_Tree_Item item,
int  docallback = 1 
)

Open the specified 'item'.

This causes the item's children (if any) to be shown.
Invokes the callback depending on the value of optional parameter 'docallback'.
Handles calling redraw() if anything changed.

The callback can use callback_item() and callback_reason() respectively to determine the item changed and the reason the callback was called.

Parameters:
[in] item -- the item to be opened. Must not be NULL.
[in] docallback -- A flag that determines if the callback() is invoked or not:

Returns:
  • 1 -- item was opened
  • 0 -- item was already open, no change
See also:
open(), close(), is_open(), is_close(), callback_item(), callback_reason()
void Fl_Tree::open_toggle ( Fl_Tree_Item item,
int  docallback = 1 
)

Toggle the open state of 'item'.

Invokes the callback depending on the value of optional parameter 'docallback'.
Handles calling redraw() if anything changed.

The callback can use callback_item() and callback_reason() respectively to determine the item changed and the reason the callback was called.

Parameters:
[in] item -- the item whose open state is to be toggled. Must not be NULL.
[in] docallback -- A flag that determines if the callback() is invoked or not:

See also:
open(), close(), is_open(), is_close(), callback_item(), callback_reason()
void Fl_Tree::openicon ( Fl_Image val  ) 

Sets the icon to be used as the 'open' icon.

This overrides the built in default '[+]' icon.

Parameters:
[in] val -- The new image, or zero to use the default [+] icon.
Fl_Image * Fl_Tree::openicon (  )  const

Returns the icon to be used as the 'open' icon.

If none was set, the internal default is returned, a simple '[+]' icon.

Fl_Tree_Item * Fl_Tree::prev ( Fl_Tree_Item item = 0  ) 

Return the previous item before 'item', or 0 if no more items.

This can be used to walk the tree in reverse, e.g.

 for ( Fl_Tree_Item *item = tree->first(); item; item = tree->prev(item) )
     printf("Item: %s\n", item->label());
Parameters:
[in] item The item to use to find the previous item. If NULL, returns 0.
Returns:
Previous item in tree, or 0 if at first item.
See also:
first(), next(), last(), prev()
void Fl_Tree::recalc_tree (  ) 

Schedule tree to recalc the entire tree size.

Note:
Must be using FLTK ABI 1.3.3 or higher for this to be effective.
int Fl_Tree::remove ( Fl_Tree_Item item  ) 

Remove the specified 'item' from the tree.

item may not be NULL. If it has children, all those are removed too. If item being removed has focus, no item will have focus.

Returns:
0 if done, -1 if 'item' not found.
void Fl_Tree::resize ( int  X,
int  Y,
int  W,
int  H 
) [virtual]

Resizes the Fl_Group widget and all of its children.

The Fl_Group widget first resizes itself, and then it moves and resizes all its children according to the rules documented for Fl_Group::resizable(Fl_Widget*)

See also:
Fl_Group::resizable(Fl_Widget*)
Fl_Group::resizable()
Fl_Widget::resize(int,int,int,int)

Reimplemented from Fl_Group.

void Fl_Tree::root ( Fl_Tree_Item newitem  ) 

Sets the root item to 'newitem'.

If a root item already exists, clear() is called first to clear it before replacing it with newitem.

Version:
1.3.3
void Fl_Tree::root_label ( const char *  new_label  ) 

Set the label for the root item to 'new_label'.

Makes an internally managed copy of 'new_label'.

void Fl_Tree::scrollbar_size ( int  size  ) 

Sets the pixel size of the scrollbars' troughs to 'size' for this widget, in pixels.

Normally you should not need this method, and should use the global Fl::scrollbar_size(int) instead to manage the size of ALL your widgets' scrollbars. This ensures your application has a consistent UI, and is the default behavior. Normally this is what you want.

Only use this method if you really need to override just THIS instance of the widget's scrollbar size. (This need should be rare.)

Setting size to the special value of 0 causes the widget to track the global Fl::scrollbar_size(), which is the default.

Parameters:
[in] size Sets the scrollbar size in pixels.
If 0 (default), scrollbar size tracks the global Fl::scrollbar_size()
See also:
Fl::scrollbar_size()
int Fl_Tree::scrollbar_size (  )  const

Gets the default size of scrollbars' troughs for this widget in pixels.

If this value is zero (default), this widget will use the global Fl::scrollbar_size() value as the scrollbar's width.

Returns:
Scrollbar size in pixels, or 0 if the global Fl::scrollbar_size() is being used.
See also:
Fl::scrollbar_size(int)
int Fl_Tree::select ( const char *  path,
int  docallback = 1 
)

Select the item specified by 'path'.

Invokes the callback depending on the value of optional parameter 'docallback'.
Handles calling redraw() if anything changed.

Items or submenus that themselves contain slashes ('/' or '\') should be escaped, e.g. select("Holidays/12\\/25\\/2010").

The callback can use callback_item() and callback_reason() respectively to determine the item changed and the reason the callback was called.

Parameters:
[in] path -- the tree item's pathname (e.g. "Flintstones/Fred")
[in] docallback -- A flag that determines if the callback() is invoked or not:

Returns:
  • 1 : OK: item's state was changed
  • 0 : OK: item was already selected, no change was made
  • -1 : ERROR: item was not found
int Fl_Tree::select ( Fl_Tree_Item item,
int  docallback = 1 
)

Select the specified 'item'.

Use 'deselect()' to deselect it.

Invokes the callback depending on the value of optional parameter docallback.
Handles calling redraw() if anything changed.

The callback can use callback_item() and callback_reason() respectively to determine the item changed and the reason the callback was called.

Parameters:
[in] item -- the item to be selected. Must not be NULL.
[in] docallback -- A flag that determines if the callback() is invoked or not:

Returns:
  • 1 - item's state was changed
  • 0 - item was already selected, no change was made
int Fl_Tree::select_all ( Fl_Tree_Item item = 0,
int  docallback = 1 
)

Select 'item' and all its children.

If item is NULL, first() is used.
Invokes the callback depending on the value of optional parameter 'docallback'.
Handles calling redraw() if anything changed.

The callback can use callback_item() and callback_reason() respectively to determine the item changed and the reason the callback was called.

Parameters:
[in] item The item that will be selected (along with all its children). If NULL, first() is used.
[in] docallback -- A flag that determines if the callback() is invoked or not:

Returns:
Count of how many items were actually changed to the selected state.
int Fl_Tree::select_only ( Fl_Tree_Item selitem,
int  docallback = 1 
)

Select only the specified item, deselecting all others that might be selected.

If 'selitem' is 0, first() is used.
Invokes the callback depending on the value of optional parameter 'docallback'.
Handles calling redraw() if anything changed.

The callback can use callback_item() and callback_reason() respectively to determine the item changed and the reason the callback was called.

Parameters:
[in] selitem The item to be selected. If NULL, first() is used.
[in] docallback -- A flag that determines if the callback() is invoked or not:

  • 0 - the callback() is not invoked
  • 1 - the callback() is invoked for each item that changed state (default), callback_reason() will be either FL_TREE_REASON_SELECTED or FL_TREE_REASON_DESELECTED
Returns:
The number of items whose selection states were changed, if any.
void Fl_Tree::select_toggle ( Fl_Tree_Item item,
int  docallback = 1 
)

Toggle the select state of the specified 'item'.

Invokes the callback depending on the value of optional parameter 'docallback'.
Handles calling redraw() if anything changed.

The callback can use callback_item() and callback_reason() respectively to determine the item changed and the reason the callback was called.

Parameters:
[in] item -- the item to be selected. Must not be NULL.
[in] docallback -- A flag that determines if the callback() is invoked or not:

void Fl_Tree::selectbox ( Fl_Boxtype  val  ) 

Gets the style of box used to draw selected items.

This is an fltk Fl_Boxtype. The default is influenced by FLTK's current Fl::scheme()

Fl_Boxtype Fl_Tree::selectbox (  )  const

Sets the style of box used to draw selected items.

This is an fltk Fl_Boxtype. The default is influenced by FLTK's current Fl::scheme()

void Fl_Tree::selectmode ( Fl_Tree_Select  val  ) 

Sets the tree's selection mode.

See Fl_Tree_Select for possible values.

Fl_Tree_Select Fl_Tree::selectmode (  )  const

Gets the tree's current selection mode.

See Fl_Tree_Select for possible values.

void Fl_Tree::set_item_focus ( Fl_Tree_Item item  ) 

Set the item that currently should have keyboard focus.

Handles calling redraw() to update the focus box (if it is visible).

Parameters:
[in] item The item that should take focus. If NULL, none will have focus.
void Fl_Tree::show_item ( Fl_Tree_Item item  ) 

Adjust the vertical scrollbar to show 'item' at the top of the display IF it is currently off-screen (for instance show_item_top()).

If it is already on-screen, no change is made.

Parameters:
[in] item The item to be shown. If NULL, first() is used.
See also:
show_item_top(), show_item_middle(), show_item_bottom()
void Fl_Tree::show_item ( Fl_Tree_Item item,
int  yoff 
)

Adjust the vertical scrollbar so that 'item' is visible 'yoff' pixels from the top of the Fl_Tree widget's display.

For instance, yoff=0 will position the item at the top.

If yoff is larger than the vertical scrollbar's limit, the value will be clipped. So if yoff=100, but scrollbar's max is 50, then 50 will be used.

Parameters:
[in] item The item to be shown. If NULL, first() is used.
[in] yoff The pixel offset from the top for the displayed position.
See also:
show_item_top(), show_item_middle(), show_item_bottom()
void Fl_Tree::show_item_bottom ( Fl_Tree_Item item  ) 

Adjust the vertical scrollbar so that 'item' is at the bottom of the display.

Parameters:
[in] item The item to be shown. If NULL, first() is used.
void Fl_Tree::show_item_middle ( Fl_Tree_Item item  ) 

Adjust the vertical scrollbar so that 'item' is in the middle of the display.

Parameters:
[in] item The item to be shown. If NULL, first() is used.
void Fl_Tree::show_item_top ( Fl_Tree_Item item  ) 

Adjust the vertical scrollbar so that 'item' is at the top of the display.

Parameters:
[in] item The item to be shown. If NULL, first() is used.
void Fl_Tree::show_self (  ) 

Print the tree as 'ascii art' to stdout.

Used mainly for debugging.

Todo:
should be const
Version:
1.3.0
void Fl_Tree::showcollapse ( int  val  ) 

Set if we should show the collapse icon or not.

If collapse icons are disabled, the user will not be able to interactively collapse items in the tree, unless the application provides some other means via open() and close().

Parameters:
[in] val 1: shows collapse icons (default),
0: hides collapse icons.
int Fl_Tree::showcollapse (  )  const

Returns 1 if the collapse icon is enabled, 0 if not.

See also:
showcollapse(int)
void Fl_Tree::showroot ( int  val  ) 

Set if the root item should be shown or not.

Parameters:
[in] val 1 -- show the root item (default)
0 -- hide the root item.
Fl_Tree_Sort Fl_Tree::sortorder (  )  const

Set the default sort order used when items are added to the tree.

See Fl_Tree_Sort for possible values.

void Fl_Tree::usericon ( Fl_Image val  ) 

Sets the Fl_Image to be used as the default user icon for all newly created items.

If you want to specify user icons on a per-item basis, use Fl_Tree_Item::usericon() instead.

Parameters:
[in] val -- The new image to be used, or zero to disable user icons.
Fl_Image * Fl_Tree::usericon (  )  const

Returns the Fl_Image being used as the default user icon for all newly created items.

Returns zero if no icon has been set, which is the default.

void Fl_Tree::usericonmarginleft ( int  val  ) 

Set the amount of white space (in pixels) that should appear to the left of the usericon.

int Fl_Tree::usericonmarginleft (  )  const

Get the amount of white space (in pixels) that should appear to the left of the usericon.

void Fl_Tree::vposition ( int  pos  ) 

Sets the vertical scroll offset to position 'pos'.

The position is how many pixels of the tree are scrolled off the top edge of the screen.

Parameters:
[in] pos The vertical position (in pixels) to scroll the tree to.
See also:
vposition(), hposition(), hposition(int)
int Fl_Tree::vposition (  )  const

Returns the vertical scroll position as a pixel offset.

The position returned is how many pixels of the tree are scrolled off the top edge of the screen.

See also:
vposition(int), hposition(), hposition(int)

The documentation for this class was generated from the following files: