mirror of
https://git.lyx.org/repos/lyx.git
synced 2024-12-16 18:03:49 +00:00
963a0aa466
Move the enum definition RowFlags in its own include file, to avoid loading Inset.h. Document it more thoroughly. Rename RowAfter to AlwaysBreakAfter. Add CanBreakInside (rows that can be themselves broken). This allow to differentiate elements before bodyPos() and allows to remove a parameter to shortenIfNeeded(). Make the Inset::rowFlags() method return int instead of RowFlags, as should be done for all the bitwise flags. Remove the hand-made bitwise operators. Set R::E::row_flags when creating elements. * INSET elements use the inset's rowFLags(); * virtual element forbid breaking before them, and inherit the *After flags from the previous element of the row; * STRING elements usr CanBreakInside, except before bodyPos. More stuff may be added later.
177 lines
4.3 KiB
C++
177 lines
4.3 KiB
C++
// -*- C++ -*-
|
|
/**
|
|
* \file InsetSpace.h
|
|
* This file is part of LyX, the document processor.
|
|
* Licence details can be found in the file COPYING.
|
|
*
|
|
* \author Asger Alstrup Nielsen
|
|
* \author Jean-Marc Lasgouttes
|
|
* \author Lars Gullik Bjønnes
|
|
* \author Jürgen Spitzmüller
|
|
*
|
|
* Full author contact details are available in file CREDITS.
|
|
*/
|
|
|
|
#ifndef INSET_SPACE_H
|
|
#define INSET_SPACE_H
|
|
|
|
#include "Inset.h"
|
|
|
|
#include "support/Length.h"
|
|
|
|
|
|
namespace lyx {
|
|
|
|
class LaTeXFeatures;
|
|
|
|
struct InsetSpaceParams {
|
|
/// The different kinds of spaces we support
|
|
enum Kind {
|
|
/// Normal space ('\ ')
|
|
NORMAL,
|
|
/// Protected (no break) space ('~')
|
|
PROTECTED,
|
|
/// Visible ("open box") space ('\textvisiblespace')
|
|
VISIBLE,
|
|
/// Thin space ('\,')
|
|
THIN,
|
|
/// Medium space ('\:')
|
|
MEDIUM,
|
|
/// Thick space ('\;')
|
|
THICK,
|
|
/// \quad (1em)
|
|
QUAD,
|
|
/// \qquad (2em)
|
|
QQUAD,
|
|
/// \enspace (0.5em unbreakable)
|
|
ENSPACE,
|
|
/// \enskip (0.5em breakable)
|
|
ENSKIP,
|
|
/// Negative thin space ('\negthinspace')
|
|
NEGTHIN,
|
|
/// Negative medium space ('\negmedspace')
|
|
NEGMEDIUM,
|
|
/// Negative thick space ('\negthickspace')
|
|
NEGTHICK,
|
|
/// rubber length
|
|
HFILL,
|
|
/// \hspace*{\fill}
|
|
HFILL_PROTECTED,
|
|
/// rubber length, filled with dots
|
|
DOTFILL,
|
|
/// rubber length, filled with a rule
|
|
HRULEFILL,
|
|
/// rubber length, filled with a left arrow
|
|
LEFTARROWFILL,
|
|
/// rubber length, filled with a right arrow
|
|
RIGHTARROWFILL,
|
|
// rubber length, filled with an up brace
|
|
UPBRACEFILL,
|
|
// rubber length, filled with a down brace
|
|
DOWNBRACEFILL,
|
|
/// \hspace{length}
|
|
CUSTOM,
|
|
/// \hspace*{length}
|
|
CUSTOM_PROTECTED
|
|
};
|
|
///
|
|
explicit InsetSpaceParams(bool m = false) : kind(NORMAL), math(m) {}
|
|
///
|
|
void write(std::ostream & os) const;
|
|
///
|
|
void read(Lexer & lex);
|
|
///
|
|
Kind kind;
|
|
///
|
|
GlueLength length;
|
|
/**
|
|
* Whether these params are to be used in mathed.
|
|
* This determines the set of valid kinds.
|
|
*/
|
|
bool math;
|
|
};
|
|
|
|
|
|
/// Used to insert different kinds of spaces
|
|
class InsetSpace : public Inset
|
|
{
|
|
public:
|
|
///
|
|
InsetSpace() : Inset(0) {}
|
|
///
|
|
explicit InsetSpace(InsetSpaceParams const & params);
|
|
///
|
|
InsetSpaceParams const & params() const { return params_; }
|
|
///
|
|
InsetSpaceParams::Kind kind() const;
|
|
|
|
///
|
|
static void string2params(std::string const &, InsetSpaceParams &);
|
|
///
|
|
static std::string params2string(InsetSpaceParams const &);
|
|
///
|
|
GlueLength length() const;
|
|
|
|
///
|
|
docstring toolTip(BufferView const & bv, int x, int y) const override;
|
|
/// unprotected spaces allow line breaking after them
|
|
int rowFlags() const override;
|
|
///
|
|
void metrics(MetricsInfo &, Dimension &) const override;
|
|
///
|
|
void draw(PainterInfo & pi, int x, int y) const override;
|
|
///
|
|
void write(std::ostream &) const override;
|
|
/// Will not be used when lyxf3
|
|
void read(Lexer & lex) override;
|
|
///
|
|
void latex(otexstream &, OutputParams const &) const override;
|
|
///
|
|
int plaintext(odocstringstream & ods, OutputParams const & op,
|
|
size_t max_length = INT_MAX) const override;
|
|
///
|
|
void docbook(XMLStream &, OutputParams const &) const override;
|
|
///
|
|
docstring xhtml(XMLStream &, OutputParams const &) const override;
|
|
///
|
|
void validate(LaTeXFeatures & features) const override;
|
|
///
|
|
void toString(odocstream &) const override;
|
|
///
|
|
void forOutliner(docstring &, size_t const, bool const) const override;
|
|
///
|
|
bool hasSettings() const override { return true; }
|
|
///
|
|
bool clickable(BufferView const &, int, int) const override { return true; }
|
|
///
|
|
InsetCode lyxCode() const override { return SPACE_CODE; }
|
|
/// does this inset try to use all available space (like \\hfill does)?
|
|
bool isHfill() const override;
|
|
/// should this inset be handled like a normal character?
|
|
bool isChar() const override { return true; }
|
|
/// is this equivalent to a letter?
|
|
bool isLetter() const override { return false; }
|
|
/// is this equivalent to a space (which is BTW different from
|
|
// a line separator)?
|
|
bool isSpace() const override { return true; }
|
|
///
|
|
std::string contextMenuName() const override;
|
|
protected:
|
|
///
|
|
Inset * clone() const override { return new InsetSpace(*this); }
|
|
///
|
|
void doDispatch(Cursor & cur, FuncRequest & cmd) override;
|
|
public:
|
|
///
|
|
bool getStatus(Cursor & cur, FuncRequest const & cmd, FuncStatus &) const override;
|
|
|
|
private:
|
|
///
|
|
InsetSpaceParams params_;
|
|
};
|
|
|
|
|
|
} // namespace lyx
|
|
|
|
#endif // INSET_SPACE_H
|