2 * \file InsetVSpace.cpp
3 * This file is part of LyX, the document processor.
4 * Licence details can be found in the file COPYING.
9 * Full author contact details are available in file CREDITS.
14 #include "InsetVSpace.h"
17 #include "BufferView.h"
19 #include "Dimension.h"
20 #include "DispatchResult.h"
21 #include "FuncRequest.h"
22 #include "FuncStatus.h"
24 #include "MetricsInfo.h"
25 #include "OutputParams.h"
26 #include "output_xhtml.h"
27 #include "texstream.h"
30 #include "support/debug.h"
31 #include "support/docstream.h"
32 #include "support/gettext.h"
33 #include "support/lassert.h"
35 #include "frontends/Application.h"
36 #include "frontends/FontMetrics.h"
37 #include "frontends/Painter.h"
47 int const ADD_TO_VSPACE_WIDTH = 5;
52 InsetVSpace::InsetVSpace(VSpace const & space)
53 : Inset(0), space_(space)
57 void InsetVSpace::doDispatch(Cursor & cur, FuncRequest & cmd)
59 switch (cmd.action()) {
61 case LFUN_INSET_MODIFY: {
63 string arg = to_utf8(cmd.argument());
64 if (arg == "vspace custom")
65 arg = (space_.kind() == VSpace::LENGTH)
66 ? "vspace " + space_.length().asString()
67 : "vspace 1" + string(stringFromUnit(Length::defaultUnit()));
68 InsetVSpace::string2params(arg, space_);
73 Inset::doDispatch(cur, cmd);
79 bool InsetVSpace::getStatus(Cursor & cur, FuncRequest const & cmd,
80 FuncStatus & status) const
82 switch (cmd.action()) {
84 case LFUN_INSET_MODIFY:
85 if (cmd.getArg(0) == "vspace") {
87 string arg = to_utf8(cmd.argument());
88 if (arg == "vspace custom")
89 arg = (space_.kind() == VSpace::LENGTH)
90 ? "vspace " + space_.length().asString()
91 : "vspace 1" + string(stringFromUnit(Length::defaultUnit()));
92 InsetVSpace::string2params(arg, vspace);
93 status.setOnOff(vspace == space_);
95 status.setEnabled(true);
99 return Inset::getStatus(cur, cmd, status);
104 void InsetVSpace::read(Lexer & lex)
106 LASSERT(lex.isOK(), return);
110 space_ = VSpace(vsp);
111 lex >> "\\end_inset";
115 void InsetVSpace::write(ostream & os) const
117 os << "VSpace " << space_.asLyXCommand();
121 docstring const InsetVSpace::label() const
123 static docstring const label = _("Vertical Space");
124 return label + " (" + space_.asGUIName() + ')';
129 int const vspace_arrow_size = 4;
133 void InsetVSpace::metrics(MetricsInfo & mi, Dimension & dim) const
135 int height = 3 * vspace_arrow_size;
136 if (space_.length().len().value() >= 0.0)
137 height = max(height, space_.inPixels(*mi.base.bv));
146 theFontMetrics(font).rectText(label(), w, a, d);
148 height = max(height, a + d);
150 dim.asc = height / 2 + (a - d) / 2; // align cursor with the
151 dim.des = height - dim.asc; // label text
152 dim.wid = ADD_TO_VSPACE_WIDTH + 2 * vspace_arrow_size + 5 + w;
153 // Cache the inset dimension.
154 setDimCache(mi, dim);
158 void InsetVSpace::draw(PainterInfo & pi, int x, int y) const
160 Dimension const dim = dimension(*pi.base.bv);
161 x += ADD_TO_VSPACE_WIDTH;
162 int const start = y - dim.asc;
163 int const end = y + dim.des;
165 // y-values for top arrow
167 // y-values for bottom arrow
170 if (space_.kind() == VSpace::VFILL) {
174 // adding or removing space
175 bool const added = space_.kind() != VSpace::LENGTH ||
176 space_.length().len().value() >= 0.0;
177 ty1 = added ? (start + vspace_arrow_size) : start;
178 ty2 = added ? start : (start + vspace_arrow_size);
179 by1 = added ? (end - vspace_arrow_size) : end;
180 by2 = added ? end : (end - vspace_arrow_size);
183 int const midx = x + vspace_arrow_size;
184 int const rightx = midx + vspace_arrow_size;
192 font.setColor(Color_added_space);
195 docstring const lab = label();
196 theFontMetrics(font).rectText(lab, w, a, d);
198 pi.pain.rectText(x + 2 * vspace_arrow_size + 5,
199 start + (end - start) / 2 + (a - d) / 2,
200 lab, font, Color_none, Color_none);
203 pi.pain.line(x, ty1, midx, ty2, Color_added_space);
204 pi.pain.line(midx, ty2, rightx, ty1, Color_added_space);
207 pi.pain.line(x, by1, midx, by2, Color_added_space);
208 pi.pain.line(midx, by2, rightx, by1, Color_added_space);
211 pi.pain.line(midx, ty2, midx, by2, Color_added_space);
215 void InsetVSpace::latex(otexstream & os, OutputParams const &) const
217 os << from_ascii(space_.asLatexCommand(buffer().params())) << '\n';
221 int InsetVSpace::plaintext(odocstringstream & os,
222 OutputParams const &, size_t) const
225 return PLAINTEXT_NEWLINE;
229 int InsetVSpace::docbook(odocstream & os, OutputParams const &) const
236 docstring InsetVSpace::xhtml(XHTMLStream & os, OutputParams const &) const
238 string const len = space_.asHTMLLength();
239 string const attr = "style='height:" + (len.empty() ? "1em" : len) + "'";
240 os << html::StartTag("div", attr, true) << html::EndTag("div");
245 string InsetVSpace::contextMenuName() const
247 return "context-vspace";
251 void InsetVSpace::string2params(string const & in, VSpace & vspace)
257 istringstream data(in);
260 lex.setContext("InsetVSpace::string2params");
261 lex >> "vspace" >> vspace;
265 string InsetVSpace::params2string(VSpace const & vspace)
268 data << "vspace" << ' ' << vspace.asLyXCommand();