Base class for import filters. More...

#include <import.h>

Inheritance diagram for CAImport:

Signals
void	documentImported (CADocument *)
void	sheetImported (CASheet *)
void	staffImported (CAStaff *)
void	voiceImported (CAVoice *)
void	lyricsContextImported (CALyricsContext *)
void	functionMarkContextImported (CAFunctionMarkContext *)
void	importDone (int status)
Public Member Functions
	CAImport (QTextStream *stream=0)
	CAImport (const QString stream)
virtual	~CAImport ()
virtual const QString	readableStatus ()
void	importDocument ()
void	importSheet ()
void	importStaff ()
void	importVoice ()
void	importLyricsContext ()
void	importFunctionMarkContext ()
CADocument *	importedDocument ()
CASheet *	importedSheet ()
CAStaff *	importedStaff ()
CAVoice *	importedVoice ()
CALyricsContext *	importedLyricsContext ()
CAFunctionMarkContext *	importedFunctionMarkContext ()
Protected Member Functions
virtual CADocument *	importDocumentImpl ()
virtual CASheet *	importSheetImpl ()
virtual CAStaff *	importStaffImpl ()
virtual CAVoice *	importVoiceImpl ()
virtual CALyricsContext *	importLyricsContextImpl ()
virtual CAFunctionMarkContext *	importFunctionMarkContextImpl ()
QTextStream &	in ()
Private Types
enum	CAImportPart { Undefined, Document, Sheet, Staff, Voice, LyricsContext, FunctionMarkContext }
Private Member Functions
void	setImportedDocument (CADocument *doc)
void	setImportedSheet (CASheet *sheet)
void	setImportedStaff (CAStaff *staff)
void	setImportedVoice (CAVoice *voice)
void	setImportedLyricsContext (CALyricsContext *lc)
void	setImportedFunctionMarkContext (CAFunctionMarkContext *fmc)
void	run ()
void	setImportPart (CAImportPart part)
CAImportPart	importPart ()
Private Attributes
CADocument *	_importedDocument
CASheet *	_importedSheet
CAStaff *	_importedStaff
CAVoice *	_importedVoice
CALyricsContext *	_importedLyricsContext
CAFunctionMarkContext *	_importedFunctionMarkContext
CAImportPart	_importPart

Detailed Description

Base class for import filters.

   Copyright (c) 2007, Matevž Jekovec, Canorus development team
   All Rights Reserved. See AUTHORS for a complete list of authors.

   Licensed under the GNU GENERAL PUBLIC LICENSE. See LICENSE.GPL for details.



   This class inherits CAFile and is the base class for any specific import filter (eg. LilyPond,
   CanorusML, MusicXML etc.).

   If a developer wants to write a new import filter, he should:
   1) Create a new class with the base class CAImport
   2) Implement CAImport constructors and at least importDocumentImpl() function which returns
      the new CADocument.
   3) Register the filter (put a new fileformat to CAFileFormats and add the filter to open/save
      dialogs in CACanorus)

   Optionally:
   Developer should change the current status and progress while operations are in progress. He should
   also rewrite the readableStatus() function.

   The following example illustrates the usage of import class:

          CAMyImportFilter import();
          import.setStreamFromFile("jingle bells.xml");
          import.importDocument();
          import.wait();
          
          setDocument( import.importedDocument() );
          CACanorus::rebuildUI();

In Python the example is even more direct using the string as an input method:

          lilyString = '\\relative c { \\clef "treble" \\time 4/4 c4 d e f | f e d c | c1 \\bar "|." }'
          myImport = CALilyPondImport( lilyString )
          myImport.importVoice()
          myImport.wait()         
          
          voice = myImport.importedVoice()

Note:: Both stream and string can be used both in Canorus and scripting. The example is only for illustration.

Member Enumeration Documentation

enum CAImport::CAImportPart [private]

Enumerator:

Undefined
Document
Sheet
Staff
Voice
LyricsContext
FunctionMarkContext

Constructor & Destructor Documentation

CAImport::CAImport ( QTextStream * stream = 0 )

References setImportedDocument(), setImportedFunctionMarkContext(), setImportedLyricsContext(), setImportedSheet(), setImportedStaff(), setImportedVoice(), setImportPart(), CAFile::setStream(), and Undefined.

Here is the call graph for this function:

CAImport::CAImport ( const QString stream )

References setImportedDocument(), setImportedFunctionMarkContext(), setImportedLyricsContext(), setImportedSheet(), setImportedStaff(), setImportedVoice(), setImportPart(), CAFile::setStream(), and Undefined.

Here is the call graph for this function:

CAImport::~CAImport ( ) [virtual]

References CAFile::stream().

Here is the call graph for this function:

Member Function Documentation

void CAImport::documentImported ( CADocument * ) [signal]

Referenced by run().

Here is the caller graph for this function:

void CAImport::functionMarkContextImported ( CAFunctionMarkContext * ) [signal]

Referenced by run().

Here is the caller graph for this function:

void CAImport::importDocument ( )

References Document, setImportPart(), and CAFile::setStatus().

Referenced by CACanImport::importDocumentImpl(), CAMainWin::openDocument(), CAAutoRecovery::openRecovery(), and CAMainWin::sourceViewPortCommit().

Here is the call graph for this function:

Here is the caller graph for this function:

virtual CADocument* CAImport::importDocumentImpl ( ) [inline, protected, virtual]

Reimplemented in CACanorusMLImport, CAMidiImport, CAMusicXmlImport, and CACanImport.

References CAFile::setStatus().

Referenced by run().

Here is the call graph for this function:

Here is the caller graph for this function:

void CAImport::importDone ( int status ) [signal]

Referenced by run().

Here is the caller graph for this function:

CADocument* CAImport::importedDocument ( ) [inline]

References _importedDocument.

Referenced by CACanImport::importDocumentImpl(), CAMainWin::openDocument(), CAAutoRecovery::openRecovery(), and CAMainWin::sourceViewPortCommit().

Here is the caller graph for this function:

CAFunctionMarkContext* CAImport::importedFunctionMarkContext ( ) [inline]

References _importedFunctionMarkContext.

CALyricsContext* CAImport::importedLyricsContext ( ) [inline]

References _importedLyricsContext.

Referenced by CAMainWin::sourceViewPortCommit().

Here is the caller graph for this function:

CASheet* CAImport::importedSheet ( ) [inline]

References _importedSheet.

CAStaff* CAImport::importedStaff ( ) [inline]

References _importedStaff.

CAVoice* CAImport::importedVoice ( ) [inline]

References _importedVoice.

Referenced by CAMainWin::sourceViewPortCommit().

Here is the caller graph for this function:

void CAImport::importFunctionMarkContext ( )

References FunctionMarkContext, setImportPart(), and CAFile::setStatus().

Here is the call graph for this function:

virtual CAFunctionMarkContext* CAImport::importFunctionMarkContextImpl ( ) [inline, protected, virtual]

References CAFile::setStatus().

Referenced by run().

Here is the call graph for this function:

Here is the caller graph for this function:

void CAImport::importLyricsContext ( )

References LyricsContext, setImportPart(), and CAFile::setStatus().

Referenced by CAMainWin::sourceViewPortCommit().

Here is the call graph for this function:

Here is the caller graph for this function:

virtual CALyricsContext* CAImport::importLyricsContextImpl ( ) [inline, protected, virtual]

Reimplemented in CALilyPondImport.

References CAFile::setStatus().

Referenced by run().

Here is the call graph for this function:

Here is the caller graph for this function:

CAImportPart CAImport::importPart ( ) [inline, private]

References _importPart.

Referenced by run().

Here is the caller graph for this function:

void CAImport::importSheet ( )

References setImportPart(), CAFile::setStatus(), and Sheet.

Here is the call graph for this function:

virtual CASheet* CAImport::importSheetImpl ( ) [inline, protected, virtual]

Reimplemented in CAMidiImport.

References CAFile::setStatus().

Referenced by run().

Here is the call graph for this function:

Here is the caller graph for this function:

void CAImport::importStaff ( )

References setImportPart(), CAFile::setStatus(), and Staff.

Here is the call graph for this function:

virtual CAStaff* CAImport::importStaffImpl ( ) [inline, protected, virtual]

References CAFile::setStatus().

Referenced by run().

Here is the call graph for this function:

Here is the caller graph for this function:

void CAImport::importVoice ( )

References setImportPart(), CAFile::setStatus(), and Voice.

Referenced by CAMainWin::sourceViewPortCommit().

Here is the call graph for this function:

Here is the caller graph for this function:

virtual CAVoice* CAImport::importVoiceImpl ( ) [inline, protected, virtual]

Reimplemented in CALilyPondImport.

References CAFile::setStatus().

Referenced by run().

Here is the call graph for this function:

Here is the caller graph for this function:

QTextStream& CAImport::in ( ) [inline, protected]

Reimplemented in CAMidiImport, and CALilyPondImport.

References CAFile::stream().

Here is the call graph for this function:

void CAImport::lyricsContextImported ( CALyricsContext * ) [signal]

Referenced by run().

Here is the caller graph for this function:

const QString CAImport::readableStatus ( ) [virtual]

Implements CAFile.

Reimplemented in CAMidiImport, CALilyPondImport, and CAMusicXmlImport.

References CAFile::status().

Referenced by CAMainWin::openDocument().

Here is the call graph for this function:

Here is the caller graph for this function:

void CAImport::run ( ) [private]

Executed when a new thread is dispatched. It looks which part of the document should be imported and starts the procedure. It emits the appropriate signal when the procedure is finished.

References Document, documentImported(), FunctionMarkContext, functionMarkContextImported(), importDocumentImpl(), importDone(), importFunctionMarkContextImpl(), importLyricsContextImpl(), importPart(), importSheetImpl(), importStaffImpl(), importVoiceImpl(), LyricsContext, lyricsContextImported(), setImportedDocument(), setImportedFunctionMarkContext(), setImportedLyricsContext(), setImportedSheet(), setImportedStaff(), setImportedVoice(), CAFile::setStatus(), Sheet, sheetImported(), Staff, staffImported(), CAFile::status(), CAFile::stream(), Voice, and voiceImported().