src/insets/InsetScript.h

   1 // -*- C++ -*-
   2 /**
   3  * \file InsetScript.h
   4  * This file is part of LyX, the document processor.
   5  * Licence details can be found in the file COPYING.
   6  *
   7  * \author Georg Baum
   8  *
   9  * Full author contact details are available in file CREDITS.
  10  */
  11
  12 #ifndef INSET_SCRIPT_H
  13 #define INSET_SCRIPT_H
  14
  15 #include "InsetText.h"
  16
  17
  18 namespace lyx {
  19
  20 class InsetScriptParams
  21 {
  22 public:
  23         enum Type {
  24                 Subscript,
  25                 Superscript
  26         };
  27         /// \c type defaults to Subscript
  28         InsetScriptParams();
  29         ///
  30         void write(std::ostream & os) const;
  31         ///
  32         void read(Lexer & lex);
  33         ///
  34         int shift(FontInfo const & font) const;
  35         ///
  36         Type type;
  37 };
  38
  39
  40 /////////////////////////////////////////////////////////////////////////
  41 //
  42 // InsetScript
  43 //
  44 /////////////////////////////////////////////////////////////////////////
  45
  46 /// The subscript and superscript inset
  47 class InsetScript : public InsetText
  48 {
  49 public:
  50         ///
  51         InsetScript(Buffer *, InsetScriptParams const & = InsetScriptParams());
  52         ///
  53         InsetScript(Buffer *, std::string const &);
  54         ///
  55         ~InsetScript();
  56         ///
  57         static std::string params2string(InsetScriptParams const &);
  58         ///
  59         static void string2params(std::string const &, InsetScriptParams &);
  60         ///
  61         InsetScriptParams const & params() const { return params_; }
  62
  63         /// \name Public functions inherited from Inset class
  64         //@{
  65         ///
  66         InsetCode lyxCode() const { return SCRIPT_CODE; }
  67         ///
  68         docstring layoutName() const;
  69         ///
  70         DisplayType display() const;
  71         ///
  72         void metrics(MetricsInfo &, Dimension &) const;
  73         ///
  74         void draw(PainterInfo & pi, int x, int y) const;
  75         ///
  76         void cursorPos(BufferView const & bv,
  77                 CursorSlice const & sl, bool boundary, int & x, int & y) const;
  78         ///
  79         void write(std::ostream &) const;
  80         ///
  81         void read(Lexer & lex);
  82         ///
  83         bool neverIndent() const { return true; }
  84         ///
  85         bool forcePlainLayout(idx_type = 0) const { return true; }
  86         ///
  87         bool allowParagraphCustomization(idx_type = 0) const { return false; }
  88         ///
  89         virtual void validate(LaTeXFeatures &) const;
  90         ///
  91         void latex(otexstream &, OutputParams const &) const;
  92         ///
  93         int plaintext(odocstream &, OutputParams const &) const;
  94         ///
  95         int docbook(odocstream &, OutputParams const &) const;
  96         ///
  97         void edit(Cursor & cur, bool front,
  98                   EntryDirection entry_from = ENTRY_DIRECTION_IGNORE);
  99         ///
 100         Inset * editXY(Cursor & cur, int x, int y);
 101         ///
 102         bool insetAllowed(InsetCode code) const;
 103         ///
 104         bool getStatus(Cursor &, FuncRequest const &, FuncStatus &) const;
 105         ///
 106         docstring toolTip(BufferView const & bv, int x, int y) const;
 107         ///
 108         Inset * clone() const { return new InsetScript(*this); }
 109         ///
 110         std::string contextMenuName() const;
 111         //@}
 112
 113         /// \name Public functions inherited from InsetText class
 114         //@{
 115         ///
 116         bool allowMultiPar() const { return false; }
 117         //@}
 118
 119 protected:
 120         /// \name Protected functions inherited from Inset class
 121         //@{
 122         ///
 123         void doDispatch(Cursor & cur, FuncRequest & cmd);
 124         //@}
 125
 126 private:
 127         /// used by the constructors
 128         void init();
 129         ///
 130         friend class InsetScriptParams;
 131         ///
 132         InsetScriptParams params_;
 133 };
 134
 135
 136 } // namespace lyx
 137
 138 #endif