src/ParagraphParameters.h

   1 // -*- C++ -*-
   2 /**
   3  * \file ParagraphParameters.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  * \author Angus Leeming
   9  * \author John Levon
  10  *
  11  * Full author contact details are available in file CREDITS.
  12  */
  13
  14 #ifndef PARAGRAPHPARAMETERS_H
  15 #define PARAGRAPHPARAMETERS_H
  16
  17 #include "LayoutEnums.h"
  18 #include "Length.h"
  19 #include "Spacing.h"
  20
  21 #include "support/debug.h"
  22 #include "support/types.h"
  23 #include "support/docstring.h"
  24
  25
  26 namespace lyx {
  27
  28 class BufferView;
  29 class Layout;
  30 class Length;
  31 class Lexer;
  32 class Paragraph;
  33 class Spacing;
  34
  35
  36 ///
  37 class ParagraphParameters {
  38 public:
  39         ///
  40         ParagraphParameters();
  41         ///
  42         friend LyXErr & operator<<(LyXErr & os, ParagraphParameters const & cur);
  43         ///
  44         void clear();
  45         ///
  46         bool sameLayout(ParagraphParameters const &) const;
  47         ///
  48         Spacing const & spacing() const;
  49         ///
  50         void spacing(Spacing const &);
  51         ///
  52         bool noindent() const;
  53         ///
  54         void noindent(bool);
  55         ///
  56         LyXAlignment align() const;
  57         ///
  58         void align(LyXAlignment);
  59         ///
  60         depth_type depth() const;
  61         ///
  62         void depth(depth_type);
  63         ///
  64         bool startOfAppendix() const;
  65         ///
  66         void startOfAppendix(bool);
  67         ///
  68         bool appendix() const;
  69         ///
  70         void appendix(bool);
  71         ///
  72         docstring const & labelString() const;
  73         ///
  74         void labelString(docstring const &);
  75         ///
  76         docstring const & labelWidthString() const;
  77         ///
  78         void labelWidthString(docstring const &);
  79         ///
  80         Length const & leftIndent() const;
  81         ///
  82         void leftIndent(Length const &);
  83
  84         /// read the parameters from a string
  85         void read (std::string str, bool merge = true);
  86
  87         /// read the parameters from a lex
  88         void read(Lexer & lex, bool merge = true);
  89
  90         ///
  91         void apply(ParagraphParameters const & params, Layout const & layout);
  92
  93         // It would be nice to have a working version of this method, so that
  94         // getStatus() could return information about what was possible.
  95         // bool canApply(ParagraphParameters const & params, Layout const & layout)
  96         //      { return true; }
  97
  98         /// write out the parameters to a stream
  99         void write(std::ostream & os) const;
 100
 101 private:
 102         ///
 103         Spacing spacing_;
 104         ///
 105         bool noindent_;
 106         ///
 107         bool start_of_appendix_;
 108         ///
 109         bool appendix_;
 110         ///
 111         LyXAlignment align_;
 112         ///
 113         depth_type depth_;
 114         ///
 115         docstring labelstring_;
 116         ///
 117         docstring labelwidthstring_;
 118         ///
 119         Length leftindent_;
 120 };
 121
 122
 123
 124 /** Generate a string \param data from \param par's ParagraphParameters.
 125     The function also generates some additional info needed by the
 126     Paragraph dialog.
 127  */
 128 void params2string(Paragraph const & par, std::string & data);
 129
 130
 131 } // namespace lyx
 132
 133 #endif