2 * \file ParagraphParameters.C
3 * This file is part of LyX, the document processor.
4 * Licence details can be found in the file COPYING.
6 * \author Lars Gullik Bjønnes
7 * \author Angus Leeming
10 * \author Jürgen Vigna
12 * Full author contact details are available in file CREDITS.
17 #include "ParagraphParameters.h"
21 #include "lyxlayout.h"
24 #include "paragraph.h"
25 #include "tex-strings.h"
27 #include "support/lstrings.h"
35 using std::istringstream;
37 using std::ostringstream;
41 static int findToken(char const * const str[], string const & search_token)
43 return search_token == "default" ?
45 support::findToken(str, search_token);
49 ParagraphParameters::ParagraphParameters()
51 start_of_appendix_(false), appendix_(false),
52 align_(LYX_ALIGN_LAYOUT), depth_(0)
56 void ParagraphParameters::clear()
58 operator=(ParagraphParameters());
62 depth_type ParagraphParameters::depth() const
68 bool ParagraphParameters::sameLayout(ParagraphParameters const & pp) const
70 return align_ == pp.align_
71 && spacing_ == pp.spacing_
72 && noindent_ == pp.noindent_
73 && depth_ == pp.depth_;
77 Spacing const & ParagraphParameters::spacing() const
83 void ParagraphParameters::spacing(Spacing const & s)
89 bool ParagraphParameters::noindent() const
95 void ParagraphParameters::noindent(bool ni)
101 LyXAlignment ParagraphParameters::align() const
107 void ParagraphParameters::align(LyXAlignment la)
113 void ParagraphParameters::depth(depth_type d)
119 bool ParagraphParameters::startOfAppendix() const
121 return start_of_appendix_;
125 void ParagraphParameters::startOfAppendix(bool soa)
127 start_of_appendix_ = soa;
131 bool ParagraphParameters::appendix() const
137 void ParagraphParameters::appendix(bool a)
143 docstring const & ParagraphParameters::labelString() const
149 void ParagraphParameters::labelString(docstring const & ls)
155 docstring const & ParagraphParameters::labelWidthString() const
157 return labelwidthstring_;
161 void ParagraphParameters::labelWidthString(docstring const & lws)
163 labelwidthstring_ = lws;
167 LyXLength const & ParagraphParameters::leftIndent() const
173 void ParagraphParameters::leftIndent(LyXLength const & li)
179 void ParagraphParameters::read(LyXLex & lex)
183 string const token = lex.getString();
188 if (token[0] != '\\') {
189 lex.pushToken(token);
193 if (token == "\\noindent") {
195 } else if (token == "\\leftindent") {
197 LyXLength value(lex.getString());
199 } else if (token == "\\start_of_appendix") {
200 startOfAppendix(true);
201 } else if (token == "\\paragraph_spacing") {
203 string const tmp = rtrim(lex.getString());
204 if (tmp == "single") {
205 spacing(Spacing(Spacing::Single));
206 } else if (tmp == "onehalf") {
207 spacing(Spacing(Spacing::Onehalf));
208 } else if (tmp == "double") {
209 spacing(Spacing(Spacing::Double));
210 } else if (tmp == "other") {
212 spacing(Spacing(Spacing::Other,
215 lex.printError("Unknown spacing token: '$$Token'");
217 } else if (token == "\\align") {
219 int tmpret = findToken(string_align, lex.getString());
222 align(LyXAlignment(1 << tmpret));
223 } else if (token == "\\labelwidthstring") {
225 labelWidthString(lex.getDocString());
227 lex.pushToken(token);
234 void ParagraphParameters::write(ostream & os) const
236 // Maybe the paragraph has special spacing
237 spacing().writeFile(os, true);
239 // The labelwidth string used in lists.
240 if (!labelWidthString().empty())
241 os << "\\labelwidthstring "
242 << to_utf8(labelWidthString()) << '\n';
244 // Start of appendix?
245 if (startOfAppendix())
246 os << "\\start_of_appendix\n";
250 os << "\\noindent\n";
252 // Do we have a manual left indent?
253 if (!leftIndent().zero())
254 os << "\\leftindent " << leftIndent().asString() << '\n';
257 if (align() != LYX_ALIGN_LAYOUT) {
260 case LYX_ALIGN_LEFT: h = 1; break;
261 case LYX_ALIGN_RIGHT: h = 2; break;
262 case LYX_ALIGN_CENTER: h = 3; break;
263 default: h = 0; break;
265 os << "\\align " << string_align[h] << '\n';
270 void params2string(Paragraph const & par, string & data)
273 ParagraphParameters params = par.params();
275 // This needs to be done separately
276 params.labelWidthString(par.getLabelWidthString());
279 LyXLayout_ptr const & layout = par.layout();
280 if (params.align() == LYX_ALIGN_LAYOUT)
281 params.align(layout->align);
286 // Is alignment possible
287 os << "\\alignpossible " << layout->alignpossible << '\n';
289 /// set default alignment
290 os << "\\aligndefault " << layout->align << '\n';
292 /// paragraph is always in inset. This is redundant.
293 os << "\\ininset " << 1 << '\n';
300 bool operator==(ParagraphParameeters const & ps1,
301 ParagraphParameeters const & ps2)
304 ps1.spacing == ps2.spacing
305 && ps1.noindent == ps2.noindent
306 && ps1.align == ps2.align
307 && ps1.depth == ps2.depth
308 && ps1.start_of_appendix == ps2.start_of_appendix
309 && ps1.appendix == ps2.appendix
310 && ps1.labelstring == ps2.labelstring
311 && ps1.labelwidthstring == ps2.labelwidthstring
312 && ps1.leftindent == ps2.leftindent;