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 namespace lyx {
  19
  20 /** The Flex inset, e.g., CharStyle, Custom inset or XML short element
  21
  22 */
  23 class InsetFlex : public InsetCollapsable {
  24 public:
  25         ///
  26         InsetFlex(Buffer const &, std::string const & layoutName);
  27         ///
  28         docstring name() const { return from_utf8(name_); }
  29
  30         ///
  31         docstring editMessage() const;
  32         ///
  33         InsetCode lyxCode() const { return FLEX_CODE; }
  34         ///
  35         void write(std::ostream &) const;
  36         ///
  37         void read(Lexer & lex);
  38         ///
  39         virtual bool allowParagraphCustomization(idx_type = 0) const { return false; }
  40
  41         ///
  42         int plaintext(odocstream &, OutputParams const &) const;
  43         ///
  44         int docbook(odocstream &, OutputParams const &) const;
  45         /// the string that is passed to the TOC
  46         void textString(odocstream &) const;
  47         ///
  48         void validate(LaTeXFeatures &) const;
  49
  50         /// should paragraph indendation be ommitted in any case?
  51         bool neverIndent() const { return true; }
  52
  53 protected:
  54         InsetFlex(InsetFlex const &);
  55
  56 private:
  57         Inset * clone() const { return new InsetFlex(*this); }
  58
  59         ///
  60         std::string name_;
  61         ///
  62         std::set<std::string> packages_;
  63         ///
  64         std::string preamble_;
  65 };
  66
  67
  68 } // namespace lyx
  69
  70 #endif