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 struct OutputParams {
  18         enum FLAVOR {
  19                 LATEX,
  20                 PDFLATEX
  21         };
  22
  23         OutputParams() : flavor(LATEX), nice(false),
  24                            moving_arg(false), free_spacing(false),
  25                            use_babel(false), mixed_content(false),
  26                            linelen(0) {}
  27
  28         /** The latex that we export depends occasionally on what is to
  29             compile the file.
  30         */
  31         FLAVOR flavor;
  32
  33         /** Are we to write a 'nice' LaTeX file or not.
  34             This esentially seems to mean whether InsetInclude, InsetGraphics
  35             and InsetExternal should add the absolute path to any external
  36             files or not.
  37         */
  38         bool nice;
  39
  40         /** moving_arg == true means that the environment in which the inset
  41             is typeset is a moving argument. The inset should take care about
  42             fragile commands by preceding the latex with \protect.
  43         */
  44         bool moving_arg;
  45
  46         /** free_spacing == true means that the inset is in a free-spacing
  47             paragraph.
  48         */
  49         bool free_spacing;
  50
  51         /** This var is set by the return value from BufferParams::writeLaTeX
  52          */
  53         bool use_babel;
  54
  55         /** Used for docbook to see if inside a region of mixed content.
  56             In that case all the white spaces are significant and can not appear
  57             at the begin or end.
  58          */
  59         bool mixed_content;
  60
  61         /** Line lenght to use with ascii export.
  62          */
  63         lyx::size_type linelen;
  64 };
  65
  66 #endif // LATEXRUNPARAMS_H