juce::FileTreeComponent Class Reference

#include <juce_FileTreeComponent.h>

Inheritance diagram for juce::FileTreeComponent:

Public Member Functions
	FileTreeComponent (DirectoryContentsList &listToShow)
	~FileTreeComponent () override
int	getNumSelectedFiles () const override
File	getSelectedFile (int index=0) const override
void	deselectAllFiles () override
void	scrollToTop () override
void	setSelectedFile (const File &) override
void	refresh ()
void	setDragAndDropDescription (const String &description)
const String &	getDragAndDropDescription () const noexcept
void	setItemHeight (int newHeight)
int	getItemHeight () const noexcept
Public Member Functions inherited from juce::TreeView
	TreeView (const String &componentName={})
	~TreeView () override
void	setRootItem (TreeViewItem *newRootItem)
TreeViewItem *	getRootItem () const noexcept
void	deleteRootItem ()
void	setRootItemVisible (bool shouldBeVisible)
bool	isRootItemVisible () const noexcept
void	setDefaultOpenness (bool isOpenByDefault)
bool	areItemsOpenByDefault () const noexcept
void	setMultiSelectEnabled (bool canMultiSelect)
bool	isMultiSelectEnabled () const noexcept
void	setOpenCloseButtonsVisible (bool shouldBeVisible)
bool	areOpenCloseButtonsVisible () const noexcept
void	clearSelectedItems ()
int	getNumSelectedItems (int maximumDepthToSearchTo=-1) const noexcept
TreeViewItem *	getSelectedItem (int index) const noexcept
void	moveSelectedRow (int deltaRows)
int	getNumRowsInTree () const
TreeViewItem *	getItemOnRow (int index) const
TreeViewItem *	getItemAt (int yPosition) const noexcept
void	scrollToKeepItemVisible (TreeViewItem *item)
Viewport *	getViewport () const noexcept
int	getIndentSize () noexcept
void	setIndentSize (int newIndentSize)
TreeViewItem *	findItemFromIdentifierString (const String &identifierString) const
Component *	getItemComponent (const TreeViewItem *item) const
std::unique_ptr< XmlElement >	getOpennessState (bool alsoIncludeScrollPosition) const
void	restoreOpennessState (const XmlElement &newState, bool restoreStoredSelection)
void	paint (Graphics &) override
void	resized () override
bool	keyPressed (const KeyPress &) override
void	colourChanged () override
void	enablementChanged () override
bool	isInterestedInFileDrag (const StringArray &) override
void	fileDragEnter (const StringArray &, int, int) override
void	fileDragMove (const StringArray &, int, int) override
void	fileDragExit (const StringArray &) override
void	filesDropped (const StringArray &, int, int) override
bool	isInterestedInDragSource (const SourceDetails &) override
void	itemDragEnter (const SourceDetails &) override
void	itemDragMove (const SourceDetails &) override
void	itemDragExit (const SourceDetails &) override
void	itemDropped (const SourceDetails &) override
Public Member Functions inherited from juce::Component
	Component () noexcept
	~Component () override
	Component (const String &componentName) noexcept
String	getName () const noexcept
virtual void	setName (const String &newName)
String	getComponentID () const noexcept
void	setComponentID (const String &newID)
virtual void	setVisible (bool shouldBeVisible)
bool	isVisible () const noexcept
virtual void	visibilityChanged ()
bool	isShowing () const
virtual void	addToDesktop (int windowStyleFlags, void *nativeWindowToAttachTo=nullptr)
void	removeFromDesktop ()
bool	isOnDesktop () const noexcept
ComponentPeer *	getPeer () const
virtual void	userTriedToCloseWindow ()
virtual void	minimisationStateChanged (bool isNowMinimised)
virtual float	getDesktopScaleFactor () const
void	toFront (bool shouldAlsoGainKeyboardFocus)
void	toBack ()
void	toBehind (Component *other)
void	setAlwaysOnTop (bool shouldStayOnTop)
bool	isAlwaysOnTop () const noexcept
int	getX () const noexcept
int	getY () const noexcept
int	getWidth () const noexcept
int	getHeight () const noexcept
int	getRight () const noexcept
Point< int >	getPosition () const noexcept
int	getBottom () const noexcept
Rectangle< int >	getBounds () const noexcept
Rectangle< int >	getLocalBounds () const noexcept
Rectangle< int >	getBoundsInParent () const noexcept
int	getScreenX () const
int	getScreenY () const
Point< int >	getScreenPosition () const
Rectangle< int >	getScreenBounds () const
Point< int >	getLocalPoint (const Component *sourceComponent, Point< int > pointRelativeToSourceComponent) const
Point< float >	getLocalPoint (const Component *sourceComponent, Point< float > pointRelativeToSourceComponent) const
Rectangle< int >	getLocalArea (const Component *sourceComponent, Rectangle< int > areaRelativeToSourceComponent) const
Rectangle< float >	getLocalArea (const Component *sourceComponent, Rectangle< float > areaRelativeToSourceComponent) const
Point< int >	localPointToGlobal (Point< int > localPoint) const
Point< float >	localPointToGlobal (Point< float > localPoint) const
Rectangle< int >	localAreaToGlobal (Rectangle< int > localArea) const
Rectangle< float >	localAreaToGlobal (Rectangle< float > localArea) const
void	setTopLeftPosition (int x, int y)
void	setTopLeftPosition (Point< int > newTopLeftPosition)
void	setTopRightPosition (int x, int y)
void	setSize (int newWidth, int newHeight)
void	setBounds (int x, int y, int width, int height)
void	setBounds (Rectangle< int > newBounds)
void	setBoundsRelative (float proportionalX, float proportionalY, float proportionalWidth, float proportionalHeight)
void	setBoundsRelative (Rectangle< float > proportionalArea)
void	setBoundsInset (BorderSize< int > borders)
void	setBoundsToFit (Rectangle< int > targetArea, Justification justification, bool onlyReduceInSize)
void	setCentrePosition (int x, int y)
void	setCentrePosition (Point< int > newCentrePosition)
void	setCentreRelative (float x, float y)
void	centreWithSize (int width, int height)
void	setTransform (const AffineTransform &transform)
AffineTransform	getTransform () const
bool	isTransformed () const noexcept
int	proportionOfWidth (float proportion) const noexcept
int	proportionOfHeight (float proportion) const noexcept
int	getParentWidth () const noexcept
int	getParentHeight () const noexcept
Rectangle< int >	getParentMonitorArea () const
int	getNumChildComponents () const noexcept
Component *	getChildComponent (int index) const noexcept
int	getIndexOfChildComponent (const Component *child) const noexcept
const Array< Component * > &	getChildren () const noexcept
Component *	findChildWithID (StringRef componentID) const noexcept
void	addChildComponent (Component *child, int zOrder=-1)
void	addChildComponent (Component &child, int zOrder=-1)
void	addAndMakeVisible (Component *child, int zOrder=-1)
void	addAndMakeVisible (Component &child, int zOrder=-1)
void	addChildAndSetID (Component *child, const String &componentID)
void	removeChildComponent (Component *childToRemove)
Component *	removeChildComponent (int childIndexToRemove)
void	removeAllChildren ()
void	deleteAllChildren ()
Component *	getParentComponent () const noexcept
template<class TargetClass>
TargetClass *	findParentComponentOfClass () const
Component *	getTopLevelComponent () const noexcept
bool	isParentOf (const Component *possibleChild) const noexcept
virtual void	parentHierarchyChanged ()
virtual void	childrenChanged ()
virtual bool	hitTest (int x, int y)
void	setInterceptsMouseClicks (bool allowClicksOnThisComponent, bool allowClicksOnChildComponents) noexcept
void	getInterceptsMouseClicks (bool &allowsClicksOnThisComponent, bool &allowsClicksOnChildComponents) const noexcept
bool	contains (Point< int > localPoint)
bool	contains (Point< float > localPoint)
bool	reallyContains (Point< int > localPoint, bool returnTrueIfWithinAChild)
bool	reallyContains (Point< float > localPoint, bool returnTrueIfWithinAChild)
Component *	getComponentAt (int x, int y)
Component *	getComponentAt (Point< int > position)
Component *	getComponentAt (Point< float > position)
void	repaint ()
void	repaint (int x, int y, int width, int height)
void	repaint (Rectangle< int > area)
void	setBufferedToImage (bool shouldBeBuffered)
Image	createComponentSnapshot (Rectangle< int > areaToGrab, bool clipImageToComponentBounds=true, float scaleFactor=1.0f)
void	paintEntireComponent (Graphics &context, bool ignoreAlphaLevel)
void	setPaintingIsUnclipped (bool shouldPaintWithoutClipping) noexcept
bool	isPaintingUnclipped () const noexcept
void	setComponentEffect (ImageEffectFilter *newEffect)
ImageEffectFilter *	getComponentEffect () const noexcept
LookAndFeel &	getLookAndFeel () const noexcept
void	setLookAndFeel (LookAndFeel *newLookAndFeel)
virtual void	lookAndFeelChanged ()
void	sendLookAndFeelChange ()
void	setOpaque (bool shouldBeOpaque)
bool	isOpaque () const noexcept
void	setBroughtToFrontOnMouseClick (bool shouldBeBroughtToFront) noexcept
bool	isBroughtToFrontOnMouseClick () const noexcept
void	setExplicitFocusOrder (int newFocusOrderIndex)
int	getExplicitFocusOrder () const
void	setFocusContainerType (FocusContainerType containerType) noexcept
bool	isFocusContainer () const noexcept
bool	isKeyboardFocusContainer () const noexcept
Component *	findFocusContainer () const
Component *	findKeyboardFocusContainer () const
void	setWantsKeyboardFocus (bool wantsFocus) noexcept
bool	getWantsKeyboardFocus () const noexcept
void	setMouseClickGrabsKeyboardFocus (bool shouldGrabFocus)
bool	getMouseClickGrabsKeyboardFocus () const noexcept
void	grabKeyboardFocus ()
void	giveAwayKeyboardFocus ()
bool	hasKeyboardFocus (bool trueIfChildIsFocused) const
void	moveKeyboardFocusToSibling (bool moveToNext)
virtual std::unique_ptr< ComponentTraverser >	createFocusTraverser ()
virtual std::unique_ptr< ComponentTraverser >	createKeyboardFocusTraverser ()
void	setHasFocusOutline (bool hasFocusOutline) noexcept
bool	hasFocusOutline () const noexcept
bool	isEnabled () const noexcept
void	setEnabled (bool shouldBeEnabled)
float	getAlpha () const noexcept
void	setAlpha (float newAlpha)
virtual void	alphaChanged ()
void	setMouseCursor (const MouseCursor &cursorType)
virtual MouseCursor	getMouseCursor ()
void	updateMouseCursor () const
virtual void	paintOverChildren (Graphics &g)
void	mouseMove (const MouseEvent &event) override
void	mouseEnter (const MouseEvent &event) override
void	mouseExit (const MouseEvent &event) override
void	mouseDown (const MouseEvent &event) override
void	mouseDrag (const MouseEvent &event) override
void	mouseUp (const MouseEvent &event) override
void	mouseDoubleClick (const MouseEvent &event) override
void	mouseWheelMove (const MouseEvent &event, const MouseWheelDetails &wheel) override
void	mouseMagnify (const MouseEvent &event, float scaleFactor) override
void	setRepaintsOnMouseActivity (bool shouldRepaint) noexcept
void	addMouseListener (MouseListener *newListener, bool wantsEventsForAllNestedChildComponents)
void	removeMouseListener (MouseListener *listenerToRemove)
void	addKeyListener (KeyListener *newListener)
void	removeKeyListener (KeyListener *listenerToRemove)
virtual bool	keyStateChanged (bool isKeyDown)
virtual void	modifierKeysChanged (const ModifierKeys &modifiers)
virtual void	focusGained (FocusChangeType cause)
virtual void	focusLost (FocusChangeType cause)
virtual void	focusOfChildComponentChanged (FocusChangeType cause)
bool	isMouseOver (bool includeChildren=false) const
bool	isMouseButtonDown (bool includeChildren=false) const
bool	isMouseOverOrDragging (bool includeChildren=false) const
Point< int >	getMouseXYRelative () const
virtual void	moved ()
virtual void	childBoundsChanged (Component *child)
virtual void	parentSizeChanged ()
virtual void	broughtToFront ()
void	addComponentListener (ComponentListener *newListener)
void	removeComponentListener (ComponentListener *listenerToRemove)
void	postCommandMessage (int commandId)
virtual void	handleCommandMessage (int commandId)
void	enterModalState (bool takeKeyboardFocus=true, ModalComponentManager::Callback *callback=nullptr, bool deleteWhenDismissed=false)
void	exitModalState (int returnValue)
bool	isCurrentlyModal (bool onlyConsiderForemostModalComponent=true) const noexcept
bool	isCurrentlyBlockedByAnotherModalComponent () const
virtual bool	canModalEventBeSentToComponent (const Component *targetComponent)
virtual void	inputAttemptWhenModal ()
NamedValueSet &	getProperties () noexcept
const NamedValueSet &	getProperties () const noexcept
Colour	findColour (int colourID, bool inheritFromParent=false) const
void	setColour (int colourID, Colour newColour)
void	removeColour (int colourID)
bool	isColourSpecified (int colourID) const
void	copyAllExplicitColoursTo (Component &target) const
void *	getWindowHandle () const
Positioner *	getPositioner () const noexcept
void	setPositioner (Positioner *newPositioner)
void	setCachedComponentImage (CachedComponentImage *newCachedImage)
CachedComponentImage *	getCachedComponentImage () const noexcept
void	setViewportIgnoreDragFlag (bool ignoreDrag) noexcept
bool	getViewportIgnoreDragFlag () const noexcept
String	getTitle () const noexcept
void	setTitle (const String &newTitle)
String	getDescription () const noexcept
void	setDescription (const String &newDescription)
String	getHelpText () const noexcept
void	setHelpText (const String &newHelpText)
void	setAccessible (bool shouldBeAccessible)
bool	isAccessible () const noexcept
AccessibilityHandler *	getAccessibilityHandler ()
void	invalidateAccessibilityHandler ()
void	setFocusContainer (bool shouldBeFocusContainer) noexcept
void	contains (int, int)=delete
Public Member Functions inherited from juce::MouseListener
virtual	~MouseListener ()=default
Public Member Functions inherited from juce::SettableTooltipClient
	~SettableTooltipClient () override=default
virtual void	setTooltip (const String &newTooltip)
String	getTooltip () override
Public Member Functions inherited from juce::TooltipClient
virtual	~TooltipClient ()=default
Public Member Functions inherited from juce::FileDragAndDropTarget
virtual	~FileDragAndDropTarget ()=default
Public Member Functions inherited from juce::DragAndDropTarget
virtual	~DragAndDropTarget ()=default
virtual bool	shouldDrawDragImageWhenOver ()
Public Member Functions inherited from juce::DirectoryContentsDisplayComponent
	DirectoryContentsDisplayComponent (DirectoryContentsList &listToShow)
virtual	~DirectoryContentsDisplayComponent ()
void	addListener (FileBrowserListener *listener)
void	removeListener (FileBrowserListener *listener)
void	sendSelectionChangeMessage ()
void	sendDoubleClickMessage (const File &)
void	sendMouseClickMessage (const File &, const MouseEvent &)

Private Attributes
String	dragAndDropDescription
int	itemHeight

Additional Inherited Members
Public Types inherited from juce::TreeView
enum	ColourIds {   backgroundColourId = 0x1000500 , linesColourId = 0x1000501 , dragAndDropIndicatorColourId = 0x1000502 , selectedItemBackgroundColourId = 0x1000503 ,   oddItemsColourId = 0x1000504 , evenItemsColourId = 0x1000505 }
Public Types inherited from juce::Component
enum class	FocusContainerType { none , focusContainer , keyboardFocusContainer }
enum	FocusChangeType { focusChangedByMouseClick , focusChangedByTabKey , focusChangedDirectly }
Public Types inherited from juce::DirectoryContentsDisplayComponent
enum	ColourIds { highlightColourId = 0x1000540 , textColourId = 0x1000541 , highlightedTextColourId = 0x1000542 }
Static Public Member Functions inherited from juce::Component
static float JUCE_CALLTYPE	getApproximateScaleFactorForComponent (const Component *targetComponent)
static Component *JUCE_CALLTYPE	getCurrentlyFocusedComponent () noexcept
static void JUCE_CALLTYPE	unfocusAllComponents ()
static void JUCE_CALLTYPE	beginDragAutoRepeat (int millisecondsBetweenCallbacks)
static bool JUCE_CALLTYPE	isMouseButtonDownAnywhere () noexcept
static int JUCE_CALLTYPE	getNumCurrentlyModalComponents () noexcept
static Component *JUCE_CALLTYPE	getCurrentlyModalComponent (int index=0) noexcept
Public Attributes inherited from juce::DirectoryContentsDisplayComponent
DirectoryContentsList &	directoryContentsList
Protected Member Functions inherited from juce::Component
virtual ComponentPeer *	createNewPeer (int styleFlags, void *nativeWindowToAttachTo)
Protected Member Functions inherited from juce::SettableTooltipClient
	SettableTooltipClient ()=default
Static Protected Member Functions inherited from juce::Component
static std::unique_ptr< AccessibilityHandler >	createIgnoredAccessibilityHandler (Component &)
Protected Attributes inherited from juce::DirectoryContentsDisplayComponent
ListenerList< FileBrowserListener >	listeners

Detailed Description

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 also

DirectoryContentsList, FileListComponent

@tags{GUI}

Constructor & Destructor Documentation

FileTreeComponent()

juce::FileTreeComponent::FileTreeComponent

(

DirectoryContentsList &

listToShow

)

Creates a listbox to show the contents of a specified directory.

~FileTreeComponent()

juce::FileTreeComponent::~FileTreeComponent ( )

override

Destructor.

Member Function Documentation

deselectAllFiles()

void juce::FileTreeComponent::deselectAllFiles ( )

overridevirtual

Deselects any files that are currently selected.

Implements juce::DirectoryContentsDisplayComponent.

getDragAndDropDescription()

const String & juce::FileTreeComponent::getDragAndDropDescription ( ) const

inlinenoexcept

Returns the last value that was set by setDragAndDropDescription().

getItemHeight()

int juce::FileTreeComponent::getItemHeight ( ) const

inlinenoexcept

Returns the height of the treeview items.

getNumSelectedFiles()

int juce::FileTreeComponent::getNumSelectedFiles ( ) const

inlineoverridevirtual

Returns the number of files the user has got selected.

See also

getSelectedFile

Implements juce::DirectoryContentsDisplayComponent.

getSelectedFile()

File juce::FileTreeComponent::getSelectedFile ( int index = 0 ) const

overridevirtual

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

Implements juce::DirectoryContentsDisplayComponent.

refresh()

void juce::FileTreeComponent::refresh

(

)

Updates the files in the list.

scrollToTop()

void juce::FileTreeComponent::scrollToTop ( )

overridevirtual

Scrolls the list to the top.

Implements juce::DirectoryContentsDisplayComponent.

setDragAndDropDescription()

void juce::FileTreeComponent::setDragAndDropDescription

(

const String &

description

)

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().

setItemHeight()

void juce::FileTreeComponent::setItemHeight

(

int

newHeight

)

Changes the height of the treeview items.

setSelectedFile()

void juce::FileTreeComponent::setSelectedFile ( const File & target )

overridevirtual

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

Implements juce::DirectoryContentsDisplayComponent.

Member Data Documentation

dragAndDropDescription

String juce::FileTreeComponent::dragAndDropDescription

private

itemHeight

int juce::FileTreeComponent::itemHeight

private

---

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

• /home/runner/work/lmms-fork/lmms-fork/plugins/CarlaBase/carla/source/modules/juce_gui_basics/filebrowser/juce_FileTreeComponent.h
• /home/runner/work/lmms-fork/lmms-fork/plugins/CarlaBase/carla/source/modules/juce_gui_basics/filebrowser/juce_FileTreeComponent.cpp