openshot-audio  0.1.6
Public Types | Public Member Functions | Protected Attributes | List of all members
juce::DirectoryContentsDisplayComponent Class Referenceabstract

#include <juce_gui_basics.h>

Inheritance diagram for juce::DirectoryContentsDisplayComponent:
juce::FileListComponent juce::FileTreeComponent

Public Types

enum  ColourIds { highlightColourId = 0x1000540, textColourId = 0x1000541 }
 

Public Member Functions

 DirectoryContentsDisplayComponent (DirectoryContentsList &listToShow)
 
virtual ~DirectoryContentsDisplayComponent ()
 
virtual int getNumSelectedFiles () const =0
 
virtual File getSelectedFile (int index) const =0
 
virtual void deselectAllFiles ()=0
 
virtual void scrollToTop ()=0
 
virtual void setSelectedFile (const File &)=0
 
void addListener (FileBrowserListener *listener)
 
void removeListener (FileBrowserListener *listener)
 
void sendSelectionChangeMessage ()
 
void sendDoubleClickMessage (const File &file)
 
void sendMouseClickMessage (const File &file, const MouseEvent &e)
 

Protected Attributes

DirectoryContentsListfileList
 
ListenerList< FileBrowserListenerlisteners
 

Detailed Description

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

See also
DirectoryContentsList

Member Enumeration Documentation

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.

DirectoryContentsDisplayComponent::~DirectoryContentsDisplayComponent ( )
virtual

Destructor.

Member Function Documentation

void DirectoryContentsDisplayComponent::addListener ( FileBrowserListener listener)

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

See also
removeListener
virtual void juce::DirectoryContentsDisplayComponent::deselectAllFiles ( )
pure virtual

Deselects any selected files.

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

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.

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.

void DirectoryContentsDisplayComponent::removeListener ( FileBrowserListener listener)

Removes a listener.

See also
addListener
virtual void juce::DirectoryContentsDisplayComponent::scrollToTop ( )
pure virtual

Scrolls this view to the top.

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

void DirectoryContentsDisplayComponent::sendDoubleClickMessage ( const File file)
void DirectoryContentsDisplayComponent::sendMouseClickMessage ( const File file,
const MouseEvent e 
)
void DirectoryContentsDisplayComponent::sendSelectionChangeMessage ( )
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& juce::DirectoryContentsDisplayComponent::fileList
protected
ListenerList<FileBrowserListener> juce::DirectoryContentsDisplayComponent::listeners
protected

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