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