lmms::ExportFilter Class Reference

#include <ExportFilter.h>

Inheritance diagram for lmms::ExportFilter:

Public Member Functions
	ExportFilter (const Descriptor *_descriptor)
	~ExportFilter () override=default
virtual bool	tryExport (const TrackContainer::TrackList &tracks, const TrackContainer::TrackList &patternTracks, int tempo, int masterPitch, const std::filesystem::path &filePath)=0
	Exports the project to a file.
Public Member Functions inherited from lmms::Plugin
	Plugin (const Descriptor *descriptor, Model *parent, const Descriptor::SubPluginFeatures::Key *key=nullptr)
	Constructor of a plugin.
	~Plugin () override=default
QString	displayName () const override
	Return display-name out of sub plugin or descriptor.
const PixmapLoader *	logo () const
	Return logo out of sub plugin or descriptor.
Type	type () const
	Return plugin type.
const Descriptor *	descriptor () const
	Return plugin Descriptor.
const Descriptor::SubPluginFeatures::Key &	key () const
virtual void	loadFile (const QString &file)
gui::PluginView *	createView (QWidget *parent)
	Create a view for the model.
Public Member Functions inherited from lmms::Model
	Model (Model *parent, QString displayName=QString(), bool defaultConstructed=false)
	~Model () override=default
bool	isDefaultConstructed () const
Model *	parentModel () const
virtual void	setDisplayName (const QString &displayName)
virtual QString	fullDisplayName () const
Public Member Functions inherited from lmms::JournallingObject
	JournallingObject ()
	~JournallingObject () override
jo_id_t	id () const
void	saveJournallingState (const bool newState)
void	restoreJournallingState ()
void	addJournalCheckPoint ()
QDomElement	saveState (QDomDocument &_doc, QDomElement &_parent) override
void	restoreState (const QDomElement &_this) override
bool	isJournalling () const
void	setJournalling (const bool _sr)
bool	testAndSetJournalling (const bool newState)
bool	isJournallingStateStackEmpty () const
Public Member Functions inherited from lmms::SerializingObject
	SerializingObject ()
virtual	~SerializingObject ()
void	setHook (SerializingObjectHook *_hook)
SerializingObjectHook *	hook ()

Protected Member Functions
void	saveSettings (QDomDocument &, QDomElement &) override
void	loadSettings (const QDomElement &) override
QString	nodeName () const override
Protected Member Functions inherited from lmms::Plugin
virtual gui::PluginView *	instantiateView (QWidget *)=0
	Create a view for the model.
void	collectErrorForUI (QString errMsg)
Protected Member Functions inherited from lmms::JournallingObject
void	changeID (jo_id_t _id)

Additional Inherited Members
Public Types inherited from lmms::Plugin
enum class	Type {   Instrument , Effect , ImportFilter , ExportFilter ,   Tool , Library , Other , Undefined = 255 }
using	DescriptorList = QList<Descriptor*>
Signals inherited from lmms::Model
void	dataChanged ()
void	dataUnchanged ()
void	propertiesChanged ()
Static Public Member Functions inherited from lmms::Plugin
static Plugin *	instantiateWithKey (const QString &pluginName, Model *parent, const Descriptor::SubPluginFeatures::Key *key, bool keyFromDnd=false)
static Plugin *	instantiate (const QString &pluginName, Model *parent, void *data)

Constructor & Destructor Documentation

ExportFilter()

lmms::ExportFilter::ExportFilter ( const Descriptor * _descriptor )

inline

~ExportFilter()

lmms::ExportFilter::~ExportFilter ( )

overridedefault

Member Function Documentation

loadSettings()

void lmms::ExportFilter::loadSettings ( const QDomElement & )

inlineoverrideprotectedvirtual

Implements lmms::SerializingObject.

nodeName()

QString lmms::ExportFilter::nodeName ( void ) const

inlineoverrideprotectedvirtual

Implements lmms::SerializingObject.

saveSettings()

void lmms::ExportFilter::saveSettings ( QDomDocument & , QDomElement &  )

inlineoverrideprotectedvirtual

Implements lmms::SerializingObject.

tryExport()

virtual bool lmms::ExportFilter::tryExport ( const TrackContainer::TrackList & tracks, const TrackContainer::TrackList & patternTracks, int tempo, int masterPitch, const std::filesystem::path & filePath )

pure virtual

Exports the project to a file.

Parameters

tracks	Song tracks
patternStoreTracks	PatternStore tracks
tempo	Song global tempo
masterPitch	Song master pitch
filePath	The path of the exported file

Returns

If operation was successful

Implemented in lmms::MidiExport.

---

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

• include/ExportFilter.h