lmms
Cross-platform music production software
Loading...
Searching...
No Matches
lmms::ImportFilter Class Referenceabstract

#include <ImportFilter.h>

Inheritance diagram for lmms::ImportFilter:
lmms::Plugin lmms::Model lmms::JournallingObject lmms::SerializingObject lmms::HydrogenImport lmms::MidiImport

Public Member Functions

 ImportFilter (const QString &_file_name, const Descriptor *_descriptor)
 ~ImportFilter () override=default
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 ()

Static Public Member Functions

static void import (const QString &_file_to_import, TrackContainer *tc)
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)

Protected Member Functions

virtual bool tryImport (TrackContainer *tc)=0
const QFile & file () const
bool openFile ()
void closeFile ()
int readByte ()
int readBlock (char *_data, int _len)
QByteArray readAllData ()
void ungetChar (char _ch)
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)

Private Attributes

QFile m_file

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 ()

Constructor & Destructor Documentation

◆ ImportFilter()

lmms::ImportFilter::ImportFilter ( const QString & _file_name,
const Descriptor * _descriptor )

◆ ~ImportFilter()

lmms::ImportFilter::~ImportFilter ( )
overridedefault

Member Function Documentation

◆ closeFile()

void lmms::ImportFilter::closeFile ( )
inlineprotected

◆ file()

const QFile & lmms::ImportFilter::file ( ) const
inlineprotected

◆ import()

void lmms::ImportFilter::import ( const QString & _file_to_import,
TrackContainer * tc )
static

◆ loadSettings()

void lmms::ImportFilter::loadSettings ( const QDomElement & )
inlineoverrideprotectedvirtual

◆ nodeName()

QString lmms::ImportFilter::nodeName ( void ) const
inlineoverrideprotectedvirtual

◆ openFile()

bool lmms::ImportFilter::openFile ( )
protected

◆ readAllData()

QByteArray lmms::ImportFilter::readAllData ( )
inlineprotected

◆ readBlock()

int lmms::ImportFilter::readBlock ( char * _data,
int _len )
inlineprotected

◆ readByte()

int lmms::ImportFilter::readByte ( )
inlineprotected

◆ saveSettings()

void lmms::ImportFilter::saveSettings ( QDomDocument & ,
QDomElement &  )
inlineoverrideprotectedvirtual

◆ tryImport()

virtual bool lmms::ImportFilter::tryImport ( TrackContainer * tc)
protectedpure virtual

Implemented in lmms::HydrogenImport, and lmms::MidiImport.

◆ ungetChar()

void lmms::ImportFilter::ungetChar ( char _ch)
inlineprotected

Member Data Documentation

◆ m_file

QFile lmms::ImportFilter::m_file
private

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