X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2Fvspace.h;h=b358b40621b486b7e94ca6077c973dd59de7a072;hb=52eb91c94fb70d58dceef430659c8781de2eccda;hp=8e224649899418477c2e5411bfbe07e50b601b8f;hpb=27de1486ca34aaad446adb798d71a77d6f6304da;p=lyx.git diff --git a/src/vspace.h b/src/vspace.h index 8e22464989..b358b40621 100644 --- a/src/vspace.h +++ b/src/vspace.h @@ -1,200 +1,84 @@ // -*- C++ -*- -/* This file is part of - * ====================================================== - * - * LyX, The Document Processor - * - * Copyright (C) 1995 1996 Matthias Ettrich - * and the LyX Team. +/** + * \file vspace.h + * This file is part of LyX, the document processor. + * Licence details can be found in the file COPYING. * - *======================================================*/ - -#ifndef _VSPACE_H_ -#define _VSPACE_H_ - -#ifdef __GNUG__ -#pragma interface -#endif - -#include - -/// LyXLength Class -class LyXLength { -public: - /// length units - enum UNIT { - /// Scaled point (65536sp = 1pt) TeX's smallest unit. - SP, - /// Point = 1/72.27in = 0.351mm - PT, - /// Big point (72bp = 1in), also PostScript point - BP, - /// Didot point = 1/72 of a French inch, = 0.376mm - DD, - /// Millimeter = 2.845pt - MM, - /// Pica = 12pt = 4.218mm - PC, - /// Cicero = 12dd = 4.531mm - CC, - /// Centimeter = 10mm = 2.371pc - CM, - /// Inch = 25.4mm = 72.27pt = 6.022pc - IN, - /// Height of a small "x" for the current font. - EX, - /// Width of capital "M" in current font. - EM, - /// Math unit (18mu = 1em) for positioning in math mode - MU, - /// no unit - UNIT_NONE - }; + * \author Matthias Ettrich + * + * Full author contact details are available in file CREDITS. + */ - //@Man: constructors - //@{ - /// - LyXLength() : val(0), uni(LyXLength::PT) {}; - LyXLength(float v, LyXLength::UNIT u) : val(v), uni(u) {}; - - /** "data" must be a decimal number, followed by a unit. */ - LyXLength(LString const & data); - //@} - - //@Man: selectors - //@{ - /// - float value() const { return val; }; - /// - LyXLength::UNIT unit() const { return uni; }; - //@} +#ifndef VSPACE_H +#define VSPACE_H - /// - bool operator==(LyXLength other); +#include "lyxgluelength.h" - /// conversion - virtual LString asString() const; - virtual LString asLatexString() const { return this->asString(); }; +namespace lyx { - /** If "data" is valid, the length represented by it is - stored into "result", if that is not NULL. */ - friend bool isValidLength(LString const & data, - LyXLength* result=NULL); -protected: - float val; - LyXLength::UNIT uni; -}; +class BufferParams; +class BufferView; -extern LyXLength::UNIT unitFromString (LString const & data); -extern bool isValidLength(LString const &data, LyXLength* result); -/// LyXGlueLength class -class LyXGlueLength : public LyXLength { +/// A class representing latex vertical spacing +class VSpace { public: - //@Man: constructors - //@{ - /// - LyXGlueLength(float v, LyXLength::UNIT u, - float pv=0.0, LyXLength::UNIT pu=LyXLength::UNIT_NONE, - float mv=0.0, LyXLength::UNIT mu=LyXLength::UNIT_NONE) - : LyXLength (v, u), - plus_val(pv), minus_val(mv), - plus_uni(pu), minus_uni(mu) {}; - - /** "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 */ - LyXGlueLength(LString const & data); - //@} - - //@Man: selectors - //@{ - /// - float plusValue() const { return plus_val; }; - /// - LyXLength::UNIT plusUnit() const { return plus_uni; }; - /// - float minusValue() const { return minus_val; }; - /// - LyXLength::UNIT minusUnit() const { return minus_uni; }; - //@} + /// The different kinds of spaces. + enum vspace_kind { + DEFSKIP, + SMALLSKIP, + MEDSKIP, + BIGSKIP, + VFILL, + LENGTH ///< user-defined length + }; - /// - bool operator==(LyXGlueLength other); + VSpace(); - /// conversion - virtual LString asString() const; - virtual LString asLatexString() const; + explicit VSpace(vspace_kind k); + explicit VSpace(LyXLength const & l); - /** If "data" is valid, the length represented by it is - stored into "result", if that is not NULL. */ - friend bool isValidGlueLength(LString const & data, - LyXGlueLength* result=NULL); + explicit VSpace(LyXGlueLength const & l); -protected: - float plus_val, minus_val; - LyXLength::UNIT plus_uni, minus_uni; -}; + /// Constructor for reading from a .lyx file + explicit VSpace(std::string const & data); -extern bool isValidGlueLength(LString const &data, LyXGlueLength* result); + /// return the type of vertical space + vspace_kind kind() const; + /// return the length of this space + LyXGlueLength const & length() const; -/// VSpace class -class VSpace { -public: + // a flag that switches between \vspace and \vspace* + bool keep() const; + /// if set true, use \vspace* when type is not DEFSKIP + void setKeep(bool val); /// - enum vspace_kind { NONE, DEFSKIP, - SMALLSKIP, MEDSKIP, BIGSKIP, - VFILL, LENGTH }; - // constructors - VSpace() : - kin (NONE), - len(0.0, LyXLength::PT), - kp (false) {}; - - VSpace(vspace_kind k) : - kin (k), - len (0.0, LyXLength::PT), - kp (false) {}; - - VSpace(LyXGlueLength l) : - kin (LENGTH), - len (l), - kp (false) {}; - - VSpace(float v, LyXLength::UNIT u) : - kin (LENGTH), - len (v, u), - kp (false) {}; - - /// this constructor is for reading from a .lyx file - VSpace(LString const & data); - - // access functions - vspace_kind kind() const { return kin; } - LyXLength length() const { return len; } + bool operator==(VSpace const &) const; - // a flag that switches between \vspace and \vspace* - bool keep() const { return kp; } - void setKeep(bool val) { kp = val; } + // conversion - bool operator== (VSpace other); + /// 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; - // conversion - LString asLyXCommand() const; // how it goes into the LyX file - LString asLatexCommand() const; - int inPixels() const; private: - vspace_kind kin; - LyXGlueLength len; - bool kp; + /// This VSpace kind + vspace_kind kind_; + /// the specified length + LyXGlueLength len_; + /// if true, use \vspace* type + bool keep_; }; -#endif +} // namespace lyx +#endif // VSPACE_H