3 * \file ParagraphParameters.h
4 * This file is part of LyX, the document processor.
5 * Licence details can be found in the file COPYING.
7 * \author Lars Gullik Bjønnes
8 * \author Angus Leeming
11 * Full author contact details are available in file CREDITS.
14 #ifndef PARAGRAPHPARAMETERS_H
15 #define PARAGRAPHPARAMETERS_H
17 #include "LayoutEnums.h"
20 #include "support/debug.h"
21 #include "support/types.h"
22 #include "support/docstring.h"
23 #include "support/Length.h"
37 class ParagraphParameters {
40 ParagraphParameters();
44 bool sameLayout(ParagraphParameters const &) const;
46 Spacing const & spacing() const;
48 void spacing(Spacing const &);
50 bool noindent() const;
54 LyXAlignment align() const;
56 void align(LyXAlignment);
58 depth_type depth() const;
60 void depth(depth_type);
62 bool startOfAppendix() const;
64 void startOfAppendix(bool);
66 bool appendix() const;
70 docstring const & labelString() const;
72 void labelString(docstring const &);
74 docstring const & labelWidthString() const;
76 void labelWidthString(docstring const &);
78 Length const & leftIndent() const;
80 void leftIndent(Length const &);
82 /// read the parameters from a string
83 void read (std::string str, bool merge = true);
85 /// read the parameters from a lex
86 void read(Lexer & lex, bool merge = true);
89 void apply(ParagraphParameters const & params, Layout const & layout);
91 // It would be nice to have a working version of this method, so that
92 // getStatus() could return information about what was possible.
93 // bool canApply(ParagraphParameters const & params, Layout const & layout)
96 /// write out the parameters to a stream
97 void write(std::ostream & os) const;
105 bool start_of_appendix_;
113 docstring labelstring_;
115 docstring labelwidthstring_;
122 /** Generate a string \param data from \param par's ParagraphParameters.
123 The function also generates some additional info needed by the
126 void params2string(Paragraph const & par, std::string & data);