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 #include "TextClass.h"
  18
  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 &, InsetLayout const &);
  30         ///
  31         docstring name() const { return from_utf8(name_); }
  32
  33         /// Is this character style defined in the document's textclass?
  34         /// May be wrong after textclass change or paste from another document
  35         bool undefined() const;
  36         ///
  37         virtual docstring const editMessage() const;
  38         ///
  39         InsetCode lyxCode() const { return FLEX_CODE; }
  40         ///
  41         void write(Buffer const &, std::ostream &) const;
  42         ///
  43         void read(Buffer const & buf, Lexer & lex);
  44         ///
  45         bool forceDefaultParagraphs(idx_type) const { return true; }
  46
  47         ///
  48         int plaintext(Buffer const &, odocstream &,
  49                       OutputParams const &) const;
  50         ///
  51         int docbook(Buffer const &, odocstream &,
  52                     OutputParams const &) const;
  53         /// the string that is passed to the TOC
  54         virtual void textString(Buffer const &, odocstream &) 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
  69
  70 } // namespace lyx
  71
  72 #endif