FileSearchPathListComponent Class Reference

Shows a set of file paths in a list, allowing them to be added, removed or re-ordered. More...

Inherits Component, SettableTooltipClient, FileDragAndDropTarget, ButtonListener, and ListBoxModel.

List of all members.

Public Types
enum	ColourIds { backgroundColourId = 0x1004100 }
	A set of colour IDs to use to change the colour of various aspects of the label. More...
Public Member Functions
	FileSearchPathListComponent ()
	Creates an empty FileSearchPathListComponent.
	~FileSearchPathListComponent ()
	Destructor.
const FileSearchPath &	getPath () const throw ()
	Returns the path as it is currently shown.
void	setPath (const FileSearchPath &newPath)
	Changes the current path.
void	setDefaultBrowseTarget (const File &newDefaultDirectory)
	Sets a file or directory to be the default starting point for the browser to show.
int	getNumRows ()
void	paintListBoxItem (int rowNumber, Graphics &g, int width, int height, bool rowIsSelected)
void	deleteKeyPressed (int lastRowSelected)
void	returnKeyPressed (int lastRowSelected)
void	listBoxItemDoubleClicked (int row, const MouseEvent &)
void	selectedRowsChanged (int lastRowSelected)
void	resized ()
void	paint (Graphics &g)
bool	isInterestedInFileDrag (const StringArray &files)
void	filesDropped (const StringArray &files, int, int)
void	buttonClicked (Button *button)

---

Detailed Description

Shows a set of file paths in a list, allowing them to be added, removed or re-ordered.

See also:

FileSearchPath

---

Member Enumeration Documentation

enum FileSearchPathListComponent::ColourIds

A set of colour IDs to use to change the colour of various aspects of the label.

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:

backgroundColourId

The background colour to fill the component with. Make this transparent if you don't want the background to be filled.

---

Constructor & Destructor Documentation

FileSearchPathListComponent::FileSearchPathListComponent

(

)

Creates an empty FileSearchPathListComponent.

FileSearchPathListComponent::~FileSearchPathListComponent

(

)

Destructor.

---

Member Function Documentation

const FileSearchPath& FileSearchPathListComponent::getPath

(

)

const throw ()

Returns the path as it is currently shown.

void FileSearchPathListComponent::setPath

(

const FileSearchPath &

newPath

)

Changes the current path.

void FileSearchPathListComponent::setDefaultBrowseTarget

(

const File &

newDefaultDirectory

)

Sets a file or directory to be the default starting point for the browser to show.

This is only used if the current file hasn't been set.

int FileSearchPathListComponent::getNumRows

(

)

[virtual]

For internal use only.

Implements ListBoxModel.

void FileSearchPathListComponent::paintListBoxItem	(	int	rowNumber,
		Graphics &	g,
		int	width,
		int	height,
		bool	rowIsSelected
	)			[virtual]

For internal use only.

Implements ListBoxModel.

void FileSearchPathListComponent::deleteKeyPressed

(

int

lastRowSelected

)

[virtual]

For internal use only.

Reimplemented from ListBoxModel.

void FileSearchPathListComponent::returnKeyPressed

(

int

lastRowSelected

)

[virtual]

For internal use only.

Reimplemented from ListBoxModel.

void FileSearchPathListComponent::listBoxItemDoubleClicked	(	int	row,
		const MouseEvent &
	)			[virtual]

For internal use only.

Reimplemented from ListBoxModel.

void FileSearchPathListComponent::selectedRowsChanged

(

int

lastRowSelected

)

[virtual]

For internal use only.

Reimplemented from ListBoxModel.

void FileSearchPathListComponent::resized

(

)

[virtual]

For internal use only.

Reimplemented from Component.

void FileSearchPathListComponent::paint

(

Graphics &

g

)

[virtual]

For internal use only.

Reimplemented from Component.

bool FileSearchPathListComponent::isInterestedInFileDrag

(

const StringArray &

files

)

[virtual]

For internal use only.

Implements FileDragAndDropTarget.

void FileSearchPathListComponent::filesDropped	(	const StringArray &	files,
		int	,
		int
	)			[virtual]

For internal use only.

Reimplemented from Component.

void FileSearchPathListComponent::buttonClicked

(

Button *

button

)

[virtual]

For internal use only.

Implements ButtonListener.

---

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

• juce_FileSearchPathListComponent.h