Cute Chess  0.1
Public Types | Signals | Public Member Functions | Protected Member Functions | List of all members
PgnImporter Class Reference

Reads PGN database in a separate thread. More...

#include <pgnimporter.h>

Inheritance diagram for PgnImporter:
Worker QObject

Public Types

enum  Error { FileDoesNotExist, IoError }
 

Signals

void databaseRead (PgnDatabase *database)
 
void databaseReadStatus (const QTime &started, int numReadGames, qint64 numReadBytes)
 
- Signals inherited from Worker
void cancelled ()
 
void error (int error)
 
void finished ()
 
void progressChanged (int value)
 
void started ()
 
void statusChanged (const QString &statusMessage)
 

Public Member Functions

QString fileName () const
 
 PgnImporter (const QString &fileName)
 
- Public Member Functions inherited from Worker
void run () override
 
QTime startTime () const
 
QString title () const
 
 Worker (const QString &title)
 
virtual ~Worker ()
 

Protected Member Functions

void work () override
 
- Protected Member Functions inherited from Worker
bool cancelRequested () const
 

Additional Inherited Members

- Public Slots inherited from Worker
void cancel ()
 

Detailed Description

Reads PGN database in a separate thread.

See also
PgnDatabase

Member Enumeration Documentation

Import error.

Enumerator
FileDoesNotExist 

The PGN file was not found.

IoError 

A generic I/O error.

Constructor & Destructor Documentation

PgnImporter::PgnImporter ( const QString fileName)

Constructs a PgnImporter with fileName as database to be imported.

Member Function Documentation

void PgnImporter::databaseRead ( PgnDatabase database)
signal

Emitted when database is read.

void PgnImporter::databaseReadStatus ( const QTime started,
int  numReadGames,
qint64  numReadBytes 
)
signal

Emitted periodically to give progress information about the import.

The import was initiated at started and so far numReadGames games and numReadBytes bytes have been read.

QString PgnImporter::fileName ( ) const

Returns the file name of the database to be imported.

void PgnImporter::work ( )
overrideprotectedvirtual

Perform the long running task.

Periodically check for cancelRequested() to see if the work should be cancelled.

Optionally emit the progressChanged and statusChanged to reflect the current status of the work.

If any error occurs emit the error() and statusChanged() signals and return from the function.

Implements Worker.


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