KLFBackend::klfOutput Struct Reference

KLFBackend::getLatexFormula() result. More...

#include <klfbackend.h>

List of all members.

Public Attributes

int status
 A code describing the status of the request.
QString errorstr
 An explicit error string.
QImage result
QByteArray pngdata
QByteArray epsdata
QByteArray pdfdata


Detailed Description

KLFBackend::getLatexFormula() result.

This struct contains data that is returned from getLatexFormula(). This includes error handling information, the resulting image (as a QImage) as well as data for PNG, (E)PS and PDF files

Definition at line 174 of file klfbackend.h.


Member Data Documentation

int KLFBackend::klfOutput::status

A code describing the status of the request.

A zero value means success for everything. A positive value means that a program (latex, dvips, ...) returned a non-zero exit code. A negative status indicates an other error.

status will be exactly one of the KLFERR_* constants.

In every case where status is non-zero, a suitable human-readable error string will be provided in the errorstr field. If status is zero, errorstr will be empty.

Definition at line 185 of file klfbackend.h.

Referenced by KLFBackend::getLatexFormula().

QString KLFBackend::klfOutput::errorstr

An explicit error string.

If status is positive (ie. latex/dvips/gs/epstopdf error) then this text is HTML-formatted suitable for a QTextBrowser. Otherwise, the message is a simple plain text sentence. It contains an empty (actually null) string if status is zero.

This string is Qt-Translated with QObject::tr() using "KLFBackend" as comment.

Definition at line 193 of file klfbackend.h.

Referenced by KLFBackend::getLatexFormula().

QImage KLFBackend::klfOutput::result

The actual resulting image.

Definition at line 195 of file klfbackend.h.

Referenced by KLFBackend::getLatexFormula().

QByteArray KLFBackend::klfOutput::pngdata

the data for a png file (exact gs output content)

Definition at line 196 of file klfbackend.h.

Referenced by KLFBackend::getLatexFormula().

QByteArray KLFBackend::klfOutput::epsdata

data for an (eps-)postscript file

Definition at line 197 of file klfbackend.h.

Referenced by KLFBackend::getLatexFormula().

QByteArray KLFBackend::klfOutput::pdfdata

data for a pdf file, if klfSettings::epstopdfexec is non-empty.

Definition at line 198 of file klfbackend.h.

Referenced by KLFBackend::getLatexFormula().


The documentation for this struct was generated from the following file:
Generated on Mon May 4 01:27:08 2009 for KLFBackend by  doxygen 1.5.3