|
JUCE
|
|
JUCE
|
Manages a list of plugin types. More...
Inherits ChangeBroadcaster.
Public Types | |
| enum | SortMethod { defaultOrder = 0, sortAlphabetically, sortByCategory, sortByManufacturer, sortByFileSystemLocation } |
| Sort methods used to change the order of the plugins in the list. More... | |
Public Member Functions | |
| KnownPluginList () | |
| Creates an empty list. | |
| ~KnownPluginList () | |
| Destructor. | |
| void | clear () |
| Clears the list. | |
| int | getNumTypes () const noexcept |
| Returns the number of types currently in the list. | |
| PluginDescription * | getType (int index) const noexcept |
| Returns one of the types. | |
| PluginDescription * | getTypeForFile (const String &fileOrIdentifier) const |
| Looks for a type in the list which comes from this file. | |
| PluginDescription * | getTypeForIdentifierString (const String &identifierString) const |
| Looks for a type in the list which matches a plugin type ID. | |
| bool | addType (const PluginDescription &type) |
| Adds a type manually from its description. | |
| void | removeType (int index) |
| Removes a type. | |
| 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. | |
| bool | isListingUpToDate (const String &possiblePluginFileOrIdentifier) const |
| Returns true if the specified file is already known about and if it hasn't been modified since our entry was created. | |
| void | scanAndAddDragAndDroppedFiles (const StringArray &filenames, OwnedArray< PluginDescription > &typesFound) |
| Scans and adds a bunch of files that might have been dragged-and-dropped. | |
| void | addToMenu (PopupMenu &menu, const SortMethod sortMethod) const |
| Adds all the plugin types to a popup menu so that the user can select one. | |
| int | getIndexChosenByMenu (int menuResultCode) const |
| Converts a menu item index that has been chosen into its index in this list. | |
| void | sort (const SortMethod method) |
| Sorts the list. | |
| XmlElement * | createXml () const |
| Creates some XML that can be used to store the state of this list. | |
| void | recreateFromXml (const XmlElement &xml) |
| Recreates the state of this list from its stored XML format. | |
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.
Creates an empty list.
Destructor.
| void KnownPluginList::clear | ( | ) |
Clears the list.
| int KnownPluginList::getNumTypes | ( | ) | const |
Returns the number of types currently in the list.
| PluginDescription* KnownPluginList::getType | ( | int | index | ) | const |
Returns one of the types.
| PluginDescription* KnownPluginList::getTypeForFile | ( | const String & | fileOrIdentifier | ) | const |
Looks for a type in the list which comes from this file.
| 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().
| bool KnownPluginList::addType | ( | const PluginDescription & | type | ) |
Adds a type manually from its description.
| void KnownPluginList::removeType | ( | int | index | ) |
Removes a type.
| 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.
| bool KnownPluginList::isListingUpToDate | ( | const String & | possiblePluginFileOrIdentifier | ) | const |
Returns true if the specified file is already known about and if it hasn't been modified since our entry was created.
| void KnownPluginList::scanAndAddDragAndDroppedFiles | ( | 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.
| void KnownPluginList::addToMenu | ( | PopupMenu & | menu, |
| const SortMethod | sortMethod | ||
| ) | 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.
| 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.
| void KnownPluginList::sort | ( | const SortMethod | method | ) |
Sorts the list.
| XmlElement* KnownPluginList::createXml | ( | ) | const |
Creates some XML that can be used to store the state of this list.
| void KnownPluginList::recreateFromXml | ( | const XmlElement & | xml | ) |
Recreates the state of this list from its stored XML format.
