lyx_mirror/src/VSpace.h

86 lines
1.7 KiB
C
Raw Normal View History

// -*- C++ -*-
/**
* \file VSpace.h
* This file is part of LyX, the document processor.
* Licence details can be found in the file COPYING.
*
* \author Matthias Ettrich
*
* Full author contact details are available in file CREDITS.
*/
#ifndef VSPACE_H
#define VSPACE_H
#include "Length.h"
namespace lyx {
class BufferParams;
class BufferView;
/// A class representing latex vertical spacing
class VSpace {
public:
/// The different kinds of spaces.
enum VSpaceKind {
DEFSKIP,
SMALLSKIP,
MEDSKIP,
BIGSKIP,
VFILL,
LENGTH ///< user-defined length
};
///
VSpace();
///
explicit VSpace(VSpaceKind k);
///
explicit VSpace(Length const & l);
///
explicit VSpace(GlueLength const & l);
/// Constructor for reading from a .lyx file
explicit VSpace(std::string const & data);
/// return the type of vertical space
VSpaceKind kind() const { return kind_; }
/// return the length of this space
GlueLength const & length() const { return len_; }
// a flag that switches between \vspace and \vspace*
bool keep() const { return keep_; }
/// if set true, use \vspace* when type is not DEFSKIP
void setKeep(bool keep) { keep_ = keep; }
///
bool operator==(VSpace const &) const;
// conversion
/// how it goes into the LyX file
std::string const asLyXCommand() const;
/// the latex representation
std::string const asLatexCommand(BufferParams const & params) const;
/// how it is seen in the LyX window
docstring const asGUIName() const;
/// the size of the space on-screen
int inPixels(BufferView const & bv) const;
private:
/// This VSpace kind
VSpaceKind kind_;
/// the specified length
GlueLength len_;
/// if true, use \vspace* type
bool keep_;
};
} // namespace lyx
#endif // VSPACE_H