X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2Fparagraph_funcs.h;h=3686b36c8429da962807f522ca8bcc50b02bcad1;hb=9ee46b846e5e84ad40ceda4f4af94aeb86cd90a2;hp=5d2a051384d3a0aadde3e6c48ef72c6b22f66cf9;hpb=38b325846cca955100f02b49456c3f6450ab73b6;p=lyx.git diff --git a/src/paragraph_funcs.h b/src/paragraph_funcs.h index 5d2a051384..3686b36c84 100644 --- a/src/paragraph_funcs.h +++ b/src/paragraph_funcs.h @@ -1,54 +1,71 @@ // -*- C++ -*- -/* This file is part of - * ====================================================== - * - * LyX, The Document Processor - * - * Copyright 1995 Matthias Ettrich - * Copyright 1995-2001 The LyX Team. +/** + * \file paragraph_funcs.h + * This file is part of LyX, the document processor. + * Licence details can be found in the file COPYING. * - * ====================================================== */ + * \author Lars Gullik Bjønnes + * + * 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" +class Buffer; class BufferParams; +class InsetBase; +class LyXFont; +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, - Paragraph *, + ParagraphList & paragraphs, + lyx::pit_type par, lyx::pos_type pos, int flag); /// void breakParagraphConservative(BufferParams const & bparams, - Paragraph *, + ParagraphList & paragraphs, + lyx::pit_type par, lyx::pos_type pos); -#if 0 -/** Paste this paragraph with the next one. - Be carefull, this doesent make any check at all. -*/ -void pasteParagraph(BufferParams const & bparams, - Paragraph *); +/** + * 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, lyx::pit_type par); /// for the environments -Paragraph * depthHook(Paragraph * par, Paragraph::depth_type depth); +lyx::pit_type depthHook(lyx::pit_type par, + ParagraphList const & plist, lyx::depth_type depth); -Paragraph * outerHook(Paragraph * par); +lyx::pit_type outerHook(lyx::pit_type par, ParagraphList const & plist); /// Is it the first par with same depth and layout? -bool isFirstInSequence(Paragraph * par); +bool isFirstInSequence(lyx::pit_type par, ParagraphList const & plist); /** Check if the current paragraph is the last paragraph in a proof environment */ -int getEndLabel(Paragraph * para, BufferParams const & bparams); -#endif +int getEndLabel(lyx::pit_type par, ParagraphList const & plist); + +LyXFont const outerFont(lyx::pit_type par_offset, ParagraphList const & pars); + +/// return the number of InsetOptArg in a paragraph +int numberOfOptArgs(Paragraph const & par); -#endif +#endif // PARAGRAPH_FUNCS_H