zrythm::gui::old_dsp::plugins::PluginCollection Class Reference

Plugin collection used in the plugin browser. More...

#include <src/gui/backend/plugin_collections.h>

Public Types
using	PluginDescriptor = zrythm::plugins::PluginDescriptor

Public Member Functions
std::string	get_name () const
void	set_name (std::string_view name)
void	clear ()
bool	contains_descriptor (const PluginDescriptor &descr) const
	Returns whether the collection contains the given descriptor.
void	add_descriptor (const PluginDescriptor &descr)
	Appends a descriptor to the collection.
void	remove_descriptor (const PluginDescriptor &descr)
	Removes the descriptor matching the given one from the collection.

Data Fields
std::string	name_
	Name of the collection.
std::string	description_
	Description of the collection (optional).
std::vector< std::unique_ptr< PluginDescriptor > >	descriptors_
	Plugin descriptors.

Friends
void	init_from (PluginCollection &obj, const PluginCollection &other, utils::ObjectCloneType clone_type)
	Generates a context menu for the collection.
void	to_json (nlohmann::json &j, const PluginCollection &p)
void	from_json (const nlohmann::json &j, PluginCollection &p)

Detailed Description

Plugin collection used in the plugin browser.

Definition at line 22 of file plugin_collections.h.

Member Typedef Documentation

PluginDescriptor

using zrythm::gui::old_dsp::plugins::PluginCollection::PluginDescriptor = zrythm::plugins::PluginDescriptor

Definition at line 25 of file plugin_collections.h.

Member Function Documentation

clear()

void zrythm::gui::old_dsp::plugins::PluginCollection::clear ( )

inline

Definition at line 31 of file plugin_collections.h.

get_name()

std::string zrythm::gui::old_dsp::plugins::PluginCollection::get_name ( ) const

inline

Definition at line 27 of file plugin_collections.h.

set_name()

void zrythm::gui::old_dsp::plugins::PluginCollection::set_name ( std::string_view name )

inline

Definition at line 29 of file plugin_collections.h.

Friends And Related Symbol Documentation

from_json

void from_json ( const nlohmann::json & j, PluginCollection & p )

friend

Definition at line 70 of file plugin_collections.h.

to_json

void to_json ( nlohmann::json & j, const PluginCollection & p )

friend

Definition at line 62 of file plugin_collections.h.

Field Documentation

description_

std::string zrythm::gui::old_dsp::plugins::PluginCollection::description_

Description of the collection (optional).

Definition at line 82 of file plugin_collections.h.

descriptors_

std::vector<std::unique_ptr<PluginDescriptor> > zrythm::gui::old_dsp::plugins::PluginCollection::descriptors_

Plugin descriptors.

Definition at line 85 of file plugin_collections.h.

name_

std::string zrythm::gui::old_dsp::plugins::PluginCollection::name_

Name of the collection.

Definition at line 79 of file plugin_collections.h.

---

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

• src/gui/backend/plugin_collections.h