[KLF Backend][KLF Tools][KLF Home]
KLatexFormula Project
Public Attributes | List of all members
KLFBackend::klfOutput Struct Reference

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

#include <klfbackend.h>

Collaboration diagram for KLFBackend::klfOutput:
Collaboration graph
[legend]

Public Attributes

int status
 A code describing the status of the request. More...
 
QString errorstr
 An explicit error string. More...
 
QImage result
 The actual resulting image.
 
klfInput input
 The input parameters used to generate this output.
 
klfSettings settings
 The settings that this output was generated with.
 
QByteArray dvidata
 The DVI file data outputted by latex executable.
 
QByteArray pngdata_raw
 the data for a png file (exact gs output content) More...
 
QByteArray pngdata
 the data for a png file (re-processed with meta information) More...
 
QByteArray epsdata_raw
 data for an (eps-)postscript file. More...
 
QByteArray epsdata_bbox
 data for an (eps-)postscript file. More...
 
QByteArray epsdata
 data for an (eps-)postscript file. More...
 
QByteArray pdfdata
 data for a pdf file
 
QByteArray svgdata
 data for a SVG file, if ghostscript supports SVG
 
double width_pt
 Width in points of the resulting equation.
 
double height_pt
 Width in points of the resulting equation.
 

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 370 of file klfbackend.h.

Member Data Documentation

◆ epsdata

QByteArray KLFBackend::klfOutput::epsdata

data for an (eps-)postscript file.

Fonts are outlined with paths if the setting klfSettings::outlineFonts is given.

Definition at line 445 of file klfbackend.h.

Referenced by KLFBackend::availableSaveFormats(), KLFBackend::getLatexFormula(), and KLFBackend::saveOutputToDevice().

◆ epsdata_bbox

QByteArray KLFBackend::klfOutput::epsdata_bbox

data for an (eps-)postscript file.

Data as output by dvips, with the corrected bounding box as specified in the settings object.

This field in output object is only initialized if klfSettings::wantRaw is TRUE.

Definition at line 441 of file klfbackend.h.

◆ epsdata_raw

QByteArray KLFBackend::klfOutput::epsdata_raw

data for an (eps-)postscript file.

Data is exactly as output by dvips -E, without any further processing.

This field in output object is only initialized if klfSettings::wantRaw is TRUE.

Definition at line 434 of file klfbackend.h.

Referenced by KLFBackend::getLatexFormula().

◆ errorstr

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 390 of file klfbackend.h.

Referenced by KLFBackend::getLatexFormula(), and KLFLatexPreviewHandler::latexPreviewError().

◆ pngdata

QByteArray KLFBackend::klfOutput::pngdata

the data for a png file (re-processed with meta information)

The following metadata tags are set in the image:

  • "AppVersion" set to "KLatexFormula <version>"
  • "Application" set to translated string "Created with KLatexFormula version <version>"
  • "Software", set to "KLatexFormula <version>"
  • "InputLatex", "InputMathMode", "InputPreamble" are set respectively to the latex code text, the math mode and the preamble as given in the klfInput object.
  • "InputFgColor" set to "rgb(<0-255>, <0-255>, <0-255>)"
  • "InputBgColor" set to "rgba(<0-255>, <0-255>, <0-255>, <0-255>)"
  • "InputDPI" set to the Dots Per Inch resolution of the image
  • "SettingsTBorderOffset", "SettingsRBorderOffset", "SettingsBBorderOffset", "SettingsLBorderOffset", are set to the border offsets in postscript points of the image (respectively top, right, bottom and left)
  • "SettingsOutlineFonts" set to "true" or "false" as given in klfSettings::outlineFonts.
  • ... along with more, see klfbackend.cpp.

Definition at line 428 of file klfbackend.h.

Referenced by KLFBackend::availableSaveFormats(), KLFBackend::getLatexFormula(), and KLFBackend::saveOutputToDevice().

◆ pngdata_raw

QByteArray KLFBackend::klfOutput::pngdata_raw

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

This image does NOT contain any meta-data. See also pngdata.

This field in output object is only initialized if klfSettings::wantRaw is TRUE.

Definition at line 408 of file klfbackend.h.

Referenced by KLFBackend::getLatexFormula().

◆ status

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 another error.

status will be exactly one of the KLFERR_* constants, defined in klfbackend.h .

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 381 of file klfbackend.h.

Referenced by KLFBackend::getLatexFormula(), and KLFLatexPreviewHandler::latexPreviewError().


The documentation for this struct was generated from the following file:

Generated by doxygen 1.8.13