DvisvgmProcess Class Reference

MathVizAnimator: DvisvgmProcess Class Reference
MathVizAnimator  0.0.1
DvisvgmProcess Class Reference

The DvisvgmProcess class handles the conversion of DVI files to SVG format using the dvisvgm utility. More...

#include <dvisvgm_process.h>

Inheritance diagram for DvisvgmProcess:
[legend]
Collaboration diagram for DvisvgmProcess:
[legend]

Signals

void processFailed (const QFileInfo &dvi_file)
 Signal emitted when the conversion process fails. More...
 
void processFinished (const QFileInfo &svg_file)
 Signal emitted when the conversion process successfully finishes. More...
 

Public Member Functions

 DvisvgmProcess (const QFileInfo &dvi_file, QObject *parent=nullptr)
 Constructs a DvisvgmProcess object. More...
 
QFileInfo dviFile () const
 Returns the QFileInfo object representing the DVI file. More...
 

Detailed Description

The DvisvgmProcess class handles the conversion of DVI files to SVG format using the dvisvgm utility.

This class inherits from QProcess and emits signals upon successful completion or failure of the conversion process. The class should be used as follows. First specify the necessary DVI file in the constructor of the class. When the conversion should be started call the QProcess::start() method. To get informed about the result of the conversion process, connect to the processFailed() and processFinished() signal of this class. The SVG File will be created in the same folder as the given DVI file having the same base name. After the conversion process the object can be destroyed.

Constructor & Destructor Documentation

◆ DvisvgmProcess()

DvisvgmProcess::DvisvgmProcess ( const QFileInfo &  dvi_file,
QObject *  parent = nullptr 
)
explicit

Constructs a DvisvgmProcess object.

Parameters
dvi_fileThe QFileInfo object representing the DVI file to be converted.
parentOptional pointer to the parent QObject.

Member Function Documentation

◆ dviFile()

QFileInfo DvisvgmProcess::dviFile ( ) const
inline

Returns the QFileInfo object representing the DVI file.

Returns
QFileInfo object representing the DVI file.

◆ processFailed

void DvisvgmProcess::processFailed ( const QFileInfo &  dvi_file)
signal

Signal emitted when the conversion process fails.

Parameters
dvi_fileThe QFileInfo object representing the DVI file that failed to convert.

◆ processFinished

void DvisvgmProcess::processFinished ( const QFileInfo &  svg_file)
signal

Signal emitted when the conversion process successfully finishes.

Parameters
svg_fileThe QFileInfo object representing the generated SVG file.

The documentation for this class was generated from the following files:
  • /home/docs/checkouts/readthedocs.org/user_builds/mathvizanimator/checkouts/latest/libs/mva_svg/include/dvisvgm_process.h
  • /home/docs/checkouts/readthedocs.org/user_builds/mathvizanimator/checkouts/latest/libs/mva_svg/src/dvisvgm_process.cpp