juce::DirectoryContentsDisplayComponent Class Reference

A base class for components that display a list of the files in a directory. More...

#include "juce_DirectoryContentsDisplayComponent.h"

Inheritance diagram for juce::DirectoryContentsDisplayComponent:

Public Types
enum	ColourIds { highlightColourId , textColourId , highlightedTextColourId }
	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.
virtual	~DirectoryContentsDisplayComponent ()
	Destructor.
virtual int	getNumSelectedFiles () const =0
	Returns the number of files the user has got selected.
virtual File	getSelectedFile (int index) const =0
	Returns one of the files that the user has currently selected.
virtual void	deselectAllFiles ()=0
	Deselects any selected files.
virtual void	scrollToTop ()=0
	Scrolls this view to the top.
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).
void	addListener (FileBrowserListener *listener)
	Adds a listener to be told when files are selected or clicked.
void	removeListener (FileBrowserListener *listener)
	Removes a listener.
void	sendSelectionChangeMessage ()
void	sendDoubleClickMessage (const File &)
void	sendMouseClickMessage (const File &, const MouseEvent &)

Public Attributes
DirectoryContentsList &	directoryContentsList
	The list that this component is displaying.

Protected Attributes
ListenerList< FileBrowserListener >	listeners

Detailed Description

A base class for components that display a list of the files in a directory.

See also

DirectoryContentsList

@tags{GUI}

Definition at line 37 of file juce_DirectoryContentsDisplayComponent.h.

Member Enumeration Documentation

ColourIds

enum juce::DirectoryContentsDisplayComponent::ColourIds

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.

See also

Component::setColour, Component::findColour, LookAndFeel::setColour, LookAndFeel::findColour

Enumerator
highlightColourId	The colour to use to fill a highlighted row of the list.
textColourId	The colour for the text.
highlightedTextColourId	The colour with which to draw the text in highlighted sections.

Definition at line 93 of file juce_DirectoryContentsDisplayComponent.h.

Constructor & Destructor Documentation

DirectoryContentsDisplayComponent()

juce::DirectoryContentsDisplayComponent::DirectoryContentsDisplayComponent

(

DirectoryContentsList &

listToShow

)

Creates a DirectoryContentsDisplayComponent for a given list of files.

Definition at line 29 of file juce_DirectoryContentsDisplayComponent.cpp.

~DirectoryContentsDisplayComponent()

juce::DirectoryContentsDisplayComponent::~DirectoryContentsDisplayComponent ( )

virtual

Destructor.

Definition at line 34 of file juce_DirectoryContentsDisplayComponent.cpp.

Member Function Documentation

addListener()

void juce::DirectoryContentsDisplayComponent::addListener

(

FileBrowserListener *

listener

)

Adds a listener to be told when files are selected or clicked.

See also

removeListener

Definition at line 43 of file juce_DirectoryContentsDisplayComponent.cpp.

deselectAllFiles()

virtual void juce::DirectoryContentsDisplayComponent::deselectAllFiles ( )

pure virtual

Deselects any selected files.

Implemented in juce::FileListComponent, and juce::FileTreeComponent.

getNumSelectedFiles()

virtual int juce::DirectoryContentsDisplayComponent::getNumSelectedFiles ( ) const

pure virtual

Returns the number of files the user has got selected.

See also

getSelectedFile

Implemented in juce::FileListComponent, and juce::FileTreeComponent.

getSelectedFile()

virtual File juce::DirectoryContentsDisplayComponent::getSelectedFile ( int  index ) const

pure virtual

Returns one of the files that the user has currently selected.

The index should be in the range 0 to (getNumSelectedFiles() - 1).

See also

getNumSelectedFiles

Implemented in juce::FileListComponent, and juce::FileTreeComponent.

removeListener()

void juce::DirectoryContentsDisplayComponent::removeListener

(

FileBrowserListener *

listener

)

Removes a listener.

See also

addListener

Definition at line 44 of file juce_DirectoryContentsDisplayComponent.cpp.

scrollToTop()

virtual void juce::DirectoryContentsDisplayComponent::scrollToTop ( )

pure virtual

Scrolls this view to the top.

Implemented in juce::FileListComponent, and juce::FileTreeComponent.

sendDoubleClickMessage()

void juce::DirectoryContentsDisplayComponent::sendDoubleClickMessage

(

const File &

file

)

Definition at line 61 of file juce_DirectoryContentsDisplayComponent.cpp.

sendMouseClickMessage()

void juce::DirectoryContentsDisplayComponent::sendMouseClickMessage	(	const File &	file,
		const MouseEvent &	e
	)

Definition at line 52 of file juce_DirectoryContentsDisplayComponent.cpp.

sendSelectionChangeMessage()

void juce::DirectoryContentsDisplayComponent::sendSelectionChangeMessage

(

)

Definition at line 46 of file juce_DirectoryContentsDisplayComponent.cpp.

setSelectedFile()

virtual void juce::DirectoryContentsDisplayComponent::setSelectedFile ( const File &  )

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.

Member Data Documentation

directoryContentsList

DirectoryContentsList& juce::DirectoryContentsDisplayComponent::directoryContentsList

The list that this component is displaying.

Definition at line 49 of file juce_DirectoryContentsDisplayComponent.h.

listeners

ListenerList<FileBrowserListener> juce::DirectoryContentsDisplayComponent::listeners

protected

Definition at line 110 of file juce_DirectoryContentsDisplayComponent.h.

---

The documentation for this class was generated from the following files:

• juce_gui_basics/filebrowser/juce_DirectoryContentsDisplayComponent.h
• juce_gui_basics/filebrowser/juce_DirectoryContentsDisplayComponent.cpp