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/types.h"
21 #include "support/strfwd.h"
22 #include "support/Length.h"
33 class ParagraphParameters {
36 ParagraphParameters();
40 bool sameLayout(ParagraphParameters const &) const;
42 Spacing const & spacing() const;
44 void spacing(Spacing const &);
46 bool noindent() const;
50 LyXAlignment align() const;
52 void align(LyXAlignment);
54 depth_type depth() const;
56 void depth(depth_type);
58 bool startOfAppendix() const;
60 void startOfAppendix(bool);
62 bool appendix() const;
66 docstring const & labelString() const;
68 void labelString(docstring const &);
70 docstring const & labelWidthString() const;
72 void labelWidthString(docstring const &);
74 Length const & leftIndent() const;
76 void leftIndent(Length const &);
78 /// read the parameters from a string
79 void read (std::string const & str, bool merge = true);
81 /// read the parameters from a lex
82 void read(Lexer & lex, bool merge = true);
85 void apply(ParagraphParameters const & params, Layout const & layout);
87 // It would be nice to have a working version of this method, so that
88 // getStatus() could return information about what was possible.
89 // bool canApply(ParagraphParameters const & params, Layout const & layout)
92 /// write out the parameters to a stream
93 void write(std::ostream & os) const;
101 bool start_of_appendix_;
109 docstring labelstring_;
111 docstring labelwidthstring_;
118 /** Generate a string \param data from \param par's ParagraphParameters.
119 The function also generates some additional info needed by the
122 void params2string(Paragraph const & par, std::string & data);