Fl_Tree_Prefs.H

Go to the documentation of this file.

//
// "$Id: Fl_Tree_Prefs.H 8340 2011-01-30 20:22:06Z greg.ercolano $"
//
 
#ifndef FL_TREE_PREFS_H
#define FL_TREE_PREFS_H

// FL/Fl_Tree_Prefs.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.
//



enum Fl_Tree_Sort {
  FL_TREE_SORT_NONE=0, 
  FL_TREE_SORT_ASCENDING=1,       
  FL_TREE_SORT_DESCENDING=2      
};

enum Fl_Tree_Connector {
  FL_TREE_CONNECTOR_NONE=0,       
  FL_TREE_CONNECTOR_DOTTED=1,   
  FL_TREE_CONNECTOR_SOLID=2      
};

enum Fl_Tree_Select {
  FL_TREE_SELECT_NONE=0,     
  FL_TREE_SELECT_SINGLE=1, 
  FL_TREE_SELECT_MULTI=2    
};

class FL_EXPORT Fl_Tree_Prefs {
  Fl_Font _labelfont;                    // label's font face
  Fl_Fontsize _labelsize;            // label's font size
  int _margintop;                       // -- 
  int _marginleft;                      //   |- tree's margins
  //int _marginright;                   //   |
  //int _marginbottom;                  // --
  int _openchild_marginbottom;          // extra space below an open child tree
  int _usericonmarginleft;              // space to left of user icon (if any)
  int _labelmarginleft;                 // space to left of label
  int _connectorwidth;                  // connector width (right of open/close icon)
  int _linespacing;                     // vertical space between lines
  // Colors
  Fl_Color _labelfgcolor;               // label's foreground color
  Fl_Color _labelbgcolor;               // background color
  Fl_Color _connectorcolor;             // connector dotted line color
  Fl_Tree_Connector _connectorstyle;   // connector line style
  Fl_Image *_openimage;                 // the 'open' icon [+]
  Fl_Image *_closeimage;                // the 'close' icon [-]
  Fl_Image *_userimage;                 // user's own icon
  char _showcollapse;                   // 1=show collapse icons, 0=don't
  char _showroot;                       // show the root item as part of the tree
  Fl_Tree_Sort   _sortorder;                // none, ascening, descending, etc.
  Fl_Boxtype     _selectbox;          // selection box type
  Fl_Tree_Select _selectmode;             // selection mode
public:
  Fl_Tree_Prefs();
  
  // Labels
  inline Fl_Font labelfont() const {
    return(_labelfont);
  }

  inline void labelfont(Fl_Font val) {
    _labelfont = val;
  }

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

  inline void labelsize(Fl_Fontsize val) {
    _labelsize = val;
  }
  
  // Margins
  inline int marginleft() const {
    return(_marginleft);
  }

  inline void marginleft(int val) {
    _marginleft = val;
  }

  inline int margintop() const {
    return(_margintop);
  }

  inline void margintop(int val) {
    _margintop = val;
  }

  inline int openchild_marginbottom() const {
    return(_openchild_marginbottom);
  }

  inline void openchild_marginbottom(int val) {
    _openchild_marginbottom = val;
  }
  
  /****** NOT IMPLEMENTED
   inline int marginright() const {
   return(_marginright);
   }
   inline void marginright(int val) {
   _marginright = val;
   }
   inline int marginbottom() const {
   return(_marginbottom);
   }
   inline void marginbottom(int val) {
   _marginbottom = val;
   }
   *******/
  
  inline int usericonmarginleft() const {
    return(_usericonmarginleft);
  }

  inline void usericonmarginleft(int val) {
    _usericonmarginleft = val;
  }

  inline int labelmarginleft() const {
    return(_labelmarginleft);
  }

  inline void labelmarginleft(int val) {
    _labelmarginleft = val;
  }

  inline int linespacing() const {
    return(_linespacing);
  }

  inline void linespacing(int val) {
    _linespacing = val;
  }
  
  // Colors and Styles
  inline Fl_Color labelfgcolor() const {
    return(_labelfgcolor);
  }

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

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

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

  inline Fl_Color connectorcolor() const {
    return(_connectorcolor);
  }

  inline void connectorcolor(Fl_Color val) {
    _connectorcolor = val;
  }

  inline Fl_Tree_Connector connectorstyle() const {
    return(_connectorstyle);
  }

  inline void connectorstyle(Fl_Tree_Connector val) {
    _connectorstyle = val;
  }

  inline void connectorstyle(int val) {
    _connectorstyle = Fl_Tree_Connector(val);
  }

  inline int connectorwidth() const {
    return(_connectorwidth);
  }

  inline void connectorwidth(int val) {
    _connectorwidth = val;
  }
  
  // Icons
  inline Fl_Image *openicon() const {
    return(_openimage);
  }
  void openicon(Fl_Image *val);
  inline Fl_Image *closeicon() const {
    return(_closeimage);
  }
  void closeicon(Fl_Image *val);
  inline Fl_Image *usericon() const {
    return(_userimage);
  }

  inline void usericon(Fl_Image *val) {
    _userimage = val;
  }
  
  // Options
  inline char showcollapse() const {
    return(_showcollapse);
  }

  inline void showcollapse(int val) {
    _showcollapse = val;
  }

  inline Fl_Tree_Sort sortorder() const {
    return(_sortorder);
  }

  inline void sortorder(Fl_Tree_Sort val) {
    _sortorder = val;
  }

  inline Fl_Boxtype selectbox() const {
    return(_selectbox);
  }

  inline void selectbox(Fl_Boxtype val) {
    _selectbox = val;
  }

  inline int showroot() const {
    return(int(_showroot));
  }

  inline void showroot(int val) {
    _showroot = char(val);
  }

  inline Fl_Tree_Select selectmode() const {
    return(_selectmode);
  }

  inline void selectmode(Fl_Tree_Select val) {
    _selectmode = val;
  }
};
 
#endif /*FL_TREE_PREFS_H*/
 
//
// End of "$Id: Fl_Tree_Prefs.H 8340 2011-01-30 20:22:06Z greg.ercolano $".
//