*
* \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 "paragraph.h"
#include "support/types.h"
+
+namespace lyx {
+
class Buffer;
class BufferParams;
-class TexRow;
-class LatexRunParams;
-class LyXLex;
+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 chenge layout to default layout when
+ * keep_layout == false
+ * - keep current depth and layout when keep_layout == true
+ * 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,
- 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,
- Paragraph::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);
-void latexParagraphs(Buffer const * buf,
- ParagraphList const & paragraphs,
- std::ostream & ofs,
- TexRow & texrow,
- LatexRunParams const &,
- bool moving_arg,
- string const & everypar = string());
+/**
+ * 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);
-/// read a paragraph from a .lyx file. Returns number of unrecognised tokens
-int readParagraph(Buffer & buf, Paragraph & par, LyXLex & lex);
+/// accept the changes within the complete ParagraphList
+void acceptChanges(ParagraphList & pars, BufferParams const & bparams);
-LyXFont const realizeFont(LyXFont const & font,
- BufferParams const & params);
-LyXFont const outerFont(ParagraphList::iterator pit,
- ParagraphList const & plist);
+} // namespace lyx
#endif // PARAGRAPH_FUNCS_H