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: {
61 InsetVSpace::string2params(to_utf8(cmd.argument()), space_);
66 Inset::doDispatch(cur, cmd);
72 bool InsetVSpace::getStatus(Cursor & cur, FuncRequest const & cmd,
73 FuncStatus & status) const
75 switch (cmd.action()) {
77 case LFUN_INSET_MODIFY:
78 if (cmd.getArg(0) == "vspace") {
80 InsetVSpace::string2params(to_utf8(cmd.argument()), vspace);
81 status.setOnOff(vspace == space_);
83 status.setEnabled(true);
87 return Inset::getStatus(cur, cmd, status);
92 void InsetVSpace::read(Lexer & lex)
94 LASSERT(lex.isOK(), /**/);
103 void InsetVSpace::write(ostream & os) const
105 os << "VSpace " << space_.asLyXCommand();
109 docstring const InsetVSpace::label() const
111 static docstring const label = _("Vertical Space");
112 return label + " (" + space_.asGUIName() + ')';
117 int const vspace_arrow_size = 4;
121 void InsetVSpace::metrics(MetricsInfo & mi, Dimension & dim) const
123 int height = 3 * vspace_arrow_size;
124 if (space_.length().len().value() >= 0.0)
125 height = max(height, space_.inPixels(*mi.base.bv));
134 theFontMetrics(font).rectText(label(), w, a, d);
136 height = max(height, a + d);
138 dim.asc = height / 2 + (a - d) / 2; // align cursor with the
139 dim.des = height - dim.asc; // label text
140 dim.wid = ADD_TO_VSPACE_WIDTH + 2 * vspace_arrow_size + 5 + w;
141 // Cache the inset dimension.
142 setDimCache(mi, dim);
146 void InsetVSpace::draw(PainterInfo & pi, int x, int y) const
148 Dimension const dim = dimension(*pi.base.bv);
149 x += ADD_TO_VSPACE_WIDTH;
150 int const start = y - dim.asc;
151 int const end = y + dim.des;
153 // y-values for top arrow
155 // y-values for bottom arrow
158 if (space_.kind() == VSpace::VFILL) {
162 // adding or removing space
163 bool const added = space_.kind() != VSpace::LENGTH ||
164 space_.length().len().value() >= 0.0;
165 ty1 = added ? (start + vspace_arrow_size) : start;
166 ty2 = added ? start : (start + vspace_arrow_size);
167 by1 = added ? (end - vspace_arrow_size) : end;
168 by2 = added ? end : (end - vspace_arrow_size);
171 int const midx = x + vspace_arrow_size;
172 int const rightx = midx + vspace_arrow_size;
180 font.setColor(Color_added_space);
183 docstring const lab = label();
184 theFontMetrics(font).rectText(lab, w, a, d);
186 pi.pain.rectText(x + 2 * vspace_arrow_size + 5,
187 start + (end - start) / 2 + (a - d) / 2,
188 lab, font, Color_none, Color_none);
191 pi.pain.line(x, ty1, midx, ty2, Color_added_space);
192 pi.pain.line(midx, ty2, rightx, ty1, Color_added_space);
195 pi.pain.line(x, by1, midx, by2, Color_added_space);
196 pi.pain.line(midx, by2, rightx, by1, Color_added_space);
199 pi.pain.line(midx, ty2, midx, by2, Color_added_space);
203 int InsetVSpace::latex(odocstream & os, OutputParams const &) const
205 os << from_ascii(space_.asLatexCommand(buffer().params())) << '\n';
210 int InsetVSpace::plaintext(odocstream & os, OutputParams const &) const
213 return PLAINTEXT_NEWLINE;
217 int InsetVSpace::docbook(odocstream & os, OutputParams const &) const
224 docstring InsetVSpace::xhtml(XHTMLStream &, OutputParams const &) const
226 odocstringstream ods;
227 XHTMLStream xds(ods);
228 string const len = space_.asHTMLLength();
229 string const attr = "style='height:" + (len.empty() ? "1em" : len) + "'";
230 xds << html::StartTag("div", attr, true) << html::EndTag("div");
235 docstring InsetVSpace::contextMenu(BufferView const &, int, int) const
237 return from_ascii("context-vspace");
241 void InsetVSpace::string2params(string const & in, VSpace & vspace)
247 istringstream data(in);
250 lex.setContext("InsetVSpace::string2params");
251 lex >> "vspace" >> vspace;
255 string InsetVSpace::params2string(VSpace const & vspace)
258 data << "vspace" << ' ' << vspace.asLyXCommand();