src/insets/InsetFlex.h

   1 // -*- C++ -*-
   2 /**
   3  * \file InsetFlex.h
   4  * This file is part of LyX, the document processor.
   5  * Licence details can be found in the file COPYING.
   6  *
   7  * \author Angus Leeming
   8  * \author Martin Vermeer
   9  *
  10  * Full author contact details are available in file CREDITS.
  11  */
  12
  13 #ifndef INSETFLEX_H
  14 #define INSETFLEX_H
  15
  16 #include "InsetCollapsable.h"
  17
  18 using std::string;
  19
  20 namespace lyx {
  21
  22
  23 /** The Flex inset, e.g., CharStyle, Custom inset or XML short element
  24
  25 */
  26 class InsetFlex : public InsetCollapsable {
  27 public:
  28         ///
  29         InsetFlex(BufferParams const &,
  30                   TextClassPtr tc, string const & layoutName);
  31         ///
  32         docstring name() const { return from_utf8(name_); }
  33
  34         ///
  35         virtual docstring const editMessage() const;
  36         ///
  37         InsetCode lyxCode() const { return FLEX_CODE; }
  38         ///
  39         void write(Buffer const &, std::ostream &) const;
  40         ///
  41         void read(Buffer const & buf, Lexer & lex);
  42         ///
  43         virtual bool allowParagraphCustomization(idx_type) const { return false; }
  44
  45         ///
  46         int plaintext(Buffer const &, odocstream &,
  47                       OutputParams const &) const;
  48         ///
  49         int docbook(Buffer const &, odocstream &,
  50                     OutputParams const &) const;
  51         /// the string that is passed to the TOC
  52         virtual void textString(Buffer const &, odocstream &) const;
  53         ///
  54         void validate(LaTeXFeatures &) const;
  55
  56         /// should paragraph indendation be ommitted in any case?
  57         bool neverIndent(Buffer const &) const { return true; }
  58
  59 protected:
  60         InsetFlex(InsetFlex const &);
  61
  62 private:
  63         virtual Inset * clone() const;
  64
  65         ///
  66         std::string name_;
  67         ///
  68         std::set<std::string> packages_;
  69         ///
  70         std::string preamble_;
  71 };
  72
  73
  74 } // namespace lyx
  75
  76 #endif