#include <juce_PluginListComponent.h>

Inheritance diagram for juce::PluginListComponent:

Classes
class	TableModel
class	Scanner

Public Member Functions
	PluginListComponent (AudioPluginFormatManager &formatManager, KnownPluginList &listToRepresent, const File &deadMansPedalFile, PropertiesFile *propertiesToUse, bool allowPluginsWhichRequireAsynchronousInstantiation=false)
	~PluginListComponent () override
void	setOptionsButtonText (const String &newText)
PopupMenu	createOptionsMenu ()
PopupMenu	createMenuForRow (int rowNumber)
void	setScanDialogText (const String &textForProgressWindowTitle, const String &textForProgressWindowDescription)
void	setNumberOfThreadsForScanning (int numThreads)
void	scanFor (AudioPluginFormat &)
void	scanFor (AudioPluginFormat &, const StringArray &filesOrIdentifiersToScan)
bool	isScanning () const noexcept
void	removeSelectedPlugins ()
void	setTableModel (TableListBoxModel *)
TableListBox &	getTableListBox () noexcept
TextButton &	getOptionsButton ()
void	resized () 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	paint (Graphics &g)
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::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)

Static Public Member Functions
static FileSearchPath	getLastSearchPath (PropertiesFile &, AudioPluginFormat &)
static void	setLastSearchPath (PropertiesFile &, AudioPluginFormat &, const FileSearchPath &)
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

Private Member Functions
void	scanFinished (const StringArray &, const std::vector< String > &)
void	updateList ()
void	removeMissingPlugins ()
void	removePluginItem (int index)
bool	isInterestedInFileDrag (const StringArray &) override
void	filesDropped (const StringArray &, int, int) override
void	changeListenerCallback (ChangeBroadcaster *) override
Private Member Functions inherited from juce::ChangeListener
virtual	~ChangeListener ()=default

Private Attributes
AudioPluginFormatManager &	formatManager
KnownPluginList &	list
File	deadMansPedalFile
TableListBox	table
TextButton	optionsButton
PropertiesFile *	propertiesToUse
String	dialogTitle
String	dialogText
bool	allowAsync
int	numThreads
std::unique_ptr< TableListBoxModel >	tableModel
std::unique_ptr< Scanner >	currentScanner

Additional Inherited Members
Public Types inherited from juce::Component
enum class	FocusContainerType { none , focusContainer , keyboardFocusContainer }
enum	FocusChangeType { focusChangedByMouseClick , focusChangedByTabKey , focusChangedDirectly }
Protected Member Functions inherited from juce::Component
virtual ComponentPeer *	createNewPeer (int styleFlags, void *nativeWindowToAttachTo)
Static Protected Member Functions inherited from juce::Component
static std::unique_ptr< AccessibilityHandler >	createIgnoredAccessibilityHandler (Component &)

Detailed Description

A component displaying a list of plugins, with options to scan for them, add, remove and sort them.

@tags{Audio}

Constructor & Destructor Documentation

◆ PluginListComponent()

juce::PluginListComponent::PluginListComponent	(	AudioPluginFormatManager &	formatManager,
		KnownPluginList &	listToRepresent,
		const File &	deadMansPedalFile,
		PropertiesFile *	propertiesToUse,
		bool	allowPluginsWhichRequireAsynchronousInstantiation = false )

Creates the list component.

For info about the deadMansPedalFile, see the PluginDirectoryScanner constructor. The properties file, if supplied, is used to store the user's last search paths.

◆ ~PluginListComponent()

juce::PluginListComponent::~PluginListComponent ( )

override

Destructor.

Member Function Documentation

◆ changeListenerCallback()

void juce::PluginListComponent::changeListenerCallback ( ChangeBroadcaster * source )

overrideprivatevirtual

Your subclass should implement this method to receive the callback.

Parameters

source the ChangeBroadcaster that triggered the callback.

Implements juce::ChangeListener.

◆ createMenuForRow()

PopupMenu juce::PluginListComponent::createMenuForRow ( int rowNumber )

Returns a menu that can be shown if a row is right-clicked, containing actions like "remove plugin" or "show folder" etc.

◆ createOptionsMenu()

PopupMenu juce::PluginListComponent::createOptionsMenu ( )

Returns a pop-up menu that contains all the options for scanning and updating the list.

◆ filesDropped()

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

overrideprivatevirtual

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.

◆ getLastSearchPath()

FileSearchPath juce::PluginListComponent::getLastSearchPath	(	PropertiesFile &	properties,
		AudioPluginFormat &	format )

static

Returns the last search path stored in a given properties file for the specified format.

◆ getOptionsButton()

TextButton & juce::PluginListComponent::getOptionsButton ( )

inline

Returns the button used to display the options menu - you can make this invisible if you want to hide it and use some other method for showing the menu.

◆ getTableListBox()

TableListBox & juce::PluginListComponent::getTableListBox ( )

inlinenoexcept

Returns the table used to display the plugin list.

◆ isInterestedInFileDrag()

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

overrideprivatevirtual

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.

◆ isScanning()

bool juce::PluginListComponent::isScanning ( ) const

noexcept

Returns true if there's currently a scan in progress.

◆ removeMissingPlugins()

void juce::PluginListComponent::removeMissingPlugins ( )

private

◆ removePluginItem()

void juce::PluginListComponent::removePluginItem ( int index )

private

◆ removeSelectedPlugins()

void juce::PluginListComponent::removeSelectedPlugins ( )

Removes the plugins currently selected in the table.

◆ resized()

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

◆ scanFinished()

void juce::PluginListComponent::scanFinished	(	const StringArray &	failedFiles,
		const std::vector< String > &	newBlacklistedFiles )

private

◆ scanFor() [1/2]

void juce::PluginListComponent::scanFor ( AudioPluginFormat & format )

Triggers an asynchronous scan for the given format.

◆ scanFor() [2/2]

void juce::PluginListComponent::scanFor	(	AudioPluginFormat &	format,
		const StringArray &	filesOrIdentifiersToScan )

Triggers an asynchronous scan for the given format and scans only the given files or identifiers.

See also: AudioPluginFormat::searchPathsForPlugins

◆ setLastSearchPath()

void juce::PluginListComponent::setLastSearchPath	(	PropertiesFile &	properties,
		AudioPluginFormat &	format,
		const FileSearchPath &	newPath )

static

Stores a search path in a properties file for the given format.

◆ setNumberOfThreadsForScanning()

void juce::PluginListComponent::setNumberOfThreadsForScanning ( int numThreads )

Sets how many threads to simultaneously scan for plugins. If this is 0, then all scanning happens on the message thread (this is the default when allowPluginsWhichRequireAsynchronousInstantiation is false). If allowPluginsWhichRequireAsynchronousInstantiation is true then numThreads must not be zero (it is one by default).

◆ setOptionsButtonText()

void juce::PluginListComponent::setOptionsButtonText ( const String & newText )

Changes the text in the panel's options button.

◆ setScanDialogText()

void juce::PluginListComponent::setScanDialogText	(	const String &	textForProgressWindowTitle,
		const String &	textForProgressWindowDescription )

Changes the text in the progress dialog box that is shown when scanning.

◆ setTableModel()

void juce::PluginListComponent::setTableModel ( TableListBoxModel * model )

Sets a custom table model to be used. This will take ownership of the model and delete it when no longer needed.

◆ updateList()

void juce::PluginListComponent::updateList ( )

private

Member Data Documentation

◆ allowAsync

bool juce::PluginListComponent::allowAsync

private

◆ currentScanner

std::unique_ptr<Scanner> juce::PluginListComponent::currentScanner

private

◆ deadMansPedalFile

File juce::PluginListComponent::deadMansPedalFile

private

◆ dialogText

String juce::PluginListComponent::dialogText

private

◆ dialogTitle

String juce::PluginListComponent::dialogTitle

private

◆ formatManager

AudioPluginFormatManager& juce::PluginListComponent::formatManager

private

◆ list

KnownPluginList& juce::PluginListComponent::list

private

◆ numThreads

int juce::PluginListComponent::numThreads

private

◆ optionsButton

TextButton juce::PluginListComponent::optionsButton

private

◆ propertiesToUse

PropertiesFile* juce::PluginListComponent::propertiesToUse

private

◆ table

TableListBox juce::PluginListComponent::table

private

◆ tableModel

std::unique_ptr<TableListBoxModel> juce::PluginListComponent::tableModel

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_audio_processors/scanning/juce_PluginListComponent.h
/home/runner/work/lmms-fork/lmms-fork/plugins/CarlaBase/carla/source/modules/juce_audio_processors/scanning/juce_PluginListComponent.cpp

Classes

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ PluginListComponent()

◆ ~PluginListComponent()

Member Function Documentation

◆ changeListenerCallback()

◆ createMenuForRow()

◆ createOptionsMenu()

◆ filesDropped()

◆ getLastSearchPath()

◆ getOptionsButton()

◆ getTableListBox()

◆ isInterestedInFileDrag()

◆ isScanning()

◆ removeMissingPlugins()

◆ removePluginItem()

◆ removeSelectedPlugins()

◆ resized()

◆ scanFinished()

◆ scanFor() [1/2]

◆ scanFor() [2/2]

◆ setLastSearchPath()

◆ setNumberOfThreadsForScanning()

◆ setOptionsButtonText()

◆ setScanDialogText()

◆ setTableModel()

◆ updateList()

Member Data Documentation

◆ allowAsync

◆ currentScanner

◆ deadMansPedalFile

◆ dialogText

◆ dialogTitle

◆ formatManager

◆ list

◆ numThreads

◆ optionsButton

◆ propertiesToUse

◆ table

◆ tableModel