src/outputparams.h

   1 // -*- C++ -*-
   2 /**
   3  * \file outputparams.h
   4  * This file is part of LyX, the document processor.
   5  * Licence details can be found in the file COPYING.
   6  *
   7  *  \author Angus Leeming
   8  *
   9  * Full author contact details are available in file CREDITS.
  10  */
  11
  12 #ifndef OUTPUTPARAMS_H
  13 #define OUTPUTPARAMS_H
  14
  15 #include "support/types.h"
  16
  17
  18 class ExportData;
  19
  20
  21 struct OutputParams {
  22         //
  23         enum FLAVOR {
  24                 LATEX,
  25                 PDFLATEX,
  26                 XML
  27         };
  28
  29         OutputParams()
  30                 : flavor(LATEX), nice(false), moving_arg(false),
  31                   free_spacing(false), use_babel(false),
  32                   mixed_content(false), linelen(0), exportdata(0)
  33         {}
  34
  35         /** The latex that we export depends occasionally on what is to
  36             compile the file.
  37         */
  38         FLAVOR flavor;
  39
  40         /** Are we to write a 'nice' LaTeX file or not.
  41             This esentially seems to mean whether InsetInclude, InsetGraphics
  42             and InsetExternal should add the absolute path to any external
  43             files or not.
  44         */
  45         bool nice;
  46
  47         /** moving_arg == true means that the environment in which the inset
  48             is typeset is a moving argument. The inset should take care about
  49             fragile commands by preceding the latex with \protect.
  50         */
  51         bool moving_arg;
  52
  53         /** free_spacing == true means that the inset is in a free-spacing
  54             paragraph.
  55         */
  56         bool free_spacing;
  57
  58         /** This var is set by the return value from BufferParams::writeLaTeX
  59         */
  60         bool use_babel;
  61
  62         /** Used for docbook to see if inside a region of mixed content.
  63             In that case all the white spaces are significant and can not appear
  64             at the begin or end.
  65         */
  66         bool mixed_content;
  67
  68         /** Line length to use with ascii export.
  69         */
  70         lyx::size_type linelen;
  71
  72         /** Export data filled in by the latex(), docbook() etc methods.
  73             This is a hack: Make it possible to add stuff to constant
  74             OutputParams instances.
  75         */
  76         ExportData *exportdata;
  77 };
  78
  79 #endif // LATEXRUNPARAMS_H