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"
29 #include "support/debug.h"
30 #include "support/docstream.h"
31 #include "support/gettext.h"
32 #include "support/lassert.h"
34 #include "frontends/Application.h"
35 #include "frontends/FontMetrics.h"
36 #include "frontends/Painter.h"
46 int const ADD_TO_VSPACE_WIDTH = 5;
51 InsetVSpace::InsetVSpace(VSpace const & space)
52 : Inset(0), space_(space)
56 void InsetVSpace::doDispatch(Cursor & cur, FuncRequest & cmd)
58 switch (cmd.action()) {
60 case LFUN_INSET_MODIFY: {
62 InsetVSpace::string2params(to_utf8(cmd.argument()), space_);
67 Inset::doDispatch(cur, cmd);
73 bool InsetVSpace::getStatus(Cursor & cur, FuncRequest const & cmd,
74 FuncStatus & status) const
76 switch (cmd.action()) {
78 case LFUN_INSET_MODIFY:
79 if (cmd.getArg(0) == "vspace") {
81 InsetVSpace::string2params(to_utf8(cmd.argument()), vspace);
82 status.setOnOff(vspace == space_);
84 status.setEnabled(true);
88 return Inset::getStatus(cur, cmd, status);
93 void InsetVSpace::read(Lexer & lex)
95 LASSERT(lex.isOK(), /**/);
100 lex >> "\\end_inset";
104 void InsetVSpace::write(ostream & os) const
106 os << "VSpace " << space_.asLyXCommand();
110 docstring const InsetVSpace::label() const
112 static docstring const label = _("Vertical Space");
113 return label + " (" + space_.asGUIName() + ')';
118 int const vspace_arrow_size = 4;
122 void InsetVSpace::metrics(MetricsInfo & mi, Dimension & dim) const
124 int height = 3 * vspace_arrow_size;
125 if (space_.length().len().value() >= 0.0)
126 height = max(height, space_.inPixels(*mi.base.bv));
135 theFontMetrics(font).rectText(label(), w, a, d);
137 height = max(height, a + d);
139 dim.asc = height / 2 + (a - d) / 2; // align cursor with the
140 dim.des = height - dim.asc; // label text
141 dim.wid = ADD_TO_VSPACE_WIDTH + 2 * vspace_arrow_size + 5 + w;
142 // Cache the inset dimension.
143 setDimCache(mi, dim);
147 void InsetVSpace::draw(PainterInfo & pi, int x, int y) const
149 Dimension const dim = dimension(*pi.base.bv);
150 x += ADD_TO_VSPACE_WIDTH;
151 int const start = y - dim.asc;
152 int const end = y + dim.des;
154 // y-values for top arrow
156 // y-values for bottom arrow
159 if (space_.kind() == VSpace::VFILL) {
163 // adding or removing space
164 bool const added = space_.kind() != VSpace::LENGTH ||
165 space_.length().len().value() >= 0.0;
166 ty1 = added ? (start + vspace_arrow_size) : start;
167 ty2 = added ? start : (start + vspace_arrow_size);
168 by1 = added ? (end - vspace_arrow_size) : end;
169 by2 = added ? end : (end - vspace_arrow_size);
172 int const midx = x + vspace_arrow_size;
173 int const rightx = midx + vspace_arrow_size;
181 font.setColor(Color_added_space);
184 docstring const lab = label();
185 theFontMetrics(font).rectText(lab, w, a, d);
187 pi.pain.rectText(x + 2 * vspace_arrow_size + 5,
188 start + (end - start) / 2 + (a - d) / 2,
189 lab, font, Color_none, Color_none);
192 pi.pain.line(x, ty1, midx, ty2, Color_added_space);
193 pi.pain.line(midx, ty2, rightx, ty1, Color_added_space);
196 pi.pain.line(x, by1, midx, by2, Color_added_space);
197 pi.pain.line(midx, by2, rightx, by1, Color_added_space);
200 pi.pain.line(midx, ty2, midx, by2, Color_added_space);
204 int InsetVSpace::latex(odocstream & os, OutputParams const &) const
206 os << from_ascii(space_.asLatexCommand(buffer().params())) << '\n';
211 int InsetVSpace::plaintext(odocstream & os, OutputParams const &) const
214 return PLAINTEXT_NEWLINE;
218 int InsetVSpace::docbook(odocstream & os, OutputParams const &) const
225 docstring InsetVSpace::xhtml(XHTMLStream &, OutputParams const &) const
227 odocstringstream ods;
228 XHTMLStream xds(ods);
229 string const len = space_.asHTMLLength();
230 string const attr = "style='height:" + (len.empty() ? "1em" : len) + "'";
231 xds << html::StartTag("div", attr, true) << html::EndTag("div");
236 docstring InsetVSpace::contextMenu(BufferView const &, int, int) const
238 return from_ascii("context-vspace");
242 void InsetVSpace::string2params(string const & in, VSpace & vspace)
248 istringstream data(in);
251 lex.setContext("InsetVSpace::string2params");
252 lex >> "vspace" >> vspace;
256 string InsetVSpace::params2string(VSpace const & vspace)
259 data << "vspace" << ' ' << vspace.asLyXCommand();