FXFileList.h

/********************************************************************************
*                                                                               *
*                        F i l 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 FXFILELIST_H
#define FXFILELIST_H

#ifndef FXICONLIST_H
#include "FXIconList.h"
#endif

namespace FX {


struct FXFileAssoc;
class FXFileList;
class FXIconSource;
class FXFileAssociations;


enum {
  FILELIST_SHOWHIDDEN   = 0x04000000, 
  FILELIST_SHOWDIRS     = 0x08000000, 
  FILELIST_SHOWFILES    = 0x10000000, 
  FILELIST_SHOWIMAGES   = 0x20000000, 
  FILELIST_NO_OWN_ASSOC = 0x40000000, 
  FILELIST_NO_PARENT    = 0x80000000  
  };


class FXAPI FXFileItem : public FXIconItem {
  FXDECLARE(FXFileItem)
  friend class FXFileList;
protected:
  FXFileAssoc *assoc;           // File association record
  FXFileItem  *link;            // Link to next item
  FXlong       size;            // File size
  FXTime       date;            // File time
  FXuint       mode;            // Mode flags
private:
  FXFileItem(const FXFileItem&);
  FXFileItem& operator=(const FXFileItem&);
protected:
  FXFileItem():assoc(nullptr),link(nullptr),size(0),date(0){}
public:

  FXFileItem(const FXString& text,FXIcon* bi=nullptr,FXIcon* mi=nullptr,void* ptr=nullptr):FXIconItem(text,bi,mi,ptr),assoc(nullptr),link(nullptr),size(0L),date(0L),mode(0){}

  FXbool isFile() const { return (mode&(FXIO::File))!=0; }

  FXbool isDirectory() const { return (mode&FXIO::Directory)!=0; }

  FXbool isExecutable() const { return (mode&FXIO::File)!=0 && (mode&FXIO::AllExec)!=0; }

  FXbool isSymlink() const { return (mode&FXIO::SymLink)!=0; }

  FXbool isChardev() const { return (mode&FXIO::Character)!=0; }

  FXbool isBlockdev() const { return (mode&FXIO::Block)!=0; }

  FXbool isFifo() const { return (mode&FXIO::Fifo)!=0; }

  FXbool isSocket() const { return (mode&FXIO::Socket)!=0; }

  FXbool isNavigational() const { return (label[0]=='.' && (label[1]=='\t' || (label[1]=='.' && label[2]=='\t'))); }

  void setAssoc(FXFileAssoc* a){ assoc=a; }

  FXFileAssoc* getAssoc() const { return assoc; }

  void setSize(FXlong s){ size=s; }

  FXlong getSize() const { return size; }

  void setDate(FXTime d){ date=d; }

  FXTime getDate() const { return date; }

  void setMode(FXuint m){ mode=m; }

  FXuint getMode() const { return mode; }
  };


class FXAPI FXFileList : public FXIconList {
  FXDECLARE(FXFileList)
protected:
  FXFileAssociations *associations;     // Association table
  FXIconSource       *iconloader;       // Icon loader
  FXFileItem         *list;             // File item list
  FXIcon             *big_folder;       // Big folder icon
  FXIcon             *mini_folder;      // Mini folder icon
  FXIcon             *big_doc;          // Big document icon
  FXIcon             *mini_doc;         // Mini document icon
  FXIcon             *big_app;          // Big application icon
  FXIcon             *mini_app;         // Mini application icon
  FXString            directory;        // Current directory
  FXString            pattern;          // Pattern of file names
  FXString            timeformat;       // File time formatting
  FXString            startdirectory;   // Start directory
  FXString            dropdirectory;    // Drop directory
  FXString            clipfiles;        // Clipped files
  FXString            dragfiles;        // Dragged files
  FXString            dropfiles;        // Dropped files
  FXDragAction        dropaction;       // Drop action
  FXuint              matchmode;        // File wildcard match mode
  FXint               imagesize;        // Image size
  FXTime              timestamp;        // Time when last refreshed
  FXuint              counter;          // Refresh counter
  FXbool              clipcut;          // Cut or copy
  FXbool              draggable;        // Dragable files
protected:
  FXFileList();
  FXbool listItems(FXbool force,FXbool notify);
  FXString getSelectedFiles() const;
  virtual FXIconItem *createItem(const FXString& text,FXIcon *big,FXIcon* mini,void* ptr);
  void delete_files(const FXString& files);
  void copy_files(const FXString& directory,const FXString& files);
  void move_files(const FXString& directory,const FXString& files);
  static FXint compareSectionNatural(const FXchar* s1,const FXchar* s2,FXint s,FXbool ci=false);
private:
  FXFileList(const FXFileList&);
  FXFileList &operator=(const FXFileList&);
public:
  long onOpenTimer(FXObject*,FXSelector,void*);
  long onRefreshTimer(FXObject*,FXSelector,void*);
  long onPreviewChore(FXObject*,FXSelector,void*);
  long onDNDEnter(FXObject*,FXSelector,void*);
  long onDNDLeave(FXObject*,FXSelector,void*);
  long onDNDMotion(FXObject*,FXSelector,void*);
  long onDNDDrop(FXObject*,FXSelector,void*);
  long onDNDRequest(FXObject*,FXSelector,void*);
  long onBeginDrag(FXObject*,FXSelector,void*);
  long onEndDrag(FXObject*,FXSelector,void*);
  long onDragged(FXObject*,FXSelector,void*);
  long onClipboardLost(FXObject*,FXSelector,void*);
  long onClipboardRequest(FXObject*,FXSelector,void*);
  long onCmdSetValue(FXObject*,FXSelector,void*);
  long onCmdGetStringValue(FXObject*,FXSelector,void*);
  long onCmdSetStringValue(FXObject*,FXSelector,void*);
  long onCmdDirectoryUp(FXObject*,FXSelector,void*);
  long onUpdDirectoryUp(FXObject*,FXSelector,void*);
  long onCmdSortByName(FXObject*,FXSelector,void*);
  long onUpdSortByName(FXObject*,FXSelector,void*);
  long onCmdSortByType(FXObject*,FXSelector,void*);
  long onUpdSortByType(FXObject*,FXSelector,void*);
  long onCmdSortBySize(FXObject*,FXSelector,void*);
  long onUpdSortBySize(FXObject*,FXSelector,void*);
  long onCmdSortByTime(FXObject*,FXSelector,void*);
  long onUpdSortByTime(FXObject*,FXSelector,void*);
  long onCmdSortByUser(FXObject*,FXSelector,void*);
  long onUpdSortByUser(FXObject*,FXSelector,void*);
  long onCmdSortByGroup(FXObject*,FXSelector,void*);
  long onUpdSortByGroup(FXObject*,FXSelector,void*);
  long onCmdSortReverse(FXObject*,FXSelector,void*);
  long onUpdSortReverse(FXObject*,FXSelector,void*);
  long onCmdSortCase(FXObject*,FXSelector,void*);
  long onUpdSortCase(FXObject*,FXSelector,void*);
  long onCmdSetPattern(FXObject*,FXSelector,void*);
  long onUpdSetPattern(FXObject*,FXSelector,void*);
  long onCmdSetDirectory(FXObject*,FXSelector,void*);
  long onUpdSetDirectory(FXObject*,FXSelector,void*);
  long onCmdToggleHidden(FXObject*,FXSelector,void*);
  long onUpdToggleHidden(FXObject*,FXSelector,void*);
  long onCmdShowHidden(FXObject*,FXSelector,void*);
  long onUpdShowHidden(FXObject*,FXSelector,void*);
  long onCmdHideHidden(FXObject*,FXSelector,void*);
  long onUpdHideHidden(FXObject*,FXSelector,void*);
  long onCmdToggleImages(FXObject*,FXSelector,void*);
  long onUpdToggleImages(FXObject*,FXSelector,void*);
  long onCmdHeader(FXObject*,FXSelector,void*);
  long onUpdHeader(FXObject*,FXSelector,void*);
  long onCmdRefresh(FXObject*,FXSelector,void*);
  long onUpdHaveSel(FXObject*,FXSelector,void*);
  long onCmdCutSel(FXObject*,FXSelector,void*);
  long onCmdCopySel(FXObject*,FXSelector,void*);
  long onCmdPasteSel(FXObject*,FXSelector,void*);
  long onCmdDeleteSel(FXObject*,FXSelector,void*);
  long onCmdDropAsk(FXObject*,FXSelector,void*);
  long onCmdDropCopy(FXObject*,FXSelector,void*);
  long onCmdDropMove(FXObject*,FXSelector,void*);
  long onCmdDropLink(FXObject*,FXSelector,void*);
public:
  static FXint ascending(const FXIconItem* a,const FXIconItem* b);
  static FXint descending(const FXIconItem* a,const FXIconItem* b);
  static FXint ascendingCase(const FXIconItem* a,const FXIconItem* b);
  static FXint descendingCase(const FXIconItem* a,const FXIconItem* b);
  static FXint ascendingType(const FXIconItem* a,const FXIconItem* b);
  static FXint descendingType(const FXIconItem* a,const FXIconItem* b);
  static FXint ascendingSize(const FXIconItem* a,const FXIconItem* b);
  static FXint descendingSize(const FXIconItem* a,const FXIconItem* b);
  static FXint ascendingTime(const FXIconItem* a,const FXIconItem* b);
  static FXint descendingTime(const FXIconItem* a,const FXIconItem* b);
  static FXint ascendingUser(const FXIconItem* a,const FXIconItem* b);
  static FXint descendingUser(const FXIconItem* a,const FXIconItem* b);
  static FXint ascendingGroup(const FXIconItem* a,const FXIconItem* b);
  static FXint descendingGroup(const FXIconItem* a,const FXIconItem* b);
public:
  enum {
    ID_OPENTIMER=FXIconList::ID_LAST,
    ID_REFRESHTIMER,
    ID_DROPASK,
    ID_DROPCOPY,
    ID_DROPMOVE,
    ID_DROPLINK,
    ID_PREVIEWCHORE,
    ID_SORT_BY_NAME,    
    ID_SORT_BY_TYPE,    
    ID_SORT_BY_SIZE,    
    ID_SORT_BY_TIME,    
    ID_SORT_BY_USER,    
    ID_SORT_BY_GROUP,   
    ID_SORT_REVERSE,    
    ID_SORT_CASE,       
    ID_DIRECTORY_UP,    
    ID_SET_PATTERN,     
    ID_SET_DIRECTORY,   
    ID_SHOW_HIDDEN,     
    ID_HIDE_HIDDEN,     
    ID_TOGGLE_HIDDEN,   
    ID_TOGGLE_IMAGES,   
    ID_REFRESH,         
    ID_CUT_SEL,         
    ID_COPY_SEL,        
    ID_DELETE_SEL,      
    ID_PASTE_SEL,       
    ID_LAST
    };
public:

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

  virtual void create();

  virtual void detach();

  virtual void destroy();

  FXbool setCurrentFile(const FXString& file,FXbool notify=false);

  FXString getCurrentFile() const;

  FXbool setDirectory(const FXString& path,FXbool notify=false);

  FXString getDirectory() const { return directory; }

  FXString getItemFilename(FXint index) const;

  FXString getItemPathname(FXint index) const;

  FXbool isItemFile(FXint index) const;

  FXbool isItemDirectory(FXint index) const;

  FXbool isItemExecutable(FXint index) const;

  FXbool isItemSymlink(FXint index) const;

  FXbool isItemNavigational(FXint index) const;

  FXFileAssoc* getItemAssoc(FXint index) const;

  FXlong getItemSize(FXint index) const;

  FXTime getItemDate(FXint index) const;

  FXuint getItemMode(FXint index) const;

  FXbool selectMatching(const FXString& ptrn="*",FXuint mode=FXPath::PathName|FXPath::NoEscape,FXbool notify=false);

  void setPattern(const FXString& ptrn="*",FXbool notify=false);

  FXString getPattern() const { return pattern; }

  void setMatchMode(FXuint mode=FXPath::PathName|FXPath::NoEscape,FXbool notify=false);

  FXuint getMatchMode() const { return matchmode; }

  void showHiddenFiles(FXbool flag,FXbool notify=false);

  FXbool showHiddenFiles() const;

  void showOnlyDirectories(FXbool flag,FXbool notify=false);

  FXbool showOnlyDirectories() const;

  void showOnlyFiles(FXbool flag,FXbool notify=false);

  FXbool showOnlyFiles() const;

  void showParents(FXbool flag,FXbool notify=false);

  FXbool showParents() const;

  void showImages(FXbool flag,FXbool notify=false);

  FXbool showImages() const;

  void setImageSize(FXint size,FXbool notify=false);

  FXint getImageSize() const { return imagesize; }

  void setDraggableFiles(FXbool flag,FXbool notify=false);

  FXbool getDraggableFiles() const { return draggable; }

  void setTimeFormat(const FXString& fmt,FXbool notify=false);

  const FXString& getTimeFormat() const { return timeformat; }

  void setAssociations(FXFileAssociations* assoc,FXbool owned=false,FXbool notify=false);

  FXFileAssociations* getAssociations() const { return associations; }

  void setIconSource(FXIconSource* src){ iconloader=src; }

  FXIconSource* getIconSource() const { return iconloader; }

  virtual void save(FXStream& store) const;

  virtual void load(FXStream& store);

  virtual ~FXFileList();
  };

}

#endif