-/* This file is part of
- * ======================================================
- *
- * LyX, The Document Processor
- *
- * Copyright 2000-2001 The LyX Team.
+/**
+ * \file insetcaption.C
+ * This file is part of LyX, the document processor.
+ * Licence details can be found in the file COPYING.
*
- * ======================================================
+ * \author Lars Gullik Bjønnes
+ *
+ * Full author contact details are available in file CREDITS.
*/
#include <config.h>
-#ifdef __GNUG__
-#pragma implementation
-#endif
-
#include "insetcaption.h"
-#include "Painter.h"
-#include "font.h"
+#include "insetfloat.h"
+#include "insetwrap.h"
+
+#include "buffer.h"
+#include "bufferparams.h"
+#include "counters.h"
+#include "cursor.h"
#include "BufferView.h"
+#include "Floating.h"
#include "FloatList.h"
-#include "insets/insetfloat.h"
-#include "debug.h"
+#include "funcrequest.h"
+#include "FuncStatus.h"
#include "gettext.h"
+#include "LColor.h"
+#include "metricsinfo.h"
+#include "output_latex.h"
+#include "outputparams.h"
+#include "paragraph.h"
+#include "paragraph_funcs.h"
+#include "TocBackend.h"
-using std::ostream;
+#include "frontends/FontMetrics.h"
+#include "frontends/Painter.h"
+
+#include "support/lstrings.h"
+#include "support/convert.h"
+
+#include <sstream>
+
+
+using std::auto_ptr;
using std::endl;
+using std::string;
+using std::ostream;
+
+
+namespace lyx {
-InsetCaption::InsetCaption()
- : InsetText()
+using support::bformat;
+
+InsetCaption::InsetCaption(BufferParams const & bp)
+ : InsetText(bp), textclass_(bp.getLyXTextClass())
{
setAutoBreakRows(true);
- setDrawFrame(0, InsetText::LOCKED);
- setFrameColor(0, LColor::captionframe);
+ setDrawFrame(true);
+ setFrameColor(LColor::captionframe);
}
-void InsetCaption::write(Buffer const * buf, ostream & os) const
+void InsetCaption::write(Buffer const & buf, ostream & os) const
{
os << "Caption\n";
- writeParagraphData(buf, os);
+ text_.write(buf, os);
}
-
-void InsetCaption::read(Buffer const * buf, LyXLex & lex)
+void InsetCaption::read(Buffer const & buf, LyXLex & lex)
{
#if 0
// We will enably this check again when the compability
}
-string const InsetCaption::editMessage() const
+docstring const InsetCaption::editMessage() const
{
return _("Opened Caption Inset");
}
-void InsetCaption::draw(BufferView * bv, LyXFont const & f,
- int baseline, float & x, bool cleared) const
+void InsetCaption::cursorPos(BufferView const & bv,
+ CursorSlice const & sl, bool boundary, int & x, int & y) const
+{
+ InsetText::cursorPos(bv, sl, boundary, x, y);
+ x += labelwidth_;
+}
+
+
+void InsetCaption::setCustomLabel(docstring const & label)
+{
+ if (!support::isAscii(label) || label.empty())
+ // This must be a user defined layout. We cannot translate
+ // this, since gettext accepts only ascii keys.
+ custom_label_ = label;
+ else
+ custom_label_ = _(to_ascii(label));
+}
+
+
+void InsetCaption::addToToc(TocList & toclist, Buffer const & buf) const
+{
+ if (type_.empty())
+ return;
+
+ ParConstIterator pit = par_const_iterator_begin(*this);
+
+ Toc & toc = toclist[type_];
+ docstring const str = convert<docstring>(counter_)
+ + ". " + pit->asString(buf, false);
+ toc.push_back(TocItem(pit, 0, str));
+}
+
+
+bool InsetCaption::metrics(MetricsInfo & mi, Dimension & dim) const
+{
+ int const width_offset = TEXT_TO_INSET_OFFSET / 2;
+ mi.base.textwidth -= width_offset;
+
+ computeFullLabel();
+
+ labelwidth_ = theFontMetrics(mi.base.font).width(full_label_);
+ // add some space to separate the label from the inset text
+ labelwidth_ += 2 * TEXT_TO_INSET_OFFSET;
+ dim.wid = labelwidth_;
+ Dimension textdim;
+ InsetText::metrics(mi, textdim);
+ // Correct for button width, and re-fit
+ mi.base.textwidth -= dim.wid;
+ InsetText::metrics(mi, textdim);
+ dim.des = std::max(dim.des - textdim.asc + dim.asc, textdim.des);
+ dim.asc = textdim.asc;
+ dim.wid += textdim.wid;
+ dim.asc += TEXT_TO_INSET_OFFSET;
+ dim.des += TEXT_TO_INSET_OFFSET;
+ dim.wid += width_offset;
+ mi.base.textwidth += width_offset;
+ bool const changed = dim_ != dim;
+ dim_ = dim;
+ return changed;
+}
+
+
+void InsetCaption::draw(PainterInfo & pi, int x, int y) const
{
// We must draw the label, we should get the label string
// from the enclosing float inset.
// the text inset or the paragraph?
// We should also draw the float number (Lgb)
- // See if we can find the name of the float this caption
- // belongs to.
- Inset * i1 = owner();
- Inset * i2 = i1 ? i1->owner() : 0;
- string const type = static_cast<InsetFloat *>(i2)->type();
- string const fl = i2 ? floatList.getType(type).name() : N_("Float");
+ // Answer: the text inset (in buffer_funcs.C: setCaption).
+
+ labelwidth_ = pi.pain.text(x, y, full_label_, pi.base.font);
+ // add some space to separate the label from the inset text
+ labelwidth_ += 2 * TEXT_TO_INSET_OFFSET;
+ InsetText::draw(pi, x + labelwidth_, y);
+ setPosCache(pi, x, y);
+}
+
+
+void InsetCaption::drawSelection(PainterInfo & pi, int x, int y) const
+{
+ InsetText::drawSelection(pi, x + labelwidth_, y);
+}
+
+
+void InsetCaption::edit(LCursor & cur, bool left)
+{
+ cur.push(*this);
+ InsetText::edit(cur, left);
+}
+
+
+InsetBase * InsetCaption::editXY(LCursor & cur, int x, int y)
+{
+ cur.push(*this);
+ return InsetText::editXY(cur, x, y);
+}
+
+
+bool InsetCaption::insetAllowed(InsetBase::Code code) const
+{
+ switch (code) {
+ case FLOAT_CODE:
+ case TABULAR_CODE:
+ case WRAP_CODE:
+ case CAPTION_CODE:
+ case PAGEBREAK_CODE:
+ return false;
+ default:
+ return InsetText::insetAllowed(code);
+ }
+}
+
- // Discover the number...
- // ...
- string const num = "#";
+bool InsetCaption::getStatus(LCursor & cur, FuncRequest const & cmd,
+ FuncStatus & status) const
+{
+ switch (cmd.action) {
+
+ case LFUN_BREAK_PARAGRAPH:
+ case LFUN_BREAK_PARAGRAPH_KEEP_LAYOUT:
+ case LFUN_BREAK_PARAGRAPH_SKIP:
+ status.enabled(false);
+ return true;
- // Generate the label
- string const label = _(fl) + " " + num + ":";
-
- Painter & pain = bv->painter();
- int const w = lyxfont::width(label, f);
- pain.text(int(x), baseline, label, f);
- x += w;
+ case LFUN_OPTIONAL_INSERT:
+ status.enabled(numberOfOptArgs(cur.paragraph()) == 0);
+ return true;
- InsetText::draw(bv, f, baseline, x, cleared);
+ default:
+ return InsetText::getStatus(cur, cmd, status);
+ }
}
-int InsetCaption::latex(Buffer const * buf, ostream & os,
- bool fragile, bool free_spc) const
+int InsetCaption::latex(Buffer const & buf, odocstream & os,
+ OutputParams const & runparams_in) const
{
// This is a bit too simplistic to take advantage of
// caption options we must add more later. (Lgb)
// This code is currently only able to handle the simple
// \caption{...}, later we will make it take advantage
// of the one of the caption packages. (Lgb)
- ostringstream ost;
- int const l = InsetText::latex(buf, ost, fragile, free_spc);
- os << "\\caption{" << ost.str() << "}\n";
+ OutputParams runparams = runparams_in;
+ // FIXME: actually, it is moving only when there is no
+ // optional argument.
+ runparams.moving_arg = true;
+ os << "\\caption";
+ int l = latexOptArgInsets(buf, paragraphs()[0], os, runparams, 1);
+ os << '{';
+ l += InsetText::latex(buf, os, runparams);
+ os << "}\n";
+ runparams_in.encoding = runparams.encoding;
return l + 1;
}
-int InsetCaption::ascii(Buffer const * /*buf*/,
- ostream & /*os*/, int /*linelen*/) const
+int InsetCaption::plaintext(Buffer const & buf, odocstream & os,
+ OutputParams const & runparams) const
{
-#ifdef WITH_WARNINGS
-#warning Implement me!
-#endif
- return 0;
+ computeFullLabel();
+
+ os << '[' << full_label_ << "\n";
+ InsetText::plaintext(buf, os, runparams);
+ os << "\n]";
+
+ return PLAINTEXT_NEWLINE + 1; // one char on a separate line
}
-int InsetCaption::docBook(Buffer const * /*buf*/, ostream & /*os*/) const
+int InsetCaption::docbook(Buffer const & buf, odocstream & os,
+ OutputParams const & runparams) const
{
-#ifdef WITH_WARNINGS
-#warning Implement me!
-#endif
- return 0;
+ int ret;
+ os << "<title>";
+ ret = InsetText::docbook(buf, os, runparams);
+ os << "</title>\n";
+ return ret;
+}
+
+
+void InsetCaption::computeFullLabel() const
+{
+ if (type_.empty())
+ full_label_ = _("Senseless!!! ");
+ else {
+ docstring const number = convert<docstring>(counter_);
+ docstring label = custom_label_.empty()? _(type_): custom_label_;
+ full_label_ = bformat(from_ascii("%1$s %2$s:"), label, number);
+ }
}
+
+
+auto_ptr<InsetBase> InsetCaption::doClone() const
+{
+ return auto_ptr<InsetBase>(new InsetCaption(*this));
+}
+
+
+} // namespace lyx