General settings for KLFBackend::getLatexFormula() More...

#include <klfbackend.h>

Collaboration diagram for KLFBackend::klfSettings:

Public Member Functions
	klfSettings ()
Public Attributes
QString	tempdir
QString	latexexec
QString	dvipsexec
QString	gsexec
QString	epstopdfexec
double	tborderoffset
double	rborderoffset
double	bborderoffset
double	lborderoffset
bool	calcEpsBoundingBox
bool	outlineFonts
bool	wantRaw
bool	wantPDF
bool	wantSVG
QStringList	execenv
TemplateGenerator *	templateGenerator
QMap< QString, QString >	userScriptInterpreters

Detailed Description

General settings for KLFBackend::getLatexFormula()

Some global settings to pass on when calling getLatexFormula(). In this struct you specify some system settings, like a temp directory and some paths

Note:: the klfclspath field was removed, because we no longer use klatexformula.cls.

Definition at line 218 of file klfbackend.h.

Constructor & Destructor Documentation

KLFBackend::klfSettings::klfSettings ( ) [inline]

A default constructor assigning default (empty) values to all fields

Definition at line 221 of file klfbackend.h.

Member Data Documentation

double KLFBackend::klfSettings::bborderoffset

The number of postscript points to add to bottom side of the resulting EPS boundingbox

Note:: Currently this value is rounded off to the nearest integer. The type double is just an anticipation of hi-resolution bounding box adjustment.

Definition at line 256 of file klfbackend.h.

Referenced by KLFBackend::detectSettings(), and KLFBackend::getLatexFormula().

bool KLFBackend::klfSettings::calcEpsBoundingBox

Call GS to recalculate EPS bounding box instead of assuming dvips' one. This setting is ignored with a non-white or non-transparent background color.

Definition at line 264 of file klfbackend.h.

Referenced by KLFBackend::getLatexFormula().

QString KLFBackend::klfSettings::dvipsexec

the dvips executable, path incl. if not in $PATH

Definition at line 231 of file klfbackend.h.

Referenced by KLFBackend::detectSettings(), and KLFBackend::getLatexFormula().

QString KLFBackend::klfSettings::epstopdfexec

Deprecated:: This setting is DEPRECATED and no longer used as of version 3.3. PDF is generated by calling ghostscript directly. This value will be ignored!

the epstopdf executable, path incl. if not in $PATH. This isn't mandatory to get PNG so you may leave this to Null or Empty string to instruct getLatexFormula() to NOT attempt to generate PDF. If, though, you do specify an epstopdf executable here, epstopdf errors will be reported as real errors.

Definition at line 243 of file klfbackend.h.

Referenced by KLFBackend::detectSettings().

QStringList KLFBackend::klfSettings::execenv

Extra environment variables to set (list of "NAME=value") when executing latex, dvips, gs.

Definition at line 289 of file klfbackend.h.

Referenced by KLFBackend::getLatexFormula(), and klf_detect_execenv().

QString KLFBackend::klfSettings::gsexec

the gs executable, path incl. if not in $PATH

Definition at line 233 of file klfbackend.h.

Referenced by KLFBackend::detectOptionSettings(), KLFBackend::detectSettings(), KLFBackend::getLatexFormula(), and klf_detect_execenv().

QString KLFBackend::klfSettings::latexexec

the latex executable, path incl. if not in $PATH

Definition at line 229 of file klfbackend.h.

Referenced by KLFBackend::detectSettings(), and KLFBackend::getLatexFormula().

double KLFBackend::klfSettings::lborderoffset

The number of postscript points to add to left side of the resulting EPS boundingbox

Note:: Currently this value is rounded off to the nearest integer. The type double is just an anticipation of hi-resolution bounding box adjustment.

Definition at line 260 of file klfbackend.h.

Referenced by KLFBackend::detectSettings(), and KLFBackend::getLatexFormula().

bool KLFBackend::klfSettings::outlineFonts

Strip away fonts in favor of vectorially outlining them with gs.

Use this option to produce output that doens't embed fonts, eg. for Adobe Illustrator.

Note:: This option is ignored when generating SVG with ghostscript and fonts are always outlined. Reason: otherwise, gs just rasterizes the fonts very uglyly (!!).

Definition at line 273 of file klfbackend.h.

Referenced by KLFBackend::getLatexFormula().

double KLFBackend::klfSettings::rborderoffset

The number of postscript points to add to right side of the resulting EPS boundingbox

Note:: Currently this value is rounded off to the nearest integer. The type double is just an anticipation of hi-resolution bounding box adjustment.

Definition at line 252 of file klfbackend.h.

Referenced by KLFBackend::detectSettings(), and KLFBackend::getLatexFormula().

double KLFBackend::klfSettings::tborderoffset

The number of postscript points to add to top side of the resulting EPS boundingbox.

Note:: Currently this value is rounded off to the nearest integer. The type double is just an anticipation of hi-resolution bounding box adjustment.

Definition at line 248 of file klfbackend.h.

Referenced by KLFBackend::detectSettings(), and KLFBackend::getLatexFormula().

QString KLFBackend::klfSettings::tempdir

A temporary directory in which we have write access, e.g. /tmp/

Definition at line 227 of file klfbackend.h.

Referenced by KLFBackend::detectSettings(), and KLFBackend::getLatexFormula().

TemplateGenerator* KLFBackend::klfSettings::templateGenerator

The TemplateGenerator object that will be used to generate the base document template. Can be NULL, in which case the default generator is used, see DefaultTemplateGenerator.

Definition at line 294 of file klfbackend.h.

Referenced by KLFBackend::getLatexFormula().

QMap<QString,QString> KLFBackend::klfSettings::userScriptInterpreters

Path to interpreters to use for different script formats. The key is the filename extension of the script (e.g. "py"), and the value is the path to the corresponding interpreter (e.g. "/usr/bin/python")

Definition at line 300 of file klfbackend.h.

bool KLFBackend::klfSettings::wantPDF

If set to false, PDF will not be generated. This is useful if you don't want to waste resources generating a PDF file that you will not need.

Definition at line 281 of file klfbackend.h.

Referenced by KLFBackend::detectSettings(), KLFBackend::getLatexFormula(), and KLFContLatexPreview::setSettings().

bool KLFBackend::klfSettings::wantRaw

If set to false, then klfOutput::pngdata_raw and klfOutput::epsdata_raw will not be initialized. This is the default, to save resources.

Definition at line 277 of file klfbackend.h.

Referenced by KLFBackend::getLatexFormula(), and KLFContLatexPreview::setSettings().

bool KLFBackend::klfSettings::wantSVG

If set to false, SVG will not be generated. This is useful if you don't want to waste resources generating an SVG file that you will not need.

Definition at line 285 of file klfbackend.h.