[KLF Application][KLF Tools][KLF Backend][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
 
unsigned long fg_color
 
unsigned long bg_color
 
int dpi
 
bool bypassTemplate
 

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

Constructor & Destructor Documentation

KLFBackend::klfInput::klfInput ( )
inline

A default constructor assigning default values to all fields.

Definition at line 181 of file klfbackend.h.

Member Data Documentation

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

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

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

Referenced by KLFBackend::getLatexFormula().

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

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

unsigned long KLFBackend::klfInput::fg_color

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.

Definition at line 195 of file klfbackend.h.

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

QString KLFBackend::klfInput::latex

The latex code to render

Definition at line 183 of file klfbackend.h.

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

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

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

QString KLFBackend::klfInput::preamble

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

Definition at line 192 of file klfbackend.h.

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


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

Generated by doxygen 1.8.8