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 class InsetFlexParams {
  24 public:
  25         ///
  26         void write(std::ostream & os) const;
  27         ///
  28         void read(Lexer & lex);
  29         ///
  30         std::string name;
  31 };
  32
  33
  34 /** The Flex inset, e.g., CharStyle, Custom inset or XML short element
  35
  36 */
  37 class InsetFlex : public InsetCollapsable {
  38 public:
  39         ///
  40         InsetFlex(BufferParams const &, InsetLayout const &);
  41         ///
  42         docstring name() const { return from_utf8(params_.name); }
  43
  44         /// Is this character style defined in the document's textclass?
  45         /// May be wrong after textclass change or paste from another document
  46         bool undefined() const;
  47         ///
  48         virtual docstring const editMessage() const;
  49         ///
  50         InsetCode lyxCode() const { return FLEX_CODE; }
  51         ///
  52         void write(Buffer const &, std::ostream &) const;
  53         ///
  54         void read(Buffer const & buf, Lexer & lex);
  55         ///
  56         bool forceDefaultParagraphs(idx_type) const { return true; }
  57
  58         ///
  59         int plaintext(Buffer const &, odocstream &,
  60                       OutputParams const &) const;
  61         ///
  62         int docbook(Buffer const &, odocstream &,
  63                     OutputParams const &) const;
  64         /// the string that is passed to the TOC
  65         virtual void textString(Buffer const &, odocstream &) const;
  66
  67         ///
  68         InsetFlexParams const & params() const { return params_; }
  69
  70         /// should paragraph indendation be ommitted in any case?
  71         bool neverIndent(Buffer const &) const { return true; }
  72
  73 protected:
  74         InsetFlex(InsetFlex const &);
  75
  76 private:
  77         friend class InsetFlexParams;
  78
  79         virtual Inset * clone() const;
  80
  81         ///
  82         InsetFlexParams params_;
  83 };
  84
  85
  86 } // namespace lyx
  87
  88 #endif