TextLayoutUi.ui: group everything into boxes for a consistent layout with the other...

[lyx.git] / src / paragraph_funcs.h

diff --git a/src/paragraph_funcs.h b/src/paragraph_funcs.h
index c25327c447111a6e637bf1dff26dc551fc116dd9..067ba94ba1e115c76ada49bd422638d34413e2b6 100644 (file)
--- a/src/paragraph_funcs.h
+++ b/src/paragraph_funcs.h
@@ -4,7 +4,7 @@
  * This file is part of LyX, the document processor.
  * Licence details can be found in the file COPYING.
  *
- * \author Lars Gullik Bjønnes
+ * \author Lars Gullik Bjønnes
  *
  * Full author contact details are available in file CREDITS.
  */
@@ -12,75 +12,76 @@
 #ifndef PARAGRAPH_FUNCS_H
 #define PARAGRAPH_FUNCS_H
 
-#include "ParagraphList_fwd.h"
+#include "support/strfwd.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:
+ * - Decrease depth by one (or change layout to default layout) when
+ *    keep_layout == false  
+ * - keep current depth and layout when keep_layout == true
+ */
 void breakParagraph(BufferParams const & bparams,
                    ParagraphList & paragraphs,
-                   ParagraphList::iterator par,
-                   lyx::pos_type pos,
-                   int flag);
+                   pit_type par,
+                   pos_type pos,
+                   bool keep_layout);
 
 ///
 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);
+
+/** Set Label Width string to all paragraphs of the same layout
+    and depth in a sequence */
+void setLabelWidthStringToSequence(pit_type par_offset,
+       ParagraphList & pars, docstring const & s);
 
 /** 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 const & 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);
-
-/// find owning paragraph containing an inset
-Paragraph const & ownerPar(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);
 
-/// return the range of pars [beg, end[ owning the range of y [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);
 
+/// return true if the whole ParagraphList is deleted
+bool isFullyDeleted(ParagraphList const & pars);
 
+} // namespace lyx
 
 #endif // PARAGRAPH_FUNCS_H