CAExport Class Reference

Base class for export filters. More...

#include <export.h>

Inheritance diagram for CAExport:

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

Definition at line 20 of file export.h.

Constructor & Destructor Documentation

CAExport::CAExport ( QTextStream * stream = 0 )

Definition at line 38 of file export.cpp.

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

Here is the call graph for this function:

CAExport::~CAExport ( ) [virtual]

Definition at line 50 of file export.cpp.

Member Function Documentation

const QString CAExport::readableStatus ( ) [virtual]

Implements CAFile.

Definition at line 133 of file export.cpp.

References CAFile::status().

Here is the call graph for this function:

void CAExport::exportDocument ( CADocument * doc )

Definition at line 97 of file export.cpp.

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

Referenced by CACanExport::exportDocumentImpl(), CAMainWin::on_uiExportDocument_triggered(), CASourceViewPort::rebuild(), CAMainWin::saveDocument(), and CAAutoRecovery::saveRecovery().

Here is the call graph for this function:

Here is the caller graph for this function:

void CAExport::exportSheet ( CASheet * sheet )

Definition at line 103 of file export.cpp.

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

Here is the call graph for this function:

void CAExport::exportStaff ( CAStaff * staff )

Definition at line 109 of file export.cpp.

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

Here is the call graph for this function:

void CAExport::exportVoice ( CAVoice * voice )

Definition at line 115 of file export.cpp.

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

Referenced by CASourceViewPort::rebuild().

Here is the call graph for this function:

void CAExport::exportLyricsContext ( CALyricsContext * lc )

Definition at line 121 of file export.cpp.

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

Referenced by CASourceViewPort::rebuild().

Here is the call graph for this function:

void CAExport::exportFunctionMarkingContext ( CAFunctionMarkingContext * fmc )

Definition at line 127 of file export.cpp.

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

Here is the call graph for this function:

CADocument* CAExport::exportedDocument ( ) [inline]

Definition at line 36 of file export.h.

References _exportedDocument.

Referenced by run(), CAMainWin::saveDocument(), and CALilyPondExport::writeDocumentHeader().

Here is the caller graph for this function:

CASheet* CAExport::exportedSheet ( ) [inline]

Definition at line 37 of file export.h.

References _exportedSheet.

Referenced by run().

Here is the caller graph for this function:

CAStaff* CAExport::exportedStaff ( ) [inline]

Definition at line 38 of file export.h.

References _exportedStaff.

Referenced by run().

Here is the caller graph for this function:

CAVoice* CAExport::exportedVoice ( ) [inline]

Definition at line 39 of file export.h.

References _exportedVoice.

Referenced by run().

Here is the caller graph for this function:

CALyricsContext* CAExport::exportedLyricsContext ( ) [inline]

Definition at line 40 of file export.h.

References _exportedLyricsContext.

Referenced by run().

Here is the caller graph for this function:

CAFunctionMarkingContext* CAExport::exportedFunctionMarkingContext ( ) [inline]

Definition at line 41 of file export.h.

References _exportedFunctionMarkingContext.

Referenced by run().

Here is the caller graph for this function:

void CAExport::documentExported ( CADocument * ) [signal]

Referenced by run().

void CAExport::sheetExported ( CASheet * ) [signal]

Referenced by run().

void CAExport::staffExported ( CAStaff * ) [signal]

Referenced by run().

void CAExport::voiceExported ( CAVoice * ) [signal]

Referenced by run().

void CAExport::lyricsContextExported ( CALyricsContext * ) [signal]

Referenced by run().

void CAExport::functionMarkingContextExported ( CAFunctionMarkingContext * ) [signal]

Referenced by run().

void CAExport::exportDone ( int status ) [signal]

Referenced by run().

virtual void CAExport::exportDocumentImpl ( CADocument * ) [inline, protected, virtual]

Reimplemented in CACanExport, CACanorusMLExport, CALilyPondExport, and CAMidiExport.

Definition at line 56 of file export.h.

References CAFile::setStatus().

Referenced by run().

Here is the call graph for this function:

Here is the caller graph for this function:

virtual void CAExport::exportSheetImpl ( CASheet * ) [inline, protected, virtual]

Reimplemented in CALilyPondExport.

Definition at line 57 of file export.h.

References CAFile::setStatus().

Referenced by run().

Here is the call graph for this function:

Here is the caller graph for this function:

virtual void CAExport::exportStaffImpl ( CAStaff * ) [inline, protected, virtual]

Definition at line 58 of file export.h.

References CAFile::setStatus().

Referenced by run().

Here is the call graph for this function:

Here is the caller graph for this function:

virtual void CAExport::exportVoiceImpl ( CAVoice * ) [inline, protected, virtual]

Reimplemented in CALilyPondExport.

Definition at line 59 of file export.h.

References CAFile::setStatus().

Referenced by run().

Here is the call graph for this function:

Here is the caller graph for this function:

virtual void CAExport::exportLyricsContextImpl ( CALyricsContext * ) [inline, protected, virtual]

Reimplemented in CALilyPondExport.

Definition at line 60 of file export.h.

References CAFile::setStatus().

Referenced by run().

Here is the call graph for this function:

Here is the caller graph for this function:

virtual void CAExport::exportFunctionMarkingContextImpl ( CAFunctionMarkingContext * ) [inline, protected, virtual]

Definition at line 61 of file export.h.

References CAFile::setStatus().

Referenced by run().

Here is the call graph for this function:

Here is the caller graph for this function:

QTextStream& CAExport::out ( ) [inline, protected]

Definition at line 63 of file export.h.

References CAFile::stream().

Referenced by CAMidiExport::exportDocumentImpl(), CALilyPondExport::exportDocumentImpl(), CACanorusMLExport::exportDocumentImpl(), CALilyPondExport::exportLyricsContextBlock(), CALilyPondExport::exportLyricsContextImpl(), CALilyPondExport::exportScoreBlock(), CALilyPondExport::exportStaffVoices(), CALilyPondExport::exportVoiceImpl(), CALilyPondExport::indent(), CALilyPondExport::writeDocumentHeader(), and CALilyPondExport::writeRelativeIntro().

Here is the call graph for this function:

Here is the caller graph for this function:

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.

Definition at line 58 of file export.cpp.

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

Here is the call graph for this function:

void CAExport::setExportedDocument ( CADocument * doc ) [inline, private]

Definition at line 68 of file export.h.

References _exportedDocument.

Referenced by CAExport(), and exportDocument().

Here is the caller graph for this function:

void CAExport::setExportedSheet ( CASheet * sheet ) [inline, private]

Definition at line 69 of file export.h.

References _exportedSheet.

Referenced by CAExport(), and exportSheet().

Here is the caller graph for this function:

void CAExport::setExportedStaff ( CAStaff * staff ) [inline, private]

Definition at line 70 of file export.h.

References _exportedStaff.

Referenced by CAExport(), and exportStaff().

Here is the caller graph for this function:

void CAExport::setExportedVoice ( CAVoice * voice ) [inline, private]

Definition at line 71 of file export.h.

References _exportedVoice.

Referenced by CAExport(), and exportVoice().

Here is the caller graph for this function:

void CAExport::setExportedLyricsContext ( CALyricsContext * lc ) [inline, private]

Definition at line 72 of file export.h.

References _exportedLyricsContext.

Referenced by CAExport(), and exportLyricsContext().

Here is the caller graph for this function:

void CAExport::setExportedFunctionMarkingContext ( CAFunctionMarkingContext * fmc ) [inline, private]

Definition at line 73 of file export.h.

References _exportedFunctionMarkingContext.

Referenced by CAExport(), and exportFunctionMarkingContext().

Here is the caller graph for this function:

Member Data Documentation

CADocument* CAExport::_exportedDocument [private]

Definition at line 75 of file export.h.

Referenced by exportedDocument(), and setExportedDocument().

CASheet* CAExport::_exportedSheet [private]

Definition at line 76 of file export.h.

Referenced by exportedSheet(), and setExportedSheet().

CAStaff* CAExport::_exportedStaff [private]

Definition at line 77 of file export.h.

Referenced by exportedStaff(), and setExportedStaff().

CAVoice* CAExport::_exportedVoice [private]

Definition at line 78 of file export.h.

Referenced by exportedVoice(), and setExportedVoice().

CALyricsContext* CAExport::_exportedLyricsContext [private]

Definition at line 79 of file export.h.

Referenced by exportedLyricsContext(), and setExportedLyricsContext().

CAFunctionMarkingContext* CAExport::_exportedFunctionMarkingContext [private]

Definition at line 80 of file export.h.

Referenced by exportedFunctionMarkingContext(), and setExportedFunctionMarkingContext().

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

/media/hdb5/canorusNightlyBuildSystem/trunk/src/export/export.h
/media/hdb5/canorusNightlyBuildSystem/trunk/src/export/export.cpp

Generated on Sat Feb 9 13:13:52 2008 for Canorus by

1.5.3


Signals
void	documentExported (CADocument *)
void	sheetExported (CASheet *)
void	staffExported (CAStaff *)
void	voiceExported (CAVoice *)
void	lyricsContextExported (CALyricsContext *)
void	functionMarkingContextExported (CAFunctionMarkingContext *)
void	exportDone (int status)
Public Member Functions
	CAExport (QTextStream *stream=0)
virtual	~CAExport ()
virtual const QString	readableStatus ()
void	exportDocument (CADocument *)
void	exportSheet (CASheet *)
void	exportStaff (CAStaff *)
void	exportVoice (CAVoice *)
void	exportLyricsContext (CALyricsContext *)
void	exportFunctionMarkingContext (CAFunctionMarkingContext *)
CADocument *	exportedDocument ()
CASheet *	exportedSheet ()
CAStaff *	exportedStaff ()
CAVoice *	exportedVoice ()
CALyricsContext *	exportedLyricsContext ()
CAFunctionMarkingContext *	exportedFunctionMarkingContext ()
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	exportFunctionMarkingContextImpl (CAFunctionMarkingContext *)
QTextStream &	out ()
void	run ()
Private Member Functions
void	setExportedDocument (CADocument *doc)
void	setExportedSheet (CASheet *sheet)
void	setExportedStaff (CAStaff *staff)
void	setExportedVoice (CAVoice *voice)
void	setExportedLyricsContext (CALyricsContext *lc)
void	setExportedFunctionMarkingContext (CAFunctionMarkingContext *fmc)
Private Attributes
CADocument *	_exportedDocument
CASheet *	_exportedSheet
CAStaff *	_exportedStaff
CAVoice *	_exportedVoice
CALyricsContext *	_exportedLyricsContext
CAFunctionMarkingContext *	_exportedFunctionMarkingContext

CAExport Class Reference

Signals

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation