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         ///
  88         docstring refprefix() const { return refprefix_; }
  89         /// The tag enclosing all the material in this inset. Default is "span".
  90         std::string const & htmltag() const;
  91         /// Additional attributes for inclusion with the start tag. Default (if
  92         /// a tag is provided) is: class="name".
  93         std::string const & htmlattr() const;
  94         /// Tag for individual paragraphs in the inset. Default is none.
  95         std::string const & htmlinnertag() const { return htmlinnertag_; }
  96         /// Attributes for that tag. Default (if a tag is provided) is:
  97         /// class="name_inner".
  98         std::string const & htmlinnerattr() const;
  99         /// A label for this environment, possibly including a reference
 100         /// to a counter. E.g., for footnote, it might be:
 101         ///    \arabic{footnote}
 102         /// No default.
 103         /// FIXME Could we get this from the layout?
 104         std::string const & htmllabel() const { return htmllabel_; }
 105         ///
 106         inline std::string htmllabeltag() const { return "span"; }
 107         ///
 108         std::string htmllabelattr() const
 109                 { return "class=\"" + defaultCSSClass() + "_label\""; }
 110         /// CSS associated with this inset.
 111         docstring htmlstyle() const;
 112         /// Additional material for the header.
 113         docstring htmlpreamble() const { return htmlpreamble_; }
 114         /// Whether this inset represents a "block" of material, i.e., a set
 115         /// of paragraphs of its own (true), or should be run into the previous
 116         /// paragraph (false). Examples:
 117         ///   For branches, this is false.
 118         ///   For footnotes, this is true.
 119         /// Defaults to true.
 120         bool htmlisblock() const { return htmlisblock_; }
 121         ///
 122         std::set<std::string> requires() const { return requires_; }
 123         ///
 124         bool isMultiPar() const { return multipar_; }
 125         ///
 126         bool forcePlainLayout() const { return forceplain_; }
 127         ///
 128         bool allowParagraphCustomization() const { return custompars_; }
 129         ///
 130         bool isPassThru() const { return passthru_; }
 131         ///
 132         bool isNeedProtect() const { return needprotect_; }
 133         ///
 134         bool isFreeSpacing() const { return freespacing_; }
 135         ///
 136         bool isKeepEmpty() const { return keepempty_; }
 137         ///
 138         bool forceLTR() const { return forceltr_; }
 139         ///
 140         bool isInToc() const { return intoc_; }
 141         ///
 142         bool spellcheck() const { return spellcheck_; }
 143 private:
 144         ///
 145         void makeDefaultCSS() const;
 146         ///
 147         std::string defaultCSSClass() const;
 148         ///
 149         std::string defaultCSSLabelClass() const { return defaultCSSClass() + "_label"; }
 150         ///
 151         docstring name_;
 152         /**
 153                 * This is only used (at present) to decide where to put them on the menus.
 154                 * Values are 'charstyle', 'custom' (things that by default look like a
 155                 * footnote), 'element' (docbook), 'standard'.
 156                 */
 157         InsetLyXType lyxtype_;
 158         ///
 159         docstring labelstring_;
 160         ///
 161         bool contentaslabel_;
 162         ///
 163         InsetDecoration decoration_;
 164         ///
 165         InsetLaTeXType latextype_;
 166         ///
 167         std::string latexname_;
 168         ///
 169         std::string latexparam_;
 170         ///
 171         FontInfo font_;
 172         ///
 173         FontInfo labelfont_;
 174         ///
 175         ColorCode bgcolor_;
 176         ///
 177         docstring counter_;
 178         ///
 179         docstring preamble_;
 180         ///
 181         docstring refprefix_;
 182         ///
 183         mutable std::string htmltag_;
 184         ///
 185         mutable std::string htmlattr_;
 186         ///
 187         std::string htmlinnertag_;
 188         ///
 189         mutable std::string htmlinnerattr_;
 190         ///
 191         std::string htmllabel_;
 192         ///
 193         docstring htmlstyle_;
 194         /// Cache for default CSS info for this inset.
 195         mutable docstring htmldefaultstyle_;
 196         /// Cache for default CSS class.
 197         mutable std::string defaultcssclass_;
 198         /// Whether to force generation of default CSS even if some is given.
 199         /// False by default.
 200         bool htmlforcecss_;
 201         ///
 202         docstring htmlpreamble_;
 203         ///
 204         bool htmlisblock_;
 205         ///
 206         std::set<std::string> requires_;
 207         ///
 208         bool multipar_;
 209         ///
 210         bool custompars_;
 211         ///
 212         bool forceplain_;
 213         ///
 214         bool passthru_;
 215         ///
 216         bool needprotect_;
 217         ///
 218         bool freespacing_;
 219         ///
 220         bool keepempty_;
 221         ///
 222         bool forceltr_;
 223         /// should the contents be written to TOC strings?
 224         bool intoc_;
 225         /// check spelling of this inset?
 226         bool spellcheck_;
 227 };
 228
 229 ///
 230 InsetLayout::InsetLyXType translateLyXType(std::string const & str);
 231
 232 } // namespace lyx
 233
 234 #endif