X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2Finsets%2FInsetSpace.h;h=a4fd6151f90a458c9a8429573e6d0cdc735f03a1;hb=239b9919ffe28338d789e6dc9122228f77ab77a7;hp=459afedcca667a4e46cfe7a8a070d8f26cd2bc98;hpb=237c132c1e6fc720b87f2fea6deb18a8395cbe0a;p=lyx.git diff --git a/src/insets/InsetSpace.h b/src/insets/InsetSpace.h index 459afedcca..a4fd6151f9 100644 --- a/src/insets/InsetSpace.h +++ b/src/insets/InsetSpace.h @@ -6,8 +6,8 @@ * * \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. */ @@ -15,87 +15,156 @@ #ifndef INSET_SPACE_H #define INSET_SPACE_H - #include "Inset.h" +#include "Length.h" namespace lyx { class LaTeXFeatures; -/// Used to insert different kinds of spaces -class InsetSpace : public Inset { -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) + /// \enskip (0.5em unbreakable) ENSPACE, /// \enspace (0.5em breakable) ENSKIP, /// Negative thin space ('\negthinspace') - NEGTHIN + 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(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(); + InsetSpace() : Inset(0) {} + /// + explicit InsetSpace(InsetSpaceParams const & par); + /// + InsetSpaceParams const & params() const { return params_; } + /// + InsetSpaceParams::Kind kind() const; /// - explicit - InsetSpace(Kind k); + static void string2params(std::string const &, InsetSpaceParams &); /// - Kind kind() const; + static std::string params2string(InsetSpaceParams const &); /// - void metrics(MetricsInfo &, Dimension &) const; + GlueLength length() const; + + /// + docstring toolTip(BufferView const & bv, int x, int y) const; /// - Dimension const dimension(BufferView const &) const { return dim_; }; + void metrics(MetricsInfo &, Dimension &) const; /// void draw(PainterInfo & pi, int x, int y) const; /// - void write(Buffer const &, std::ostream &) const; + void write(std::ostream &) const; /// Will not be used when lyxf3 - void read(Buffer const &, Lexer & lex); + void read(Lexer & lex); /// - int latex(Buffer const &, odocstream &, - OutputParams const &) const; + void latex(otexstream &, OutputParams const &) const; /// - int plaintext(Buffer const &, odocstream &, - OutputParams const &) const; + int plaintext(odocstringstream & ods, OutputParams const & op, + size_t max_length = INT_MAX) const; /// - int docbook(Buffer const &, odocstream &, - OutputParams const &) const; - /// the string that is passed to the TOC - virtual int textString(Buffer const &, odocstream &, - OutputParams const &) const; + int docbook(odocstream &, OutputParams const &) const; /// - Inset::Code lyxCode() const { return Inset::SPACE_CODE; } - /// We don't need \begin_inset and \end_inset - bool directWrite() const { return true; } - - // should this inset be handled like a normal charater - bool isChar() const; + docstring xhtml(XHTMLStream &, OutputParams const &) const; + /// + void validate(LaTeXFeatures & features) const; + /// + void toString(odocstream &) const; + /// + void forOutliner(docstring &, size_t const, bool const) const; + /// + bool hasSettings() const { return true; } + /// + bool clickable(BufferView const &, int, int) const { return true; } + /// + InsetCode lyxCode() const { return SPACE_CODE; } + /// does this inset try to use all available space (like \\hfill does)? + bool isHfill() const; + /// should this inset be handled like a normal character? + bool isChar() const { return true; } /// is this equivalent to a letter? - bool isLetter() const; + bool isLetter() const { return false; } /// is this equivalent to a space (which is BTW different from // a line separator)? - bool isSpace() const; -private: - virtual Inset * clone() const; + bool isSpace() const { return true; } + /// + std::string contextMenuName() const; +protected: + /// + Inset * clone() const { return new InsetSpace(*this); } + /// + void doDispatch(Cursor & cur, FuncRequest & cmd); +public: + /// + bool getStatus(Cursor & cur, FuncRequest const & cmd, FuncStatus &) const; - /// And which kind is this? - Kind kind_; +private: /// - mutable Dimension dim_; + InsetSpaceParams params_; };