#include <juce_FileSearchPathListComponent.h>

Inheritance diagram for juce::FileSearchPathListComponent:

Public Types
enum	ColourIds { backgroundColourId = 0x1004100 }
Public Types inherited from juce::Component
enum class	FocusContainerType { none , focusContainer , keyboardFocusContainer }
enum	FocusChangeType { focusChangedByMouseClick , focusChangedByTabKey , focusChangedDirectly }

Public Member Functions
	FileSearchPathListComponent ()
const FileSearchPath &	getPath () const noexcept
void	setPath (const FileSearchPath &newPath)
void	setDefaultBrowseTarget (const File &newDefaultDirectory)
int	getNumRows () override
void	paintListBoxItem (int rowNumber, Graphics &g, int width, int height, bool rowIsSelected) override
void	deleteKeyPressed (int lastRowSelected) override
void	returnKeyPressed (int lastRowSelected) override
void	listBoxItemDoubleClicked (int row, const MouseEvent &) override
void	selectedRowsChanged (int lastRowSelected) override
void	resized () override
void	paint (Graphics &) override
bool	isInterestedInFileDrag (const StringArray &) override
void	filesDropped (const StringArray &files, int, int) 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)
virtual void	enablementChanged ()
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	keyPressed (const KeyPress &key)
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
virtual void	colourChanged ()
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
virtual void	fileDragEnter (const StringArray &files, int x, int y)
virtual void	fileDragMove (const StringArray &files, int x, int y)
virtual void	fileDragExit (const StringArray &files)

Private Member Functions
void	changed ()
void	updateButtons ()
void	addPath ()
void	deleteSelected ()
void	editSelected ()
void	moveSelection (int)
Private Member Functions inherited from juce::ListBoxModel
virtual	~ListBoxModel ()=default
virtual Component *	refreshComponentForRow (int rowNumber, bool isRowSelected, Component *existingComponentToUpdate)
virtual String	getNameForRow (int rowNumber)
virtual void	listBoxItemClicked (int row, const MouseEvent &)
virtual void	backgroundClicked (const MouseEvent &)
virtual void	listWasScrolled ()
virtual var	getDragSourceDescription (const SparseSet< int > &rowsToDescribe)
virtual String	getTooltipForRow (int row)
virtual MouseCursor	getMouseCursorForRow (int row)

Private Attributes
FileSearchPath	path
File	defaultBrowseTarget
std::unique_ptr< FileChooser >	chooser
ListBox	listBox
TextButton	addButton
TextButton	removeButton
TextButton	changeButton
DrawableButton	upButton
DrawableButton	downButton

Additional Inherited Members
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
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 &)

Detailed Description

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

See also: FileSearchPath

@tags{GUI}

Member Enumeration Documentation

◆ ColourIds

enum juce::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()

juce::FileSearchPathListComponent::FileSearchPathListComponent ( )

Creates an empty FileSearchPathListComponent.

Member Function Documentation

◆ addPath()

void juce::FileSearchPathListComponent::addPath ( )

private

◆ changed()

void juce::FileSearchPathListComponent::changed ( )

private

◆ deleteKeyPressed()

void juce::FileSearchPathListComponent::deleteKeyPressed ( int lastRowSelected )

overridevirtual

Override this to be informed when the delete key is pressed.

If no rows are selected when they press the key, this won't be called.

Parameters

lastRowSelected the last row that had been selected when they pressed the key - if there are multiple selections, this might not be very useful

Reimplemented from juce::ListBoxModel.

◆ deleteSelected()

void juce::FileSearchPathListComponent::deleteSelected ( )

private

◆ editSelected()

void juce::FileSearchPathListComponent::editSelected ( )

private

◆ filesDropped()

void juce::FileSearchPathListComponent::filesDropped	(	const StringArray &	files,
		int	x,
		int	y )

overridevirtual

Callback to indicate that the user has dropped the files onto this component.

When the user drops the files, this get called, and you can use the files in whatever way is appropriate.

Note that after this is called, the fileDragExit method may not be called, so you should clean up in here if there's anything you need to do when the drag finishes.

Parameters

files	the set of (absolute) pathnames of the files that the user is dragging
x	the mouse x position, relative to this component
y	the mouse y position, relative to this component

Implements juce::FileDragAndDropTarget.

◆ getNumRows()

int juce::FileSearchPathListComponent::getNumRows ( )

overridevirtual

This has to return the number of items in the list.

See also: ListBox::getNumRows()

Implements juce::ListBoxModel.

◆ getPath()

const FileSearchPath & juce::FileSearchPathListComponent::getPath ( ) const

inlinenoexcept

Returns the path as it is currently shown.

◆ isInterestedInFileDrag()

bool juce::FileSearchPathListComponent::isInterestedInFileDrag ( const StringArray & files )

overridevirtual

Callback to check whether this target is interested in the set of files being offered.

Note that this will be called repeatedly when the user is dragging the mouse around over your component, so don't do anything time-consuming in here, like opening the files to have a look inside them!

Parameters

files the set of (absolute) pathnames of the files that the user is dragging

Returns: true if this component wants to receive the other callbacks regarding this type of object; if it returns false, no other callbacks will be made.

Implements juce::FileDragAndDropTarget.

◆ listBoxItemDoubleClicked()

void juce::FileSearchPathListComponent::listBoxItemDoubleClicked	(	int	row,
		const MouseEvent &	)

overridevirtual

This can be overridden to react to the user double-clicking on a row.

See also: listBoxItemClicked

Reimplemented from juce::ListBoxModel.

◆ moveSelection()

void juce::FileSearchPathListComponent::moveSelection ( int delta )

private

◆ paint()

void juce::FileSearchPathListComponent::paint ( Graphics & g )

overridevirtual

Components can override this method to draw their content.

The paint() method gets called when a region of a component needs redrawing, either because the component's repaint() method has been called, or because something has happened on the screen that means a section of a window needs to be redrawn.

Any child components will draw themselves over whatever this method draws. If you need to paint over the top of your child components, you can also implement the paintOverChildren() method to do this.

If you want to cause a component to redraw itself, this is done asynchronously - calling the repaint() method marks a region of the component as "dirty", and the paint() method will automatically be called sometime later, by the message thread, to paint any bits that need refreshing. In JUCE (and almost all modern UI frameworks), you never redraw something synchronously.

You should never need to call this method directly - to take a snapshot of the component you could use createComponentSnapshot() or paintEntireComponent().

Parameters

g	the graphics context that must be used to do the drawing operations.

See also: repaint, paintOverChildren, Graphics

Reimplemented from juce::Component.

◆ paintListBoxItem()

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

overridevirtual

This method must be implemented to draw a row of the list. Note that the rowNumber value may be greater than the number of rows in your list, so be careful that you don't assume it's less than getNumRows().

Implements juce::ListBoxModel.

◆ resized()

void juce::FileSearchPathListComponent::resized ( )

overridevirtual

Called when this component's size has been changed.

A component can implement this method to do things such as laying out its child components when its width or height changes.

The method is called synchronously as a result of the setBounds or setSize methods, so repeatedly changing a components size will repeatedly call its resized method (unlike things like repainting, where multiple calls to repaint are coalesced together).

If the component is a top-level window on the desktop, its size could also be changed by operating-system factors beyond the application's control.

See also: moved, setSize

Reimplemented from juce::Component.

◆ returnKeyPressed()

void juce::FileSearchPathListComponent::returnKeyPressed ( int lastRowSelected )

overridevirtual

Override this to be informed when the return key is pressed.

If no rows are selected when they press the key, this won't be called.

Parameters

lastRowSelected the last row that had been selected when they pressed the key - if there are multiple selections, this might not be very useful

Reimplemented from juce::ListBoxModel.

◆ selectedRowsChanged()

void juce::FileSearchPathListComponent::selectedRowsChanged ( int lastRowSelected )

overridevirtual

Override this to be informed when rows are selected or deselected.

This will be called whenever a row is selected or deselected. If a range of rows is selected all at once, this will just be called once for that event.

Parameters

lastRowSelected the last row that the user selected. If no rows are currently selected, this may be -1.

Reimplemented from juce::ListBoxModel.

◆ setDefaultBrowseTarget()

void juce::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.

◆ setPath()

void juce::FileSearchPathListComponent::setPath ( const FileSearchPath & newPath )

Changes the current path.

◆ updateButtons()

void juce::FileSearchPathListComponent::updateButtons ( )

private

Member Data Documentation

◆ addButton

TextButton juce::FileSearchPathListComponent::addButton

private

◆ changeButton

TextButton juce::FileSearchPathListComponent::changeButton

private

◆ chooser

std::unique_ptr<FileChooser> juce::FileSearchPathListComponent::chooser

private

◆ defaultBrowseTarget

File juce::FileSearchPathListComponent::defaultBrowseTarget

private

◆ downButton

DrawableButton juce::FileSearchPathListComponent::downButton

private

◆ listBox

ListBox juce::FileSearchPathListComponent::listBox

private

◆ path

FileSearchPath juce::FileSearchPathListComponent::path

private

◆ removeButton

TextButton juce::FileSearchPathListComponent::removeButton

private

◆ upButton

DrawableButton juce::FileSearchPathListComponent::upButton

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_FileSearchPathListComponent.h
/home/runner/work/lmms-fork/lmms-fork/plugins/CarlaBase/carla/source/modules/juce_gui_basics/filebrowser/juce_FileSearchPathListComponent.cpp

Public Types

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ ColourIds

Constructor & Destructor Documentation

◆ FileSearchPathListComponent()

Member Function Documentation

◆ addPath()

◆ changed()

◆ deleteKeyPressed()

◆ deleteSelected()

◆ editSelected()

◆ filesDropped()

◆ getNumRows()

◆ getPath()

◆ isInterestedInFileDrag()

◆ listBoxItemDoubleClicked()

◆ moveSelection()

◆ paint()

◆ paintListBoxItem()

◆ resized()

◆ returnKeyPressed()

◆ selectedRowsChanged()

◆ setDefaultBrowseTarget()

◆ setPath()

◆ updateButtons()

Member Data Documentation

◆ addButton

◆ changeButton

◆ chooser

◆ defaultBrowseTarget

◆ downButton

◆ listBox

◆ path

◆ removeButton

◆ upButton