TGFSContainer.h

Go to the documentation of this file.

// @(#)root/gui:$Id$
// Author: Fons Rademakers   19/01/98
 
/*************************************************************************
 * Copyright (C) 1995-2021, Rene Brun and Fons Rademakers.               *
 * All rights reserved.                                                  *
 *                                                                       *
 * For the licensing terms see $ROOTSYS/LICENSE.                         *
 * For the list of contributors see $ROOTSYS/README/CREDITS.             *
 *************************************************************************/
 
#ifndef ROOT_TGFSContainer
#define ROOT_TGFSContainer
 
 
#include "TGListView.h"
#include "TGDNDManager.h"
 
//----- file sort mode
enum EFSSortMode {
   kSortByName,
   kSortByType,
   kSortBySize,
   kSortByDate,
   kSortByOwner,
   kSortByGroup
};
 
 
class TRegexp;
class TGPicture;
class TGFileContainer;
class TViewUpdateTimer;
class TGFileIcon;
class TGFileItem;
class TTimer;
class TString;
class TBufferFile;
struct FileStat_t;
 
 
class TGFileItem : public TGLVEntry {
 
protected:
   const TGPicture  *fBlpic;        ///< big icon
   const TGPicture  *fSlpic;        ///< small icon
   const TGPicture  *fLcurrent;     ///< current icon
   Int_t             fType;         ///< file type
   Int_t             fUid, fGid;    ///< file uid and gid
   Bool_t            fIsLink;       ///< true if symbolic link
   Long_t            fModTime;      ///< modification time
   Long64_t          fSize;         ///< file size
   TBufferFile      *fBuf;          ///< buffer used for Drag and Drop
   TDNDData          fDNDData;      ///< Drag and Drop data
 
   void         Init(const TGPicture *blpic, const TGPicture *slpic,
                     FileStat_t &stat, EListViewMode viewMode);
   void DoRedraw() override;
 
public:
   TGFileItem(const TGWindow *p = nullptr,
              const TGPicture *bpic = nullptr, const TGPicture *blpic = nullptr,
              const TGPicture *spic = nullptr, const TGPicture *slpic = nullptr,
              TGString *name = nullptr, Int_t type = 0, Long64_t size = 1,
              Int_t uid = 0, Int_t gid = 0, Long_t modtime = 0,
              EListViewMode viewMode = kLVList, UInt_t options = kVerticalFrame,
              Pixel_t back = GetWhitePixel());
 
   TGFileItem(const TGWindow *p,
              const TGPicture *bpic, const TGPicture *blpic,
              const TGPicture *spic, const TGPicture *slpic,
              TGString *name, FileStat_t &stat,
              EListViewMode viewMode = kLVList, UInt_t options = kVerticalFrame,
              Pixel_t back = GetWhitePixel());
 
   ~TGFileItem() override;
 
   void     SetViewMode(EListViewMode viewMode) override;
 
   Bool_t   IsActive() const override { return fActive; }
   Bool_t   IsSymLink() const { return fIsLink; }
   Int_t    GetType() const { return fType; }
   Long64_t GetSize() const { return fSize; }
   Long_t   GetModTime() const { return fModTime; }
   Int_t    GetUid() const { return fUid; }
   Int_t    GetGid() const { return fGid; }
 
   virtual TDNDData *GetDNDdata(Atom_t) {
      return &fDNDData;
   }
 
   Atom_t HandleDNDEnter(Atom_t *) override;
 
   Bool_t HandleDNDLeave() override {
      return kTRUE;
   }
 
   Atom_t HandleDNDPosition(int, int, Atom_t action, int, int) override {
      if (action == TGDNDManager::GetDNDActionCopy()) return action;
      return kNone;
   }
 
   Bool_t HandleDNDFinished() override {
      return ((TGFrame *)(const_cast<TGWindow*>(GetParent())))->HandleDNDFinished();
   }
 
   void SetDNDData(TDNDData *data);
 
   void SetDNDObject(TObject *obj);
 
   ClassDefOverride(TGFileItem,0)   // Class representing file system object
};
 
 
class TGFileContainer : public TGLVContainer {
 
friend class TGFSFrameElement;
 
protected:
   EFSSortMode       fSortType;       ///< sorting mode of contents
   TRegexp          *fFilter;         ///< file filter
   TViewUpdateTimer *fRefresh;        ///< refresh timer
   ULong_t           fMtime;          ///< directory modification time
   TString           fDirectory;      ///< current directory
   TList            *fCleanups;       ///< list of pictures to cleanup
   const TGPicture  *fFolder_t;       ///< small folder icon
   const TGPicture  *fFolder_s;       ///< big folder icon
   const TGPicture  *fApp_t;          ///< small application icon
   const TGPicture  *fApp_s;          ///< big application icon
   const TGPicture  *fDoc_t;          ///< small document icon
   const TGPicture  *fDoc_s;          ///< big document icon
   const TGPicture  *fSlink_t;        ///< small symbolic link icon
   const TGPicture  *fSlink_s;        ///< big symbolic link icon
   Bool_t            fCachePictures;  ///< kTRUE use caching
   Bool_t            fDisplayStat;    ///< kFALSE to interrupt display directory
                                      ///< contents in case of many files inside
 
   void CreateFileList();
 
public:
   TGFileContainer(const TGWindow *p = nullptr, UInt_t w = 1, UInt_t h = 1,
                   UInt_t options = kSunkenFrame,
                   Pixel_t back = GetDefaultFrameBackground());
   TGFileContainer(TGCanvas *p, UInt_t options = kSunkenFrame,
                   Pixel_t back = GetDefaultFrameBackground());
 
   ~TGFileContainer() override;
 
   Bool_t HandleTimer(TTimer *t) override;
   void StopRefreshTimer();
   void StartRefreshTimer(ULong_t msec=1000);
 
   virtual TGFileItem *AddFile(const char *name, const TGPicture *pic = nullptr, const TGPicture *lpic = nullptr);
   virtual TGFileItem *AddRemoteFile(TObject *obj, const TGPicture *ipic = nullptr, const TGPicture *ilpic = nullptr);
   void AddFrame(TGFrame *f, TGLayoutHints *l = nullptr) override;
   virtual void Sort(EFSSortMode sortType);
   virtual void SetFilter(const char *filter);
   virtual void ChangeDirectory(const char *path);
   virtual void DisplayDirectory();
   virtual void SetDisplayStat(Bool_t stat = kTRUE) { fDisplayStat = stat; }
   Bool_t       GetDisplayStat() { return fDisplayStat; }
 
   const char *GetDirectory() const { return fDirectory.Data(); }
 
   virtual void GetFilePictures(const TGPicture **pic, const TGPicture **lpic,
                                Int_t file_type, Bool_t is_link, const char *ext,
                                Bool_t small);
 
   void SavePrimitive(std::ostream &out, Option_t *option = "") override;
 
   ClassDefOverride(TGFileContainer,0)  // Container containing file system objects
};
 
#endif