LaTeXProcess Class Reference

The LaTeXProcess class handles the execution of LaTeX typesetting process to a DVI file. More...

#include <latex_process.h>

Inheritance diagram for LaTeXProcess:

Collaboration diagram for LaTeXProcess:

Signals
void	processFailed (const QFileInfo &latex_file)
	Signal emitted when the LaTeX compilation process fails. More...
void	processFinished (const QFileInfo &dvi_file)
	Signal emitted when the LaTeX compilation process successfully finishes. More...

Public Member Functions
	LaTeXProcess (const QFileInfo &latex_file, QObject *parent=nullptr)
	Constructs a LaTeXProcess object. More...
void	cleanup () const
	Performs cleanup by removing auxiliary files generated during the LaTeX compilation process.
QFileInfo	latexFile () const
	Returns the QFileInfo object representing the LaTeX file. More...

Detailed Description

The LaTeXProcess class handles the execution of LaTeX typesetting process to a DVI file.

This class inherits from QProcess and provides functionalities to compile LaTeX files into DVI format and clean up auxiliary files generated during the compilation process. The class should be used as follows. First specify the necessary LaTeX 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 DVI File will be created in the same folder as the given LaTeX file having the same base name. After the conversion process the object can be destroyed.

Constructor & Destructor Documentation

LaTeXProcess()

LaTeXProcess::LaTeXProcess ( const QFileInfo &  latex_file, QObject *  parent = nullptr  )

explicit

Constructs a LaTeXProcess object.

Parameters

latex_file	The QFileInfo object representing the LaTeX file to be compiled.
parent	Optional pointer to the parent QObject.

Member Function Documentation

latexFile()

QFileInfo LaTeXProcess::latexFile ( ) const

inline

Returns the QFileInfo object representing the LaTeX file.

Returns

QFileInfo object representing the LaTeX file.

processFailed

void LaTeXProcess::processFailed ( const QFileInfo &  latex_file )

signal

Signal emitted when the LaTeX compilation process fails.

Parameters

latex_file

The QFileInfo object representing the LaTeX file that failed to compile.

processFinished

void LaTeXProcess::processFinished ( const QFileInfo &  dvi_file )

signal

Signal emitted when the LaTeX compilation process successfully finishes.

Parameters

dvi_file

The QFileInfo object representing the generated DVI 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/latex_process.h
• /home/docs/checkouts/readthedocs.org/user_builds/mathvizanimator/checkouts/latest/libs/mva_svg/src/latex_process.cpp