src/definitions.h

   1 // -*- C++ -*-
   2 /* This file is part of
   3  * ======================================================
   4  *
   5  *           LyX, The Document Processor
   6  *
   7  *          Copyright (C) 1995 Matthias Ettrich
   8  *
   9  *======================================================*/
  10 #ifndef _DEFINITIONS_H
  11 #define _DEFINITIONS_H
  12
  13 // NOTE:
  14 // We are trying to get rid of the global enums below, so try to _not_
  15 // add any more of them. Preferably enums should be located inside classes.
  16 // (i.e. class FooBar {
  17 //            enum some {
  18 //                more,
  19 //                thing
  20 //            };
  21 //        }
  22 //  to be accesed as FooBar::more and FooBar::thing
  23
  24 // ALL the enums below should be given names, this to get better typechecking.
  25 // some don't have names now because this cause warings when compiling.
  26
  27
  28 ///
  29 enum { // no good name for this
  30         ///
  31         LYX_ENVIRONMENT_DEFAULT = 97,
  32         ///
  33         LYX_LAYOUT_DEFAULT = 99
  34 };
  35 // Could this cause confusion that both DUMMY_LAYOUT and  LAYOUT_DEFAULT has
  36 // the same value? (Lgb)
  37 ///
  38 #define LYX_DUMMY_LAYOUT 99
  39
  40 ///
  41 enum LYX_META_KIND {
  42         ///
  43         LYX_META_FOOTNOTE = 1,
  44         ///
  45         LYX_META_MARGIN,
  46         ///
  47         LYX_META_FIG,
  48         ///
  49         LYX_META_TAB,
  50         ///
  51         LYX_META_ALGORITHM,
  52         ///
  53         LYX_META_WIDE_FIG,
  54         ///
  55         LYX_META_WIDE_TAB,
  56         ///
  57         LYX_META_HFILL,
  58         ///
  59         LYX_META_NEWLINE,
  60         ///
  61         LYX_META_PROTECTED_SEPARATOR,
  62         ///
  63         LYX_META_INSET
  64 };
  65
  66 ///
  67 enum LYX_PARSEP {
  68         ///
  69         LYX_PARSEP_INDENT,
  70         ///
  71         LYX_PARSEP_SKIP
  72 };
  73
  74 ///
  75 enum OLD_LYX_PAPER_SIZE {
  76         ///
  77         OLD_PAPER_A4PAPER,
  78         ///
  79         OLD_PAPER_A4,
  80         ///
  81         OLD_PAPER_A4WIDE,
  82         ///
  83         OLD_PAPER_WIDEMARGINSA4,
  84         ///
  85         OLD_PAPER_USLETTER,
  86         ///
  87         OLD_PAPER_A5PAPER,
  88         ///
  89         OLD_PAPER_B5PAPER,
  90         ///
  91         OLD_PAPER_EXECUTIVEPAPER,
  92         ///
  93         OLD_PAPER_LEGALPAPER
  94 };
  95
  96 ///
  97 enum LYX_PAPER_SIZE {
  98         ///
  99         PAPER_DEFAULT,
 100         ///
 101         PAPER_USLETTER,
 102         ///
 103         PAPER_LEGALPAPER,
 104         ///
 105         PAPER_EXECUTIVEPAPER,
 106         ///
 107         PAPER_A3PAPER,
 108         ///
 109         PAPER_A4PAPER,
 110         ///
 111         PAPER_A5PAPER,
 112         ///
 113         PAPER_B5PAPER
 114 };
 115
 116 ///
 117 enum LYX_VMARGIN_PAPER_TYPE {
 118         ///
 119         VM_PAPER_DEFAULT,
 120         ///
 121         VM_PAPER_CUSTOM,
 122         ///
 123         VM_PAPER_USLETTER,
 124         ///
 125         VM_PAPER_USLEGAL,
 126         ///
 127         VM_PAPER_USEXECUTIVE,
 128         ///
 129         VM_PAPER_A3,
 130         ///
 131         VM_PAPER_A4,
 132         ///
 133         VM_PAPER_A5,
 134         ///
 135         VM_PAPER_B3,
 136         ///
 137         VM_PAPER_B4,
 138         ///
 139         VM_PAPER_B5
 140 };
 141
 142 ///
 143 enum LYX_PAPER_PACKAGES {
 144         ///
 145         PACKAGE_NONE,
 146         ///
 147         PACKAGE_A4,
 148         ///
 149         PACKAGE_A4WIDE,
 150         ///
 151         PACKAGE_WIDEMARGINSA4
 152 };
 153
 154 ///
 155 enum LYX_PAPER_ORIENTATION {
 156         ///
 157         ORIENTATION_PORTRAIT,
 158         ///
 159         ORIENTATION_LANDSCAPE
 160 };
 161
 162 ///
 163 enum LYX_PEXTRA_TYPE {
 164         ///
 165         PEXTRA_NONE,
 166         ///
 167         PEXTRA_INDENT,
 168         ///
 169         PEXTRA_MINIPAGE,
 170         ///
 171         PEXTRA_FLOATFLT
 172 };
 173
 174 ///
 175 enum LYX_MINIPAGE_ALIGNMENT {
 176         ///
 177         MINIPAGE_ALIGN_TOP,
 178         ///
 179         MINIPAGE_ALIGN_MIDDLE,
 180         ///
 181         MINIPAGE_ALIGN_BOTTOM
 182 };
 183
 184 #endif