A base class for components that display a list of the files in a directory. More...
#include <juce_DirectoryContentsDisplayComponent.h>
Public Types | |
enum | ColourIds { highlightColourId = 0x1000540, textColourId = 0x1000541, highlightedTextColourId = 0x1000542 } |
A set of colour IDs to use to change the colour of various aspects of the list. More... | |
Public Member Functions | |
DirectoryContentsDisplayComponent (DirectoryContentsList &listToShow) | |
Creates a DirectoryContentsDisplayComponent for a given list of files. More... | |
virtual | ~DirectoryContentsDisplayComponent () |
Destructor. More... | |
void | addListener (FileBrowserListener *listener) |
Adds a listener to be told when files are selected or clicked. More... | |
virtual void | deselectAllFiles ()=0 |
Deselects any selected files. More... | |
virtual int | getNumSelectedFiles () const =0 |
Returns the number of files the user has got selected. More... | |
virtual File | getSelectedFile (int index) const =0 |
Returns one of the files that the user has currently selected. More... | |
void | removeListener (FileBrowserListener *listener) |
Removes a listener. More... | |
virtual void | scrollToTop ()=0 |
Scrolls this view to the top. More... | |
void | sendDoubleClickMessage (const File &) |
void | sendMouseClickMessage (const File &, const MouseEvent &) |
void | sendSelectionChangeMessage () |
virtual void | setSelectedFile (const File &)=0 |
If the specified file is in the list, it will become the only selected item (and if the file isn't in the list, all other items will be deselected). More... | |
Public Attributes | |
DirectoryContentsList & | directoryContentsList |
The list that this component is displaying. More... | |
Protected Attributes | |
ListenerList< FileBrowserListener > | listeners |
A base class for components that display a list of the files in a directory.
@tags{GUI}
A set of colour IDs to use to change the colour of various aspects of the list.
These constants can be used either via the Component::setColour(), or LookAndFeel::setColour() methods.
juce::DirectoryContentsDisplayComponent::DirectoryContentsDisplayComponent | ( | DirectoryContentsList & | listToShow | ) |
Creates a DirectoryContentsDisplayComponent for a given list of files.
|
virtual |
Destructor.
void juce::DirectoryContentsDisplayComponent::addListener | ( | FileBrowserListener * | listener | ) |
Adds a listener to be told when files are selected or clicked.
|
pure virtual |
Deselects any selected files.
Implemented in juce::FileListComponent, and juce::FileTreeComponent.
|
pure virtual |
Returns the number of files the user has got selected.
Implemented in juce::FileListComponent, and juce::FileTreeComponent.
|
pure virtual |
Returns one of the files that the user has currently selected.
The index should be in the range 0 to (getNumSelectedFiles() - 1).
Implemented in juce::FileListComponent, and juce::FileTreeComponent.
void juce::DirectoryContentsDisplayComponent::removeListener | ( | FileBrowserListener * | listener | ) |
Removes a listener.
|
pure virtual |
Scrolls this view to the top.
Implemented in juce::FileListComponent, and juce::FileTreeComponent.
void juce::DirectoryContentsDisplayComponent::sendDoubleClickMessage | ( | const File & | ) |
void juce::DirectoryContentsDisplayComponent::sendMouseClickMessage | ( | const File & | , |
const MouseEvent & | |||
) |
void juce::DirectoryContentsDisplayComponent::sendSelectionChangeMessage | ( | ) |
|
pure virtual |
If the specified file is in the list, it will become the only selected item (and if the file isn't in the list, all other items will be deselected).
Implemented in juce::FileListComponent, and juce::FileTreeComponent.
DirectoryContentsList& juce::DirectoryContentsDisplayComponent::directoryContentsList |
The list that this component is displaying.
|
protected |