This comment is wrong and causes bug in revision control.

[lyx.git] / src / Paragraph.h

diff --git a/src/Paragraph.h b/src/Paragraph.h
index 20e255797b7efa48848f60a2e5aaf1c33f13793e..c83ede5975788122307fe8715662ddde34b66bf9 100644 (file)
--- a/src/Paragraph.h
+++ b/src/Paragraph.h
@@ -17,7 +17,7 @@
 #define PARAGRAPH_H
 
 #include "FontEnums.h"
-#include "LayoutPtr.h"
+#include "Layout.h"
 
 #include "insets/InsetCode.h"
 
@@ -72,6 +72,15 @@ enum TextCase {
 };
 
 
+///
+enum AsStringParameter
+{
+       AS_STR_NONE = 0, ///< No option, only printable characters.
+       AS_STR_LABEL = 1, ///< Prefix with paragraph label.
+       AS_STR_INSETS = 2 ///< Go into insets.
+};
+
+
 /// A Paragraph holds all text, attributes and insets in a text paragraph
 class Paragraph
 {
@@ -98,10 +107,15 @@ public:
        bool isMultiLingual(BufferParams const &) const;
 
        /// Convert the paragraph to a string.
-       /// Used for building the table of contents
-       docstring asString(bool label) const;
+       /// \param AsStringParameter options. This can contain any combination of
+       /// asStringParameter values. Valid examples:
+       ///             asString(AS_STR_LABEL)
+       ///             asString(AS_STR_LABEL | AS_STR_INSETS)
+       ///             asString(AS_STR_INSETS)
+       docstring asString(int options = AS_STR_NONE) const;
        ///
-       docstring asString(pos_type beg, pos_type end, bool label) const;
+       docstring asString(pos_type beg, pos_type end,
+               int options = AS_STR_NONE) const;
 
        ///
        void write(std::ostream &, BufferParams const &,
@@ -142,24 +156,22 @@ public:
        ///
        InsetCode ownerCode() const;
        ///
-       bool forceEmptyLayout() const;
+       bool forcePlainLayout() const;
        ///
        bool allowParagraphCustomization() const;
        ///
-       bool useEmptyLayout() const;
+       bool usePlainLayout() const;
        ///
        pos_type size() const;
        ///
        bool empty() const;
 
        ///
-       LayoutPtr const & layout() const;
-       ///
-       void setLayout(LayoutPtr const & layout);
-       ///
-       void setLayout(Layout const & layout) { setLayout(&layout); }
+       Layout const & layout() const;
+       /// Do not pass a temporary to this!
+       void setLayout(Layout const & layout);
        ///
-       void setEmptyOrDefaultLayout(DocumentClass const & tc);
+       void setPlainOrDefaultLayout(DocumentClass const & tc);
 
        /// This is the item depth, only used by enumerate and itemize
        signed char itemdepth;
@@ -212,7 +224,7 @@ public:
        docstring const translateIfPossible(docstring const & label,
                BufferParams const & bparams) const;
        /// Expand the counters for the labelstring of \c layout
-       docstring expandLabel(LayoutPtr const &, BufferParams const &,
+       docstring expandLabel(Layout const &, BufferParams const &,
                bool process_appendix = true) const;
        /// Actual paragraph alignment used
        char getAlign() const;
@@ -322,6 +334,10 @@ public:
        /// True if the character/inset at this point can be part of a word.
        /// Note that digits in particular are considered as letters
        bool isLetter(pos_type pos) const;
+       /// True if the element at this point is a character that is not a letter.
+       bool isChar(pos_type pos) const;
+       /// True if the element at this point is a space
+       bool isSpace(pos_type pos) const;
 
        /// returns true if at least one line break or line separator has been deleted
        /// at the beginning of the paragraph (either physically or logically)