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);
  41         ///
  42         docstring name() const { return from_ascii("Flex"); }
  43         ///
  44         InsetLayout const & getLayout(BufferParams const &) const { return layout_; }
  45         /// Is this character style defined in the document's textclass?
  46         /// May be wrong after textclass change or paste from another document
  47         bool undefined() const;
  48         /// (Re-)set the character style parameters from \p il
  49         void setLayout(InsetLayout il);
  50         ///
  51         virtual docstring const editMessage() const;
  52         ///
  53         InsetCode lyxCode() const { return FLEX_CODE; }
  54         ///
  55         void write(Buffer const &, std::ostream &) const;
  56         ///
  57         void read(Buffer const & buf, Lexer & lex);
  58         ///
  59         bool forceDefaultParagraphs(idx_type) const { return true; }
  60
  61         ///
  62         int plaintext(Buffer const &, odocstream &,
  63                       OutputParams const &) const;
  64         ///
  65         int docbook(Buffer const &, odocstream &,
  66                     OutputParams const &) const;
  67         /// the string that is passed to the TOC
  68         virtual void textString(Buffer const &, odocstream &) const;
  69
  70         ///
  71         InsetFlexParams const & params() const { return params_; }
  72
  73         /// should paragraph indendation be ommitted in any case?
  74         bool neverIndent(Buffer const &) const { return true; }
  75
  76 protected:
  77         InsetFlex(InsetFlex const &);
  78
  79 private:
  80         friend class InsetFlexParams;
  81
  82         virtual Inset * clone() const;
  83
  84         ///
  85         InsetFlexParams params_;
  86 };
  87
  88
  89 } // namespace lyx
  90
  91 #endif