*
* \author Asger Alstrup Nielsen
* \author Jean-Marc Lasgouttes
- * \author Lars Gullik Bjønnes
- * \author Jürgen Spitzmüller
+ * \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 "Length.h"
-#include "MailInset.h"
+
+#include "support/Length.h"
namespace lyx {
class LaTeXFeatures;
-class InsetSpaceParams {
-public:
+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,
- /// \enspace (0.5em breakable)
+ /// \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
};
///
- InsetSpaceParams() : kind(NORMAL), length(Length()) {}
+ explicit InsetSpaceParams(bool m = false) : kind(NORMAL), math(m) {}
///
void write(std::ostream & os) const;
///
///
Kind kind;
///
- Length length;
+ 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 {
+class InsetSpace : public Inset
+{
public:
///
- InsetSpace();
+ InsetSpace() : Inset(0) {}
///
- ~InsetSpace();
-
+ explicit InsetSpace(InsetSpaceParams const & params);
///
- explicit
- InsetSpace(InsetSpaceParams par);
- ///
- InsetSpaceParams params() const { return params_; }
+ InsetSpaceParams const & params() const { return params_; }
///
InsetSpaceParams::Kind kind() const;
+
///
- Length length() const;
+ static void string2params(std::string const &, InsetSpaceParams &);
///
- docstring toolTip(BufferView const & bv, int x, int y) const;
+ static std::string params2string(InsetSpaceParams const &);
///
- void metrics(MetricsInfo &, Dimension &) const;
+ GlueLength length() const;
+
///
- void draw(PainterInfo & pi, int x, int y) const;
+ docstring toolTip(BufferView const & bv, int x, int y) const override;
+ /// unprotected spaces allow line breaking after them
+ int rowFlags() const override;
///
- void write(std::ostream &) const;
+ 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);
+ void read(Lexer & lex) override;
///
- int latex(odocstream &, OutputParams const &) const;
+ void latex(otexstream &, OutputParams const &) const override;
///
- int plaintext(odocstream &, OutputParams const &) const;
+ int plaintext(odocstringstream & ods, OutputParams const & op,
+ size_t max_length = INT_MAX) const override;
///
- int docbook(odocstream &, OutputParams const &) const;
- /// the string that is passed to the TOC
- void textString(odocstream &) const;
+ void docbook(XMLStream &, OutputParams const &) const override;
///
- InsetCode lyxCode() const { return SPACE_CODE; }
- /// is this an expandible space (rubber length)?
- bool isStretchableSpace() const;
-
- // should this inset be handled like a normal charater
- bool isChar() const { return true; }
- /// is this equivalent to a letter?
- bool isLetter() const { return false; }
- /// is this equivalent to a space (which is BTW different from
- // a line separator)?
- bool isSpace() const { return true; }
-private:
- virtual Inset * clone() const { return new InsetSpace(*this); }
+ docstring xhtml(XMLStream &, OutputParams const &) const override;
///
- void doDispatch(Cursor & cur, FuncRequest & cmd);
-
+ void validate(LaTeXFeatures & features) const override;
///
- InsetSpaceParams params_;
-};
-
-
-class InsetSpaceMailer : public MailInset {
-public:
+ void toString(odocstream &) const override;
+ ///
+ void forOutliner(docstring &, size_t const, bool const) const override;
+ ///
+ bool hasSettings() const override { return true; }
///
- InsetSpaceMailer(InsetSpace & inset);
+ bool clickable(BufferView const &, int, int) const override { return true; }
///
- virtual Inset & inset() const { return inset_; }
+ 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; }
///
- virtual std::string const & name() const { return name_; }
+ std::string contextMenuName() const override;
+protected:
///
- virtual std::string const inset2string(Buffer const &) const;
+ Inset * clone() const override { return new InsetSpace(*this); }
///
- static void string2params(std::string const &, InsetSpaceParams &);
+ void doDispatch(Cursor & cur, FuncRequest & cmd) override;
+public:
///
- static std::string const params2string(InsetSpaceParams const &);
+ bool getStatus(Cursor & cur, FuncRequest const & cmd, FuncStatus &) const override;
+
private:
///
- static std::string const name_;
- ///
- InsetSpace & inset_;
+ InsetSpaceParams params_;
};
projects / lyx.git / blobdiff