openshot-audio  0.1.7
Public Member Functions | List of all members
juce::FileTreeComponent Class Reference

#include <juce_gui_basics.h>

Inheritance diagram for juce::FileTreeComponent:
juce::TreeView juce::DirectoryContentsDisplayComponent juce::Component juce::SettableTooltipClient juce::FileDragAndDropTarget juce::DragAndDropTarget juce::MouseListener juce::TooltipClient

Public Member Functions

 FileTreeComponent (DirectoryContentsList &listToShow)
 
 ~FileTreeComponent ()
 
int getNumSelectedFiles () const
 
File getSelectedFile (int index=0) const
 
void deselectAllFiles ()
 
void scrollToTop ()
 
void setSelectedFile (const File &)
 
void refresh ()
 
void setDragAndDropDescription (const String &description)
 
const StringgetDragAndDropDescription () const noexcept
 
void setItemHeight (int newHeight)
 
int getItemHeight () const noexcept
 
- Public Member Functions inherited from juce::TreeView
 TreeView (const String &componentName=String::empty)
 
 ~TreeView ()
 
void setRootItem (TreeViewItem *newRootItem)
 
TreeViewItemgetRootItem () 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
 
TreeViewItemgetSelectedItem (int index) const noexcept
 
void moveSelectedRow (int deltaRows)
 
int getNumRowsInTree () const
 
TreeViewItemgetItemOnRow (int index) const
 
TreeViewItemgetItemAt (int yPosition) const noexcept
 
void scrollToKeepItemVisible (TreeViewItem *item)
 
ViewportgetViewport () const noexcept
 
int getIndentSize () noexcept
 
void setIndentSize (int newIndentSize)
 
TreeViewItemfindItemFromIdentifierString (const String &identifierString) const
 
XmlElementgetOpennessState (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 &files) override
 
void fileDragEnter (const StringArray &files, int x, int y) override
 
void fileDragMove (const StringArray &files, int x, int y) override
 
void fileDragExit (const StringArray &files) override
 
void filesDropped (const StringArray &files, int x, int y) 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
 
virtual ~Component ()
 
 Component (const String &componentName) noexcept
 
const StringgetName () const noexcept
 
virtual void setName (const String &newName)
 
const StringgetComponentID () 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
 
ComponentPeergetPeer () const
 
virtual void userTriedToCloseWindow ()
 
virtual void minimisationStateChanged (bool isNowMinimised)
 
virtual float getDesktopScaleFactor () const
 
void toFront (bool shouldAlsoGainFocus)
 
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
 
const 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, const Rectangle< int > &areaRelativeToSourceComponent) const
 
Point< int > localPointToGlobal (Point< int > localPoint) const
 
Point< float > localPointToGlobal (Point< float > localPoint) const
 
Rectangle< int > localAreaToGlobal (const Rectangle< int > &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 (const Rectangle< int > &newBounds)
 
void setBounds (const RelativeRectangle &newBounds)
 
void setBounds (const String &newBoundsExpression)
 
void setBoundsRelative (float proportionalX, float proportionalY, float proportionalWidth, float proportionalHeight)
 
void setBoundsInset (const BorderSize< int > &borders)
 
void setBoundsToFit (int x, int y, int width, int height, Justification justification, bool onlyReduceInSize)
 
void setCentrePosition (int x, int y)
 
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
 
ComponentgetChildComponent (int index) const noexcept
 
int getIndexOfChildComponent (const Component *child) const noexcept
 
ComponentfindChildWithID (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)
 
ComponentremoveChildComponent (int childIndexToRemove)
 
void removeAllChildren ()
 
void deleteAllChildren ()
 
ComponentgetParentComponent () const noexcept
 
template<class TargetClass >
TargetClass * findParentComponentOfClass () const
 
ComponentgetTopLevelComponent () 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 reallyContains (Point< int > localPoint, bool returnTrueIfWithinAChild)
 
ComponentgetComponentAt (int x, int y)
 
ComponentgetComponentAt (Point< int > position)
 
void repaint ()
 
void repaint (int x, int y, int width, int height)
 
void repaint (const Rectangle< int > &area)
 
void setBufferedToImage (bool shouldBeBuffered)
 
Image createComponentSnapshot (const Rectangle< int > &areaToGrab, bool clipImageToComponentBounds=true, float scaleFactor=1.0f)
 
void paintEntireComponent (Graphics &context, bool ignoreAlphaLevel)
 
void setPaintingIsUnclipped (bool shouldPaintWithoutClipping) noexcept
 
void setComponentEffect (ImageEffectFilter *newEffect)
 
ImageEffectFiltergetComponentEffect () const noexcept
 
LookAndFeelgetLookAndFeel () 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 setWantsKeyboardFocus (bool wantsFocus) noexcept
 
bool getWantsKeyboardFocus () const noexcept
 
void setMouseClickGrabsKeyboardFocus (bool shouldGrabFocus)
 
bool getMouseClickGrabsKeyboardFocus () const noexcept
 
void grabKeyboardFocus ()
 
bool hasKeyboardFocus (bool trueIfChildIsFocused) const
 
void moveKeyboardFocusToSibling (bool moveToNext)
 
virtual KeyboardFocusTraversercreateFocusTraverser ()
 
int getExplicitFocusOrder () const
 
void setExplicitFocusOrder (int newFocusOrderIndex)
 
void setFocusContainer (bool shouldBeFocusContainer) noexcept
 
bool isFocusContainer () const noexcept
 
bool isEnabled () const noexcept
 
void setEnabled (bool shouldBeEnabled)
 
void setAlpha (float newAlpha)
 
float getAlpha () const
 
void setMouseCursor (const MouseCursor &cursorType)
 
virtual MouseCursor getMouseCursor ()
 
void updateMouseCursor () const
 
virtual void paintOverChildren (Graphics &g)
 
virtual void mouseMove (const MouseEvent &event) override
 
virtual void mouseEnter (const MouseEvent &event) override
 
virtual void mouseExit (const MouseEvent &event) override
 
virtual void mouseDown (const MouseEvent &event) override
 
virtual void mouseDrag (const MouseEvent &event) override
 
virtual void mouseUp (const MouseEvent &event) override
 
virtual void mouseDoubleClick (const MouseEvent &event) override
 
virtual void mouseWheelMove (const MouseEvent &event, const MouseWheelDetails &wheel) override
 
virtual void mouseMagnify (const MouseEvent &event, float scaleFactor)
 
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 () const
 
bool isMouseOverOrDragging () 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)
 
int runModalLoop ()
 
void enterModalState (bool takeKeyboardFocus=true, ModalComponentManager::Callback *callback=nullptr, bool deleteWhenDismissed=false)
 
void exitModalState (int returnValue)
 
bool isCurrentlyModal () const noexcept
 
bool isCurrentlyBlockedByAnotherModalComponent () const
 
virtual bool canModalEventBeSentToComponent (const Component *targetComponent)
 
virtual void inputAttemptWhenModal ()
 
NamedValueSetgetProperties () noexcept
 
const NamedValueSetgetProperties () 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
 
virtual MarkerListgetMarkers (bool xAxis)
 
void * getWindowHandle () const
 
PositionergetPositioner () const noexcept
 
void setPositioner (Positioner *newPositioner)
 
void setCachedComponentImage (CachedComponentImage *newCachedImage)
 
CachedComponentImagegetCachedComponentImage () const noexcept
 
 JUCE_DEPRECATED (Point< int > relativePositionToGlobal(Point< int >) const)
 
 JUCE_DEPRECATED (Point< int > globalPositionToRelative(Point< int >) const)
 
 JUCE_DEPRECATED (Point< int > relativePositionToOtherComponent(const Component *, Point< int >) const)
 
- Public Member Functions inherited from juce::MouseListener
virtual ~MouseListener ()
 
- Public Member Functions inherited from juce::SettableTooltipClient
virtual ~SettableTooltipClient ()
 
virtual void setTooltip (const String &newTooltip)
 
virtual String getTooltip ()
 
- Public Member Functions inherited from juce::TooltipClient
virtual ~TooltipClient ()
 
- Public Member Functions inherited from juce::FileDragAndDropTarget
virtual ~FileDragAndDropTarget ()
 
- Public Member Functions inherited from juce::DragAndDropTarget
virtual ~DragAndDropTarget ()
 
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 &file)
 
void sendMouseClickMessage (const File &file, const MouseEvent &e)
 

Additional Inherited Members

- Public Types inherited from juce::TreeView
enum  ColourIds { backgroundColourId = 0x1000500, linesColourId = 0x1000501, dragAndDropIndicatorColourId = 0x1000502, selectedItemBackgroundColourId = 0x1000503 }
 
- Public Types inherited from juce::Component
enum  FocusChangeType { focusChangedByMouseClick, focusChangedByTabKey, focusChangedDirectly }
 
- Public Types inherited from juce::DirectoryContentsDisplayComponent
enum  ColourIds { highlightColourId = 0x1000540, textColourId = 0x1000541 }
 
- Static Public Member Functions inherited from juce::Component
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
 
- Protected Member Functions inherited from juce::Component
virtual ComponentPeercreateNewPeer (int styleFlags, void *nativeWindowToAttachTo)
 
- Protected Member Functions inherited from juce::SettableTooltipClient
 SettableTooltipClient ()
 
- Protected Attributes inherited from juce::DirectoryContentsDisplayComponent
DirectoryContentsListfileList
 
ListenerList< FileBrowserListenerlisteners
 

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

Constructor & Destructor Documentation

◆ FileTreeComponent()

FileTreeComponent::FileTreeComponent ( DirectoryContentsList listToShow)

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

◆ ~FileTreeComponent()

FileTreeComponent::~FileTreeComponent ( )

Destructor.

Member Function Documentation

◆ deselectAllFiles()

void FileTreeComponent::deselectAllFiles ( )
virtual

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
inlinevirtual

Returns the number of files the user has got selected.

See also
getSelectedFile

Implements juce::DirectoryContentsDisplayComponent.

◆ getSelectedFile()

File FileTreeComponent::getSelectedFile ( int  index = 0) const
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

Implements juce::DirectoryContentsDisplayComponent.

◆ refresh()

void FileTreeComponent::refresh ( )

Updates the files in the list.

◆ scrollToTop()

void FileTreeComponent::scrollToTop ( )
virtual

Scrolls the list to the top.

Implements juce::DirectoryContentsDisplayComponent.

◆ setDragAndDropDescription()

void 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 FileTreeComponent::setItemHeight ( int  newHeight)

Changes the height of the treeview items.

◆ setSelectedFile()

void FileTreeComponent::setSelectedFile ( const File target)
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).

Implements juce::DirectoryContentsDisplayComponent.


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