juce/source/src/gui/components/filebrowser/juce_FileListComponent.cpp

   1 /*
   2   ==============================================================================
   3
   4    This file is part of the JUCE library - "Jules' Utility Class Extensions"
   5    Copyright 2004-11 by Raw Material Software Ltd.
   6
   7   ------------------------------------------------------------------------------
   8
   9    JUCE can be redistributed and/or modified under the terms of the GNU General
  10    Public License (Version 2), as published by the Free Software Foundation.
  11    A copy of the license is included in the JUCE distribution, or can be found
  12    online at www.gnu.org/licenses.
  13
  14    JUCE is distributed in the hope that it will be useful, but WITHOUT ANY
  15    WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
  16    A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
  17
  18   ------------------------------------------------------------------------------
  19
  20    To release a closed-source product which uses JUCE, commercial licenses are
  21    available: visit www.rawmaterialsoftware.com/juce for more information.
  22
  23   ==============================================================================
  24 */
  25
  26 #include "../../../core/juce_StandardHeader.h"
  27
  28 BEGIN_JUCE_NAMESPACE
  29
  30 #include "juce_FileListComponent.h"
  31 #include "../lookandfeel/juce_LookAndFeel.h"
  32 #include "../../graphics/imaging/juce_ImageCache.h"
  33 #include "../../../events/juce_AsyncUpdater.h"
  34
  35 Image juce_createIconForFile (const File& file);
  36
  37
  38 //==============================================================================
  39 FileListComponent::FileListComponent (DirectoryContentsList& listToShow)
  40     : ListBox (String::empty, nullptr),
  41       DirectoryContentsDisplayComponent (listToShow)
  42 {
  43     setModel (this);
  44     fileList.addChangeListener (this);
  45 }
  46
  47 FileListComponent::~FileListComponent()
  48 {
  49     fileList.removeChangeListener (this);
  50 }
  51
  52 int FileListComponent::getNumSelectedFiles() const
  53 {
  54     return getNumSelectedRows();
  55 }
  56
  57 const File FileListComponent::getSelectedFile (int index) const
  58 {
  59     return fileList.getFile (getSelectedRow (index));
  60 }
  61
  62 void FileListComponent::deselectAllFiles()
  63 {
  64     deselectAllRows();
  65 }
  66
  67 void FileListComponent::scrollToTop()
  68 {
  69     getVerticalScrollBar()->setCurrentRangeStart (0);
  70 }
  71
  72 //==============================================================================
  73 void FileListComponent::changeListenerCallback (ChangeBroadcaster*)
  74 {
  75     updateContent();
  76
  77     if (lastDirectory != fileList.getDirectory())
  78     {
  79         lastDirectory = fileList.getDirectory();
  80         deselectAllRows();
  81     }
  82 }
  83
  84 //==============================================================================
  85 class FileListItemComponent  : public Component,
  86                                public TimeSliceClient,
  87                                public AsyncUpdater
  88 {
  89 public:
  90     //==============================================================================
  91     FileListItemComponent (FileListComponent& owner_, TimeSliceThread& thread_)
  92         : owner (owner_), thread (thread_), index (0), highlighted (false)
  93     {
  94     }
  95
  96     ~FileListItemComponent()
  97     {
  98         thread.removeTimeSliceClient (this);
  99     }
 100
 101     //==============================================================================
 102     void paint (Graphics& g)
 103     {
 104         getLookAndFeel().drawFileBrowserRow (g, getWidth(), getHeight(),
 105                                              file.getFileName(),
 106                                              &icon, fileSize, modTime,
 107                                              isDirectory, highlighted,
 108                                              index, owner);
 109     }
 110
 111     void mouseDown (const MouseEvent& e)
 112     {
 113         owner.selectRowsBasedOnModifierKeys (index, e.mods, false);
 114         owner.sendMouseClickMessage (file, e);
 115     }
 116
 117     void mouseDoubleClick (const MouseEvent&)
 118     {
 119         owner.sendDoubleClickMessage (file);
 120     }
 121
 122     void update (const File& root,
 123                  const DirectoryContentsList::FileInfo* const fileInfo,
 124                  const int index_,
 125                  const bool highlighted_)
 126     {
 127         thread.removeTimeSliceClient (this);
 128
 129         if (highlighted_ != highlighted || index_ != index)
 130         {
 131             index = index_;
 132             highlighted = highlighted_;
 133             repaint();
 134         }
 135
 136         File newFile;
 137         String newFileSize, newModTime;
 138
 139         if (fileInfo != nullptr)
 140         {
 141             newFile = root.getChildFile (fileInfo->filename);
 142             newFileSize = File::descriptionOfSizeInBytes (fileInfo->fileSize);
 143             newModTime = fileInfo->modificationTime.formatted ("%d %b '%y %H:%M");
 144         }
 145
 146         if (newFile != file
 147              || fileSize != newFileSize
 148              || modTime != newModTime)
 149         {
 150             file = newFile;
 151             fileSize = newFileSize;
 152             modTime = newModTime;
 153             icon = Image::null;
 154             isDirectory = fileInfo != nullptr && fileInfo->isDirectory;
 155
 156             repaint();
 157         }
 158
 159         if (file != File::nonexistent && icon.isNull() && ! isDirectory)
 160         {
 161             updateIcon (true);
 162
 163             if (! icon.isValid())
 164                 thread.addTimeSliceClient (this);
 165         }
 166     }
 167
 168     int useTimeSlice()
 169     {
 170         updateIcon (false);
 171         return -1;
 172     }
 173
 174     void handleAsyncUpdate()
 175     {
 176         repaint();
 177     }
 178
 179 private:
 180     //==============================================================================
 181     FileListComponent& owner;
 182     TimeSliceThread& thread;
 183     File file;
 184     String fileSize, modTime;
 185     Image icon;
 186     int index;
 187     bool highlighted, isDirectory;
 188
 189     void updateIcon (const bool onlyUpdateIfCached)
 190     {
 191         if (icon.isNull())
 192         {
 193             const int hashCode = (file.getFullPathName() + "_iconCacheSalt").hashCode();
 194             Image im (ImageCache::getFromHashCode (hashCode));
 195
 196             if (im.isNull() && ! onlyUpdateIfCached)
 197             {
 198                 im = juce_createIconForFile (file);
 199
 200                 if (im.isValid())
 201                     ImageCache::addImageToCache (im, hashCode);
 202             }
 203
 204             if (im.isValid())
 205             {
 206                 icon = im;
 207                 triggerAsyncUpdate();
 208             }
 209         }
 210     }
 211
 212     JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR (FileListItemComponent);
 213 };
 214
 215 //==============================================================================
 216 int FileListComponent::getNumRows()
 217 {
 218     return fileList.getNumFiles();
 219 }
 220
 221 void FileListComponent::paintListBoxItem (int, Graphics&, int, int, bool)
 222 {
 223 }
 224
 225 Component* FileListComponent::refreshComponentForRow (int row, bool isSelected, Component* existingComponentToUpdate)
 226 {
 227     FileListItemComponent* comp = dynamic_cast <FileListItemComponent*> (existingComponentToUpdate);
 228
 229     if (comp == nullptr)
 230     {
 231         delete existingComponentToUpdate;
 232         comp = new FileListItemComponent (*this, fileList.getTimeSliceThread());
 233     }
 234
 235     DirectoryContentsList::FileInfo fileInfo;
 236
 237     if (fileList.getFileInfo (row, fileInfo))
 238         comp->update (fileList.getDirectory(), &fileInfo, row, isSelected);
 239     else
 240         comp->update (fileList.getDirectory(), nullptr, row, isSelected);
 241
 242     return comp;
 243 }
 244
 245 void FileListComponent::selectedRowsChanged (int /*lastRowSelected*/)
 246 {
 247     sendSelectionChangeMessage();
 248 }
 249
 250 void FileListComponent::deleteKeyPressed (int /*currentSelectedRow*/)
 251 {
 252 }
 253
 254 void FileListComponent::returnKeyPressed (int currentSelectedRow)
 255 {
 256     sendDoubleClickMessage (fileList.getFile (currentSelectedRow));
 257 }
 258
 259
 260 END_JUCE_NAMESPACE