src/insets/InsetVSpace.h

   1 // -*- C++ -*-
   2 /**
   3  * \file InsetVSpace.h
   4  * This file is part of LyX, the document processor.
   5  * Licence details can be found in the file COPYING.
   6  *
   7  * \author André Pönitz
   8  *
   9  * Full author contact details are available in file CREDITS.
  10  */
  11
  12 #ifndef INSET_VSPACE_H
  13 #define INSET_VSPACE_H
  14
  15 #include "Inset.h"
  16 #include "VSpace.h"
  17
  18
  19 namespace lyx {
  20
  21 class InsetVSpace : public Inset
  22 {
  23 public:
  24         ///
  25         InsetVSpace() : Inset(0) {}
  26         ///
  27         InsetVSpace(VSpace const &);
  28         /// How much?
  29         VSpace const & space() const { return space_; }
  30         ///
  31         InsetCode lyxCode() const { return VSPACE_CODE; }
  32         ///
  33         bool hasSettings() const { return true; }
  34         ///
  35         std::string contextMenuName() const;
  36         ///
  37         static void string2params(std::string const &, VSpace &);
  38         ///
  39         static std::string params2string(VSpace const &);
  40 private:
  41         ///
  42         void metrics(MetricsInfo & mi, Dimension & dim) const;
  43         ///
  44         void draw(PainterInfo & pi, int x, int y) const;
  45         ///
  46         void latex(otexstream &, OutputParams const &) const;
  47         ///
  48         int plaintext(odocstringstream & ods, OutputParams const & op,
  49                       size_t max_length = INT_MAX) const;
  50         ///
  51         int docbook(odocstream &, OutputParams const &) const;
  52         /// Note that this returns the inset rather than writing it,
  53         /// so it will actually be written after the present paragraph.
  54         /// The normal case is that this inset will be on a line by
  55         /// itself, and in that case the present paragraph will not,
  56         /// in fact, appear at all.
  57         docstring xhtml(XHTMLStream &, OutputParams const &) const;
  58         ///
  59         void read(Lexer & lex);
  60         ///
  61         void write(std::ostream & os) const;
  62         ///
  63         DisplayType display() const { return AlignCenter; }
  64         ///
  65         void doDispatch(Cursor & cur, FuncRequest & cmd);
  66         ///
  67         bool getStatus(Cursor & cur, FuncRequest const & cmd, FuncStatus &) const;
  68         ///
  69         Inset * clone() const { return new InsetVSpace(*this); }
  70         ///
  71         docstring const label() const;
  72
  73         ///
  74         VSpace space_;
  75 };
  76
  77
  78 } // namespace lyx
  79
  80 #endif