* Licence details can be found in the file COPYING.
*
* \author Dekel Tsur
+ * \author Uwe Stöhr
*
* Full author contact details are available in file CREDITS.
*/
#include <config.h>
#include "InsetWrap.h"
+#include "InsetCaption.h"
#include "Buffer.h"
#include "BufferParams.h"
#include "BufferView.h"
+#include "Counters.h"
#include "Cursor.h"
-#include "debug.h"
#include "DispatchResult.h"
#include "Floating.h"
#include "FloatList.h"
#include "FuncRequest.h"
#include "FuncStatus.h"
-#include "gettext.h"
#include "LaTeXFeatures.h"
-#include "Color.h"
#include "Lexer.h"
-#include "OutputParams.h"
-#include "Paragraph.h"
-#include "TocBackend.h"
+#include "xml.h"
+#include "texstream.h"
+#include "TextClass.h"
-#include "support/convert.h"
+#include "support/debug.h"
+#include "support/docstream.h"
+#include "support/gettext.h"
+#include "frontends/Application.h"
-namespace lyx {
+#include <climits>
+
+using namespace std;
-using std::string;
-using std::endl;
-using std::auto_ptr;
-using std::istringstream;
-using std::ostream;
-using std::ostringstream;
+namespace lyx {
-InsetWrap::InsetWrap(BufferParams const & bp, string const & type)
- : InsetCollapsable(bp), name_(from_utf8(type))
+InsetWrap::InsetWrap(Buffer * buf, string const & type)
+ : InsetCaptionable(buf)
{
- setLabel(_("wrap: ") + floatName(type, bp));
- Font font(Font::ALL_SANE);
- font.decSize();
- font.decSize();
- font.setColor(Color::collapsable);
- setLabelFont(font);
- params_.type = type;
- params_.width = Length(50, Length::PCW);
+ setCaptionType(type);
}
InsetWrap::~InsetWrap()
{
- InsetWrapMailer(*this).hideDialog();
+ hideDialogs("wrap", this);
+}
+
+
+// Enforce equality of float type and caption type.
+void InsetWrap::setCaptionType(std::string const & type)
+{
+ InsetCaptionable::setCaptionType(type);
+ params_.type = captionType();
+ setLabel(_("Wrap: ") + floatName(type));
+}
+
+
+docstring InsetWrap::layoutName() const
+{
+ return "Wrap:" + from_utf8(params_.type);
+}
+
+
+docstring InsetWrap::toolTip(BufferView const & bv, int x, int y) const
+{
+ if (isOpen(bv))
+ return InsetCaptionable::toolTip(bv, x, y);
+ OutputParams rp(&buffer().params().encoding());
+ docstring caption_tip = getCaptionText(rp);
+ if (!caption_tip.empty())
+ caption_tip += from_ascii("\n");
+ return toolTipText(caption_tip);
}
void InsetWrap::doDispatch(Cursor & cur, FuncRequest & cmd)
{
- switch (cmd.action) {
+ switch (cmd.action()) {
case LFUN_INSET_MODIFY: {
+ cur.recordUndoInset(this);
InsetWrapParams params;
- InsetWrapMailer::string2params(to_utf8(cmd.argument()), params);
+ InsetWrap::string2params(to_utf8(cmd.argument()), params);
+ params_.lines = params.lines;
params_.placement = params.placement;
- params_.width = params.width;
+ params_.overhang = params.overhang;
+ params_.width = params.width;
break;
}
case LFUN_INSET_DIALOG_UPDATE:
- InsetWrapMailer(*this).updateDialog(&cur.bv());
- break;
-
- case LFUN_MOUSE_RELEASE: {
- if (cmd.button() == mouse_button::button3 && hitButton(cmd)) {
- InsetWrapMailer(*this).showDialog(&cur.bv());
- break;
- }
- InsetCollapsable::doDispatch(cur, cmd);
+ cur.bv().updateDialog("wrap", params2string(params()));
break;
- }
default:
- InsetCollapsable::doDispatch(cur, cmd);
+ InsetCaptionable::doDispatch(cur, cmd);
break;
}
}
bool InsetWrap::getStatus(Cursor & cur, FuncRequest const & cmd,
FuncStatus & flag) const
{
- switch (cmd.action) {
+ switch (cmd.action()) {
case LFUN_INSET_MODIFY:
case LFUN_INSET_DIALOG_UPDATE:
- flag.enabled(true);
+ flag.setEnabled(true);
return true;
default:
- return InsetCollapsable::getStatus(cur, cmd, flag);
+ return InsetCaptionable::getStatus(cur, cmd, flag);
}
}
-void InsetWrapParams::write(ostream & os) const
+void InsetWrap::updateBuffer(ParIterator const & it, UpdateType utype, bool const deleted)
{
- os << "Wrap " << type << '\n';
+ InsetCaptionable::updateBuffer(it, utype, deleted);
+}
- if (!placement.empty())
- os << "placement " << placement << "\n";
+void InsetWrapParams::write(ostream & os) const
+{
+ os << "Wrap " << type << '\n';
+ os << "lines " << lines << '\n';
+ os << "placement " << placement << '\n';
+ os << "overhang " << overhang.asString() << '\n';
os << "width \"" << width.asString() << "\"\n";
}
void InsetWrapParams::read(Lexer & lex)
{
- string token;
- lex >> token;
- if (token == "placement")
- lex >> placement;
- else {
- // take countermeasures
- lex.pushToken(token);
- }
- if (!lex)
- return;
- lex >> token;
- if (token == "width") {
- lex.next();
- width = Length(lex.getString());
- } else {
- lyxerr << "InsetWrap::Read:: Missing 'width'-tag!"
- << endl;
- // take countermeasures
- lex.pushToken(token);
- }
+ lex.setContext("InsetWrapParams::read");
+ lex >> "lines" >> lines;
+ lex >> "placement" >> placement;
+ lex >> "overhang" >> overhang;
+ lex >> "width" >> width;
}
-void InsetWrap::write(Buffer const & buf, ostream & os) const
+void InsetWrap::write(ostream & os) const
{
params_.write(os);
- InsetCollapsable::write(buf, os);
+ InsetCaptionable::write(os);
}
-void InsetWrap::read(Buffer const & buf, Lexer & lex)
+void InsetWrap::read(Lexer & lex)
{
params_.read(lex);
- InsetCollapsable::read(buf, lex);
+ InsetCaptionable::read(lex);
}
void InsetWrap::validate(LaTeXFeatures & features) const
{
- features.require("floatflt");
- InsetCollapsable::validate(features);
+ features.require("wrapfig");
+ features.inFloat(true);
+ InsetCaptionable::validate(features);
+ features.inFloat(false);
}
-auto_ptr<Inset> InsetWrap::doClone() const
+void InsetWrap::latex(otexstream & os, OutputParams const & runparams_in) const
{
- return auto_ptr<Inset>(new InsetWrap(*this));
+ OutputParams runparams(runparams_in);
+ runparams.inFloat = OutputParams::MAINFLOAT;
+ os << "\\begin{wrap" << from_ascii(params_.type) << '}';
+ // no optional argument when lines are zero
+ if (params_.lines != 0)
+ os << '[' << params_.lines << ']';
+ os << '{' << from_ascii(params_.placement) << '}';
+ Length over(params_.overhang);
+ // no optional argument when the value is zero
+ if (over.value() != 0)
+ os << '[' << from_ascii(params_.overhang.asLatexString()) << ']';
+ os << '{' << from_ascii(params_.width.asLatexString()) << "}%\n";
+ InsetText::latex(os, runparams);
+ os << "\\end{wrap" << from_ascii(params_.type) << "}%\n";
}
-docstring const InsetWrap::editMessage() const
+int InsetWrap::plaintext(odocstringstream & os,
+ OutputParams const & runparams, size_t max_length) const
{
- return _("Opened Wrap Inset");
-}
-
+ os << '[' << buffer().B_("wrap") << ' '
+ << floatName(params_.type) << ":\n";
+ InsetText::plaintext(os, runparams, max_length);
+ os << "\n]";
-int InsetWrap::latex(Buffer const & buf, odocstream & os,
- OutputParams const & runparams) const
-{
- os << "\\begin{floating" << from_ascii(params_.type) << '}';
- if (!params_.placement.empty())
- os << '[' << from_ascii(params_.placement) << ']';
- os << '{' << from_ascii(params_.width.asLatexString()) << "}%\n";
- int const i = InsetText::latex(buf, os, runparams);
- os << "\\end{floating" << from_ascii(params_.type) << "}%\n";
- return i + 2;
+ return PLAINTEXT_NEWLINE + 1; // one char on a separate line
}
-int InsetWrap::plaintext(Buffer const & buf, odocstream & os,
- OutputParams const & runparams) const
+void InsetWrap::docbook(XMLStream & xs, OutputParams const & runparams) const
{
- os << '[' << buf.B_("wrap") << ' ' << floatName(params_.type, buf.params()) << ":\n";
- InsetText::plaintext(buf, os, runparams);
- os << "\n]";
+ InsetLayout const & il = getLayout();
- return PLAINTEXT_NEWLINE + 1; // one char on a separate line
+ xs << xml::StartTag(il.docbooktag(), il.docbookattr()); // TODO: Detect when there is a title.
+ InsetText::docbook(xs, runparams);
+ xs << xml::EndTag(il.docbooktag());
}
-int InsetWrap::docbook(Buffer const & buf, odocstream & os,
- OutputParams const & runparams) const
+docstring InsetWrap::xhtml(XMLStream & xs, OutputParams const & rp) const
{
- // FIXME UNICODE
- os << '<' << from_ascii(params_.type) << '>';
- int const i = InsetText::docbook(buf, os, runparams);
- os << "</" << from_ascii(params_.type) << '>';
- return i;
+ string const len = params_.width.asHTMLString();
+ string const width = len.empty() ? "50%" : len;
+ InsetLayout const & il = getLayout();
+ string const & tag = il.htmltag();
+ string const attr = il.htmlattr() + " style='width:" + width + ";'";
+ xs << xml::StartTag(tag, attr);
+ docstring const deferred =
+ InsetText::insetAsXHTML(xs, rp, InsetText::WriteInnerTag);
+ xs << xml::EndTag(tag);
+ return deferred;
}
-bool InsetWrap::insetAllowed(Inset::Code code) const
+bool InsetWrap::insetAllowed(InsetCode code) const
{
switch(code) {
- case FLOAT_CODE:
+ case WRAP_CODE:
case FOOT_CODE:
case MARGIN_CODE:
return false;
default:
- return InsetCollapsable::insetAllowed(code);
+ return InsetCaptionable::insetAllowed(code);
}
}
bool InsetWrap::showInsetDialog(BufferView * bv) const
{
if (!InsetText::showInsetDialog(bv))
- InsetWrapMailer(const_cast<InsetWrap &>(*this)).showDialog(bv);
+ bv->showDialog("wrap", params2string(params()),
+ const_cast<InsetWrap *>(this));
return true;
}
-void InsetWrap::addToToc(TocList & toclist, Buffer const & buf) const
-{
- // Is there a need to provide a list of wrap insets?
- return;
-}
-
-
-string const InsetWrapMailer::name_("wrap");
-
-InsetWrapMailer::InsetWrapMailer(InsetWrap & inset)
- : inset_(inset)
-{}
-
-
-string const InsetWrapMailer::inset2string(Buffer const &) const
-{
- return params2string(inset_.params());
-}
-
-
-void InsetWrapMailer::string2params(string const & in, InsetWrapParams & params)
+void InsetWrap::string2params(string const & in, InsetWrapParams & params)
{
params = InsetWrapParams();
- if (in.empty())
- return;
-
istringstream data(in);
- Lexer lex(0,0);
+ Lexer lex;
lex.setStream(data);
-
- string name;
- lex >> name;
- if (!lex || name != name_)
- return print_mailer_error("InsetWrapMailer", in, 1, name_);
-
- // This is part of the inset proper that is usually swallowed
- // by Text::readInset
- string id;
- lex >> id;
- if (!lex || id != "Wrap")
- return print_mailer_error("InsetBoxMailer", in, 2, "Wrap");
-
- // We have to read the type here!
- lex >> params.type;
+ lex.setContext("InsetWrap::string2params");
+ lex >> "wrap";
+ lex >> "Wrap"; // Part of the inset proper, swallowed by Text::readInset
+ lex >> params.type; // We have to read the type here!
params.read(lex);
}
-string const InsetWrapMailer::params2string(InsetWrapParams const & params)
+string InsetWrap::params2string(InsetWrapParams const & params)
{
ostringstream data;
- data << name_ << ' ';
+ data << "wrap" << ' ';
params.write(data);
return data.str();
}