src/layout.h

   1 // -*- C++ -*-
   2 /**
   3  * \file layout.h
   4  * This file is part of LyX, the document processor.
   5  * Licence details can be found in the file COPYING.
   6  *
   7  * \author Lars Gullik Bjønnes
   8  * \author Jean-Marc Lasgouttes
   9  *
  10  * Full author contact details are available in file CREDITS.
  11  */
  12
  13 #ifndef LAYOUT_H
  14 #define LAYOUT_H
  15
  16 /// The different output types
  17 enum OutputType {
  18         ///
  19         LATEX = 1,
  20         ///
  21         DOCBOOK,
  22         ///
  23         LITERATE
  24 };
  25
  26
  27 /// The different margin types
  28 enum LYX_MARGIN_TYPE {
  29         ///
  30         MARGIN_MANUAL = 1,
  31         ///
  32         MARGIN_FIRST_DYNAMIC,
  33         ///
  34         MARGIN_DYNAMIC,
  35         ///
  36         MARGIN_STATIC,
  37         ///
  38         MARGIN_RIGHT_ADDRESS_BOX
  39 };
  40
  41
  42 ///
  43 enum LyXAlignment {
  44         ///
  45         LYX_ALIGN_NONE = 0,
  46         ///
  47         LYX_ALIGN_BLOCK = 1,
  48         ///
  49         LYX_ALIGN_LEFT = 2,
  50         ///
  51         LYX_ALIGN_RIGHT = 4,
  52         ///
  53         LYX_ALIGN_CENTER = 8,
  54         ///
  55         LYX_ALIGN_LAYOUT = 16,
  56         ///
  57         LYX_ALIGN_SPECIAL = 32
  58 };
  59
  60 ///
  61 inline
  62 void operator|=(LyXAlignment & la1, LyXAlignment la2) {
  63         la1 = static_cast<LyXAlignment>(la1 | la2);
  64 }
  65
  66
  67 /// The different LaTeX-Types
  68 enum LYX_LATEX_TYPES {
  69         ///
  70         LATEX_PARAGRAPH = 1,
  71         ///
  72         LATEX_COMMAND,
  73         ///
  74         LATEX_ENVIRONMENT,
  75         ///
  76         LATEX_ITEM_ENVIRONMENT,
  77         ///
  78         LATEX_BIB_ENVIRONMENT,
  79         ///
  80         LATEX_LIST_ENVIRONMENT
  81 };
  82
  83
  84 /// The different title types
  85 enum LYX_TITLE_LATEX_TYPES {
  86         ///
  87         TITLE_COMMAND_AFTER = 1,
  88         ///
  89         TITLE_ENVIRONMENT
  90 };
  91
  92
  93 /// The different label types
  94 enum LYX_LABEL_TYPES {
  95         ///
  96         LABEL_NO_LABEL,
  97         ///
  98         LABEL_MANUAL,
  99         ///
 100         LABEL_BIBLIO,
 101         ///
 102         LABEL_TOP_ENVIRONMENT,
 103         ///
 104         LABEL_CENTERED_TOP_ENVIRONMENT,
 105
 106         // the flushright labels following now must start with LABEL_STATIC
 107         ///
 108         LABEL_STATIC,
 109         ///
 110         LABEL_SENSITIVE,
 111         ///
 112         LABEL_COUNTER,
 113         ///
 114         LABEL_ENUMERATE,
 115         ///
 116         LABEL_ITEMIZE
 117 };
 118
 119
 120 ///
 121 enum LYX_END_LABEL_TYPES {
 122         ///
 123         END_LABEL_NO_LABEL,
 124         ///
 125         END_LABEL_BOX,
 126         ///
 127         END_LABEL_FILLED_BOX,
 128         ///
 129         END_LABEL_STATIC,
 130         ///
 131         END_LABEL_ENUM_FIRST = END_LABEL_NO_LABEL,
 132         ///
 133         END_LABEL_ENUM_LAST = END_LABEL_STATIC
 134 };
 135
 136 /* Fix labels are printed flushright, manual labels flushleft.
 137  * MARGIN_MANUAL and MARGIN_FIRST_DYNAMIC are *only* for LABEL_MANUAL,
 138  * MARGIN_DYNAMIC and MARGIN_STATIC are *not* for LABEL_MANUAL.
 139  * This seems a funny restriction, but I think other combinations are
 140  * not needed, so I will not change it yet.
 141  * Correction: MARGIN_FIRST_DYNAMIC also usable with LABEL_STATIC
 142  */
 143
 144
 145 /* There is a parindent and a parskip. Which one is used depends on the
 146  * paragraph_separation-flag of the text-object.
 147  * BUT: parindent is only thrown away, if a parskip is defined! So if you
 148  * want a space between the paragraphs and a parindent at the same time,
 149  * you should set parskip to zero and use topsep, parsep and bottomsep.
 150  *
 151  * The standard layout is an exception: its parindent is only set, if the
 152  * previous paragraph is standard too. Well, this is LateX and it is good!
 153  */
 154
 155
 156 #endif