lyx_mirror/src/lyxgluelength.h
Lars Gullik Bjønnes 44cd0fc9a1 The std::string mammoth path.
git-svn-id: svn://svn.lyx.org/lyx/lyx-devel/trunk@7862 a592a061-630c-0410-9148-cb99ea01b6c8
2003-10-06 15:43:21 +00:00

73 lines
1.7 KiB
C++

// -*- C++ -*-
/**
* \file lyxgluelength.h
* This file is part of LyX, the document processor.
* Licence details can be found in the file COPYING.
*
* \author Lars Gullik Bjønnes
* \author Matthias Ettrich
* \author Jean-Marc Lasgouttes
*
* Full author contact details are available in file CREDITS.
*/
#ifndef LYX_GLUE_LENGTH_H
#define LYX_GLUE_LENGTH_H
#include "lyxlength.h"
class LyXGlueLength {
public:
///
LyXGlueLength() {}
///
explicit LyXGlueLength(LyXLength const & len);
///
LyXGlueLength(LyXLength const & len,
LyXLength const & plus,
LyXLength const & minus);
/** "data" must be a decimal number, followed by a unit, and
optional "glue" indicated by "+" and "-". You may abbreviate
reasonably. Examples:
1.2 cm // 4mm +2pt // 2cm -4mm +2mm // 4+0.1-0.2cm
The traditional Latex format is also accepted, like
4cm plus 10pt minus 10pt */
explicit LyXGlueLength(std::string const & data);
///
LyXLength const & len() const;
///
LyXLength const & plus() const;
///
LyXLength const & minus() const;
/// conversion
std::string const asString() const;
///
std::string const asLatexString() const;
friend bool isValidGlueLength(std::string const & data,
LyXGlueLength* result);
private:
/// the normal vlaue
LyXLength len_;
/// extra stretch
LyXLength plus_;
/// extra shrink
LyXLength minus_;
};
///
bool operator==(LyXGlueLength const & l1, LyXGlueLength const & l2);
///
bool operator!=(LyXGlueLength const & l1, LyXGlueLength const & l2);
/** If "data" is valid, the length represented by it is
stored into "result", if that is not 0. */
bool isValidGlueLength(std::string const & data, LyXGlueLength * result = 0);
#endif // LYXGLUELENGTH_H