src/paragraph_funcs.h

   1 // -*- C++ -*-
   2 /**
   3  * \file paragraph_funcs.h
   4  * This file is part of LyX, the document processor.
   5  * Licence details can be found in the file COPYING.
   6  *
   7  * \author Lars Gullik Bjønnes
   8  *
   9  * Full author contact details are available in file CREDITS.
  10  */
  11
  12 #ifndef PARAGRAPH_FUNCS_H
  13 #define PARAGRAPH_FUNCS_H
  14
  15 #include "support/types.h"
  16
  17
  18 namespace lyx {
  19
  20 class Buffer;
  21 class BufferParams;
  22 class Inset;
  23 class Font;
  24 class Paragraph;
  25 class ParagraphList;
  26
  27 /**
  28  * This breaks a paragraph at the specified position.
  29  * The new paragraph will:
  30  * - Decrease depth by one (or change layout to default layout) when
  31  *    keep_layout == false
  32  * - keep current depth and layout when keep_layout == true
  33  */
  34 void breakParagraph(BufferParams const & bparams,
  35                     ParagraphList & paragraphs,
  36                     pit_type par,
  37                     pos_type pos,
  38                     bool keep_layout);
  39
  40 ///
  41 void breakParagraphConservative(BufferParams const & bparams,
  42                                 ParagraphList & paragraphs,
  43                                 pit_type par,
  44                                 pos_type pos);
  45
  46 /**
  47  * Append the next paragraph onto the tail of this one.
  48  * Be careful, this doesent make any check at all.
  49  */
  50 void mergeParagraph(BufferParams const & bparams,
  51         ParagraphList & paragraphs, pit_type par);
  52
  53
  54 /// for the environments
  55 pit_type depthHook(pit_type par,
  56         ParagraphList const & plist, depth_type depth);
  57
  58 pit_type outerHook(pit_type par, ParagraphList const & plist);
  59
  60 /// Is it the first par with same depth and layout?
  61 bool isFirstInSequence(pit_type par, ParagraphList const & plist);
  62
  63 /** Check if the current paragraph is the last paragraph in a
  64     proof environment */
  65 int getEndLabel(pit_type par, ParagraphList const & plist);
  66
  67 /**
  68  * Get the font of the "environment" of paragraph \p par_offset in \p pars.
  69  * All font changes of the paragraph are relative to this font.
  70  */
  71 Font const outerFont(pit_type par_offset, ParagraphList const & pars);
  72
  73 /// accept the changes within the complete ParagraphList
  74 void acceptChanges(ParagraphList & pars, BufferParams const & bparams);
  75
  76
  77 } // namespace lyx
  78
  79 #endif // PARAGRAPH_FUNCS_H