remove obsolete references to saveSelection

[lyx.git] / src / paragraph_funcs.h

diff --git a/src/paragraph_funcs.h b/src/paragraph_funcs.h
index 22be6f6668179bd670592c4bcdd398d535c58b55..59786081cbafd90e9d872a7a090855b60d93976c 100644 (file)
--- a/src/paragraph_funcs.h
+++ b/src/paragraph_funcs.h
@@ -12,75 +12,73 @@
 #ifndef PARAGRAPH_FUNCS_H
 #define PARAGRAPH_FUNCS_H
 
-#include "ParagraphList_fwd.h"
 #include "support/types.h"
 
-#include <string>
 
+namespace lyx {
 
 class Buffer;
 class BufferParams;
-class LyXFont;
-class LyXLex;
-class InsetOld;
+class Inset;
+class Font;
+class Paragraph;
+class ParagraphList;
 
-///
+/**
+ * This breaks a paragraph at the specified position.
+ * The new paragraph will:
+ * get the default layout, when flag == 0
+ * will inherit the existing one, except for depth, when flag == 1
+ * will inherit the existing one, including depth, when flag == 2
+ * Be aware that the old or new paragraph does not contain any rows
+ * after this.
+ */
 void breakParagraph(BufferParams const & bparams,
                    ParagraphList & paragraphs,
-                   ParagraphList::iterator par,
-                   lyx::pos_type pos,
+                   pit_type par,
+                   pos_type pos,
                    int flag);
 
 ///
 void breakParagraphConservative(BufferParams const & bparams,
                                ParagraphList & paragraphs,
-                               ParagraphList::iterator par,
-                               lyx::pos_type pos);
+                               pit_type par,
+                               pos_type pos);
 
 /**
  * Append the next paragraph onto the tail of this one.
  * Be careful, this doesent make any check at all.
  */
 void mergeParagraph(BufferParams const & bparams,
-                   ParagraphList & paragraphs,
-                   ParagraphList::iterator par);
+       ParagraphList & paragraphs, pit_type par);
 
 
 /// for the environments
-ParagraphList::iterator depthHook(ParagraphList::iterator pit,
-                                 ParagraphList const & plist,
-                                 lyx::depth_type depth);
+pit_type depthHook(pit_type par,
+       ParagraphList const & plist, depth_type depth);
 
-ParagraphList::iterator outerHook(ParagraphList::iterator pit,
-                                 ParagraphList const & plist);
+pit_type outerHook(pit_type par, ParagraphList const & plist);
 
 /// Is it the first par with same depth and layout?
-bool isFirstInSequence(ParagraphList::iterator par,
-                      ParagraphList const & plist);
+bool isFirstInSequence(pit_type par, ParagraphList const & plist);
 
 /** Check if the current paragraph is the last paragraph in a
     proof environment */
-int getEndLabel(ParagraphList::iterator pit,
-               ParagraphList const & plist);
+int getEndLabel(pit_type par, ParagraphList const & plist);
 
-/// read a paragraph from a .lyx file. Returns number of unrecognised tokens
-int readParagraph(Buffer & buf, Paragraph & par, LyXLex & lex);
-
-LyXFont const outerFont(ParagraphList::iterator pit,
-                       ParagraphList const & plist);
-
-/// find outermost paragraph containing an inset
-ParagraphList::iterator outerPar(Buffer const & buf, InsetOld const * inset);
+/**
+ * Get the font of the "environment" of paragraph \p par_offset in \p pars.
+ * All font changes of the paragraph are relative to this font.
+ */
+Font const outerFont(pit_type par_offset, ParagraphList const & pars);
 
-/// find owning paragraph containing an inset
-Paragraph const & ownerPar(Buffer const & buf, InsetOld const * inset);
+/// return the number of InsetOptArg in a paragraph
+int numberOfOptArgs(Paragraph const & par);
 
-/// stretch range beg,end to the minimum containing ystart, yend
-void getParsInRange(ParagraphList & pl,
-                   int ystart, int yend,
-                   ParagraphList::iterator & beg,
-                   ParagraphList::iterator & end);
+/// accept the changes within the complete ParagraphList
+void acceptChanges(ParagraphList & pars, BufferParams const & bparams);
 
 
+} // namespace lyx
 
 #endif // PARAGRAPH_FUNCS_H