Remove all BufferParam arguments in InsetXXX methods (since insets know about their...

[lyx.git] / src / insets / InsetLayout.h

diff --git a/src/insets/InsetLayout.h b/src/insets/InsetLayout.h
index 0e118f1c5a414d4b4cf6ee32f04ad31c078728f9..b7a109eaf4ed1c8c28c6b9fc840194e56a7e8063 100644 (file)
--- a/src/insets/InsetLayout.h
+++ b/src/insets/InsetLayout.h
@@ -4,6 +4,9 @@
  * This file is part of LyX, the document processor.
  * Licence details can be found in the file COPYING.
  *
+ * \author Martin Vermeer
+ * \author Richard Heck
+ *
  * Full author contact details are available in file CREDITS.
  */
 
@@ -15,30 +18,170 @@
 
 #include "support/docstring.h"
 
+#include <set>
+#include <string>
+
 namespace lyx {
 
+class Lexer;
+class TextClass;
+
 ///
 class InsetLayout {
 public:
-       std::string name;
-       std::string lyxtype;
-       docstring labelstring;
-       std::string decoration;
-       std::string latextype;
-       std::string latexname;
-       std::string latexparam;
-       FontInfo font;
-       FontInfo labelfont;
-       ColorCode bgcolor;
-       std::string preamble;
-       bool multipar;
-       bool passthru;
-       bool needprotect;
-       bool freespacing;
-       bool keepempty;
-       bool forceltr;
+       ///
+       InsetLayout();
+       ///
+       enum InsetDecoration {
+               CLASSIC,
+               MINIMALISTIC,
+               CONGLOMERATE,
+               DEFAULT
+       };
+       enum InsetLyXType {
+               NOLYXTYPE,
+               CHARSTYLE,
+               CUSTOM,
+               ELEMENT,
+               END,
+               STANDARD
+       };
+       enum InsetLaTeXType {
+               NOLATEXTYPE,
+               COMMAND,
+               ENVIRONMENT,
+               ILT_ERROR
+       };
+       ///
+       bool read(Lexer & lexrc, TextClass const & tclass);
+       ///
+       docstring name() const { return name_; }
+       ///
+       void setName(docstring const & n) { name_ = n; }
+       ///
+       InsetLyXType lyxtype() const { return lyxtype_; }
+       ///
+       docstring labelstring() const { return labelstring_; }
+       ///
+       InsetDecoration decoration() const { return decoration_; }
+       ///
+       InsetLaTeXType latextype() const { return latextype_; }
+       ///
+       std::string latexname() const { return latexname_; }
+       ///
+       std::string latexparam() const { return latexparam_; }
+       ///
+       FontInfo font() const { return font_; }
+       ///
+       FontInfo labelfont() const { return labelfont_; }
+       ///
+       ColorCode bgcolor() const { return bgcolor_; }
+       ///
+       docstring preamble() const { return preamble_; }
+       ///
+       docstring counter() const { return counter_; }
+       /// 
+       std::string const & htmlinnertag() const { return htmlinnertag_; }
+       /// 
+       std::string const & htmlinnerattr() const { return htmlinnerattr_; }
+       ///
+       std::string const & htmltag() const { return htmltag_; }
+       /// 
+       std::string const & htmlattr() const { return htmlattr_; }
+       ///
+       std::string const & htmllabel() const { return htmllabel_; }
+       /// 
+       docstring htmlstyle() const { return htmlstyle_; }
+       /// 
+       docstring htmlpreamble() const { return htmlpreamble_; }
+       ///
+       std::set<std::string> requires() const { return requires_; };
+       ///
+       bool isMultiPar() const { return multipar_; };
+       ///
+       bool forcePlainLayout() const { return forceplain_; }
+       ///
+       bool allowParagraphCustomization() const { return custompars_; }
+       ///
+       bool isPassThru() const { return passthru_; };
+       ///
+       bool isNeedProtect() const { return needprotect_; };
+       ///
+       bool isFreeSpacing() const { return freespacing_; };
+       ///
+       bool isKeepEmpty() const { return keepempty_; };
+       ///
+       bool isForceLtr() const { return forceltr_; };
+       ///
+       bool isInToc() const { return intoc_; };
+private:
+       ///
+       docstring name_;
+       /**
+               * This is only used (at present) to decide where to put them on the menus.
+               * Values are 'charstyle', 'custom' (things that by default look like a
+               * footnote), 'element' (docbook), 'standard'.
+               */
+       InsetLyXType lyxtype_;
+       ///
+       docstring labelstring_;
+       ///
+       InsetDecoration decoration_;
+       ///
+       InsetLaTeXType latextype_;
+       ///
+       std::string latexname_;
+       ///
+       std::string latexparam_;
+       ///
+       FontInfo font_;
+       ///
+       FontInfo labelfont_;
+       ///
+       ColorCode bgcolor_;
+       ///
+       docstring counter_;
+       ///
+       docstring preamble_;
+       /// 
+       std::string htmltag_;
+       /// 
+       std::string htmlattr_;
+       ///
+       std::string htmlinnertag_;
+       /// 
+       std::string htmlinnerattr_;
+       ///
+       std::string htmllabel_;
+       /// 
+       docstring htmlstyle_;
+       /// 
+       docstring htmlpreamble_;
+       ///
+       std::set<std::string> requires_;
+       ///
+       bool multipar_;
+       /// 
+       bool custompars_;
+       ///
+       bool forceplain_;
+       ///
+       bool passthru_;
+       ///
+       bool needprotect_;
+       ///
+       bool freespacing_;
+       ///
+       bool keepempty_;
+       ///
+       bool forceltr_;
+       /// should the contents be written to TOC strings?
+       bool intoc_;
 };
 
+///
+InsetLayout::InsetLyXType translateLyXType(std::string const & str);
+
 } // namespace lyx
 
 #endif