DirectoryContentsDisplayComponent Class Reference

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

Inherited by FileListComponent, and FileTreeComponent.

List of all members.

Public Types
enum	ColourIds { highlightColourId = 0x1000540, textColourId = 0x1000541 }
	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 &file)
void	sendMouseClickMessage (const File &file, const MouseEvent &e)
Protected Attributes
DirectoryContentsList &	fileList
ListenerList< FileBrowserListener >	listeners

---

Detailed Description

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

See also:

DirectoryContentsList

---

Member Enumeration Documentation

enum 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.

---

Constructor & Destructor Documentation

DirectoryContentsDisplayComponent::DirectoryContentsDisplayComponent

(

DirectoryContentsList &

listToShow

)

Creates a DirectoryContentsDisplayComponent for a given list of files.

virtual DirectoryContentsDisplayComponent::~DirectoryContentsDisplayComponent

(

)

[virtual]

Destructor.

---

Member Function Documentation

virtual int DirectoryContentsDisplayComponent::getNumSelectedFiles

(

)

const [pure virtual]

Returns the number of files the user has got selected.

See also:

getSelectedFile

Implemented in FileListComponent, and FileTreeComponent.

virtual File 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 FileListComponent, and FileTreeComponent.

virtual void DirectoryContentsDisplayComponent::deselectAllFiles

(

)

[pure virtual]

Deselects any selected files.

Implemented in FileListComponent, and FileTreeComponent.

virtual void DirectoryContentsDisplayComponent::scrollToTop

(

)

[pure virtual]

Scrolls this view to the top.

Implemented in FileListComponent, and FileTreeComponent.

virtual void 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 FileListComponent, and FileTreeComponent.

void DirectoryContentsDisplayComponent::addListener

(

FileBrowserListener *

listener

)

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

See also:

removeListener

void DirectoryContentsDisplayComponent::removeListener

(

FileBrowserListener *

listener

)

Removes a listener.

See also:

addListener

void DirectoryContentsDisplayComponent::sendSelectionChangeMessage

(

)

void DirectoryContentsDisplayComponent::sendDoubleClickMessage

(

const File &

file

)

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

---

Member Data Documentation

DirectoryContentsList& DirectoryContentsDisplayComponent::fileList [protected]

ListenerList<FileBrowserListener> DirectoryContentsDisplayComponent::listeners [protected]

---

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

• juce_DirectoryContentsDisplayComponent.h