X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2FParagraph.h;h=9d7e5f1d4c86063c990994a60f3c2c87302bdbd1;hb=96007ce5ac7944bbb30366e21730979498ef296c;hp=e7fdf143a577a1167bc6d09f1f590a37fdfcc3f0;hpb=a01cb111a07717a337c18860216359cdbe22af3c;p=lyx.git

diff --git a/src/Paragraph.h b/src/Paragraph.h
index e7fdf143a5..9d7e5f1d4c 100644
--- a/src/Paragraph.h
+++ b/src/Paragraph.h
@@ -33,6 +33,7 @@ class Change;
 class Counters;
 class Cursor;
 class CursorSlice;
+class DocIterator;
 class DocumentClass;
 class Inset;
 class InsetBibitem;
@@ -47,7 +48,7 @@ class OutputParams;
 class PainterInfo;
 class ParagraphParameters;
 class TexRow;
-
+class Toc;
 
 class FontSpan {
 public:
@@ -72,6 +73,16 @@ 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.
+	AS_STR_NEWLINES = 4 ///< Get also newline characters.
+};
+
+
 /// A Paragraph holds all text, attributes and insets in a text paragraph
 class Paragraph
 {
@@ -80,6 +91,9 @@ public:
 	Paragraph();
 	///
 	Paragraph(Paragraph const &);
+	/// Partial copy constructor.
+	/// Copy the Paragraph contents from \p beg to \p end (without end).
+	Paragraph(Paragraph const & par, pos_type beg, pos_type end);
 	///
 	Paragraph & operator=(Paragraph const &);
 	///
@@ -87,6 +101,8 @@ public:
 	///
 	int id() const;
 
+	///
+	void addChangesToToc(DocIterator const & cdit, Buffer const & buf) const;
 	///
 	Language const * getParLanguage(BufferParams const &) const;
 	///
@@ -98,10 +114,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 &,
@@ -136,17 +157,17 @@ public:
 	void makeSameLayout(Paragraph const & par);
 
 	///
-	void setInsetOwner(Inset * inset);
+	void setInsetOwner(Inset const * inset);
 	///
-	Inset * inInset() const;
+	Inset const & inInset() const;
 	///
 	InsetCode ownerCode() const;
 	///
-	bool forceEmptyLayout() const;
+	bool forcePlainLayout() const;
 	///
 	bool allowParagraphCustomization() const;
 	///
-	bool useEmptyLayout() const;
+	bool usePlainLayout() const;
 	///
 	pos_type size() const;
 	///
@@ -154,10 +175,10 @@ public:
 
 	///
 	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;
@@ -233,10 +254,10 @@ public:
 	    between the characters font and the layoutfont.
 	    This is what is stored in the fonttable
 	*/
-	Font const
+	Font const &
 	getFontSettings(BufferParams const &, pos_type pos) const;
 	///
-	Font const getFirstFontSettings(BufferParams const &) const;
+	Font const & getFirstFontSettings(BufferParams const &) const;
 
 	/** Get fully instantiated font. If pos == -1, use the layout
 	    font attached to this paragraph.
@@ -284,14 +305,15 @@ public:
 	///
 	void insertChar(pos_type pos, char_type c,
 			Font const &, Change const & change);
-	///
-	void insertInset(pos_type pos, Inset * inset,
+	/// Insert \p inset at position \p pos with \p change traking status.
+	/// \return true if successful.
+	bool insertInset(pos_type pos, Inset * inset,
 			 Change const & change);
-	///
-	void insertInset(pos_type pos, Inset * inset,
-			 Font const &, Change const & change);
-	///
-	bool insetAllowed(InsetCode code);
+	/// Insert \p inset at position \p pos with \p change traking status and
+	/// \p font.
+	/// \return true if successful.
+	bool insertInset(pos_type pos, Inset * inset,
+			 Font const & font, Change const & change);
 	///
 	Inset * getInset(pos_type pos);
 	///
@@ -305,6 +327,8 @@ public:
 
 	///
 	InsetList const & insetList() const;
+	///
+	void setBuffer(Buffer &);
 
 	///
 	bool isHfill(pos_type pos) const;
@@ -320,6 +344,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)