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 "InsetWrap.h"
15 #include "InsetCaption.h"
18 #include "BufferParams.h"
19 #include "BufferView.h"
22 #include "DispatchResult.h"
24 #include "FloatList.h"
25 #include "FuncRequest.h"
26 #include "FuncStatus.h"
27 #include "LaTeXFeatures.h"
29 #include "output_xhtml.h"
30 #include "TextClass.h"
32 #include "support/debug.h"
33 #include "support/docstream.h"
34 #include "support/gettext.h"
36 #include "frontends/Application.h"
43 InsetWrap::InsetWrap(Buffer * buf, string const & type)
44 : InsetCollapsable(buf)
46 setLabel(_("wrap: ") + floatName(type));
49 params_.placement = "o";
50 params_.overhang = Length(0, Length::PCW);
51 params_.width = Length(50, Length::PCW);
55 InsetWrap::~InsetWrap()
57 hideDialogs("wrap", this);
61 docstring InsetWrap::name() const
63 return "Wrap:" + from_utf8(params_.type);
67 docstring InsetWrap::toolTip(BufferView const & bv, int x, int y) const
70 return InsetCollapsable::toolTip(bv, x, y);
71 OutputParams rp(&buffer().params().encoding());
72 docstring caption_tip = getCaptionText(rp);
73 if (!caption_tip.empty())
74 caption_tip += from_ascii("\n");
75 return toolTipText(caption_tip);
79 void InsetWrap::doDispatch(Cursor & cur, FuncRequest & cmd)
81 switch (cmd.action()) {
82 case LFUN_INSET_MODIFY: {
83 InsetWrapParams params;
84 InsetWrap::string2params(to_utf8(cmd.argument()), params);
85 params_.lines = params.lines;
86 params_.placement = params.placement;
87 params_.overhang = params.overhang;
88 params_.width = params.width;
92 case LFUN_INSET_DIALOG_UPDATE:
93 cur.bv().updateDialog("wrap", params2string(params()));
97 InsetCollapsable::doDispatch(cur, cmd);
103 bool InsetWrap::getStatus(Cursor & cur, FuncRequest const & cmd,
104 FuncStatus & flag) const
106 switch (cmd.action()) {
107 case LFUN_INSET_MODIFY:
108 case LFUN_INSET_DIALOG_UPDATE:
109 flag.setEnabled(true);
113 return InsetCollapsable::getStatus(cur, cmd, flag);
118 void InsetWrap::updateBuffer(ParIterator const & it, UpdateType utype)
120 setLabel(_("wrap: ") + floatName(params_.type));
122 buffer().masterBuffer()->params().documentClass().counters();
123 if (utype == OutputUpdate) {
124 // counters are local to the wrap
125 cnts.saveLastCounter();
127 string const saveflt = cnts.current_float();
129 // Tell to captions what the current float is
130 cnts.current_float(params().type);
132 InsetCollapsable::updateBuffer(it, utype);
135 cnts.current_float(saveflt);
136 if (utype == OutputUpdate)
137 cnts.restoreLastCounter();
141 void InsetWrapParams::write(ostream & os) const
143 os << "Wrap " << type << '\n';
144 os << "lines " << lines << '\n';
145 os << "placement " << placement << '\n';
146 os << "overhang " << overhang.asString() << '\n';
147 os << "width \"" << width.asString() << "\"\n";
151 void InsetWrapParams::read(Lexer & lex)
153 lex.setContext("InsetWrapParams::read");
154 lex >> "lines" >> lines;
155 lex >> "placement" >> placement;
156 lex >> "overhang" >> overhang;
157 lex >> "width" >> width;
161 void InsetWrap::write(ostream & os) const
164 InsetCollapsable::write(os);
168 void InsetWrap::read(Lexer & lex)
171 InsetCollapsable::read(lex);
175 void InsetWrap::validate(LaTeXFeatures & features) const
177 features.require("wrapfig");
178 features.inFloat(true);
179 InsetCollapsable::validate(features);
180 features.inFloat(false);
184 int InsetWrap::latex(odocstream & os, OutputParams const & runparams_in) const
186 OutputParams runparams(runparams_in);
187 runparams.inFloat = OutputParams::MAINFLOAT;
188 os << "\\begin{wrap" << from_ascii(params_.type) << '}';
189 // no optional argument when lines are zero
190 if (params_.lines != 0)
191 os << '[' << params_.lines << ']';
192 os << '{' << from_ascii(params_.placement) << '}';
193 Length over(params_.overhang);
194 // no optional argument when the value is zero
195 if (over.value() != 0)
196 os << '[' << from_ascii(params_.overhang.asLatexString()) << ']';
197 os << '{' << from_ascii(params_.width.asLatexString()) << "}%\n";
198 int const i = InsetText::latex(os, runparams);
199 os << "\\end{wrap" << from_ascii(params_.type) << "}%\n";
204 int InsetWrap::plaintext(odocstream & os, OutputParams const & runparams) const
206 os << '[' << buffer().B_("wrap") << ' '
207 << floatName(params_.type) << ":\n";
208 InsetText::plaintext(os, runparams);
211 return PLAINTEXT_NEWLINE + 1; // one char on a separate line
215 int InsetWrap::docbook(odocstream & os, OutputParams const & runparams) const
218 os << '<' << from_ascii(params_.type) << '>';
219 int const i = InsetText::docbook(os, runparams);
220 os << "</" << from_ascii(params_.type) << '>';
225 docstring InsetWrap::xhtml(XHTMLStream & xs, OutputParams const & rp) const
227 string const len = params_.width.asHTMLString();
228 string const width = len.empty() ? "50%" : len;
229 string const attr = "class='wrap' style='width: " + len + ";'";
230 xs << html::StartTag("div", attr);
231 docstring const deferred =
232 InsetText::insetAsXHTML(xs, rp, InsetText::WriteInnerTag);
234 xs << html::EndTag("div");
239 bool InsetWrap::insetAllowed(InsetCode code) const
247 return InsetCollapsable::insetAllowed(code);
252 bool InsetWrap::showInsetDialog(BufferView * bv) const
254 if (!InsetText::showInsetDialog(bv))
255 bv->showDialog("wrap", params2string(params()),
256 const_cast<InsetWrap *>(this));
261 void InsetWrap::string2params(string const & in, InsetWrapParams & params)
263 params = InsetWrapParams();
264 istringstream data(in);
267 lex.setContext("InsetWrap::string2params");
269 lex >> "Wrap"; // Part of the inset proper, swallowed by Text::readInset
270 lex >> params.type; // We have to read the type here!
275 string InsetWrap::params2string(InsetWrapParams const & params)
278 data << "wrap" << ' ';