Fl_Tree_Item.H

Go to the documentation of this file.

//

#ifndef FL_TREE_ITEM_H
#define FL_TREE_ITEM_H

#include <FL/Fl.H>
#include <FL/Fl_Widget.H>
#include <FL/Fl_Image.H>
#include <FL/fl_draw.H>

#include <FL/Fl_Tree_Item_Array.H>
#include <FL/Fl_Tree_Prefs.H>

// FL/Fl_Tree_Item.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:
//
//     https://www.fltk.org/COPYING.php
//
// Please see the following page on how to report bugs and issues:
//
//     https://www.fltk.org/bugs.php
//


class Fl_Tree;
class FL_EXPORT Fl_Tree_Item {
  Fl_Tree                *_tree;                // parent tree
  const char             *_label;               // label (memory managed)
  Fl_Font                 _labelfont;           // label's font face
  Fl_Fontsize             _labelsize;           // label's font size
  Fl_Color                _labelfgcolor;        // label's fg color
  Fl_Color                _labelbgcolor;        // label's bg color (0xffffffff is 'transparent')
  enum Fl_Tree_Item_Flags {
    OPEN                = 1<<0,         
    VISIBLE             = 1<<1,         
    ACTIVE              = 1<<2,         
    SELECTED            = 1<<3          
  };
  unsigned short _flags;                // misc flags
  int                     _xywh[4];             // xywh of this widget (if visible)
  int                     _collapse_xywh[4];    // xywh of collapse icon (if visible)
  int                     _label_xywh[4];       // xywh of label
  Fl_Widget              *_widget;              // item's label widget (optional)
  Fl_Image               *_usericon;            // item's user-specific icon (optional)
  Fl_Image               *_userdeicon;          // deactivated usericon
  Fl_Tree_Item_Array      _children;            // array of child items
  Fl_Tree_Item           *_parent;              // parent item (=0 if root)
  void                   *_userdata;            // user data that can be associated with an item
  Fl_Tree_Item           *_prev_sibling;        // previous sibling (same level)
  Fl_Tree_Item           *_next_sibling;        // next sibling (same level)
  // Protected methods
protected:
  void _Init(const Fl_Tree_Prefs &prefs, Fl_Tree *tree);
  void show_widgets();
  void hide_widgets();
  void draw_vertical_connector(int x, int y1, int y2, const Fl_Tree_Prefs &prefs);
  void draw_horizontal_connector(int x1, int x2, int y, const Fl_Tree_Prefs &prefs);
  void recalc_tree();
  int calc_item_height(const Fl_Tree_Prefs &prefs) const;
  Fl_Color drawfgcolor() const;
  Fl_Color drawbgcolor() const;

public:
  Fl_Tree_Item(const Fl_Tree_Prefs &prefs);     // CTOR -- backwards compatible
  Fl_Tree_Item(Fl_Tree *tree);                  // CTOR -- ABI 1.3.3+
  virtual ~Fl_Tree_Item();                      // DTOR -- ABI 1.3.3+
  Fl_Tree_Item(const Fl_Tree_Item *o);          // COPY CTOR
  int x() const { return(_xywh[0]); }
  int y() const { return(_xywh[1]); }
  int w() const { return(_xywh[2]); }
  int h() const { return(_xywh[3]); }
  int label_x() const { return(_label_xywh[0]); }
  int label_y() const { return(_label_xywh[1]); }
  int label_w() const { return(_label_xywh[2]); }
  int label_h() const { return(_label_xywh[3]); }
  virtual int draw_item_content(int render);
  void draw(int X, int &Y, int W, Fl_Tree_Item *itemfocus,
            int &tree_item_xmax, int lastchild=1, int render=1);
  void show_self(const char *indent = "") const;
  void label(const char *val);
  const char *label() const;

  inline void user_data( void* data ) { _userdata = data; }

  inline void* user_data() const { return _userdata; }

  void labelfont(Fl_Font val) {
    _labelfont = val;
    recalc_tree();              // may change tree geometry
  }
  Fl_Font labelfont() const {
    return(_labelfont);
  }
  void labelsize(Fl_Fontsize val) {
    _labelsize = val;
    recalc_tree();              // may change tree geometry
  }
  Fl_Fontsize labelsize() const {
    return(_labelsize);
  }
  void labelfgcolor(Fl_Color val) {
    _labelfgcolor = val;
  }
  Fl_Color labelfgcolor() const {
    return(_labelfgcolor);
  }
  void labelcolor(Fl_Color val) {
     labelfgcolor(val);
  }
  Fl_Color labelcolor() const {
    return labelfgcolor();
  }
  void labelbgcolor(Fl_Color val) {
    _labelbgcolor = val;
  }
  Fl_Color labelbgcolor() const {
    return(_labelbgcolor);
  }
  void widget(Fl_Widget *val) {
    _widget = val;
    recalc_tree();              // may change tree geometry
  }
  Fl_Widget *widget() const {
    return(_widget);
  }
  int children() const {
    return(_children.total());
  }
  Fl_Tree_Item *child(int index) {
    return(_children[index]);
  }
  const Fl_Tree_Item *child(int t) const;
  int has_children() const {
    return(children());
  }
  int find_child(const char *name);
  int find_child(Fl_Tree_Item *item);
  int remove_child(Fl_Tree_Item *item);
  int remove_child(const char *new_label);
  void clear_children();
  void swap_children(int ax, int bx);
  int swap_children(Fl_Tree_Item *a, Fl_Tree_Item *b);
  const Fl_Tree_Item *find_child_item(const char *name) const;
        Fl_Tree_Item *find_child_item(const char *name);
  const Fl_Tree_Item *find_child_item(char **arr) const;
        Fl_Tree_Item *find_child_item(char **arr);
  const Fl_Tree_Item *find_item(char **arr) const;
        Fl_Tree_Item *find_item(char **arr);
  // Adding items
  Fl_Tree_Item *add(const Fl_Tree_Prefs &prefs,
                    const char *new_label,
                    Fl_Tree_Item *newitem);
  Fl_Tree_Item *add(const Fl_Tree_Prefs &prefs,
                    const char *new_label);
  Fl_Tree_Item *add(const Fl_Tree_Prefs &prefs,
                    char **arr,
                    Fl_Tree_Item *newitem);
  Fl_Tree_Item *add(const Fl_Tree_Prefs &prefs,
                    char **arr);
  Fl_Tree_Item *replace(Fl_Tree_Item *new_item);
  Fl_Tree_Item *replace_child(Fl_Tree_Item *olditem, Fl_Tree_Item *newitem);
  Fl_Tree_Item *insert(const Fl_Tree_Prefs &prefs, const char *new_label, int pos=0);
  Fl_Tree_Item *insert_above(const Fl_Tree_Prefs &prefs, const char *new_label);
  Fl_Tree_Item* deparent(int index);
  int reparent(Fl_Tree_Item *newchild, int index);
  int move(int to, int from);
  int move(Fl_Tree_Item *item, int op=0, int pos=0);
  int move_above(Fl_Tree_Item *item);
  int move_below(Fl_Tree_Item *item);
  int move_into(Fl_Tree_Item *item, int pos=0);
  int depth() const;
  Fl_Tree_Item *prev();
  Fl_Tree_Item *next();
  Fl_Tree_Item *next_sibling();
  Fl_Tree_Item *prev_sibling();
  void update_prev_next(int index);
  Fl_Tree_Item *next_displayed(Fl_Tree_Prefs &prefs);   // deprecated
  Fl_Tree_Item *prev_displayed(Fl_Tree_Prefs &prefs);   // deprecated
  Fl_Tree_Item *next_visible(Fl_Tree_Prefs &prefs);
  Fl_Tree_Item *prev_visible(Fl_Tree_Prefs &prefs);

  Fl_Tree_Item *parent() {
    return(_parent);
  }
  const Fl_Tree_Item *parent() const {
    return(_parent);
  }
  void parent(Fl_Tree_Item *val) {
    _parent = val;
  }
  const Fl_Tree_Prefs& prefs() const;
  const Fl_Tree *tree() const {
    return(_tree);
  }
  Fl_Tree *tree() {
    return(_tree);
  }
  // State
  void open();
  void close();
  int is_open() const {
    return(is_flag(OPEN));
  }
  int is_close() const {
    return(is_flag(OPEN)?0:1);
  }
  void open_toggle() {
    is_open()?close():open();   // handles calling recalc_tree()
  }
  void select(int val=1) {
    set_flag(SELECTED, val);
  }
  void select_toggle() {
    if ( is_selected() ) {
      deselect();       // deselect if selected
    } else {
      select();         // select if deselected
    }
  }
  int select_all() {
    int count = 0;
    if ( ! is_selected() ) {
      select();
      ++count;
    }
    for ( int t=0; t<children(); t++ ) {
      count += child(t)->select_all();
    }
    return(count);
  }
  void deselect() {
    set_flag(SELECTED, 0);
  }
  int deselect_all() {
    int count = 0;
    if ( is_selected() ) {
      deselect();
      ++count;
    }
    for ( int t=0; t<children(); t++ ) {
      count += child(t)->deselect_all();
    }
    return(count);
  }
  char is_selected() const {
    return(is_flag(SELECTED));
  }
  void activate(int val=1) {
    set_flag(ACTIVE,val);
    if ( _widget && val != (int)_widget->active() ) {
      if ( val ) {
        _widget->activate();
      } else {
        _widget->deactivate();
      }
      _widget->redraw();
    }
  }
  void deactivate() {
    activate(0);
  }
  char is_activated() const {
    return(is_flag(ACTIVE));
  }
  char is_active() const {
    return(is_activated());
  }
  int visible() const {
    return(is_visible());
  }
  int is_visible() const {
    return(is_flag(VISIBLE));
  }
  int visible_r() const;

  void usericon(Fl_Image *val) {
    _usericon = val;
    recalc_tree();              // may change tree geometry
  }
  Fl_Image *usericon() const {
    return(_usericon);
  }
  void userdeicon(Fl_Image* val) {
    _userdeicon = val;
  }
  Fl_Image* userdeicon() const {
    return _userdeicon;
  }
  // Events
  const Fl_Tree_Item* find_clicked(const Fl_Tree_Prefs &prefs, int yonly=0) const;
  Fl_Tree_Item* find_clicked(const Fl_Tree_Prefs &prefs, int yonly=0);
  int event_on_item(const Fl_Tree_Prefs &prefs) const;
  int event_on_collapse_icon(const Fl_Tree_Prefs &prefs) const;
  int event_on_user_icon(const Fl_Tree_Prefs &prefs) const;
  int event_on_label(const Fl_Tree_Prefs &prefs) const;
  int is_root() const {
    return(_parent==0?1:0);
  }

  // Protected methods
  // TODO: move these to top 'protected:' section
protected:
  inline void set_flag(unsigned short flag,int val) {
    if ( flag==OPEN || flag==VISIBLE ) {
      recalc_tree();            // may change tree geometry
    }
    if ( val ) _flags |= flag; else _flags &= ~flag;
  }
  inline int is_flag(unsigned short val) const {
    return(_flags & val ? 1 : 0);
  }

};

#endif /*FL_TREE_ITEM_H*/