[KLF Application][KLF Tools][KLF Backend][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
 
klfInput input
 
klfSettings settings
 
QByteArray pngdata_raw
 
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 217 of file klfbackend.h.

Member Data Documentation

QByteArray KLFBackend::klfOutput::epsdata

data for an (eps-)postscript file

Definition at line 270 of file klfbackend.h.

Referenced by KLFBackend::saveOutputToDevice().

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

Referenced by KLFBackend::getLatexFormula().

klfInput KLFBackend::klfOutput::input

The input parameters used to generate this output

Definition at line 241 of file klfbackend.h.

QByteArray KLFBackend::klfOutput::pdfdata

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

Definition at line 272 of file klfbackend.h.

Referenced by KLFBackend::saveOutputToDevice().

QByteArray KLFBackend::klfOutput::pngdata

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

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.

Definition at line 268 of file klfbackend.h.

Referenced by KLFBackend::saveOutputToDevice().

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.

Definition at line 249 of file klfbackend.h.

QImage KLFBackend::klfOutput::result

The actual resulting image.

Definition at line 238 of file klfbackend.h.

Referenced by KLFBackend::saveOutputToDevice().

klfSettings KLFBackend::klfOutput::settings

The settings that this output was generated with

Definition at line 243 of file klfbackend.h.

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

Referenced by KLFBackend::getLatexFormula().


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

Generated by doxygen 1.8.11