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"
18 #include "Dimension.h"
19 #include "DispatchResult.h"
20 #include "FuncRequest.h"
21 #include "FuncStatus.h"
22 #include "support/gettext.h"
25 #include "MetricsInfo.h"
26 #include "OutputParams.h"
28 #include "frontends/FontMetrics.h"
29 #include "frontends/Painter.h"
39 int const ADD_TO_VSPACE_WIDTH = 5;
44 InsetVSpace::InsetVSpace(VSpace const & space)
49 InsetVSpace::~InsetVSpace()
51 InsetVSpaceMailer(*this).hideDialog();
55 void InsetVSpace::doDispatch(Cursor & cur, FuncRequest & cmd)
59 case LFUN_INSET_MODIFY: {
60 InsetVSpaceMailer::string2params(to_utf8(cmd.argument()), space_);
64 case LFUN_MOUSE_RELEASE:
66 InsetVSpaceMailer(*this).showDialog(&cur.bv());
70 Inset::doDispatch(cur, cmd);
76 bool InsetVSpace::getStatus(Cursor & cur, FuncRequest const & cmd,
77 FuncStatus & status) const
81 case LFUN_INSET_MODIFY:
82 if (cmd.getArg(0) == "vspace") {
84 InsetVSpaceMailer::string2params(to_utf8(cmd.argument()), vspace);
85 status.setOnOff(vspace == space_);
90 return Inset::getStatus(cur, cmd, status);
95 void InsetVSpace::edit(Cursor & cur, bool, EntryDirection)
97 InsetVSpaceMailer(*this).showDialog(&cur.bv());
101 void InsetVSpace::read(Lexer & lex)
103 BOOST_ASSERT(lex.isOK());
107 space_ = VSpace(vsp);
111 if (end_token != "\\end_inset")
112 lex.printError("Missing \\end_inset at this point. "
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 arrow_size = 4;
135 void InsetVSpace::metrics(MetricsInfo & mi, Dimension & dim) const
137 int height = 3 * 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 * 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 + arrow_size) : start;
180 ty2 = added ? start : (start + arrow_size);
181 by1 = added ? (end - arrow_size) : end;
182 by2 = added ? end : (end - arrow_size);
185 int const midx = x + arrow_size;
186 int const rightx = midx + 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 * 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::contextMenu(BufferView const &, int, int) const
240 return from_ascii("context-vspace");
244 string const InsetVSpaceMailer::name_ = "vspace";
247 InsetVSpaceMailer::InsetVSpaceMailer(InsetVSpace & inset)
252 string const InsetVSpaceMailer::inset2string(Buffer const &) const
254 return params2string(inset_.space());
258 void InsetVSpaceMailer::string2params(string const & in, VSpace & vspace)
264 istringstream data(in);
270 if (!lex || name != name_)
271 return print_mailer_error("InsetVSpaceMailer", in, 1, name_);
276 vspace = VSpace(vsp);
280 string const InsetVSpaceMailer::params2string(VSpace const & vspace)
283 data << name_ << ' ' << vspace.asLyXCommand();