src/insets/InsetLayout.h

   1 // -*- C++ -*-
   2 /**
   3  * \file InsetLayout.h
   4  * This file is part of LyX, the document processor.
   5  * Licence details can be found in the file COPYING.
   6  *
   7  * \author Martin Vermeer
   8  * \author Richard Heck
   9  *
  10  * Full author contact details are available in file CREDITS.
  11  */
  12
  13 #ifndef INSET_LAYOUT_H
  14 #define INSET_LAYOUT_H
  15
  16 #include "ColorCode.h"
  17 #include "FontInfo.h"
  18
  19 #include "support/docstring.h"
  20
  21 #include <set>
  22 #include <string>
  23
  24 namespace lyx {
  25
  26 class Lexer;
  27 class TextClass;
  28
  29 ///
  30 class InsetLayout {
  31 public:
  32         ///
  33         InsetLayout();
  34         ///
  35         enum InsetDecoration {
  36                 CLASSIC,
  37                 MINIMALISTIC,
  38                 CONGLOMERATE,
  39                 DEFAULT
  40         };
  41         ///
  42         enum InsetLyXType {
  43                 NOLYXTYPE,
  44                 CHARSTYLE,
  45                 CUSTOM,
  46                 ELEMENT,
  47                 END,
  48                 STANDARD
  49         };
  50         ///
  51         enum InsetLaTeXType {
  52                 NOLATEXTYPE,
  53                 COMMAND,
  54                 ENVIRONMENT,
  55                 ILT_ERROR
  56         };
  57         ///
  58         bool read(Lexer & lexrc, TextClass const & tclass);
  59         ///
  60         docstring name() const { return name_; }
  61         ///
  62         void setName(docstring const & n) { name_ = n; }
  63         ///
  64         InsetLyXType lyxtype() const { return lyxtype_; }
  65         ///
  66         docstring labelstring() const { return labelstring_; }
  67         ///
  68         bool contentaslabel() const { return contentaslabel_; }
  69         ///
  70         InsetDecoration decoration() const { return decoration_; }
  71         ///
  72         InsetLaTeXType latextype() const { return latextype_; }
  73         ///
  74         std::string latexname() const { return latexname_; }
  75         ///
  76         std::string latexparam() const { return latexparam_; }
  77         ///
  78         FontInfo font() const { return font_; }
  79         ///
  80         FontInfo labelfont() const { return labelfont_; }
  81         ///
  82         ColorCode bgcolor() const { return bgcolor_; }
  83         ///
  84         docstring preamble() const { return preamble_; }
  85         ///
  86         docstring counter() const { return counter_; }
  87         /// The tag enclosing all the material in this inset. Default is "span".
  88         std::string const & htmltag() const;
  89         /// Additional attributes for inclusion with the start tag. Default (if
  90         /// a tag is provided) is: class="name".
  91         std::string const & htmlattr() const;
  92         /// Tag for individual paragraphs in the inset. Default is none.
  93         std::string const & htmlinnertag() const { return htmlinnertag_; }
  94         /// Attributes for that tag. Default (if a tag is provided) is:
  95         /// class="name_inner".
  96         std::string const & htmlinnerattr() const;
  97         /// A label for this environment, possibly including a reference
  98         /// to a counter. E.g., for footnote, it might be:
  99         ///    \arabic{footnote}
 100         /// No default.
 101         /// FIXME Could we get this from the layout?
 102         std::string const & htmllabel() const { return htmllabel_; }
 103         ///
 104         inline std::string htmllabeltag() const { return "span"; }
 105         ///
 106         std::string htmllabelattr() const
 107                 { return "class=\"" + defaultCSSClass() + "_label\""; }
 108         /// CSS associated with this inset.
 109         docstring htmlstyle() const;
 110         /// Additional material for the header.
 111         docstring htmlpreamble() const { return htmlpreamble_; }
 112         /// Whether this inset represents a "block" of material, i.e., a set
 113         /// of paragraphs of its own (true), or should be run into the previous
 114         /// paragraph (false). Examples:
 115         ///   For branches, this is false.
 116         ///   For footnotes, this is true.
 117         /// Defaults to true.
 118         bool htmlisblock() const { return htmlisblock_; }
 119         ///
 120         std::set<std::string> requires() const { return requires_; }
 121         ///
 122         bool isMultiPar() const { return multipar_; }
 123         ///
 124         bool forcePlainLayout() const { return forceplain_; }
 125         ///
 126         bool allowParagraphCustomization() const { return custompars_; }
 127         ///
 128         bool isPassThru() const { return passthru_; }
 129         ///
 130         bool isNeedProtect() const { return needprotect_; }
 131         ///
 132         bool isFreeSpacing() const { return freespacing_; }
 133         ///
 134         bool isKeepEmpty() const { return keepempty_; }
 135         ///
 136         bool forceLTR() const { return forceltr_; }
 137         ///
 138         bool isInToc() const { return intoc_; }
 139         ///
 140         bool spellcheck() const { return spellcheck_; }
 141 private:
 142         ///
 143         void makeDefaultCSS() const;
 144         ///
 145         std::string defaultCSSClass() const;
 146         ///
 147         std::string defaultCSSLabelClass() const { return defaultCSSClass() + "_label"; }
 148         ///
 149         docstring name_;
 150         /**
 151                 * This is only used (at present) to decide where to put them on the menus.
 152                 * Values are 'charstyle', 'custom' (things that by default look like a
 153                 * footnote), 'element' (docbook), 'standard'.
 154                 */
 155         InsetLyXType lyxtype_;
 156         ///
 157         docstring labelstring_;
 158         ///
 159         bool contentaslabel_;
 160         ///
 161         InsetDecoration decoration_;
 162         ///
 163         InsetLaTeXType latextype_;
 164         ///
 165         std::string latexname_;
 166         ///
 167         std::string latexparam_;
 168         ///
 169         FontInfo font_;
 170         ///
 171         FontInfo labelfont_;
 172         ///
 173         ColorCode bgcolor_;
 174         ///
 175         docstring counter_;
 176         ///
 177         docstring preamble_;
 178         ///
 179         mutable std::string htmltag_;
 180         ///
 181         mutable std::string htmlattr_;
 182         ///
 183         std::string htmlinnertag_;
 184         ///
 185         mutable std::string htmlinnerattr_;
 186         ///
 187         std::string htmllabel_;
 188         ///
 189         docstring htmlstyle_;
 190         /// Cache for default CSS info for this inset.
 191         mutable docstring htmldefaultstyle_;
 192         /// Cache for default CSS class.
 193         mutable std::string defaultcssclass_;
 194         /// Whether to force generation of default CSS even if some is given.
 195         /// False by default.
 196         bool htmlforcecss_;
 197         ///
 198         docstring htmlpreamble_;
 199         ///
 200         bool htmlisblock_;
 201         ///
 202         std::set<std::string> requires_;
 203         ///
 204         bool multipar_;
 205         ///
 206         bool custompars_;
 207         ///
 208         bool forceplain_;
 209         ///
 210         bool passthru_;
 211         ///
 212         bool needprotect_;
 213         ///
 214         bool freespacing_;
 215         ///
 216         bool keepempty_;
 217         ///
 218         bool forceltr_;
 219         /// should the contents be written to TOC strings?
 220         bool intoc_;
 221         /// check spelling of this inset?
 222         bool spellcheck_;
 223 };
 224
 225 ///
 226 InsetLayout::InsetLyXType translateLyXType(std::string const & str);
 227
 228 } // namespace lyx
 229
 230 #endif