Fl_Tree.H

Go to the documentation of this file.

//
// "$Id$"
//
 
#ifndef FL_TREE_H
#define FL_TREE_H
 
#include <FL/Fl.H>
#include <FL/Fl_Group.H>
#include <FL/Fl_Scrollbar.H>
#include <FL/fl_draw.H>
 
#include <FL/Fl_Tree_Item.H>
#include <FL/Fl_Tree_Prefs.H>
 
// FL/Fl_Tree.H
//
// 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
//
 
 
 
enum Fl_Tree_Reason {
  FL_TREE_REASON_NONE=0,        
  FL_TREE_REASON_SELECTED,      
  FL_TREE_REASON_DESELECTED,    
#if FLTK_ABI_VERSION >= 10301
  FL_TREE_REASON_RESELECTED,    
#endif /*FLTK_ABI_VERSION*/
  FL_TREE_REASON_OPENED,        
  FL_TREE_REASON_CLOSED,        
  FL_TREE_REASON_DRAGGED        
};
 
class FL_EXPORT Fl_Tree : public Fl_Group {
  friend class Fl_Tree_Item;
  Fl_Tree_Item  *_root;                         // can be null!
  Fl_Tree_Item  *_item_focus;                   // item that has focus box
  Fl_Tree_Item  *_callback_item;                // item invoked during callback (can be NULL)
  Fl_Tree_Reason _callback_reason;              // reason for the callback
  Fl_Tree_Prefs  _prefs;                        // all the tree's settings
  int            _scrollbar_size;               // size of scrollbar trough
#if FLTK_ABI_VERSION >= 10301
  // NEW: 
  Fl_Tree_Item *_lastselect;                    // used to extend selections
#else /*FLTK_ABI_VERSION*/
  // OLD: static data inside handle() method
#endif /*FLTK_ABI_VERSION*/
  void fix_scrollbar_order();
 
protected:
  Fl_Scrollbar *_vscroll;       
#if FLTK_ABI_VERSION >= 10303
  Fl_Scrollbar *_hscroll;       
  int _tox,_toy,_tow,_toh;      
  int _tix,_tiy,_tiw,_tih;      
 
  int _tree_w;
  int _tree_h;
#endif
  void item_clicked(Fl_Tree_Item* val);
  void do_callback_for_item(Fl_Tree_Item* item, Fl_Tree_Reason reason);
#if FLTK_ABI_VERSION >= 10303
// next_visible_item() and extend_selection() moved to 'public' in ABI 1.3.3
// undocmented draw_tree() dropped -- draw() does all the work now
#else
  Fl_Tree_Item *next_visible_item(Fl_Tree_Item *start, int dir);
  void extend_selection(Fl_Tree_Item *from, Fl_Tree_Item *to);
  int draw_tree();
#endif
 
public:
  Fl_Tree(int X, int Y, int W, int H, const char *L=0);
  ~Fl_Tree();
  int handle(int e);
  void draw();
  void show_self();
  void resize(int,int,int,int);
 
  // root methods
  void root_label(const char *new_label);
  Fl_Tree_Item* root();
  void root(Fl_Tree_Item *newitem);
  const Fl_Tree_Prefs& prefs() const { return _prefs; }
 
  // Item creation/removal methods
#if FLTK_ABI_VERSION >= 10303
  Fl_Tree_Item *add(const char *path, Fl_Tree_Item *newitem=0);
#else
  Fl_Tree_Item *add(const char *path);
  Fl_Tree_Item *add(const char *path, Fl_Tree_Item *newitem);
#endif
  Fl_Tree_Item* add(Fl_Tree_Item *parent_item, const char *name);
  Fl_Tree_Item *insert_above(Fl_Tree_Item *above, const char *name);
  Fl_Tree_Item* insert(Fl_Tree_Item *item, const char *name, int pos);
  int remove(Fl_Tree_Item *item);
  void clear();
  void clear_children(Fl_Tree_Item *item);
 
  // Item lookup methods
  Fl_Tree_Item *find_item(const char *path);
  const Fl_Tree_Item *find_item(const char *path) const;
  int item_pathname(char *pathname, int pathnamelen, const Fl_Tree_Item *item) const;
#if FLTK_ABI_VERSION >= 10303
  const Fl_Tree_Item* find_clicked(int yonly=0) const;
  Fl_Tree_Item* find_clicked(int yonly=0);
#else
  const Fl_Tree_Item *find_clicked() const;
  Fl_Tree_Item *find_clicked();
#endif
  Fl_Tree_Item *item_clicked();
  Fl_Tree_Item *first();
  Fl_Tree_Item *first_visible();                // deprecated in ABI 10303
  Fl_Tree_Item *first_visible_item();
  Fl_Tree_Item *next(Fl_Tree_Item *item=0);
  Fl_Tree_Item *prev(Fl_Tree_Item *item=0);
  Fl_Tree_Item *last();
  Fl_Tree_Item *last_visible();                 // deprecated in ABI 10303
  Fl_Tree_Item *last_visible_item();
#if FLTK_ABI_VERSION >= 10303
  Fl_Tree_Item *next_visible_item(Fl_Tree_Item *start, int dir);        // made public in 1.3.3 ABI
#endif
  Fl_Tree_Item *first_selected_item();
  Fl_Tree_Item *last_selected_item();
  Fl_Tree_Item *next_item(Fl_Tree_Item *item, int dir=FL_Down, bool visible=false);
#if FLTK_ABI_VERSION >= 10303
  Fl_Tree_Item *next_selected_item(Fl_Tree_Item *item=0, int dir=FL_Down);
  int get_selected_items(Fl_Tree_Item_Array &ret_items);
#else
  Fl_Tree_Item *next_selected_item(Fl_Tree_Item *item=0);
  Fl_Tree_Item *next_selected_item(Fl_Tree_Item *item, int dir);
#endif
 
  // Item open/close methods
  int open(Fl_Tree_Item *item, int docallback=1);
  int open(const char *path, int docallback=1);
  void open_toggle(Fl_Tree_Item *item, int docallback=1);
  int close(Fl_Tree_Item *item, int docallback=1);
  int close(const char *path, int docallback=1);
  int is_open(Fl_Tree_Item *item) const;
  int is_open(const char *path) const;
  int is_close(Fl_Tree_Item *item) const;
  int is_close(const char *path) const;
 
  // Item selection methods
  int select(Fl_Tree_Item *item, int docallback=1);
  int select(const char *path, int docallback=1);
  void select_toggle(Fl_Tree_Item *item, int docallback=1);
  int deselect(Fl_Tree_Item *item, int docallback=1);
  int deselect(const char *path, int docallback=1);
  int deselect_all(Fl_Tree_Item *item=0, int docallback=1);
  int select_only(Fl_Tree_Item *selitem, int docallback=1);
  int select_all(Fl_Tree_Item *item=0, int docallback=1);
  int extend_selection_dir(Fl_Tree_Item *from,
                           Fl_Tree_Item *to,
                           int dir,
                           int val,
                           bool visible);
#if FLTK_ABI_VERSION >= 10303
  int extend_selection(Fl_Tree_Item *from,
                       Fl_Tree_Item *to,
                       int val=1,
                       bool visible=false);
#else
private:
  // Adding overload if not at least one overload breaks ABI, so avoid
  // by keeping private until we can break ABI. ref: http://www.ros.org/reps/rep-0009.html
  int extend_selection__(Fl_Tree_Item *from,
                         Fl_Tree_Item *to,
                         int val,
                         bool visible);
public:
#endif
  void set_item_focus(Fl_Tree_Item *item);
  Fl_Tree_Item *get_item_focus() const;
  int is_selected(Fl_Tree_Item *item) const;
  int is_selected(const char *path);
 
  // Item attribute related methods
  Fl_Font     item_labelfont() const;
  void        item_labelfont(Fl_Font val);
  Fl_Fontsize item_labelsize() const;
  void        item_labelsize(Fl_Fontsize val);
  Fl_Color    item_labelfgcolor(void) const;
  void        item_labelfgcolor(Fl_Color val);
  Fl_Color    item_labelbgcolor(void) const;
  void        item_labelbgcolor(Fl_Color val);
  Fl_Color connectorcolor() const;
  void connectorcolor(Fl_Color val);
  int marginleft() const;
  void marginleft(int val);
  int margintop() const;
  void margintop(int val);
#if FLTK_ABI_VERSION >= 10301
  int marginbottom() const;
  void marginbottom(int val);
#endif /*FLTK_ABI_VERSION*/
  int linespacing() const;
  void linespacing(int val);
  int openchild_marginbottom() const;
  void openchild_marginbottom(int val);
  int usericonmarginleft() const;
  void usericonmarginleft(int val);
  int labelmarginleft() const;
  void labelmarginleft(int val);
#if FLTK_ABI_VERSION >= 10301
  int widgetmarginleft() const;
  void widgetmarginleft(int val);
#endif /*FLTK_ABI_VERSION*/
  int connectorwidth() const;
  void connectorwidth(int val);
  Fl_Image* usericon() const;
  void usericon(Fl_Image *val);
  Fl_Image* openicon() const;
  void openicon(Fl_Image *val);
  Fl_Image* closeicon() const;
  void closeicon(Fl_Image *val);
  int showcollapse() const;
  void showcollapse(int val);
  int showroot() const;
  void showroot(int val);
  Fl_Tree_Connector connectorstyle() const;
  void connectorstyle(Fl_Tree_Connector val);
  Fl_Tree_Sort sortorder() const;
  void sortorder(Fl_Tree_Sort val);
  Fl_Boxtype selectbox() const;
  void selectbox(Fl_Boxtype val);
  Fl_Tree_Select selectmode() const;
  void selectmode(Fl_Tree_Select val);
#if FLTK_ABI_VERSION >= 10301
  Fl_Tree_Item_Reselect_Mode item_reselect_mode() const;
  void item_reselect_mode(Fl_Tree_Item_Reselect_Mode mode);
  Fl_Tree_Item_Draw_Mode item_draw_mode() const;
  void item_draw_mode(Fl_Tree_Item_Draw_Mode mode);
  void item_draw_mode(int mode);
#endif
#if FLTK_ABI_VERSION >= 10303
  void calc_dimensions();
  void calc_tree();
#endif
  void recalc_tree();
  int displayed(Fl_Tree_Item *item);
  void show_item(Fl_Tree_Item *item, int yoff);
  void show_item(Fl_Tree_Item *item);
  void show_item_top(Fl_Tree_Item *item);
  void show_item_middle(Fl_Tree_Item *item);
  void show_item_bottom(Fl_Tree_Item *item);
  void display(Fl_Tree_Item *item);
  int  vposition() const;
  void vposition(int pos);
  int  hposition() const;
  void hposition(int pos);
 
  int is_scrollbar(Fl_Widget *w);
  int scrollbar_size() const;
  void scrollbar_size(int size);
  int is_vscroll_visible() const;
  int is_hscroll_visible() const;
 
  // callback related
  void callback_item(Fl_Tree_Item* item);
  Fl_Tree_Item* callback_item();
  void callback_reason(Fl_Tree_Reason reason);
  Fl_Tree_Reason callback_reason() const;
 
  void load(class Fl_Preferences&);
};
 
#endif /*FL_TREE_H*/
 
//
// End of "$Id$".
//