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"
18 #include "tex-strings.h"
22 #include "BufferView.h"
27 #include "frontends/LyXView.h"
29 #include "support/lstrings.h"
32 using namespace lyx::support;
36 // Initialize static member var.
37 ShareContainer<ParameterStruct> ParagraphParameters::container;
39 ParagraphParameters::ParagraphParameters()
46 void ParagraphParameters::clear()
48 ParameterStruct tmp(*param);
50 tmp.line_bottom = false;
51 tmp.pagebreak_top = false;
52 tmp.pagebreak_bottom = false;
53 tmp.added_space_top = VSpace(VSpace::NONE);
54 tmp.added_space_bottom = VSpace(VSpace::NONE);
55 tmp.spacing.set(Spacing::Default);
56 tmp.align = LYX_ALIGN_LAYOUT;
59 tmp.labelstring.erase();
60 tmp.labelwidthstring.erase();
61 tmp.start_of_appendix = false;
66 bool ParagraphParameters::sameLayout(ParagraphParameters const & pp) const
68 return param->align == pp.param->align &&
69 param->line_bottom == pp.param->line_bottom &&
70 param->pagebreak_bottom == pp.param->pagebreak_bottom &&
71 param->added_space_bottom == pp.param->added_space_bottom &&
73 param->line_top == pp.param->line_top &&
74 param->pagebreak_top == pp.param->pagebreak_top &&
75 param->added_space_top == pp.param->added_space_top &&
76 param->spacing == pp.param->spacing &&
77 param->noindent == pp.param->noindent &&
78 param->depth == pp.param->depth;
82 void ParagraphParameters::set_from_struct(ParameterStruct const & ps)
84 // get new param from container with tmp as template
85 param = container.get(ps);
89 VSpace const & ParagraphParameters::spaceTop() const
91 return param->added_space_top;
95 void ParagraphParameters::spaceTop(VSpace const & vs)
97 ParameterStruct tmp(*param);
98 tmp.added_space_top = vs;
103 VSpace const & ParagraphParameters::spaceBottom() const
105 return param->added_space_bottom;
109 void ParagraphParameters::spaceBottom(VSpace const & vs)
111 ParameterStruct tmp(*param);
112 tmp.added_space_bottom = vs;
113 set_from_struct(tmp);
117 Spacing const & ParagraphParameters::spacing() const
119 return param->spacing;
123 void ParagraphParameters::spacing(Spacing const & s)
125 ParameterStruct tmp(*param);
127 set_from_struct(tmp);
131 bool ParagraphParameters::noindent() const
133 return param->noindent;
137 void ParagraphParameters::noindent(bool ni)
139 ParameterStruct tmp(*param);
141 set_from_struct(tmp);
145 bool ParagraphParameters::lineTop() const
147 return param->line_top;
151 void ParagraphParameters::lineTop(bool lt)
153 ParameterStruct tmp(*param);
155 set_from_struct(tmp);
159 bool ParagraphParameters::lineBottom() const
161 return param->line_bottom;
165 void ParagraphParameters::lineBottom(bool lb)
167 ParameterStruct tmp(*param);
168 tmp.line_bottom = lb;
169 set_from_struct(tmp);
173 bool ParagraphParameters::pagebreakTop() const
175 return param->pagebreak_top;
179 void ParagraphParameters::pagebreakTop(bool pbt)
181 ParameterStruct tmp(*param);
182 tmp.pagebreak_top = pbt;
183 set_from_struct(tmp);
187 bool ParagraphParameters::pagebreakBottom() const
189 return param->pagebreak_bottom;
193 void ParagraphParameters::pagebreakBottom(bool pbb)
195 ParameterStruct tmp(*param);
196 tmp.pagebreak_bottom = pbb;
197 set_from_struct(tmp);
201 LyXAlignment ParagraphParameters::align() const
207 void ParagraphParameters::align(LyXAlignment la)
209 ParameterStruct tmp(*param);
211 set_from_struct(tmp);
215 void ParagraphParameters::depth(depth_type d)
217 ParameterStruct tmp(*param);
219 set_from_struct(tmp);
223 bool ParagraphParameters::startOfAppendix() const
225 return param->start_of_appendix;
229 void ParagraphParameters::startOfAppendix(bool soa)
231 ParameterStruct tmp(*param);
232 tmp.start_of_appendix = soa;
233 set_from_struct(tmp);
237 bool ParagraphParameters::appendix() const
239 return param->appendix;
243 void ParagraphParameters::appendix(bool a)
245 ParameterStruct tmp(*param);
247 set_from_struct(tmp);
251 string const & ParagraphParameters::labelString() const
253 return param->labelstring;
257 void ParagraphParameters::labelString(string const & ls)
259 ParameterStruct tmp(*param);
260 tmp.labelstring = ls;
261 set_from_struct(tmp);
265 string const & ParagraphParameters::labelWidthString() const
267 return param->labelwidthstring;
271 void ParagraphParameters::labelWidthString(string const & lws)
273 ParameterStruct tmp(*param);
274 tmp.labelwidthstring = lws;
275 set_from_struct(tmp);
279 LyXLength const & ParagraphParameters::leftIndent() const
281 return param->leftindent;
285 void ParagraphParameters::leftIndent(LyXLength const & li)
287 ParameterStruct tmp(*param);
289 set_from_struct(tmp);
293 void ParagraphParameters::read(LyXLex & lex)
297 string const token = lex.getString();
302 if (token[0] != '\\') {
303 lex.pushToken(token);
307 if (token == "\\noindent") {
309 } else if (token == "\\leftindent") {
311 LyXLength value(lex.getString());
313 } else if (token == "\\fill_top") {
314 spaceTop(VSpace(VSpace::VFILL));
315 } else if (token == "\\fill_bottom") {
316 spaceBottom(VSpace(VSpace::VFILL));
317 } else if (token == "\\line_top") {
319 } else if (token == "\\line_bottom") {
321 } else if (token == "\\pagebreak_top") {
323 } else if (token == "\\pagebreak_bottom") {
324 pagebreakBottom(true);
325 } else if (token == "\\start_of_appendix") {
326 startOfAppendix(true);
327 } else if (token == "\\paragraph_spacing") {
329 string const tmp = rtrim(lex.getString());
330 if (tmp == "single") {
331 spacing(Spacing(Spacing::Single));
332 } else if (tmp == "onehalf") {
333 spacing(Spacing(Spacing::Onehalf));
334 } else if (tmp == "double") {
335 spacing(Spacing(Spacing::Double));
336 } else if (tmp == "other") {
338 spacing(Spacing(Spacing::Other,
341 lex.printError("Unknown spacing token: '$$Token'");
343 } else if (token == "\\align") {
344 int tmpret = lex.findToken(string_align);
347 align(LyXAlignment(1 << tmpret));
348 } else if (token == "\\added_space_top") {
350 VSpace value = VSpace(lex.getString());
351 // only add the length when value > 0 or
353 if ((value.length().len().value() != 0) ||
355 (value.kind() != VSpace::LENGTH))
357 } else if (token == "\\added_space_bottom") {
359 VSpace value = VSpace(lex.getString());
360 // only add the length when value > 0 or
362 if ((value.length().len().value() != 0) ||
364 (value.kind() != VSpace::LENGTH))
366 } else if (token == "\\labelwidthstring") {
368 labelWidthString(lex.getString());
370 lex.pushToken(token);
377 void ParagraphParameters::write(ostream & os) const
379 // Maybe some vertical spaces.
380 if (spaceTop().kind() != VSpace::NONE)
381 os << "\\added_space_top "
382 << spaceTop().asLyXCommand() << ' ';
383 if (spaceBottom().kind() != VSpace::NONE)
384 os << "\\added_space_bottom "
385 << spaceBottom().asLyXCommand() << ' ';
387 // Maybe the paragraph has special spacing
388 spacing().writeFile(os, true);
390 // The labelwidth string used in lists.
391 if (!labelWidthString().empty())
392 os << "\\labelwidthstring "
393 << labelWidthString() << '\n';
395 // Lines above or below?
399 os << "\\line_bottom ";
401 // Pagebreaks above or below?
403 os << "\\pagebreak_top ";
404 if (pagebreakBottom())
405 os << "\\pagebreak_bottom ";
407 // Start of appendix?
408 if (startOfAppendix())
409 os << "\\start_of_appendix ";
415 // Do we have a manual left indent?
416 if (!leftIndent().zero())
417 os << "\\leftindent " << leftIndent().asString()
421 if (align() != LYX_ALIGN_LAYOUT) {
424 case LYX_ALIGN_LEFT: h = 1; break;
425 case LYX_ALIGN_RIGHT: h = 2; break;
426 case LYX_ALIGN_CENTER: h = 3; break;
427 default: h = 0; break;
429 os << "\\align " << string_align[h] << ' ';
435 void setParagraphParams(BufferView & bv, string const & data)
437 istringstream is(STRCONV(data));
441 ParagraphParameters params;
444 LyXText * text = bv.getLyXText();
445 text->setParagraph(params.lineTop(),
447 params.pagebreakTop(),
448 params.pagebreakBottom(),
450 params.spaceBottom(),
453 params.labelWidthString(),
457 bv.owner()->message(_("Paragraph layout set"));
461 void params2string(Paragraph const & par, string & data)
464 ParagraphParameters params = par.params();
466 // This needs to be done separately
467 params.labelWidthString(par.getLabelWidthString());
470 LyXLayout_ptr const & layout = par.layout();
471 if (params.align() == LYX_ALIGN_LAYOUT)
472 params.align(layout->align);
477 // Is alignment possible
478 os << '\n' << "\\alignpossible " << layout->alignpossible << '\n';
480 /// set default alignment
481 os << "\\aligndefault " << layout->align << '\n';
483 /// is paragraph in inset
484 os << "\\ininset " << (par.inInset()?1:0) << '\n';
486 data = STRCONV(os.str());