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 InsetVSpace::~InsetVSpace()
58 hideDialogs("vspace", this);
62 void InsetVSpace::doDispatch(Cursor & cur, FuncRequest & cmd)
66 case LFUN_INSET_MODIFY: {
67 InsetVSpace::string2params(to_utf8(cmd.argument()), space_);
72 Inset::doDispatch(cur, cmd);
78 bool InsetVSpace::getStatus(Cursor & cur, FuncRequest const & cmd,
79 FuncStatus & status) const
83 case LFUN_INSET_MODIFY:
84 if (cmd.getArg(0) == "vspace") {
86 InsetVSpace::string2params(to_utf8(cmd.argument()), vspace);
87 status.setOnOff(vspace == space_);
89 status.setEnabled(true);
93 return Inset::getStatus(cur, cmd, status);
98 bool InsetVSpace::showInsetDialog(BufferView * bv) const
100 bv->showDialog("vspace", params2string(space()),
101 const_cast<InsetVSpace *>(this));
106 void InsetVSpace::read(Lexer & lex)
108 LASSERT(lex.isOK(), /**/);
112 space_ = VSpace(vsp);
113 lex >> "\\end_inset";
117 void InsetVSpace::write(ostream & os) const
119 os << "VSpace " << space_.asLyXCommand();
123 docstring const InsetVSpace::label() const
125 static docstring const label = _("Vertical Space");
126 return label + " (" + space_.asGUIName() + ')';
131 int const vspace_arrow_size = 4;
135 void InsetVSpace::metrics(MetricsInfo & mi, Dimension & dim) const
137 int height = 3 * vspace_arrow_size;
138 if (space_.length().len().value() >= 0.0)
139 height = max(height, space_.inPixels(*mi.base.bv));
148 theFontMetrics(font).rectText(label(), w, a, d);
150 height = max(height, a + d);
152 dim.asc = height / 2 + (a - d) / 2; // align cursor with the
153 dim.des = height - dim.asc; // label text
154 dim.wid = ADD_TO_VSPACE_WIDTH + 2 * vspace_arrow_size + 5 + w;
155 // Cache the inset dimension.
156 setDimCache(mi, dim);
160 void InsetVSpace::draw(PainterInfo & pi, int x, int y) const
162 Dimension const dim = dimension(*pi.base.bv);
163 x += ADD_TO_VSPACE_WIDTH;
164 int const start = y - dim.asc;
165 int const end = y + dim.des;
167 // y-values for top arrow
169 // y-values for bottom arrow
172 if (space_.kind() == VSpace::VFILL) {
176 // adding or removing space
177 bool const added = space_.kind() != VSpace::LENGTH ||
178 space_.length().len().value() >= 0.0;
179 ty1 = added ? (start + vspace_arrow_size) : start;
180 ty2 = added ? start : (start + vspace_arrow_size);
181 by1 = added ? (end - vspace_arrow_size) : end;
182 by2 = added ? end : (end - vspace_arrow_size);
185 int const midx = x + vspace_arrow_size;
186 int const rightx = midx + vspace_arrow_size;
194 font.setColor(Color_added_space);
197 docstring const lab = label();
198 theFontMetrics(font).rectText(lab, w, a, d);
200 pi.pain.rectText(x + 2 * vspace_arrow_size + 5,
201 start + (end - start) / 2 + (a - d) / 2,
202 lab, font, Color_none, Color_none);
205 pi.pain.line(x, ty1, midx, ty2, Color_added_space);
206 pi.pain.line(midx, ty2, rightx, ty1, Color_added_space);
209 pi.pain.line(x, by1, midx, by2, Color_added_space);
210 pi.pain.line(midx, by2, rightx, by1, Color_added_space);
213 pi.pain.line(midx, ty2, midx, by2, Color_added_space);
217 int InsetVSpace::latex(odocstream & os, OutputParams const &) const
219 os << from_ascii(space_.asLatexCommand(buffer().params())) << '\n';
224 int InsetVSpace::plaintext(odocstream & os, OutputParams const &) const
227 return PLAINTEXT_NEWLINE;
231 int InsetVSpace::docbook(odocstream & os, OutputParams const &) const
238 docstring InsetVSpace::xhtml(XHTMLStream &, OutputParams const &) const
240 odocstringstream ods;
241 XHTMLStream xds(ods);
242 string const len = space_.asHTMLLength();
243 string const attr = "style='height:" + (len.empty() ? "1em" : len) + "'";
244 xds << html::StartTag("div", attr, true) << html::EndTag("div");
249 docstring InsetVSpace::contextMenu(BufferView const &, int, int) const
251 return from_ascii("context-vspace");
255 void InsetVSpace::string2params(string const & in, VSpace & vspace)
261 istringstream data(in);
264 lex.setContext("InsetVSpace::string2params");
265 lex >> "vspace" >> vspace;
269 string InsetVSpace::params2string(VSpace const & vspace)
272 data << "vspace" << ' ' << vspace.asLyXCommand();