X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2Fparagraph_funcs.h;h=3593a65d24b2e9be8a1c3646eb5a8801c7e40bff;hb=ef1a53c4929133e2d261a78a62cbbd87a687ca14;hp=6a573f458fc35dbe4dcd22db83586828951fa533;hpb=68b7ef25fb7d2da230d3eb11d6737701abfc2e64;p=lyx.git diff --git a/src/paragraph_funcs.h b/src/paragraph_funcs.h index 6a573f458f..3593a65d24 100644 --- a/src/paragraph_funcs.h +++ b/src/paragraph_funcs.h @@ -14,6 +14,9 @@ #include "support/types.h" + +namespace lyx { + class Buffer; class BufferParams; class InsetBase; @@ -21,53 +24,58 @@ 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, ParagraphList & paragraphs, - lyx::par_type par, - lyx::pos_type pos, + pit_type par, + pos_type pos, int flag); /// void breakParagraphConservative(BufferParams const & bparams, ParagraphList & paragraphs, - lyx::par_type 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, lyx::par_type par); + ParagraphList & paragraphs, pit_type par); /// for the environments -lyx::par_type depthHook(lyx::par_type par, - ParagraphList const & plist, lyx::depth_type depth); +pit_type depthHook(pit_type par, + ParagraphList const & plist, depth_type depth); -lyx::par_type outerHook(lyx::par_type par, ParagraphList const & plist); +pit_type outerHook(pit_type par, ParagraphList const & plist); /// Is it the first par with same depth and layout? -bool isFirstInSequence(lyx::par_type 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(lyx::par_type par, ParagraphList const & plist); +int getEndLabel(pit_type par, ParagraphList const & plist); -LyXFont const outerFont(lyx::par_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. + */ +LyXFont const outerFont(pit_type par_offset, ParagraphList const & pars); -/// find outermost paragraph containing an inset -lyx::par_type outerPar(Buffer const & buf, InsetBase const * inset); +/// return the number of InsetOptArg in a paragraph +int numberOfOptArgs(Paragraph const & par); -/// find owning paragraph containing an inset -Paragraph const & ownerPar(Buffer const & buf, InsetBase const * inset); -/// return the range of pars [beg, end[ owning the range of y [ystart, yend] -void getParsInRange(ParagraphList & plist, - int ystart, int yend, - lyx::par_type & beg, - lyx::par_type & end); +} // namespace lyx #endif // PARAGRAPH_FUNCS_H