mirror of
https://github.com/juce-framework/JUCE.git
synced 2026-01-10 23:44:24 +00:00
101 lines
3.9 KiB
C++
101 lines
3.9 KiB
C++
/*
|
|
==============================================================================
|
|
|
|
This file is part of the JUCE library - "Jules' Utility Class Extensions"
|
|
Copyright 2004-11 by Raw Material Software Ltd.
|
|
|
|
------------------------------------------------------------------------------
|
|
|
|
JUCE can be redistributed and/or modified under the terms of the GNU General
|
|
Public License (Version 2), as published by the Free Software Foundation.
|
|
A copy of the license is included in the JUCE distribution, or can be found
|
|
online at www.gnu.org/licenses.
|
|
|
|
JUCE is distributed in the hope that it will be useful, but WITHOUT ANY
|
|
WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
|
|
A PARTICULAR PURPOSE. See the GNU General Public License for more details.
|
|
|
|
------------------------------------------------------------------------------
|
|
|
|
To release a closed-source product which uses JUCE, commercial licenses are
|
|
available: visit www.rawmaterialsoftware.com/juce for more information.
|
|
|
|
==============================================================================
|
|
*/
|
|
|
|
#ifndef __JUCE_FILETREECOMPONENT_JUCEHEADER__
|
|
#define __JUCE_FILETREECOMPONENT_JUCEHEADER__
|
|
|
|
#include "juce_DirectoryContentsDisplayComponent.h"
|
|
#include "../widgets/juce_TreeView.h"
|
|
|
|
|
|
//==============================================================================
|
|
/**
|
|
A component that displays the files in a directory as a treeview.
|
|
|
|
This implements the DirectoryContentsDisplayComponent base class so that
|
|
it can be used in a FileBrowserComponent.
|
|
|
|
To attach a listener to it, use its DirectoryContentsDisplayComponent base
|
|
class and the FileBrowserListener class.
|
|
|
|
@see DirectoryContentsList, FileListComponent
|
|
*/
|
|
class JUCE_API FileTreeComponent : public TreeView,
|
|
public DirectoryContentsDisplayComponent
|
|
{
|
|
public:
|
|
//==============================================================================
|
|
/** Creates a listbox to show the contents of a specified directory.
|
|
*/
|
|
FileTreeComponent (DirectoryContentsList& listToShow);
|
|
|
|
/** Destructor. */
|
|
~FileTreeComponent();
|
|
|
|
//==============================================================================
|
|
/** Returns the number of files the user has got selected.
|
|
@see getSelectedFile
|
|
*/
|
|
int getNumSelectedFiles() const { return TreeView::getNumSelectedItems(); }
|
|
|
|
/** Returns one of the files that the user has currently selected.
|
|
The index should be in the range 0 to (getNumSelectedFiles() - 1).
|
|
@see getNumSelectedFiles
|
|
*/
|
|
File getSelectedFile (int index = 0) const;
|
|
|
|
/** Deselects any files that are currently selected. */
|
|
void deselectAllFiles();
|
|
|
|
/** Scrolls the list to the top. */
|
|
void scrollToTop();
|
|
|
|
/** 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 setSelectedFile (const File&);
|
|
|
|
/** Updates the files in the list. */
|
|
void refresh();
|
|
|
|
/** Setting a name for this allows tree items to be dragged.
|
|
|
|
The string that you pass in here will be returned by the getDragSourceDescription()
|
|
of the items in the tree. For more info, see TreeViewItem::getDragSourceDescription().
|
|
*/
|
|
void setDragAndDropDescription (const String& description);
|
|
|
|
/** Returns the last value that was set by setDragAndDropDescription().
|
|
*/
|
|
const String& getDragAndDropDescription() const noexcept { return dragAndDropDescription; }
|
|
|
|
private:
|
|
//==============================================================================
|
|
String dragAndDropDescription;
|
|
|
|
JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR (FileTreeComponent);
|
|
};
|
|
|
|
|
|
#endif // __JUCE_FILETREECOMPONENT_JUCEHEADER__
|