-/* This file is part of
- * ======================================================
- *
- * LyX, The Document Processor
- *
- * Copyright 1998-2001 The LyX Team.
+/**
+ * \file insetfloat.C
+ * This file is part of LyX, the document processor.
+ * Licence details can be found in the file COPYING.
*
- * ====================================================== */
+ * \author Jürgen Vigna
+ * \author Lars Gullik Bjønnes
+ *
+ * Full author contact details are available in file CREDITS.
+ */
#include <config.h>
-#ifdef __GNUG__
-#pragma implementation
-#endif
-
#include "insetfloat.h"
-#include "gettext.h"
-#include "lyxfont.h"
+
+#include "buffer.h"
+#include "bufferparams.h"
#include "BufferView.h"
-#include "lyxtext.h"
-#include "insets/insettext.h"
-#include "support/LOstream.h"
-#include "FloatList.h"
-#include "LaTeXFeatures.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 "LColor.h"
+#include "lyxlex.h"
+#include "outputparams.h"
+#include "paragraph.h"
+#include "TocBackend.h"
+
+#include "support/lstrings.h"
+#include "support/convert.h"
+
+
+namespace lyx {
+
+using support::contains;
-using std::ostream;
using std::endl;
+using std::string;
+using std::auto_ptr;
+using std::istringstream;
+using std::ostream;
+using std::ostringstream;
+
// With this inset it will be possible to support the latex package
// float.sty, and I am sure that with this and some additional support
// within - This (optional) argument determines whether floats of this
// class will be numbered within some sectional unit of the
// document. For example, if within is equal to chapter, the
-// floats will be numbered within chapters.
+// floats will be numbered within chapters.
// \floatstyle{style}
// style - plain, boxed, ruled
// \floatname{float}{floatname}
//
// Lgb
-InsetFloat::InsetFloat(string const & type)
- : InsetCollapsable(), wide_(false)
+
+InsetFloat::InsetFloat(BufferParams const & bp, string const & type)
+ : InsetCollapsable(bp)
{
- string lab(_("float:"));
- lab += type;
- setLabel(lab);
+ setLabel(_("float: ") + floatName(type, bp));
LyXFont font(LyXFont::ALL_SANE);
font.decSize();
font.decSize();
- font.setColor(LColor::footnote);
+ font.setColor(LColor::collapsable);
setLabelFont(font);
- setAutoCollapse(false);
- floatType_ = type;
- setInsetName(type);
+ params_.type = type;
+ setInsetName(from_utf8(type));
}
-void InsetFloat::Write(Buffer const * buf, ostream & os) const
+InsetFloat::~InsetFloat()
{
- os << "Float " // getInsetName()
- << floatType_ << '\n';
+ InsetFloatMailer(*this).hideDialog();
+}
- if (floatPlacement_.empty()) {
- os << "placement "
- << floatList.getType(floatType_).placement() << "\n";
- } else {
- os << "placement " << floatPlacement_ << "\n";
+
+void InsetFloat::doDispatch(LCursor & cur, FuncRequest & cmd)
+{
+ switch (cmd.action) {
+
+ case LFUN_INSET_MODIFY: {
+ InsetFloatParams params;
+ InsetFloatMailer::string2params(to_utf8(cmd.argument()), params);
+ params_.placement = params.placement;
+ params_.wide = params.wide;
+ params_.sideways = params.sideways;
+ wide(params_.wide, cur.buffer().params());
+ sideways(params_.sideways, cur.buffer().params());
+ break;
}
- if (wide_) {
+
+ case LFUN_INSET_DIALOG_UPDATE: {
+ InsetFloatMailer(*this).updateDialog(&cur.bv());
+ break;
+ }
+
+ case LFUN_MOUSE_RELEASE: {
+ if (cmd.button() == mouse_button::button3 && hitButton(cmd)) {
+ InsetFloatMailer(*this).showDialog(&cur.bv());
+ break;
+ }
+ InsetCollapsable::doDispatch(cur, cmd);
+ break;
+ }
+
+ default:
+ InsetCollapsable::doDispatch(cur, cmd);
+ break;
+ }
+}
+
+
+bool InsetFloat::getStatus(LCursor & cur, FuncRequest const & cmd,
+ FuncStatus & flag) const
+{
+ switch (cmd.action) {
+
+ case LFUN_INSET_MODIFY:
+ case LFUN_INSET_DIALOG_UPDATE:
+ flag.enabled(true);
+ return true;
+
+ default:
+ return InsetCollapsable::getStatus(cur, cmd, flag);
+ }
+}
+
+
+void InsetFloatParams::write(ostream & os) const
+{
+ os << "Float " << type << '\n';
+
+ if (!placement.empty())
+ os << "placement " << placement << "\n";
+
+ if (wide)
os << "wide true\n";
- } else {
+ else
os << "wide false\n";
- }
-
- InsetCollapsable::Write(buf, os);
+
+ if (sideways)
+ os << "sideways true\n";
+ else
+ os << "sideways false\n";
}
-void InsetFloat::Read(Buffer const * buf, LyXLex & lex)
+void InsetFloatParams::read(LyXLex & lex)
{
- if (lex.IsOK()) {
- lex.next();
- string token = lex.GetString();
- if (token == "placement") {
- lex.next();
- floatPlacement_ = lex.GetString();
- } else {
- lyxerr << "InsetFloat::Read: Missing placement!"
- << endl;
- }
- lex.next();
- token = lex.GetString();
- if (token == "wide") {
- lex.next();
- string const tmptoken = lex.GetString();
- if (tmptoken == "true")
- wide(true);
- else
- wide(false);
- } else {
- lyxerr << "InsetFloat::Read:: Missing wide!"
- << endl;
- }
+ string token;
+ lex >> token;
+ if (token == "placement") {
+ lex >> placement;
+ } else {
+ // take countermeasures
+ lex.pushToken(token);
+ }
+ lex >> token;
+ if (token == "wide") {
+ lex >> wide;
+ } else {
+ lyxerr << "InsetFloat::Read:: Missing wide!"
+ << endl;
+ // take countermeasures
+ lex.pushToken(token);
}
- InsetCollapsable::Read(buf, lex);
+ lex >> token;
+ if (token == "sideways") {
+ lex >> sideways;
+ } else {
+ lyxerr << "InsetFloat::Read:: Missing sideways!"
+ << endl;
+ // take countermeasures
+ lex.pushToken(token);
+ }
+}
+
+
+void InsetFloat::write(Buffer const & buf, ostream & os) const
+{
+ params_.write(os);
+ InsetCollapsable::write(buf, os);
}
-void InsetFloat::Validate(LaTeXFeatures & features) const
+void InsetFloat::read(Buffer const & buf, LyXLex & lex)
{
- features.usedFloats.insert(floatType_);
+ params_.read(lex);
+ wide(params_.wide, buf.params());
+ sideways(params_.sideways, buf.params());
+ InsetCollapsable::read(buf, lex);
}
-Inset * InsetFloat::Clone(Buffer const &) const
+void InsetFloat::validate(LaTeXFeatures & features) const
{
- InsetFloat * result = new InsetFloat(floatType_);
- result->inset.init(&inset);
+ if (contains(params_.placement, 'H')) {
+ features.require("float");
+ }
+
+ if (params_.sideways)
+ features.require("rotating");
- result->collapsed = collapsed;
- return result;
+ features.useFloat(params_.type);
+ InsetCollapsable::validate(features);
}
-string const InsetFloat::EditMessage() const
+auto_ptr<InsetBase> InsetFloat::doClone() const
+{
+ return auto_ptr<InsetBase>(new InsetFloat(*this));
+}
+
+
+docstring const InsetFloat::editMessage() const
{
return _("Opened Float Inset");
}
-int InsetFloat::Latex(Buffer const * buf,
- ostream & os, bool fragile, bool fp) const
+int InsetFloat::latex(Buffer const & buf, odocstream & os,
+ OutputParams const & runparams) const
{
- string const tmptype = (wide_ ? floatType_ + "*" : floatType_);
-
- os << "\\begin{" << tmptype << "}";
- if (!floatPlacement_.empty()
- && floatPlacement_ != floatList.defaultPlacement(floatType_))
- os << "[" << floatPlacement_ << "]";
- os << "%\n";
-
- int const i = inset.Latex(buf, os, fragile, fp);
- os << "\\end{" << tmptype << "}%\n";
-
- return i + 2;
+ FloatList const & floats = buf.params().getLyXTextClass().floats();
+ string tmptype = (params_.wide ? params_.type + "*" : params_.type);
+ if (params_.sideways) {
+ if (params_.type == "table")
+ tmptype = "sidewaystable";
+ else if (params_.type == "figure")
+ tmptype = "sidewaysfigure";
+ }
+ // Figure out the float placement to use.
+ // From lowest to highest:
+ // - float default placement
+ // - document wide default placement
+ // - specific float placement
+ string placement;
+ string const buf_placement = buf.params().float_placement;
+ string const def_placement = floats.defaultPlacement(params_.type);
+ if (!params_.placement.empty()
+ && params_.placement != def_placement) {
+ placement = params_.placement;
+ } else if (params_.placement.empty()
+ && !buf_placement.empty()
+ && buf_placement != def_placement) {
+ placement = buf_placement;
+ }
+
+ // The \n is used to force \begin{<floatname>} to appear in a new line.
+ // The % is needed to prevent two consecutive \n chars in the case
+ // when the current output line is empty.
+ os << "%\n\\begin{" << from_ascii(tmptype) << '}';
+ // We only output placement if different from the def_placement.
+ // sidewaysfloats always use their own page
+ if (!placement.empty() && !params_.sideways) {
+ os << '[' << from_ascii(placement) << ']';
+ }
+ os << '\n';
+
+ int const i = InsetText::latex(buf, os, runparams);
+
+ // The \n is used to force \end{<floatname>} to appear in a new line.
+ // In this case, we do not case if the current output line is empty.
+ os << "\n\\end{" << from_ascii(tmptype) << "}\n";
+
+ return i + 4;
}
-int InsetFloat::DocBook(Buffer const * buf, ostream & os) const
+int InsetFloat::docbook(Buffer const & buf, odocstream & os,
+ OutputParams const & runparams) const
{
- os << "<" << floatType_ << ">";
- int const i = inset.DocBook(buf, os);
- os << "</" << floatType_ << ">";
+ // FIXME UNICODE
+ os << '<' << from_ascii(params_.type) << '>';
+ int const i = InsetText::docbook(buf, os, runparams);
+ os << "</" << from_ascii(params_.type) << '>';
return i;
}
-bool InsetFloat::InsertInsetAllowed(Inset * in) const
+bool InsetFloat::insetAllowed(InsetBase::Code code) const
{
- if ((in->LyxCode() == Inset::FOOT_CODE) ||
- (in->LyxCode() == Inset::MARGIN_CODE)) {
- return false;
- }
+ return code != InsetBase::FLOAT_CODE
+ && code != InsetBase::FOOT_CODE
+ && code != InsetBase::MARGIN_CODE;
+}
+
+
+bool InsetFloat::showInsetDialog(BufferView * bv) const
+{
+ if (!InsetText::showInsetDialog(bv))
+ InsetFloatMailer(const_cast<InsetFloat &>(*this)).showDialog(bv);
return true;
}
-void InsetFloat::InsetButtonRelease(BufferView * bv, int x, int y, int button)
+void InsetFloat::wide(bool w, BufferParams const & bp)
{
- if (x >= top_x
- && x < button_length
- && y >= button_top_y
- && y < button_bottom_y
- && button == 3) {
- // This obviously need to change.
- lyxerr << "InsetFloat: Let's edit this floats parameters!"
- << endl;
- //bv->owner()->getDialogs()->showFloat(this);
- } else {
- InsetCollapsable::InsetButtonRelease(bv, x, y, button);
- }
+ params_.wide = w;
+ docstring lab = _("float: ") + floatName(params_.type, bp);
+ if (params_.wide)
+ lab += '*';
+ setLabel(lab);
}
-string const & InsetFloat::type() const
+void InsetFloat::sideways(bool s, BufferParams const & bp)
{
- return floatType_;
+ params_.sideways = s;
+ docstring lab = _("float: ") + floatName(params_.type, bp);
+ if (params_.sideways)
+ lab += _(" (sideways)");
+ setLabel(lab);
}
-void InsetFloat::placement(string const & p)
+void InsetFloat::addToToc(TocList & toclist, Buffer const & buf) const
{
- // Here we should only allow the placement to be set
- // if a valid value.
-#ifdef WITH_WARNINGS
-#warning FIX!
-#endif
- floatPlacement_ = p;
+ ParConstIterator pit = par_const_iterator_begin(*this);
+ ParConstIterator end = par_const_iterator_end(*this);
+
+ // Find a caption layout in one of the (child inset's) pars
+ for (; pit != end; ++pit) {
+ if (pit->layout()->labeltype == LABEL_SENSITIVE) {
+ Toc & toc = toclist[params_.type];
+ docstring const str =
+ convert<docstring>(toc.size() + 1)
+ + ". " + pit->asString(buf, false);
+ toc.push_back(TocItem(pit, 0, str));
+ return;
+ }
+ }
}
-string const & InsetFloat::placement() const
+string const InsetFloatMailer::name_("float");
+
+InsetFloatMailer::InsetFloatMailer(InsetFloat & inset)
+ : inset_(inset)
+{}
+
+
+string const InsetFloatMailer::inset2string(Buffer const &) const
{
- return floatPlacement_;
+ return params2string(inset_.params());
}
-void InsetFloat::wide(bool w)
+void InsetFloatMailer::string2params(string const & in,
+ InsetFloatParams & params)
{
- wide_ = w;
- if (wide_) {
- string lab(_("float:"));
- lab += floatType_;
- lab += "*";
- setLabel(lab);
- } else {
- string lab(_("float:"));
- lab += floatType_;
- setLabel(lab);
- }
+ params = InsetFloatParams();
+ if (in.empty())
+ return;
+
+ istringstream data(in);
+ LyXLex lex(0,0);
+ lex.setStream(data);
+
+ string name;
+ lex >> name;
+ if (!lex || name != name_)
+ return print_mailer_error("InsetFloatMailer", in, 1, name_);
+
+ // This is part of the inset proper that is usually swallowed
+ // by LyXText::readInset
+ string id;
+ lex >> id;
+ if (!lex || id != "Float")
+ return print_mailer_error("InsetBoxMailer", in, 2, "Float");
+
+ // We have to read the type here!
+ lex >> params.type;
+ params.read(lex);
}
-bool InsetFloat::wide() const
+string const InsetFloatMailer::params2string(InsetFloatParams const & params)
{
- return wide_;
+ ostringstream data;
+ data << name_ << ' ';
+ params.write(data);
+ return data.str();
}
+
+
+} // namespace lyx
projects / lyx.git / blobdiff