Manages a list of plugin types. More...

Inheritance diagram for KnownPluginList:

Classes

class  CustomScanner
 
struct  PluginTree
 A structure that recursively holds a tree of plugins. More...
 

Public Types

enum  SortMethod {
  defaultOrder = 0, sortAlphabetically, sortByCategory, sortByManufacturer,
  sortByFormat, sortByFileSystemLocation, sortByInfoUpdateTime
}
 Sort methods used to change the order of the plugins in the list. More...
 

Public Member Functions

 KnownPluginList ()
 Creates an empty list. More...
 
 ~KnownPluginList ()
 Destructor. More...
 
void clear ()
 Clears the list. More...
 
int getNumTypes () const noexcept
 Returns the number of types currently in the list. More...
 
PluginDescriptiongetType (int index) const noexcept
 Returns one of the types. More...
 
PluginDescription ** begin () const noexcept
 Type iteration. More...
 
PluginDescription ** end () const noexcept
 Type iteration. More...
 
PluginDescriptiongetTypeForFile (const String &fileOrIdentifier) const
 Looks for a type in the list which comes from this file. More...
 
PluginDescriptiongetTypeForIdentifierString (const String &identifierString) const
 Looks for a type in the list which matches a plugin type ID. More...
 
bool addType (const PluginDescription &type)
 Adds a type manually from its description. More...
 
void removeType (int index)
 Removes a type. More...
 
bool scanAndAddFile (const String &possiblePluginFileOrIdentifier, bool dontRescanIfAlreadyInList, OwnedArray< PluginDescription > &typesFound, AudioPluginFormat &formatToUse)
 Looks for all types that can be loaded from a given file, and adds them to the list. More...
 
void scanFinished ()
 Tells a custom scanner that a scan has finished, and it can release any resources. More...
 
bool isListingUpToDate (const String &possiblePluginFileOrIdentifier, AudioPluginFormat &formatToUse) const
 Returns true if the specified file is already known about and if it hasn't been modified since our entry was created. More...
 
void scanAndAddDragAndDroppedFiles (AudioPluginFormatManager &formatManager, const StringArray &filenames, OwnedArray< PluginDescription > &typesFound)
 Scans and adds a bunch of files that might have been dragged-and-dropped. More...
 
const StringArraygetBlacklistedFiles () const
 Returns the list of blacklisted files. More...
 
void addToBlacklist (const String &pluginID)
 Adds a plugin ID to the black-list. More...
 
void removeFromBlacklist (const String &pluginID)
 Removes a plugin ID from the black-list. More...
 
void clearBlacklistedFiles ()
 Clears all the blacklisted files. More...
 
void addToMenu (PopupMenu &menu, SortMethod sortMethod, const String &currentlyTickedPluginID=String()) const
 Adds all the plugin types to a popup menu so that the user can select one. More...
 
int getIndexChosenByMenu (int menuResultCode) const
 Converts a menu item index that has been chosen into its index in this list. More...
 
void sort (SortMethod method, bool forwards)
 Sorts the list. More...
 
XmlElementcreateXml () const
 Creates some XML that can be used to store the state of this list. More...
 
void recreateFromXml (const XmlElement &xml)
 Recreates the state of this list from its stored XML format. More...
 
PluginTreecreateTree (const SortMethod sortMethod) const
 Creates a PluginTree object containing all the known plugins. More...
 
void setCustomScanner (CustomScanner *)
 Supplies a custom scanner to be used in future scans. More...
 
- Public Member Functions inherited from ChangeBroadcaster
 ChangeBroadcaster () noexcept
 Creates an ChangeBroadcaster. More...
 
virtual ~ChangeBroadcaster ()
 Destructor. More...
 
void addChangeListener (ChangeListener *listener)
 Registers a listener to receive change callbacks from this broadcaster. More...
 
void removeChangeListener (ChangeListener *listener)
 Unregisters a listener from the list. More...
 
void removeAllChangeListeners ()
 Removes all listeners from the list. More...
 
void sendChangeMessage ()
 Causes an asynchronous change message to be sent to all the registered listeners. More...
 
void sendSynchronousChangeMessage ()
 Sends a synchronous change message to all the registered listeners. More...
 
void dispatchPendingMessages ()
 If a change message has been sent but not yet dispatched, this will call sendSynchronousChangeMessage() to make the callback immediately. More...
 

Detailed Description

Manages a list of plugin types.

This can be easily edited, saved and loaded, and used to create instances of the plugin types in it.

See also
PluginListComponent

Member Enumeration Documentation

◆ SortMethod

Sort methods used to change the order of the plugins in the list.

Enumerator
defaultOrder 
sortAlphabetically 
sortByCategory 
sortByManufacturer 
sortByFormat 
sortByFileSystemLocation 
sortByInfoUpdateTime 

Constructor & Destructor Documentation

◆ KnownPluginList()

KnownPluginList::KnownPluginList ( )

Creates an empty list.

◆ ~KnownPluginList()

KnownPluginList::~KnownPluginList ( )

Destructor.

Member Function Documentation

◆ clear()

void KnownPluginList::clear ( )

Clears the list.

◆ getNumTypes()

int KnownPluginList::getNumTypes ( ) const
noexcept

Returns the number of types currently in the list.

See also
getType

◆ getType()

PluginDescription* KnownPluginList::getType ( int  index) const
noexcept

Returns one of the types.

See also
getNumTypes

◆ begin()

PluginDescription** KnownPluginList::begin ( ) const
noexcept

Type iteration.

◆ end()

PluginDescription** KnownPluginList::end ( ) const
noexcept

Type iteration.

◆ getTypeForFile()

PluginDescription* KnownPluginList::getTypeForFile ( const String fileOrIdentifier) const

Looks for a type in the list which comes from this file.

◆ getTypeForIdentifierString()

PluginDescription* KnownPluginList::getTypeForIdentifierString ( const String identifierString) const

Looks for a type in the list which matches a plugin type ID.

The identifierString parameter must have been created by PluginDescription::createIdentifierString().

◆ addType()

bool KnownPluginList::addType ( const PluginDescription type)

Adds a type manually from its description.

◆ removeType()

void KnownPluginList::removeType ( int  index)

Removes a type.

◆ scanAndAddFile()

bool KnownPluginList::scanAndAddFile ( const String possiblePluginFileOrIdentifier,
bool  dontRescanIfAlreadyInList,
OwnedArray< PluginDescription > &  typesFound,
AudioPluginFormat formatToUse 
)

Looks for all types that can be loaded from a given file, and adds them to the list.

If dontRescanIfAlreadyInList is true, then the file will only be loaded and re-tested if it's not already in the list, or if the file's modification time has changed since the list was created. If dontRescanIfAlreadyInList is false, the file will always be reloaded and tested.

Returns true if any new types were added, and all the types found in this file (even if it was already known and hasn't been re-scanned) get returned in the array.

◆ scanFinished()

void KnownPluginList::scanFinished ( )

Tells a custom scanner that a scan has finished, and it can release any resources.

◆ isListingUpToDate()

bool KnownPluginList::isListingUpToDate ( const String possiblePluginFileOrIdentifier,
AudioPluginFormat formatToUse 
) const

Returns true if the specified file is already known about and if it hasn't been modified since our entry was created.

◆ scanAndAddDragAndDroppedFiles()

void KnownPluginList::scanAndAddDragAndDroppedFiles ( AudioPluginFormatManager formatManager,
const StringArray filenames,
OwnedArray< PluginDescription > &  typesFound 
)

Scans and adds a bunch of files that might have been dragged-and-dropped.

If any types are found in the files, their descriptions are returned in the array.

◆ getBlacklistedFiles()

const StringArray& KnownPluginList::getBlacklistedFiles ( ) const

Returns the list of blacklisted files.

◆ addToBlacklist()

void KnownPluginList::addToBlacklist ( const String pluginID)

Adds a plugin ID to the black-list.

◆ removeFromBlacklist()

void KnownPluginList::removeFromBlacklist ( const String pluginID)

Removes a plugin ID from the black-list.

◆ clearBlacklistedFiles()

void KnownPluginList::clearBlacklistedFiles ( )

Clears all the blacklisted files.

◆ addToMenu()

void KnownPluginList::addToMenu ( PopupMenu menu,
SortMethod  sortMethod,
const String currentlyTickedPluginID = String() 
) const

Adds all the plugin types to a popup menu so that the user can select one.

Depending on the sort method, it may add sub-menus for categories, manufacturers, etc.

Use getIndexChosenByMenu() to find out the type that was chosen.

◆ getIndexChosenByMenu()

int KnownPluginList::getIndexChosenByMenu ( int  menuResultCode) const

Converts a menu item index that has been chosen into its index in this list.

Returns -1 if it's not an ID that was used.

See also
addToMenu

◆ sort()

void KnownPluginList::sort ( SortMethod  method,
bool  forwards 
)

Sorts the list.

◆ createXml()

XmlElement* KnownPluginList::createXml ( ) const

Creates some XML that can be used to store the state of this list.

◆ recreateFromXml()

void KnownPluginList::recreateFromXml ( const XmlElement xml)

Recreates the state of this list from its stored XML format.

◆ createTree()

PluginTree* KnownPluginList::createTree ( const SortMethod  sortMethod) const

Creates a PluginTree object containing all the known plugins.

◆ setCustomScanner()

void KnownPluginList::setCustomScanner ( CustomScanner )

Supplies a custom scanner to be used in future scans.

The KnownPluginList will take ownership of the object passed in.


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