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 ace89ee07d963e597e2d7f67b7adb8b2ef182b80..067ba94ba1e115c76ada49bd422638d34413e2b6 100644 (file)
--- a/src/paragraph_funcs.h
+++ b/src/paragraph_funcs.h
@@ -4,72 +4,84 @@
  * 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
+ * Full author contact details are available in file CREDITS.
  */
 
 #ifndef PARAGRAPH_FUNCS_H
 #define PARAGRAPH_FUNCS_H
 
-#include "ParagraphList.h"
+#include "support/strfwd.h"
 #include "support/types.h"
 
+
+namespace lyx {
+
 class Buffer;
 class BufferParams;
+class Inset;
+class Font;
 class Paragraph;
-class TexRow;
+class ParagraphList;
 
-///
-void breakParagraph(Buffer * buf,
-                   ParagraphList::iterator par,
-                   lyx::pos_type pos,
-                   int flag);
+/**
+ * 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,
+                   pit_type par,
+                   pos_type pos,
+                   bool keep_layout);
 
 ///
-void breakParagraphConservative(Buffer * buf,
-                               ParagraphList::iterator par,
-                               lyx::pos_type pos);
+void breakParagraphConservative(BufferParams const & bparams,
+                               ParagraphList & paragraphs,
+                               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(Buffer * buf,
-                   ParagraphList::iterator par);
+void mergeParagraph(BufferParams const & bparams,
+       ParagraphList & paragraphs, pit_type par);
 
 
-#if 0
 /// for the environments
-Paragraph * depthHook(Paragraph * par, Paragraph::depth_type depth);
+pit_type depthHook(pit_type par,
+       ParagraphList const & plist, depth_type depth);
 
-Paragraph * outerHook(Paragraph * par);
+pit_type outerHook(pit_type par, ParagraphList const & plist);
 
 /// Is it the first par with same depth and layout?
-bool isFirstInSequence(Paragraph * par);
+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(Paragraph * para, BufferParams const & bparams);
-#endif
-
-ParagraphList::iterator
-TeXDeeper(Buffer const * buf,
-         BufferParams const & bparams,
-         ParagraphList::iterator pit,
-         std::ostream & os, TexRow & texrow);
-
-ParagraphList::iterator
-TeXEnvironment(Buffer const * buf,
-              BufferParams const & bparams,
-              ParagraphList::iterator pit,
-              std::ostream & os, TexRow & texrow);
-
-ParagraphList::iterator
-TeXOnePar(Buffer const * buf,
-         BufferParams const & bparams,
-         ParagraphList::iterator pit,
-         std::ostream & os, TexRow & texrow,
-         bool moving_arg);
+int getEndLabel(pit_type par, ParagraphList const & plist);
+
+/**
+ * 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);
+
+/// 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