FXTreeList.h

/********************************************************************************
*                                                                               *
*                         T r e e   L i s t   W i d g e t                       *
*                                                                               *
*********************************************************************************
* Copyright (C) 1997,2024 by Jeroen van der Zijp.   All Rights Reserved.        *
*********************************************************************************
* This library is free software; you can redistribute it and/or modify          *
* it under the terms of the GNU Lesser General Public License as published by   *
* the Free Software Foundation; either version 3 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 Lesser General Public License for more details.                           *
*                                                                               *
* You should have received a copy of the GNU Lesser General Public License      *
* along with this program.  If not, see <http://www.gnu.org/licenses/>          *
********************************************************************************/
#ifndef FXTREELIST_H
#define FXTREELIST_H

#ifndef FXSCROLLAREA_H
#include "FXScrollArea.h"
#endif

namespace FX {


class FXIcon;
class FXFont;
class FXTreeList;
class FXDirList;


enum {
  TREELIST_EXTENDEDSELECT = 0,            
  TREELIST_SINGLESELECT   = 0x00100000,   
  TREELIST_BROWSESELECT   = 0x00200000,   
  TREELIST_MULTIPLESELECT = 0x00300000,   
  TREELIST_AUTOSELECT     = 0x00400000,   
  TREELIST_SHOWS_LINES    = 0x00800000,   
  TREELIST_SHOWS_BOXES    = 0x01000000,   
  TREELIST_ROOT_BOXES     = 0x02000000,   
  TREELIST_NORMAL         = TREELIST_EXTENDEDSELECT
  };


class FXAPI FXTreeItem : public FXObject {
  FXDECLARE(FXTreeItem)
  friend class FXTreeList;
  friend class FXDirList;
protected:
  FXTreeItem *parent;           // Parent item
  FXTreeItem *prev;             // Previous item
  FXTreeItem *next;             // Next item
  FXTreeItem *first;            // First child item
  FXTreeItem *last;             // Last child item
  FXString    label;            // Text of item
  FXIcon     *openIcon;         // Icon of item
  FXIcon     *closedIcon;       // Icon of item
  FXptr       data;             // Item user data pointer
  FXuint      state;            // Item state flags
  FXint       x,y;
private:
  FXTreeItem(const FXTreeItem&);
  FXTreeItem& operator=(const FXTreeItem&);
protected:
  FXTreeItem():parent(nullptr),prev(nullptr),next(nullptr),first(nullptr),last(nullptr),openIcon(nullptr),closedIcon(nullptr),data(nullptr),state(0),x(0),y(0){}
  virtual void draw(const FXTreeList* list,FXDC& dc,FXint x,FXint y,FXint w,FXint h) const;
  virtual FXint hitItem(const FXTreeList* list,FXint x,FXint y) const;
public:
  enum{
    SELECTED        = 1,        
    FOCUS           = 2,        
    DISABLED        = 4,        
    OPENED          = 8,        
    EXPANDED        = 16,       
    HASITEMS        = 32,       
    DRAGGABLE       = 64,       
    OPENICONOWNED   = 128,      
    CLOSEDICONOWNED = 256       
    };
public:

  FXTreeItem(const FXString& text,FXIcon* oi=nullptr,FXIcon* ci=nullptr,FXptr ptr=nullptr):parent(nullptr),prev(nullptr),next(nullptr),first(nullptr),last(nullptr),label(text),openIcon(oi),closedIcon(ci),data(ptr),state(0),x(0),y(0){}

  FXTreeItem* getParent() const { return parent; }

  FXTreeItem* getNext() const { return next; }

  FXTreeItem* getPrev() const { return prev; }

  FXTreeItem* getFirst() const { return first; }

  FXTreeItem* getLast() const { return last; }

  FXTreeItem* getBelow() const;

  FXTreeItem* getAbove() const;

  FXint getNumChildren() const;

  virtual void setText(const FXString& txt);

  const FXString& getText() const { return label; }

  virtual void setOpenIcon(FXIcon* icn,FXbool owned=false);

  FXIcon* getOpenIcon() const { return openIcon; }

  virtual void setClosedIcon(FXIcon* icn,FXbool owned=false);

  FXIcon* getClosedIcon() const { return closedIcon; }

  void setData(FXptr ptr){ data=ptr; }

  FXptr getData() const { return data; }

  virtual void setFocus(FXbool focus);

  FXbool hasFocus() const { return (state&FOCUS)!=0; }

  virtual void setSelected(FXbool selected);

  FXbool isSelected() const { return (state&SELECTED)!=0; }

  virtual void setOpened(FXbool opened);

  FXbool isOpened() const { return (state&OPENED)!=0; }

  virtual void setExpanded(FXbool expanded);

  FXbool isExpanded() const { return (state&EXPANDED)!=0; }

  virtual void setEnabled(FXbool enabled);

  FXbool isEnabled() const { return (state&DISABLED)==0; }

  virtual void setDraggable(FXbool draggable);

  FXbool isDraggable() const { return (state&DRAGGABLE)!=0; }

  FXbool hasItems() const { return (state&HASITEMS)!=0; }

  void setHasItems(FXbool flag);

  FXbool isChildOf(const FXTreeItem* item) const;

  FXbool isParentOf(const FXTreeItem* item) const;

  virtual FXString getTipText() const;

  virtual FXint getWidth(const FXTreeList* list) const;

  virtual FXint getHeight(const FXTreeList* list) const;

  virtual void create();

  virtual void detach();

  virtual void destroy();

  virtual void save(FXStream& store) const;

  virtual void load(FXStream& store);

  virtual ~FXTreeItem();
  };



typedef FXint (*FXTreeListSortFunc)(const FXTreeItem*,const FXTreeItem*);



class FXAPI FXTreeList : public FXScrollArea {
  FXDECLARE(FXTreeList)
protected:
  FXTreeItem        *firstitem;         // First root item
  FXTreeItem        *lastitem;          // Last root item
  FXTreeItem        *anchoritem;        // Selection anchor item
  FXTreeItem        *currentitem;       // Current item
  FXTreeItem        *extentitem;        // Selection extent
  FXTreeItem        *viewableitem;      // Visible item
  FXFont            *font;              // Font
  FXTreeListSortFunc sortfunc;          // Item sort function
  FXColor            textColor;         // Text color
  FXColor            selbackColor;      // Selected background color
  FXColor            seltextColor;      // Selected text color
  FXColor            lineColor;         // Line color
  FXint              treeWidth;         // Tree width
  FXint              treeHeight;        // Tree height
  FXint              visible;           // Number of visible items
  FXint              indent;            // Parent to child indentation
  FXint              grabx;             // Grab point x
  FXint              graby;             // Grab point y
  FXString           lookup;            // Lookup string
  FXString           tip;
  FXString           help;              // Help string
  FXbool             state;             // State of item
protected:
  FXTreeList();
  virtual FXTreeItem* createItem(const FXString& text,FXIcon* oi,FXIcon* ci,FXptr ptr);
  void sort(FXTreeItem*& f1,FXTreeItem*& t1,FXTreeItem*& f2,FXTreeItem*& t2,int n);
  void recompute();
private:
  FXTreeList(const FXTreeList&);
  FXTreeList& operator=(const FXTreeList&);
public:
  long onPaint(FXObject*,FXSelector,void*);
  long onEnter(FXObject*,FXSelector,void*);
  long onLeave(FXObject*,FXSelector,void*);
  long onUngrabbed(FXObject*,FXSelector,void*);
  long onMotion(FXObject*,FXSelector,void*);
  long onKeyPress(FXObject*,FXSelector,void*);
  long onKeyRelease(FXObject*,FXSelector,void*);
  long onLeftBtnPress(FXObject*,FXSelector,void*);
  long onLeftBtnRelease(FXObject*,FXSelector,void*);
  long onRightBtnPress(FXObject*,FXSelector,void*);
  long onRightBtnRelease(FXObject*,FXSelector,void*);
  long onQueryTip(FXObject*,FXSelector,void*);
  long onQueryHelp(FXObject*,FXSelector,void*);
  long onTipTimer(FXObject*,FXSelector,void*);
  long onFocusIn(FXObject*,FXSelector,void*);
  long onFocusOut(FXObject*,FXSelector,void*);
  long onAutoScroll(FXObject*,FXSelector,void*);
  long onClicked(FXObject*,FXSelector,void*);
  long onDoubleClicked(FXObject*,FXSelector,void*);
  long onTripleClicked(FXObject*,FXSelector,void*);
  long onCommand(FXObject*,FXSelector,void*);
  long onLookupTimer(FXObject*,FXSelector,void*);
public:
  static FXint ascending(const FXTreeItem*,const FXTreeItem*);
  static FXint descending(const FXTreeItem*,const FXTreeItem*);
  static FXint ascendingCase(const FXTreeItem*,const FXTreeItem*);
  static FXint descendingCase(const FXTreeItem*,const FXTreeItem*);
public:
  enum {
    ID_LOOKUPTIMER=FXScrollArea::ID_LAST,
    ID_LAST
    };
public:

  FXTreeList(FXComposite *p,FXObject* tgt=nullptr,FXSelector sel=0,FXuint opts=TREELIST_NORMAL,FXint x=0,FXint y=0,FXint w=0,FXint h=0);

  virtual void create();

  virtual void detach();

  virtual void layout();

  virtual FXint getDefaultWidth();

  virtual FXint getDefaultHeight();

  virtual FXint getContentWidth();

  virtual FXint getContentHeight();

  virtual void recalc();

  virtual FXbool canFocus() const;

  virtual void setFocus();

  virtual void killFocus();

  FXint getNumItems() const;

  FXint getNumVisible() const { return visible; }

  void setNumVisible(FXint nvis);

  FXTreeItem* getFirstItem() const { return firstitem; }

  FXTreeItem* getLastItem() const { return lastitem; }

  FXint fillItems(FXTreeItem* father,const FXchar *const *strings,FXIcon* oi=nullptr,FXIcon* ci=nullptr,FXptr ptr=nullptr,FXbool notify=false);

  FXint fillItems(FXTreeItem* father,const FXString* strings,FXIcon* oi=nullptr,FXIcon* ci=nullptr,FXptr ptr=nullptr,FXbool notify=false);

  FXint fillItems(FXTreeItem* father,const FXString& strings,FXIcon* oi=nullptr,FXIcon* ci=nullptr,FXptr ptr=nullptr,FXbool notify=false);

  FXTreeItem* setItem(FXTreeItem* orig,FXTreeItem* item,FXbool notify=false);

  FXTreeItem* insertItem(FXTreeItem* other,FXTreeItem* father,FXTreeItem* item,FXbool notify=false);

  FXTreeItem* insertItem(FXTreeItem* other,FXTreeItem* father,const FXString& text,FXIcon* oi=nullptr,FXIcon* ci=nullptr,FXptr ptr=nullptr,FXbool notify=false);

  FXTreeItem* appendItem(FXTreeItem* father,FXTreeItem* item,FXbool notify=false);

  FXTreeItem* appendItem(FXTreeItem* father,const FXString& text,FXIcon* oi=nullptr,FXIcon* ci=nullptr,FXptr ptr=nullptr,FXbool notify=false);

  FXTreeItem* prependItem(FXTreeItem* father,FXTreeItem* item,FXbool notify=false);

  FXTreeItem* prependItem(FXTreeItem* father,const FXString& text,FXIcon* oi=nullptr,FXIcon* ci=nullptr,FXptr ptr=nullptr,FXbool notify=false);

  FXTreeItem *moveItem(FXTreeItem* other,FXTreeItem* father,FXTreeItem* item);

  FXTreeItem* extractItem(FXTreeItem* item,FXbool notify=false);

  void removeItem(FXTreeItem* item,FXbool notify=false);

  void removeItems(FXTreeItem* fm,FXTreeItem* to,FXbool notify=false);

  void clearItems(FXbool notify=false);

  FXint getItemWidth(const FXTreeItem* item) const { return item->getWidth(this); }

  FXint getItemHeight(const FXTreeItem* item) const { return item->getHeight(this); }

  virtual FXTreeItem* getItemAt(FXint x,FXint y) const;

  FXint hitItem(const FXTreeItem* item,FXint x,FXint y) const;

  virtual void makeItemVisible(FXTreeItem* item);

  FXTreeItem* findItem(const FXString& string,FXTreeItem* start=nullptr,FXuint flags=SEARCH_FORWARD|SEARCH_WRAP) const;

  FXTreeItem* findItemByData(FXptr ptr,FXTreeItem* start=nullptr,FXuint flags=SEARCH_FORWARD|SEARCH_WRAP) const;

  void setItemText(FXTreeItem* item,const FXString& text);

  FXString getItemText(const FXTreeItem* item) const;

  void setItemOpenIcon(FXTreeItem* item,FXIcon* icon,FXbool owned=false);

  FXIcon* getItemOpenIcon(const FXTreeItem* item) const;

  void setItemClosedIcon(FXTreeItem* item,FXIcon* icon,FXbool owned=false);

  FXIcon* getItemClosedIcon(const FXTreeItem* item) const;

  void setItemData(FXTreeItem* item,void* ptr) const;

  void* getItemData(const FXTreeItem* item) const;

  FXbool isItemSelected(const FXTreeItem* item) const;

  FXbool isItemCurrent(const FXTreeItem* item) const;

  FXbool isItemVisible(const FXTreeItem* item) const;

  FXbool isItemOpened(const FXTreeItem* item) const;

  FXbool isItemExpanded(const FXTreeItem* item) const;

  FXbool isItemLeaf(const FXTreeItem* item) const;

  FXbool isItemEnabled(const FXTreeItem* item) const;

  void updateItem(FXTreeItem* item) const;

  virtual FXbool enableItem(FXTreeItem* item);

  virtual FXbool disableItem(FXTreeItem* item);

  virtual FXbool selectItem(FXTreeItem* item,FXbool notify=false);

  virtual FXbool deselectItem(FXTreeItem* item,FXbool notify=false);

  virtual FXbool toggleItem(FXTreeItem* item,FXbool notify=false);

  virtual FXbool extendSelection(FXTreeItem* item,FXbool notify=false);

  virtual FXbool selectAll(FXbool notify=false);

  virtual FXbool killSelection(FXbool notify=false);

  virtual FXbool openItem(FXTreeItem* item,FXbool notify=false);

  virtual FXbool closeItem(FXTreeItem* item,FXbool notify=false);

  virtual FXbool collapseTree(FXTreeItem* tree,FXbool notify=false);

  virtual FXbool expandTree(FXTreeItem* tree,FXbool notify=false);

  virtual void setCurrentItem(FXTreeItem* item,FXbool notify=false);

  FXTreeItem* getCurrentItem() const { return currentitem; }

  void setAnchorItem(FXTreeItem* item);

  FXTreeItem* getAnchorItem() const { return anchoritem; }

  void sortItems();

  void sortRootItems();

  void sortChildItems(FXTreeItem* item);

  FXTreeListSortFunc getSortFunc() const { return sortfunc; }

  void setSortFunc(FXTreeListSortFunc func){ sortfunc=func; }

  void setFont(FXFont* fnt);

  FXFont* getFont() const { return font; }

  void setIndent(FXint in);

  FXint getIndent() const { return indent; }

  FXColor getTextColor() const { return textColor; }

  void setTextColor(FXColor clr);

  FXColor getSelBackColor() const { return selbackColor; }

  void setSelBackColor(FXColor clr);

  FXColor getSelTextColor() const { return seltextColor; }

  void setSelTextColor(FXColor clr);

  FXColor getLineColor() const { return lineColor; }

  void setLineColor(FXColor clr);

  FXuint getListStyle() const;

  void setListStyle(FXuint style);

  void setHelpText(const FXString& text);

  const FXString& getHelpText() const { return help; }

  virtual void save(FXStream& store) const;

  virtual void load(FXStream& store);

  virtual ~FXTreeList();
  };

}

#endif