Fl_Tree_Item.H

Go to the documentation of this file.

//
// "$Id: Fl_Tree_Item.H 8340 2011-01-30 20:22:06Z greg.ercolano $"
//
 
#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; you can redistribute it and/or
// modify it under the terms of the GNU Library General Public
// License as published by the Free Software Foundation; either
// version 2 of the License, or (at your option) any later version.
//
// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// Library General Public License for more details.
//
// You should have received a copy of the GNU Library General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
// USA.
//


class FL_EXPORT Fl_Tree_Item {
  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
  char                    _open;                // item is open?
  char                    _visible;             // item is visible?
  char                    _active;              // item activated?
  char                    _selected;            // item selected?
  int                     _xywh[4];             // xywh of this widget (if visible)
  int                     _collapse_xywh[4];    // xywh of collapse icon (if any)
  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_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
protected:
  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);
public:
  Fl_Tree_Item(const Fl_Tree_Prefs &prefs);    // CTOR
  ~Fl_Tree_Item();                         // DTOR
  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]); }
  void draw(int X, int &Y, int W, Fl_Widget *tree, Fl_Tree_Item *itemfocus, const Fl_Tree_Prefs &prefs, int lastchild=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; 
  }

  Fl_Font labelfont() const {
    return(_labelfont);
  }

  void labelsize(Fl_Fontsize val) {
    _labelsize = val; 
  }

  Fl_Fontsize labelsize() const {
    return(_labelsize);
  }

  void labelfgcolor(Fl_Color val) {
    _labelfgcolor = val; 
  }

  void labelcolor(Fl_Color val) {
    _labelfgcolor = val; 
  }

  Fl_Color labelcolor() const {
    return(_labelfgcolor); 
  }

  Fl_Color labelfgcolor() const {
    return(_labelfgcolor); 
  }

  void labelbgcolor(Fl_Color val) {
    _labelbgcolor = val; 
  }

  Fl_Color labelbgcolor() const {
    return(_labelbgcolor); 
  }

  void widget(Fl_Widget *val) {
    _widget = val; 
  }

  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(char **arr) const;    // const
        Fl_Tree_Item *find_child_item(char **arr);          // non-const
  const Fl_Tree_Item *find_item(char **arr) const;          // const
        Fl_Tree_Item *find_item(char **arr);                        // non-const
  // Adding items
  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 *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);
  int depth() const;
  Fl_Tree_Item *prev();
  Fl_Tree_Item *next();
  Fl_Tree_Item *next_sibling();
  Fl_Tree_Item *prev_sibling();
  Fl_Tree_Item *next_displayed(Fl_Tree_Prefs &prefs);
  Fl_Tree_Item *prev_displayed(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;
  }

  // State
  void open();
  void close();
  int is_open() const {
    return(_open?1:0);
  }

  int is_close() const {
    return(_open?0:1);
  }

  void open_toggle() {
    _open?close():open();
  }

  void select(int val=1) {
    _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() {
    _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(_selected);
  }

  void activate(int val=1) {
    _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(_active);
  }

  char is_active() const {
    return(_active);
  }

  int visible() const {
    return(_visible ? 1 : 0);
  }
  int visible_r() const;

  void usericon(Fl_Image *val) {
    _usericon = val;
  }

  Fl_Image *usericon() const {
    return(_usericon);
  }

  // Events
  const Fl_Tree_Item *find_clicked(const Fl_Tree_Prefs &prefs) const;
  Fl_Tree_Item *find_clicked(const Fl_Tree_Prefs &prefs);
  int event_on_collapse_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);
  }
};
 
#endif /*FL_TREE_ITEM_H*/
 
//
// End of "$Id: Fl_Tree_Item.H 8340 2011-01-30 20:22:06Z greg.ercolano $".
//