]> git.lyx.org Git - lyx.git/blobdiff - src/insets/InsetSpace.h
Rename LATEX debug level to OUTFILE and use it for DocBook, HTML, and XML messages.
[lyx.git] / src / insets / InsetSpace.h
index 8363645698e2eaa607dbddb3dcffe70b44e36992..e401d6d9ae7586624cfbd1abe910d239a8aa519b 100644 (file)
 #define INSET_SPACE_H
 
 #include "Inset.h"
-#include "Length.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}
@@ -65,7 +75,7 @@ public:
                CUSTOM_PROTECTED
        };
        ///
-       InsetSpaceParams() : kind(NORMAL), length(Length()) {}
+       explicit InsetSpaceParams(bool m = false) : kind(NORMAL), math(m) {}
        ///
        void write(std::ostream & os) const;
        ///
@@ -73,7 +83,12 @@ public:
        ///
        Kind kind;
        ///
-       Length length;
+       GlueLength length;
+       /**
+        * Whether these params are to be used in mathed.
+        * This determines the set of valid kinds.
+        */
+       bool math;
 };
 
 
@@ -82,68 +97,75 @@ class InsetSpace : public Inset
 {
 public:
        ///
-       InsetSpace() {}
+       InsetSpace() : Inset(0) {}
        ///
-       explicit InsetSpace(InsetSpaceParams const & par);
+       explicit InsetSpace(InsetSpaceParams const & params);
        ///
-       InsetSpaceParams params() const { return params_; }
+       InsetSpaceParams const & params() const { return params_; }
        ///
        InsetSpaceParams::Kind kind() const;
-       ///
-       ~InsetSpace();
 
        ///
        static void string2params(std::string const &, InsetSpaceParams &);
        ///
        static std::string params2string(InsetSpaceParams const &);
        ///
-       Length length() const;
+       GlueLength length() const;
 
-private:
        ///
-       docstring toolTip(BufferView const & bv, 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 metrics(MetricsInfo &, Dimension &) const;
+       void metrics(MetricsInfo &, Dimension &) const override;
        ///
-       void draw(PainterInfo & pi, int x, int y) const;
+       void draw(PainterInfo & pi, int x, int y) const override;
        ///
-       void write(std::ostream &) const;
+       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 tocString(odocstream &) const;
+       void docbook(XMLStream &, OutputParams const &) const override;
        ///
-       void edit(Cursor & cur, bool front,
-               EntryDirection entry_from = ENTRY_DIRECTION_IGNORE);
+       docstring xhtml(XMLStream &, OutputParams const &) const override;
        ///
-       EDITABLE editable() const { return IS_EDITABLE; }
+       void validate(LaTeXFeatures & features) 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; }
+       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 { return false; }
+       bool isLetter() const override { return false; }
        /// is this equivalent to a space (which is BTW different from
        // a line separator)?
-       bool isSpace() const { return true; }
+       bool isSpace() const override { return true; }
        ///
-       docstring contextMenu(BufferView const & bv, int x, int y) const;
+       std::string contextMenuName() const override;
+protected:
        ///
-       Inset * clone() const { return new InsetSpace(*this); }
+       Inset * clone() const override { return new InsetSpace(*this); }
        ///
-       void doDispatch(Cursor & cur, FuncRequest & cmd);
+       void doDispatch(Cursor & cur, FuncRequest & cmd) override;
+public:
        ///
-       bool getStatus(Cursor & cur, FuncRequest const & cmd, FuncStatus &) const;
+       bool getStatus(Cursor & cur, FuncRequest const & cmd, FuncStatus &) const override;
 
+private:
        ///
        InsetSpaceParams params_;
 };