FXList.h

/********************************************************************************
*                                                                               *
*                            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 FXLIST_H
#define FXLIST_H

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

namespace FX {


enum {
  LIST_EXTENDEDSELECT    = 0,             
  LIST_SINGLESELECT      = 0x00100000,    
  LIST_BROWSESELECT      = 0x00200000,    
  LIST_MULTIPLESELECT    = 0x00300000,    
  LIST_AUTOSELECT        = 0x00400000,    
  LIST_NORMAL            = LIST_EXTENDEDSELECT
  };


class FXIcon;
class FXFont;
class FXList;


class FXAPI FXListItem : public FXObject {
  FXDECLARE(FXListItem)
  friend class FXList;
protected:
  FXString  label;
  FXIcon   *icon;
  FXptr     data;
  FXuint    state;
  FXint     x,y;
private:
  FXListItem(const FXListItem&);
  FXListItem& operator=(const FXListItem&);
protected:
  FXListItem():icon(nullptr),data(nullptr),state(0),x(0),y(0){}
  virtual void draw(const FXList* list,FXDC& dc,FXint x,FXint y,FXint w,FXint h) const;
  virtual FXint hitItem(const FXList* list,FXint x,FXint y) const;
public:
  enum {
    SELECTED  = 1,      
    FOCUS     = 2,      
    DISABLED  = 4,      
    DRAGGABLE = 8,      
    ICONOWNED = 16      
    };
public:

  FXListItem(const FXString& text,FXIcon* ic=nullptr,FXptr ptr=nullptr):label(text),icon(ic),data(ptr),state(0),x(0),y(0){}

  virtual void setText(const FXString& txt);

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

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

  FXIcon* getIcon() const { return icon; }

  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 setEnabled(FXbool enabled);

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

  virtual void setDraggable(FXbool draggable);

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

  virtual FXString getTipText() const;

  virtual FXint getWidth(const FXList* list) const;

  virtual FXint getHeight(const FXList* list) const;

  virtual void create();

  virtual void detach();

  virtual void destroy();

  virtual void save(FXStream& store) const;

  virtual void load(FXStream& store);

  virtual ~FXListItem();
  };


typedef FXint (*FXListSortFunc)(const FXListItem*,const FXListItem*);


typedef FXObjectListOf<FXListItem> FXListItemList;


class FXAPI FXList : public FXScrollArea {
  FXDECLARE(FXList)
protected:
  FXListItemList items;             // Item list
  FXint          anchor;            // Anchor item
  FXint          current;           // Current item
  FXint          extent;            // Extent item
  FXint          viewable;          // Viewable item
  FXFont        *font;              // Font
  FXColor        textColor;         // Text color
  FXColor        selbackColor;      // Selected back color
  FXColor        seltextColor;      // Selected text color
  FXint          listWidth;         // List width
  FXint          listHeight;        // List height
  FXint          visible;           // Number of rows high
  FXString       help;              // Help text
  FXListSortFunc sortfunc;          // Item sort function
  FXint          grabx;             // Grab point x
  FXint          graby;             // Grab point y
  FXString       lookup;            // Lookup string
  FXbool         state;             // State of item
protected:
  FXList();
  void recompute();
  virtual FXListItem *createItem(const FXString& text,FXIcon* icon,FXptr ptr);
private:
  FXList(const FXList&);
  FXList &operator=(const FXList&);
public:
  long onPaint(FXObject*,FXSelector,void*);
  long onEnter(FXObject*,FXSelector,void*);
  long onLeave(FXObject*,FXSelector,void*);
  long onUngrabbed(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 onMotion(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 onQueryTip(FXObject*,FXSelector,void*);
  long onQueryHelp(FXObject*,FXSelector,void*);
  long onTipTimer(FXObject*,FXSelector,void*);
  long onLookupTimer(FXObject*,FXSelector,void*);
  long onCmdSetValue(FXObject*,FXSelector,void*);public:
  long onCmdGetIntValue(FXObject*,FXSelector,void*);
  long onCmdSetIntValue(FXObject*,FXSelector,void*);
public:
  static FXint ascending(const FXListItem* a,const FXListItem* b);
  static FXint descending(const FXListItem* a,const FXListItem* b);
  static FXint ascendingCase(const FXListItem* a,const FXListItem* b);
  static FXint descendingCase(const FXListItem* a,const FXListItem* b);
public:
  enum {
    ID_LOOKUPTIMER=FXScrollArea::ID_LAST,
    ID_LAST
    };
public:

  FXList(FXComposite *p,FXObject* tgt=nullptr,FXSelector sel=0,FXuint opts=LIST_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 { return (FXint)items.no(); }

  FXint getNumVisible() const { return visible; }

  void setNumVisible(FXint nvis);

  FXListItem *getItem(FXint index) const;

  FXint setItem(FXint index,FXListItem* item,FXbool notify=false);

  FXint setItem(FXint index,const FXString& text,FXIcon *icon=nullptr,FXptr ptr=nullptr,FXbool notify=false);

  FXint fillItems(const FXchar *const *strings,FXIcon *icon=nullptr,FXptr ptr=nullptr,FXbool notify=false);

  FXint fillItems(const FXString* strings,FXIcon *icon=nullptr,FXptr ptr=nullptr,FXbool notify=false);

  FXint fillItems(const FXString& strings,FXIcon *icon=nullptr,FXptr ptr=nullptr,FXbool notify=false);

  FXint insertItem(FXint index,FXListItem* item,FXbool notify=false);

  FXint insertItem(FXint index,const FXString& text,FXIcon *icon=nullptr,FXptr ptr=nullptr,FXbool notify=false);

  FXint appendItem(FXListItem* item,FXbool notify=false);

  FXint appendItem(const FXString& text,FXIcon *icon=nullptr,FXptr ptr=nullptr,FXbool notify=false);

  FXint prependItem(FXListItem* item,FXbool notify=false);

  FXint prependItem(const FXString& text,FXIcon *icon=nullptr,FXptr ptr=nullptr,FXbool notify=false);

  FXint moveItem(FXint newindex,FXint oldindex,FXbool notify=false);

  FXListItem* extractItem(FXint index,FXbool notify=false);

  void removeItem(FXint index,FXbool notify=false);

  void clearItems(FXbool notify=false);

  FXint getItemWidth(FXint index) const;

  FXint getItemHeight(FXint index) const;

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

  FXint hitItem(FXint index,FXint x,FXint y) const;

  virtual void makeItemVisible(FXint index);

  FXint findItem(const FXString& string,FXint start=-1,FXuint flags=SEARCH_FORWARD|SEARCH_WRAP) const;

  FXint findItemByData(FXptr ptr,FXint start=-1,FXuint flags=SEARCH_FORWARD|SEARCH_WRAP) const;

  void setItemText(FXint index,const FXString& text);

  FXString getItemText(FXint index) const;

  void setItemIcon(FXint index,FXIcon* icon,FXbool owned=false);

  FXIcon* getItemIcon(FXint index) const;

  void setItemData(FXint index,FXptr ptr);

  FXptr getItemData(FXint index) const;

  FXbool isItemSelected(FXint index) const;

  FXbool isItemCurrent(FXint index) const;

  FXbool isItemVisible(FXint index) const;

  FXbool isItemEnabled(FXint index) const;

  void updateItem(FXint index) const;

  virtual FXbool enableItem(FXint index);

  virtual FXbool disableItem(FXint index);

  virtual FXbool selectItem(FXint index,FXbool notify=false);

  virtual FXbool deselectItem(FXint index,FXbool notify=false);

  virtual FXbool toggleItem(FXint index,FXbool notify=false);

  virtual FXbool extendSelection(FXint index,FXbool notify=false);

  virtual FXbool selectAll(FXbool notify=false);

  virtual FXbool killSelection(FXbool notify=false);

  virtual void setCurrentItem(FXint index,FXbool notify=false);

  FXint getCurrentItem() const { return current; }

  void setAnchorItem(FXint index);

  FXint getAnchorItem() const { return anchor; }

  void sortItems();

  FXListSortFunc getSortFunc() const { return sortfunc; }

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

  void setFont(FXFont* fnt);

  FXFont* getFont() const { return font; }

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

  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 ~FXList();
  };

}

#endif