Adapt all German and English manuals to new index features

[features.git] / src / Paragraph.h

diff --git a/src/Paragraph.h b/src/Paragraph.h
index 3b5f2b81624b72ac968a529fda1c350ea05748ea..ca88dd774e9d48e7f0472b8db35972899af5c0d0 100644 (file)
--- a/src/Paragraph.h
+++ b/src/Paragraph.h
@@ -16,7 +16,6 @@
 #ifndef PARAGRAPH_H
 #define PARAGRAPH_H
 
-#include "FontEnums.h"
 #include "LayoutEnums.h"
 #include "SpellChecker.h"
 
@@ -24,6 +23,7 @@
 #include "support/types.h"
 
 #include <set>
+#include <vector>
 
 namespace lyx {
 
@@ -31,28 +31,25 @@ class AuthorList;
 class Buffer;
 class BufferParams;
 class Change;
-class Counters;
-class Cursor;
-class CursorSlice;
 class DocIterator;
 class docstring_list;
 class DocumentClass;
 class Inset;
-class InsetBibitem;
 class LaTeXFeatures;
 class InsetList;
 class Language;
 class Layout;
 class Font;
-class MetricsInfo;
 class OutputParams;
-class PainterInfo;
 class ParagraphParameters;
 class TocBackend;
 class WordLangTuple;
-class XHTMLStream;
+class XMLStream;
 class otexstream;
 
+/// Inset identifier (above 0x10ffff, for ucs-4)
+char_type const META_INSET = 0x200001;
+
 class FontSpan {
 public:
        /// Invalid font span containing no character
@@ -126,7 +123,8 @@ enum AsStringParameter
        AS_STR_INSETS = 2, ///< Go into insets.
        AS_STR_NEWLINES = 4, ///< Get also newline characters.
        AS_STR_SKIPDELETE = 8, ///< Skip deleted text in change tracking.
-       AS_STR_PLAINTEXT = 16 ///< Don't export formatting when descending into insets.
+       AS_STR_PLAINTEXT = 16, ///< Don't export formatting when descending into insets.
+       AS_STR_MATHED = 32 ///< Use a format suitable for mathed (eg. for InsetRef).
 };
 
 
@@ -196,30 +194,33 @@ public:
        /// Can we drop the standard paragraph wrapper?
        bool emptyTag() const;
 
-       /// Get the id of the paragraph, usefull for docbook
+       /// Get the id of the paragraph, useful for DocBook
        std::string getID(Buffer const & buf, OutputParams const & runparams) const;
 
        /// Output the first word of a paragraph, return the position where it left.
-       pos_type firstWordDocBook(odocstream & os, OutputParams const & runparams) const;
+       pos_type firstWordDocBook(XMLStream & xs, OutputParams const & runparams) const;
 
        /// Output the first word of a paragraph, return the position where it left.
-       pos_type firstWordLyXHTML(XHTMLStream & xs, OutputParams const & runparams) const;
-
-       /// Writes to stream the docbook representation
-       void simpleDocBookOnePar(Buffer const & buf,
-                                odocstream &,
-                                OutputParams const & runparams,
-                                Font const & outerfont,
-                                pos_type initial = 0) const;
+       pos_type firstWordLyXHTML(XMLStream & xs, OutputParams const & runparams) const;
+
+       /// Outputs to stream the DocBook representation, one element per paragraph.
+       std::tuple<std::vector<docstring>, std::vector<docstring>, std::vector<docstring>>
+       simpleDocBookOnePar(Buffer const & buf,
+                                                                          OutputParams const & runparams,
+                                                                          Font const & outerfont,
+                                                                          pos_type initial = 0,
+                                                                          bool is_last_par = false,
+                                                                          bool ignore_fonts = false) const;
+
        /// \return any material that has had to be deferred until after the
        /// paragraph has closed.
        docstring simpleLyXHTMLOnePar(Buffer const & buf,
-                                XHTMLStream & xs,
-                                OutputParams const & runparams,
-                                Font const & outerfont,
-                                bool start_paragraph = true,
-                                bool close_paragraph = true,
-                                pos_type initial = 0) const;
+                                                                 XMLStream & xs,
+                                                                 OutputParams const & runparams,
+                                                                 Font const & outerfont,
+                                                                 bool start_paragraph = true,
+                                                                 bool close_paragraph = true,
+                                                                 pos_type initial = 0) const;
 
        ///
        bool hasSameLayout(Paragraph const & par) const;
@@ -238,6 +239,10 @@ public:
        ///
        bool isPassThru() const;
        ///
+       bool parbreakIsNewline() const;
+       ///
+       bool isPartOfTextSequence() const;
+       ///
        pos_type size() const;
        ///
        bool empty() const;
@@ -306,8 +311,6 @@ public:
        ///
        docstring expandLabel(Layout const &, BufferParams const &) const;
        ///
-       docstring expandDocBookLabel(Layout const &, BufferParams const &) const;
-       ///
        docstring const & labelString() const;
        /// the next two functions are for the manual labels
        docstring const getLabelWidthString() const;