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

Specific input to KLFBackend::getLatexFormula() More...

#include <klfbackend.h>

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

Public Member Functions

 klfInput ()
 

Public Attributes

QString latex
 
QString mathmode
 
QString preamble
 
double fontsize
 
unsigned long fg_color
 
unsigned long bg_color
 
int dpi
 
double vectorscale
 
bool bypassTemplate
 
QString userScript
 A Path to a user script that acts as wrapper around LaTeX. More...
 
QMap< QString, QStringuserScriptParam
 Arbitrary parameters to pass to user script. More...
 

Detailed Description

Specific input to KLFBackend::getLatexFormula()

This struct descibes the input of getLatexFormula(), ie. the LaTeX code, the mathmode to use, the dpi for rendering png, colors etc.

Definition at line 306 of file klfbackend.h.

Constructor & Destructor Documentation

◆ klfInput()

KLFBackend::klfInput::klfInput ( )
inline

A default constructor assigning default values to all fields.

Definition at line 309 of file klfbackend.h.

Member Data Documentation

◆ bg_color

unsigned long KLFBackend::klfInput::bg_color

The background color to use, in format given by qRgba(r, g, b, alpha).

Warning
background alpha value can only be 0 or 255, not any arbitrary value. Any non-zero value will be considered as 255.
(E)PS and PDF formats can't handle transparency.

Definition at line 334 of file klfbackend.h.

Referenced by KLFBackend::DefaultTemplateGenerator::generateTemplate(), KLFBackend::getLatexFormula(), and operator==().

◆ bypassTemplate

bool KLFBackend::klfInput::bypassTemplate

If TRUE, indicates that latex contains the whole of the latex code, it should not be included into a default document template.

In particular, if TRUE, then mathmode and preamble are have no effect.

This property is FALSE by default.

Definition at line 348 of file klfbackend.h.

Referenced by KLFBackend::getLatexFormula(), and operator==().

◆ dpi

int KLFBackend::klfInput::dpi

The dots per inch resolution of the resulting image. This is directly passed to the -r option of the gs program.

Definition at line 337 of file klfbackend.h.

Referenced by operator==().

◆ fontsize

double KLFBackend::klfInput::fontsize

The foreground color to use, in format given by qRgb(r, g, b). You may not specify an alpha value here, it will be ignored. The wanted font size in latex points. If negative, leaves the default font size.

Definition at line 326 of file klfbackend.h.

Referenced by KLFBackend::DefaultTemplateGenerator::generateTemplate(), and operator==().

◆ latex

QString KLFBackend::klfInput::latex

The latex code to render

Definition at line 312 of file klfbackend.h.

Referenced by KLFBackend::DefaultTemplateGenerator::generateTemplate(), KLFBackend::getLatexFormula(), and operator==().

◆ mathmode

QString KLFBackend::klfInput::mathmode

The mathmode to use. You may pass an arbitrary string containing '...' . '...' will be replaced by the latex code. Examples are:

  • \[ ... \]
  • $ ... $

Definition at line 318 of file klfbackend.h.

Referenced by KLFBackend::DefaultTemplateGenerator::generateTemplate(), KLFBackend::getLatexFormula(), and operator==().

◆ preamble

QString KLFBackend::klfInput::preamble

The LaTeX preample, ie the code that appears after '\documentclass{...}' and before '\begin{document}'

Definition at line 321 of file klfbackend.h.

Referenced by KLFBackend::DefaultTemplateGenerator::generateTemplate(), and operator==().

◆ userScript

QString KLFBackend::klfInput::userScript

A Path to a user script that acts as wrapper around LaTeX.

In short, we will call this script instead of latex. This script should understand some command-line arguments and environment vars, TO BE DOCUMENTED.

Bug:
......... DOC ........... & IMPLEMENT ................

Definition at line 356 of file klfbackend.h.

Referenced by KLFBackend::getLatexFormula(), and operator==().

◆ userScriptParam

QMap<QString,QString> KLFBackend::klfInput::userScriptParam

Arbitrary parameters to pass to user script.

Only relevant if a userScript is set.

These parameters will be set as environment variables of the form "KLF_ARG_<map-key>".

Definition at line 364 of file klfbackend.h.

◆ vectorscale

double KLFBackend::klfInput::vectorscale

Scale factor for vector formats. This is size ratio, not in percent (i.e. original size is 1.0).

Definition at line 340 of file klfbackend.h.

Referenced by operator==().


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

Generated by doxygen 1.8.13