juce/source/src/gui/components/filebrowser/juce_DirectoryContentsDisplayComponent.h

   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 #ifndef __JUCE_DIRECTORYCONTENTSDISPLAYCOMPONENT_JUCEHEADER__
  27 #define __JUCE_DIRECTORYCONTENTSDISPLAYCOMPONENT_JUCEHEADER__
  28
  29 #include "../juce_Component.h"
  30 #include "juce_DirectoryContentsList.h"
  31 #include "juce_FileBrowserListener.h"
  32
  33
  34 //==============================================================================
  35 /**
  36     A base class for components that display a list of the files in a directory.
  37
  38     @see DirectoryContentsList
  39 */
  40 class JUCE_API  DirectoryContentsDisplayComponent
  41 {
  42 public:
  43     //==============================================================================
  44     /** Creates a DirectoryContentsDisplayComponent for a given list of files. */
  45     DirectoryContentsDisplayComponent (DirectoryContentsList& listToShow);
  46
  47     /** Destructor. */
  48     virtual ~DirectoryContentsDisplayComponent();
  49
  50     //==============================================================================
  51     /** Returns the number of files the user has got selected.
  52         @see getSelectedFile
  53     */
  54     virtual int getNumSelectedFiles() const = 0;
  55
  56     /** Returns one of the files that the user has currently selected.
  57         The index should be in the range 0 to (getNumSelectedFiles() - 1).
  58         @see getNumSelectedFiles
  59     */
  60     virtual const File getSelectedFile (int index) const = 0;
  61
  62     /** Deselects any selected files. */
  63     virtual void deselectAllFiles() = 0;
  64
  65     /** Scrolls this view to the top. */
  66     virtual void scrollToTop() = 0;
  67
  68     //==============================================================================
  69     /** Adds a listener to be told when files are selected or clicked.
  70         @see removeListener
  71     */
  72     void addListener (FileBrowserListener* listener);
  73
  74     /** Removes a listener.
  75         @see addListener
  76     */
  77     void removeListener (FileBrowserListener* listener);
  78
  79
  80     //==============================================================================
  81     /** A set of colour IDs to use to change the colour of various aspects of the list.
  82
  83         These constants can be used either via the Component::setColour(), or LookAndFeel::setColour()
  84         methods.
  85
  86         @see Component::setColour, Component::findColour, LookAndFeel::setColour, LookAndFeel::findColour
  87     */
  88     enum ColourIds
  89     {
  90         highlightColourId      = 0x1000540, /**< The colour to use to fill a highlighted row of the list. */
  91         textColourId           = 0x1000541, /**< The colour for the text. */
  92     };
  93
  94     //==============================================================================
  95     /** @internal */
  96     void sendSelectionChangeMessage();
  97     /** @internal */
  98     void sendDoubleClickMessage (const File& file);
  99     /** @internal */
 100     void sendMouseClickMessage (const File& file, const MouseEvent& e);
 101
 102 protected:
 103     //==============================================================================
 104     DirectoryContentsList& fileList;
 105     ListenerList <FileBrowserListener> listeners;
 106
 107 private:
 108     JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR (DirectoryContentsDisplayComponent);
 109 };
 110
 111
 112 #endif   // __JUCE_DIRECTORYCONTENTSDISPLAYCOMPONENT_JUCEHEADER__