File import/export base class. More...

#include <file.h>

Inheritance diagram for CAFile:

Public Member Functions
	CAFile ()

virtual	~CAFile ()

const int	status ()

const int	progress ()

virtual const QString	readableStatus ()=0

void	setStreamFromFile (const QString filename)

void	setStreamToFile (const QString filename)

void	setStreamFromDevice (QIODevice *device)

void	setStreamToDevice (QIODevice *device)

Protected Member Functions
void	setStatus (const int status)

void	setProgress (const int progress)

QTextStream *	stream ()

virtual void	setStream (QTextStream *stream)

QFile *	file ()

void	setFile (QFile *file)

Private Attributes
int	_status

int	_progress

QTextStream *	_stream

QFile *	_file

bool	_deleteStream

Detailed Description

File import/export base class.

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

This class brings tools for manipulating with files and streams (most notably import and export). Classes CAImport and CAExport inherit this class and implement specific methods for import and export.

All file operations are done in a separate thread. While the file operations are in progress user can poll the status by calling status(), progress() and readableStatus() for human-readable status defined by the filter. Waiting for the thread to be finished can be implemented by calling QThread::wait() or by catching the signals emitted by children import and export classes.

See Also: CAImport, CAExport

Constructor & Destructor Documentation

CAFile::CAFile ( )

References _deleteStream, setFile(), setProgress(), setStatus(), and setStream().

Here is the call graph for this function:

CAFile::~CAFile ( )

virtual

Destructor. Also destroys the created stream and file, if set.

References _deleteStream, file(), and stream().

Here is the call graph for this function:

Member Function Documentation

QFile* CAFile::file ( )

inlineprotected

References _file.

Referenced by CAMidiImport::closeFile(), CAPDFExport::exportDocumentImpl(), CASVGExport::exportDocumentImpl(), CACanorusMLExport::exportResources(), CACanImport::importDocumentImpl(), CACanorusMLImport::importResource(), CAPDFExport::pdfFinished(), setFile(), setStreamFromFile(), setStreamToFile(), CASVGExport::svgFinished(), and ~CAFile().

Here is the caller graph for this function:

const int CAFile::progress ( )

inline

References _progress.

Referenced by setProgress().

Here is the caller graph for this function:

virtual const QString CAFile::readableStatus ( )

pure virtual

Implemented in CAMidiImport, CALilyPondImport, CAMusicXmlImport, CAExport, and CAImport.

void CAFile::setFile ( QFile * file )

inlineprotected

References _file, and file().

Referenced by CAFile(), setStreamFromFile(), and setStreamToFile().

Here is the call graph for this function:

Here is the caller graph for this function:

void CAFile::setProgress ( const int progress )

inlineprotected

References _progress, and progress().

Referenced by CAFile(), and CACanorusMLExport::exportDocumentImpl().

Here is the call graph for this function:

Here is the caller graph for this function:

void CAFile::setStatus ( const int status )

inlineprotected

References _status, and status().

Here is the call graph for this function:

Here is the caller graph for this function:

virtual void CAFile::setStream ( QTextStream * stream )

inlineprotectedvirtual

References _stream, and stream().

Referenced by CAExport::CAExport(), CAFile(), CAImport::CAImport(), setStreamFromDevice(), setStreamFromFile(), setStreamToDevice(), and setStreamToFile().

Here is the call graph for this function:

Here is the caller graph for this function:

void CAFile::setStreamFromDevice ( QIODevice * device )

Creates and sets the stream from the given device. Read-only if the device is not already open.

References _deleteStream, setStream(), and stream().

Here is the call graph for this function:

void CAFile::setStreamFromFile ( const QString filename )

Creates and sets the stream from the file named filename. Stream is Read-only. This method is usually called from the main window when opening a document. This method is also very important for python developers as they cannot directly access QTextStream class, so they call this wrapper instead with a simple string as parameter.

References _deleteStream, file(), setFile(), setStream(), and stream().

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

Here is the call graph for this function:

Here is the caller graph for this function:

void CAFile::setStreamToDevice ( QIODevice * device )

Creates and sets the stream from the given device. Read-write if the given device is not already open.

References _deleteStream, setStream(), and stream().

Referenced by CATypesetCtl::exportDocument(), and CACanExport::exportDocumentImpl().

Here is the call graph for this function:

Here is the caller graph for this function:

void CAFile::setStreamToFile ( const QString filename )

Creates and sets the stream from the file named filename. Stream is Read-Write. This method is usually called from the main window when saving the document. This method is also very important for python developers as they cannot directly access QTextStream class, so they call this wrapper instead with a simple string as parameter.

References _deleteStream, file(), setFile(), setStream(), and stream().

Referenced by CAExport::setStreamToFile().

Here is the call graph for this function: