Base class for export filters. More...

#include <export.h>

Inheritance diagram for CAExport:

[legend]

Signals
void	documentExported (CADocument *)

void	sheetExported (CASheet *)

void	staffExported (CAStaff *)

void	voiceExported (CAVoice *)

void	lyricsContextExported (CALyricsContext *)

void	functionMarkContextExported (CAFunctionMarkContext *)

void	exportDone (int status)

Public Member Functions
	CAExport (QTextStream *stream=0)

virtual	~CAExport ()

virtual const QString	readableStatus ()

void	exportDocument (CADocument *, bool bStartThread=true)

void	exportSheet (CASheet *)

void	exportStaff (CAStaff *)

void	exportVoice (CAVoice *)

void	exportLyricsContext (CALyricsContext *)

void	exportFunctionMarkContext (CAFunctionMarkContext *)

CADocument *	exportedDocument ()

CASheet *	exportedSheet ()

CAStaff *	exportedStaff ()

CAVoice *	exportedVoice ()

CALyricsContext *	exportedLyricsContext ()

CAFunctionMarkContext *	exportedFunctionMarkContext ()

virtual void	setStreamToFile (const QString filename)

bool	wait (unsigned long time=ULONG_MAX)

Public Member Functions inherited from CAFile
	CAFile ()

virtual	~CAFile ()

const int	status ()

const int	progress ()

void	setStreamFromFile (const QString filename)

void	setStreamToFile (const QString filename)

void	setStreamFromDevice (QIODevice *device)

void	setStreamToDevice (QIODevice *device)

void	setStreamToString ()

QString	getStreamAsString ()

Protected Member Functions
virtual void	exportDocumentImpl (CADocument *)

virtual void	exportSheetImpl (CASheet *)

virtual void	exportStaffImpl (CAStaff *)

virtual void	exportVoiceImpl (CAVoice *)

virtual void	exportLyricsContextImpl (CALyricsContext *)

virtual void	exportFunctionMarkContextImpl (CAFunctionMarkContext *)

QTextStream &	out ()

void	run ()

Protected Member Functions inherited from CAFile
void	setStatus (const int status)

void	setProgress (const int progress)

QTextStream *	stream ()

virtual void	setStream (QTextStream *stream)

QFile *	file ()

void	setFile (QFile *file)

Private Member Functions
void	setExportedDocument (CADocument *doc)

void	setExportedSheet (CASheet *sheet)

void	setExportedStaff (CAStaff *staff)

void	setExportedVoice (CAVoice *voice)

void	setExportedLyricsContext (CALyricsContext *lc)

void	setExportedFunctionMarkContext (CAFunctionMarkContext *fmc)

Private Attributes
CADocument *	_exportedDocument

CASheet *	_exportedSheet

CAStaff *	_exportedStaff

CAVoice *	_exportedVoice

CALyricsContext *	_exportedLyricsContext

CAFunctionMarkContext *	_exportedFunctionMarkContext

Detailed Description

Base class for export filters.

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 export filter, he should: 1) Create a new class with the base class CAExport 2) Implement CAExport constructors and at least exportDocumentImpl() function 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 export class:

CAMyExportFilter export();
export.setStreamToFile("jingle bells.xml");
export.exportDocument( curDocument );
 
export.wait();

Constructor & Destructor Documentation

◆ CAExport()

CAExport::CAExport ( QTextStream * stream = 0 )

References setExportedDocument(), setExportedFunctionMarkContext(), setExportedLyricsContext(), setExportedSheet(), setExportedStaff(), setExportedVoice(), CAFile::setStream(), and CAFile::stream().

Here is the call graph for this function:

◆ ~CAExport()

CAExport::~CAExport ( )

virtual

Member Function Documentation

◆ documentExported

void CAExport::documentExported ( CADocument * )

signal

Referenced by exportDocument(), and run().

Here is the caller graph for this function:

◆ exportDocument()

void CAExport::exportDocument	(	CADocument *	doc,
		bool	bStartThread = `true`
	)

References documentExported(), exportDocumentImpl(), exportDone(), exportedDocument(), setExportedDocument(), CAFile::setStatus(), CAFile::status(), and CAFile::stream().

Referenced by CATypesetCtl::exportDocument(), CACanExport::exportDocumentImpl(), CASourceView::rebuild(), CAMainWin::saveDocument(), and CAAutoRecovery::saveRecovery().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ exportDocumentImpl()

virtual void CAExport::exportDocumentImpl ( CADocument * )

inlineprotectedvirtual

Reimplemented in CASVGExport, CAPDFExport, CAMidiExport, CACanorusMLExport, and CACanExport.

References CAFile::setStatus().

Referenced by exportDocument(), and run().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ exportDone

void CAExport::exportDone ( int status )

signal

Referenced by exportDocument(), and run().

Here is the caller graph for this function:

◆ exportedDocument()

CADocument* CAExport::exportedDocument ( )

inline

References _exportedDocument.

Referenced by exportDocument(), and run().

Here is the caller graph for this function:

◆ exportedFunctionMarkContext()

CAFunctionMarkContext* CAExport::exportedFunctionMarkContext ( )

inline

References _exportedFunctionMarkContext.

Referenced by run().

Here is the caller graph for this function:

◆ exportedLyricsContext()

CALyricsContext* CAExport::exportedLyricsContext ( )

inline

References _exportedLyricsContext.

Referenced by run().

Here is the caller graph for this function:

◆ exportedSheet()

CASheet* CAExport::exportedSheet ( )

inline

References _exportedSheet.

Referenced by run().

Here is the caller graph for this function:

◆ exportedStaff()

CAStaff* CAExport::exportedStaff ( )

inline

References _exportedStaff.

Referenced by run().

Here is the caller graph for this function:

◆ exportedVoice()

CAVoice* CAExport::exportedVoice ( )

inline

References _exportedVoice.

Referenced by run().

Here is the caller graph for this function:

◆ exportFunctionMarkContext()

void CAExport::exportFunctionMarkContext ( CAFunctionMarkContext * fmc )

References setExportedFunctionMarkContext(), and CAFile::setStatus().

Here is the call graph for this function:

◆ exportFunctionMarkContextImpl()

virtual void CAExport::exportFunctionMarkContextImpl ( CAFunctionMarkContext * )

inlineprotectedvirtual

References CAFile::setStatus().

Referenced by run().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ exportLyricsContext()

void CAExport::exportLyricsContext ( CALyricsContext * lc )

References setExportedLyricsContext(), and CAFile::setStatus().

Referenced by CASourceView::rebuild().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ exportLyricsContextImpl()

virtual void CAExport::exportLyricsContextImpl ( CALyricsContext * )

inlineprotectedvirtual

Reimplemented in CALilyPondExport.

References CAFile::setStatus().

Referenced by run().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ exportSheet()

void CAExport::exportSheet ( CASheet * sheet )

References setExportedSheet(), and CAFile::setStatus().

Referenced by CATypesetCtl::exportSheet(), CAMainWin::on_uiExportDocument_triggered(), CAPreviewCtl::on_uiPrintPreview_triggered(), and CAPrintCtl::printDocument().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ exportSheetImpl()

virtual void CAExport::exportSheetImpl ( CASheet * )

inlineprotectedvirtual

Reimplemented in CAMidiExport, CALilyPondExport, CAMusicXmlExport, CASVGExport, and CAPDFExport.

References CAFile::setStatus().

Referenced by run().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ exportStaff()

void CAExport::exportStaff ( CAStaff * staff )

References setExportedStaff(), and CAFile::setStatus().

Here is the call graph for this function:

◆ exportStaffImpl()

virtual void CAExport::exportStaffImpl ( CAStaff * )

inlineprotectedvirtual

References CAFile::setStatus().

Referenced by run().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ exportVoice()

void CAExport::exportVoice ( CAVoice * voice )

References setExportedVoice(), and CAFile::setStatus().

Referenced by CASourceView::rebuild().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ exportVoiceImpl()

virtual void CAExport::exportVoiceImpl ( CAVoice * )

inlineprotectedvirtual

Reimplemented in CALilyPondExport.

References CAFile::setStatus().

Referenced by run().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ functionMarkContextExported

void CAExport::functionMarkContextExported ( CAFunctionMarkContext * )

signal

Referenced by run().

Here is the caller graph for this function:

◆ lyricsContextExported

void CAExport::lyricsContextExported ( CALyricsContext * )

signal

Referenced by run().

Here is the caller graph for this function:

◆ out()

QTextStream& CAExport::out ( )

inlineprotected

References CAFile::stream().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ readableStatus()

const QString CAExport::readableStatus ( )

virtual

Implements CAFile.

References CAFile::status().

Referenced by CAMainWin::saveDocument().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ run()

void CAExport::run ( )

protected

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

References documentExported(), exportDocumentImpl(), exportDone(), exportedDocument(), exportedFunctionMarkContext(), exportedLyricsContext(), exportedSheet(), exportedStaff(), exportedVoice(), exportFunctionMarkContextImpl(), exportLyricsContextImpl(), exportSheetImpl(), exportStaffImpl(), exportVoiceImpl(), functionMarkContextExported(), lyricsContextExported(), CAFile::setStatus(), sheetExported(), staffExported(), CAFile::status(), CAFile::stream(), and voiceExported().