FXTreeListBox.h

/********************************************************************************
*                                                                               *
*                      T r e e   L i s t   B o x   W i d g e t                  *
*                                                                               *
*********************************************************************************
* Copyright (C) 1999,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 FXTREELISTBOX_H
#define FXTREELISTBOX_H

#ifndef FXPACKER_H
#include "FXPacker.h"
#endif

namespace FX {


enum {
  TREELISTBOX_NORMAL         = 0          
  };


class FXButton;
class FXMenuButton;
class FXTreeList;
class FXPopup;


class FXAPI FXTreeListBox : public FXPacker {
  FXDECLARE(FXTreeListBox)
protected:
  FXButton      *field;
  FXMenuButton  *button;
  FXTreeList    *tree;
  FXPopup       *pane;
protected:
  FXTreeListBox(){}
private:
  FXTreeListBox(const FXTreeListBox&);
  FXTreeListBox& operator=(const FXTreeListBox&);
public:
  long onFocusUp(FXObject*,FXSelector,void*);
  long onFocusDown(FXObject*,FXSelector,void*);
  long onFocusSelf(FXObject*,FXSelector,void*);
  long onMouseWheel(FXObject*,FXSelector,void*);
  long onFieldButton(FXObject*,FXSelector,void*);
  long onTreeUpdate(FXObject*,FXSelector,void*);
  long onTreeForward(FXObject*,FXSelector,void*);
  long onTreeClicked(FXObject*,FXSelector,void*);
  long onTreeCommand(FXObject*,FXSelector,void*);
public:
  enum{
    ID_TREE=FXPacker::ID_LAST,
    ID_FIELD,
    ID_LAST
    };
public:

  FXTreeListBox(FXComposite *p,FXObject* tgt=nullptr,FXSelector sel=0,FXuint opts=FRAME_SUNKEN|FRAME_THICK|TREELISTBOX_NORMAL,FXint x=0,FXint y=0,FXint w=0,FXint h=0,FXint pl=DEFAULT_PAD,FXint pr=DEFAULT_PAD,FXint pt=DEFAULT_PAD,FXint pb=DEFAULT_PAD);

  virtual void create();

  virtual void detach();

  virtual void destroy();

  virtual void layout();

  virtual void enable();

  virtual void disable();

  virtual FXint getDefaultWidth();

  virtual FXint getDefaultHeight();

  FXint getNumItems() const;

  FXint getNumVisible() const;

  void setNumVisible(FXint nvis);

  FXTreeItem* getFirstItem() const;

  FXTreeItem* getLastItem() const;

  FXbool isItemCurrent(const FXTreeItem* item) const;

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

  FXTreeItem* getCurrentItem() const;

  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);

  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,FXptr ptr) const;

  FXptr getItemData(const FXTreeItem* item) const;

  FXbool isItemLeaf(const FXTreeItem* item) const;

  FXbool isItemEnabled(const FXTreeItem* item) const;

  FXbool enableItem(FXTreeItem* item);

  FXbool disableItem(FXTreeItem* item);

  void showMenu(FXbool shw);

  FXbool isMenuShown() const;

  void sortItems();

  void sortRootItems();

  void sortChildItems(FXTreeItem* item);

  void setFont(FXFont* fnt);

  FXFont* getFont() const;

  void setListStyle(FXuint style);

  FXuint getListStyle() const;

  void setShrinkWrap(FXbool flag);

  FXbool getShrinkWrap() const;

  FXTreeListSortFunc getSortFunc() const;

  void setSortFunc(FXTreeListSortFunc func);

  void setHelpText(const FXString& txt);

  const FXString& getHelpText() const;

  void setTipText(const FXString& txt);

  const FXString& getTipText() const;

  virtual void save(FXStream& store) const;

  virtual void load(FXStream& store);

  virtual ~FXTreeListBox();
  };

}

#endif