]> git.lyx.org Git - lyx.git/blobdiff - src/insets/InsetWrap.cpp
Make members of FuncRequest private, per the FIXME there. Again, this is
[lyx.git] / src / insets / InsetWrap.cpp
index 10d12d096703bd0cb4a7a90541e1e33230c89c94..4ee0f7eed733985de182628f1332619bb30a129f 100644 (file)
@@ -4,6 +4,7 @@
  * 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 "output_xhtml.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 {
+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)
+       : InsetCollapsable(buf)
 {
-       setLabel(_("wrap: ") + floatName(type, bp));
-       Font font(Font::ALL_SANE);
-       font.decSize();
-       font.decSize();
-       font.setColor(Color::collapsable);
-       setLabelFont(font);
+       setLabel(_("wrap: ") + floatName(type));
        params_.type = type;
+       params_.lines = 0;
+       params_.placement = "o";
+       params_.overhang = Length(0, Length::PCW);
        params_.width = Length(50, Length::PCW);
 }
 
 
 InsetWrap::~InsetWrap()
 {
-       InsetWrapMailer(*this).hideDialog();
+       hideDialogs("wrap", this);
+}
+
+
+docstring InsetWrap::name() const
+{
+       return "Wrap:" + from_utf8(params_.type);
+}
+
+
+docstring InsetWrap::toolTip(BufferView const & bv, int x, int y) const
+{
+       OutputParams rp(&buffer().params().encoding());
+       docstring default_tip = InsetCollapsable::toolTip(bv, x, y);
+       docstring caption_tip = getCaptionText(rp);
+       if (!isOpen(bv) && !caption_tip.empty())
+               return caption_tip + '\n' + default_tip;
+       return default_tip;
 }
 
 
 void InsetWrap::doDispatch(Cursor & cur, FuncRequest & cmd)
 {
-       switch (cmd.action) {
+       switch (cmd.action()) {
        case LFUN_INSET_MODIFY: {
                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());
+               cur.bv().updateDialog("wrap", params2string(params()));
                break;
 
-       case LFUN_MOUSE_RELEASE: {
-               if (cmd.button() == mouse_button::button3 && hitButton(cmd)) {
-                       InsetWrapMailer(*this).showDialog(&cur.bv());
-                       break;
-               }
-               InsetCollapsable::doDispatch(cur, cmd);
-               break;
-       }
-
        default:
                InsetCollapsable::doDispatch(cur, cmd);
                break;
@@ -97,10 +102,10 @@ void InsetWrap::doDispatch(Cursor & cur, FuncRequest & cmd)
 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:
@@ -109,114 +114,131 @@ bool InsetWrap::getStatus(Cursor & cur, FuncRequest const & cmd,
 }
 
 
-void InsetWrapParams::write(ostream & os) const
+void InsetWrap::updateBuffer(ParIterator const & it, UpdateType utype)
 {
-       os << "Wrap " << type << '\n';
+       setLabel(_("wrap: ") + floatName(params_.type));
+       Counters & cnts =
+               buffer().masterBuffer()->params().documentClass().counters();
+       if (utype == OutputUpdate) {
+               // counters are local to the wrap
+               cnts.saveLastCounter();
+       }
+       string const saveflt = cnts.current_float();
+
+       // Tell to captions what the current float is
+       cnts.current_float(params().type);
+
+       InsetCollapsable::updateBuffer(it, utype);
+
+       // reset afterwards
+       cnts.current_float(saveflt);
+       if (utype == OutputUpdate)
+               cnts.restoreLastCounter();
+}
 
-       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);
+       InsetCollapsable::write(os);
 }
 
 
-void InsetWrap::read(Buffer const & buf, Lexer & lex)
+void InsetWrap::read(Lexer & lex)
 {
        params_.read(lex);
-       InsetCollapsable::read(buf, lex);
+       InsetCollapsable::read(lex);
 }
 
 
 void InsetWrap::validate(LaTeXFeatures & features) const
 {
-       features.require("floatflt");
+       features.require("wrapfig");
+       features.inFloat(true);
        InsetCollapsable::validate(features);
+       features.inFloat(false);
 }
 
 
-auto_ptr<Inset> InsetWrap::doClone() const
+int InsetWrap::latex(odocstream & os, OutputParams const & runparams_in) const
 {
-       return auto_ptr<Inset>(new InsetWrap(*this));
-}
-
-
-docstring const InsetWrap::editMessage() const
-{
-       return _("Opened Wrap Inset");
-}
-
-
-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) << ']';
+       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";
-       int const i = InsetText::latex(buf, os, runparams);
-       os << "\\end{floating" << from_ascii(params_.type) << "}%\n";
+       int const i = InsetText::latex(os, runparams);
+       os << "\\end{wrap" << from_ascii(params_.type) << "}%\n";
        return i + 2;
 }
 
 
-int InsetWrap::plaintext(Buffer const & buf, odocstream & os,
-                         OutputParams const & runparams) const
+int InsetWrap::plaintext(odocstream & os, OutputParams const & runparams) const
 {
-       os << '[' << buf.B_("wrap") << ' ' << floatName(params_.type, buf.params()) << ":\n";
-       InsetText::plaintext(buf, os, runparams);
+       os << '[' << buffer().B_("wrap") << ' '
+               << floatName(params_.type) << ":\n";
+       InsetText::plaintext(os, runparams);
        os << "\n]";
 
        return PLAINTEXT_NEWLINE + 1; // one char on a separate line
 }
 
 
-int InsetWrap::docbook(Buffer const & buf, odocstream & os,
-                       OutputParams const & runparams) const
+int InsetWrap::docbook(odocstream & os, OutputParams const & runparams) const
 {
-        // FIXME UNICODE
-        os << '<' << from_ascii(params_.type) << '>';
-       int const i = InsetText::docbook(buf, os, runparams);
+       // FIXME UNICODE
+       os << '<' << from_ascii(params_.type) << '>';
+       int const i = InsetText::docbook(os, runparams);
        os << "</" << from_ascii(params_.type) << '>';
        return i;
 }
 
 
-bool InsetWrap::insetAllowed(Inset::Code code) const
+docstring InsetWrap::xhtml(XHTMLStream & xs, OutputParams const & rp) const
+{
+       string const len = params_.width.asHTMLString();
+       string const width = len.empty() ? "50%" : len;
+       string const attr = "class='wrap' style='width: " + len + ";'";
+       xs << html::StartTag("div", attr);
+       docstring const deferred = 
+               InsetText::insetAsXHTML(xs, rp, InsetText::WriteInnerTag);
+       if (!len.empty())
+               xs << html::EndTag("div");
+       return deferred;
+}
+
+
+bool InsetWrap::insetAllowed(InsetCode code) const
 {
        switch(code) {
-       case FLOAT_CODE:
+       case WRAP_CODE:
        case FOOT_CODE:
        case MARGIN_CODE:
                return false;
@@ -229,63 +251,30 @@ bool InsetWrap::insetAllowed(Inset::Code code) const
 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();
 }