src/insets/InsetCharStyle.h

   1 // -*- C++ -*-
   2 /**
   3  * \file InsetCharStyle.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 INSETCHARSTYLE_H
  14 #define INSETCHARSTYLE_H
  15
  16 #include "InsetCollapsable.h"
  17 #include "TextClass.h"
  18
  19
  20 namespace lyx {
  21
  22
  23 class InsetCharStyleParams {
  24 public:
  25         ///
  26         void write(std::ostream & os) const;
  27         ///
  28         void read(Lexer & lex);
  29         ///
  30         std::string type;
  31         ///
  32         std::string latextype;
  33         ///
  34         std::string latexname;
  35         ///
  36         std::string latexparam;
  37         ///
  38         Font font;
  39         ///
  40         Font labelfont;
  41 };
  42
  43
  44 /** The CharStyle inset, also XML short element
  45
  46 */
  47 class InsetCharStyle : public InsetCollapsable {
  48 public:
  49         /// Construct an undefined character style
  50         InsetCharStyle(BufferParams const &, std::string const);
  51         ///
  52         InsetCharStyle(BufferParams const &, CharStyles::iterator);
  53         ///
  54         docstring name() const { return from_ascii("CharStyle"); }
  55         /// Is this character style defined in the document's textclass?
  56         /// May be wrong after textclass change or paste from another document
  57         bool undefined() const;
  58         /// Set the character style to "undefined"
  59         void setUndefined();
  60         /// (Re-)set the character style parameters from \p cs
  61         void setDefined(CharStyles::iterator cs);
  62         ///
  63         virtual docstring const editMessage() const;
  64         ///
  65         Inset::Code lyxCode() const { return Inset::CHARSTYLE_CODE; }
  66         ///
  67         void write(Buffer const &, std::ostream &) const;
  68         ///
  69         void read(Buffer const & buf, Lexer & lex);
  70         ///
  71         bool metrics(MetricsInfo &, Dimension &) const;
  72         ///
  73         void draw(PainterInfo &, int, int) const;
  74         ///
  75         void getDrawFont(Font &) const;
  76         ///
  77         bool forceDefaultParagraphs(idx_type) const { return true; }
  78         ///
  79         virtual Decoration decoration() const { return Conglomerate; }
  80
  81         ///
  82         int latex(Buffer const &, odocstream &,
  83                   OutputParams const &) const;
  84         ///
  85         int plaintext(Buffer const &, odocstream &,
  86                       OutputParams const &) const;
  87         ///
  88         int docbook(Buffer const &, odocstream &,
  89                     OutputParams const &) const;
  90         /// the string that is passed to the TOC
  91         virtual void textString(Buffer const &, odocstream &) const;
  92         ///
  93         void validate(LaTeXFeatures &) const;
  94
  95         ///
  96         InsetCharStyleParams const & params() const { return params_; }
  97
  98         /// should paragraph indendation be ommitted in any case?
  99         bool neverIndent(Buffer const &) const { return true; }
 100
 101 protected:
 102         InsetCharStyle(InsetCharStyle const &);
 103         virtual void doDispatch(Cursor & cur, FuncRequest & cmd);
 104         ///
 105         bool getStatus(Cursor & cur, FuncRequest const & cmd, FuncStatus &) const;
 106
 107 private:
 108         friend class InsetCharStyleParams;
 109
 110         virtual std::auto_ptr<Inset> doClone() const;
 111
 112         /// used by the constructors
 113         void init();
 114         ///
 115         InsetCharStyleParams params_;
 116 };
 117
 118
 119 } // namespace lyx
 120
 121 #endif