4 * This file is part of LyX, the document processor.
5 * Licence details can be found in the file COPYING.
7 * \author Matthias Ettrich
9 * Full author contact details are available in file CREDITS.
15 #include "lyxgluelength.h"
22 /// A class representing latex vertical spacing
25 /// The different kinds of spaces.
27 NONE, ///< no added vertical space
33 LENGTH ///< user-defined length
38 explicit VSpace(vspace_kind k);
40 explicit VSpace(LyXLength const & l);
42 explicit VSpace(LyXGlueLength const & l);
44 /// Constructor for reading from a .lyx file
45 explicit VSpace(std::string const & data);
47 /// return the type of vertical space
48 vspace_kind kind() const;
49 /// return the length of this space
50 LyXGlueLength const & length() const;
52 // a flag that switches between \vspace and \vspace*
54 /// if set true, use \vspace* when type is not DEFSKIP
55 void setKeep(bool val);
57 bool operator==(VSpace const &) const;
61 /// how it goes into the LyX file
62 std::string const asLyXCommand() const;
63 /// the latex representation
64 std::string const asLatexCommand(BufferParams const & params) const;
65 /// the size of the space on-screen
66 int inPixels(BufferView const & bv) const;
71 /// the specified length
73 /// if true, use \vspace* type