2 * \file InsetCaption.cpp
3 * This file is part of LyX, the document processor.
4 * Licence details can be found in the file COPYING.
6 * \author Lars Gullik Bjønnes
8 * Full author contact details are available in file CREDITS.
13 #include "InsetCaption.h"
14 #include "InsetFloat.h"
15 #include "InsetWrap.h"
18 #include "BufferParams.h"
19 #include "BufferView.h"
22 #include "Dimension.h"
24 #include "FloatList.h"
25 #include "FuncRequest.h"
26 #include "FuncStatus.h"
27 #include "InsetList.h"
29 #include "MetricsInfo.h"
30 #include "output_latex.h"
31 #include "output_xhtml.h"
32 #include "OutputParams.h"
33 #include "Paragraph.h"
34 #include "ParIterator.h"
35 #include "TextClass.h"
36 #include "TextMetrics.h"
37 #include "TocBackend.h"
39 #include "frontends/FontMetrics.h"
40 #include "frontends/Painter.h"
42 #include "support/gettext.h"
43 #include "support/lstrings.h"
48 using namespace lyx::support;
53 InsetCaption::InsetCaption(Buffer * buf, string const & type)
54 : InsetText(buf, InsetText::PlainLayout), type_(type)
57 setFrameColor(Color_collapsableframe);
61 void InsetCaption::write(ostream & os) const
71 docstring InsetCaption::layoutName() const
74 return from_ascii("Caption");
75 return from_utf8("Caption:" + type_);
79 void InsetCaption::cursorPos(BufferView const & bv,
80 CursorSlice const & sl, bool boundary, int & x, int & y) const
82 InsetText::cursorPos(bv, sl, boundary, x, y);
87 void InsetCaption::setCustomLabel(docstring const & label)
89 custom_label_ = translateIfPossible(label);
93 void InsetCaption::addToToc(DocIterator const & cpit, bool output_active,
94 UpdateType utype) const
96 string const & type = floattype_.empty() ? "senseless" : floattype_;
97 DocIterator pit = cpit;
98 pit.push_back(CursorSlice(const_cast<InsetCaption &>(*this)));
99 int length = (utype == OutputUpdate) ?
100 // For output (e.g. xhtml) all (bug #8603) or nothing
101 (output_active ? INT_MAX : 0) :
102 // TOC for LyX interface
107 text().forOutliner(str, length);
109 buffer().tocBackend().builder(type)->captionItem(pit, str, output_active);
110 // Proceed with the rest of the inset.
111 InsetText::addToToc(cpit, output_active, utype);
115 void InsetCaption::metrics(MetricsInfo & mi, Dimension & dim) const
117 FontInfo tmpfont = mi.base.font;
118 mi.base.font = mi.base.bv->buffer().params().getFont().fontInfo();
119 labelwidth_ = theFontMetrics(mi.base.font).width(full_label_);
120 // add some space to separate the label from the inset text
121 labelwidth_ += 2 * TEXT_TO_INSET_OFFSET;
122 dim.wid = labelwidth_;
124 // Correct for button and label width
125 mi.base.textwidth -= dim.wid;
126 InsetText::metrics(mi, textdim);
127 mi.base.font = tmpfont;
128 mi.base.textwidth += dim.wid;
129 dim.des = max(dim.des - textdim.asc + dim.asc, textdim.des);
130 dim.asc = textdim.asc;
131 dim.wid += textdim.wid;
135 void InsetCaption::drawBackground(PainterInfo & pi, int x, int y) const
137 TextMetrics & tm = pi.base.bv->textMetrics(&text());
138 int const h = tm.height() + 2 * TEXT_TO_INSET_OFFSET;
139 int const yy = y - TEXT_TO_INSET_OFFSET - tm.ascent();
140 pi.pain.fillRectangle(x, yy, labelwidth_, h, pi.backgroundColor(this));
144 void InsetCaption::draw(PainterInfo & pi, int x, int y) const
146 // We must draw the label, we should get the label string
147 // from the enclosing float inset.
148 // The question is: Who should draw the label, the caption inset,
149 // the text inset or the paragraph?
150 // We should also draw the float number (Lgb)
152 // Answer: the text inset (in buffer_funcs.cpp: setCaption).
154 FontInfo tmpfont = pi.base.font;
155 pi.base.font = pi.base.bv->buffer().params().getFont().fontInfo();
156 pi.base.font.setColor(pi.textColor(pi.base.font.color()).baseColor);
157 int const xx = x + TEXT_TO_INSET_OFFSET;
158 pi.pain.text(xx, y, full_label_, pi.base.font);
159 InsetText::draw(pi, x + labelwidth_, y);
160 pi.base.font = tmpfont;
164 void InsetCaption::edit(Cursor & cur, bool front, EntryDirection entry_from)
167 InsetText::edit(cur, front, entry_from);
171 Inset * InsetCaption::editXY(Cursor & cur, int x, int y)
174 return InsetText::editXY(cur, x, y);
178 bool InsetCaption::insetAllowed(InsetCode code) const
181 // code that is not allowed in a caption
192 return InsetText::insetAllowed(code);
197 void InsetCaption::doDispatch(Cursor & cur, FuncRequest & cmd)
199 switch (cmd.action()) {
201 case LFUN_INSET_MODIFY: {
202 if (cmd.getArg(0) == "changetype") {
203 cur.recordUndoInset(this);
204 type_ = cmd.getArg(1);
205 cur.forceBufferUpdate();
211 InsetText::doDispatch(cur, cmd);
217 bool InsetCaption::getStatus(Cursor & cur, FuncRequest const & cmd,
218 FuncStatus & status) const
220 switch (cmd.action()) {
222 case LFUN_INSET_MODIFY: {
223 string const first_arg = cmd.getArg(0);
224 if (first_arg == "changetype") {
225 string const type = cmd.getArg(1);
226 status.setOnOff(type == type_);
227 bool varia = type != "LongTableNoNumber";
228 // check if the immediate parent inset allows caption variation
229 if (cur.depth() > 1) {
230 varia = cur[cur.depth() - 2].inset().allowsCaptionVariation(type);
232 status.setEnabled(varia
233 && buffer().params().documentClass().hasInsetLayout(
234 from_ascii("Caption:" + type)));
237 return InsetText::getStatus(cur, cmd, status);
240 case LFUN_INSET_TOGGLE:
241 // pass back to owner
246 return InsetText::getStatus(cur, cmd, status);
251 void InsetCaption::latex(otexstream & os,
252 OutputParams const & runparams_in) const
254 if (runparams_in.inFloat == OutputParams::SUBFLOAT)
255 // caption is output as an optional argument
257 // This is a bit too simplistic to take advantage of
258 // caption options we must add more later. (Lgb)
259 // This code is currently only able to handle the simple
260 // \caption{...}, later we will make it take advantage
261 // of the one of the caption packages. (Lgb)
262 OutputParams runparams = runparams_in;
263 InsetText::latex(os, runparams);
264 // Backwards compatibility: We always had a linebreak after
265 // the caption (see #8514)
267 runparams_in.encoding = runparams.encoding;
271 int InsetCaption::plaintext(odocstringstream & os,
272 OutputParams const & runparams, size_t max_length) const
274 os << '[' << full_label_ << "\n";
275 InsetText::plaintext(os, runparams, max_length);
278 return PLAINTEXT_NEWLINE + 1; // one char on a separate line
282 int InsetCaption::docbook(odocstream & os,
283 OutputParams const & runparams) const
287 ret = InsetText::docbook(os, runparams);
293 docstring InsetCaption::xhtml(XHTMLStream & xs, OutputParams const & rp) const
295 if (rp.html_disable_captions)
297 InsetLayout const & il = getLayout();
298 string const & tag = il.htmltag();
299 string attr = il.htmlattr();
300 if (!type_.empty()) {
301 string const our_class = "float-caption-" + type_;
302 size_t const loc = attr.find("class='");
303 if (loc != string::npos)
304 attr.insert(loc + 7, our_class+ " ");
306 attr = attr + " class='" + our_class + "'";
308 xs << html::StartTag(tag, attr);
309 docstring def = getCaptionAsHTML(xs, rp);
310 xs << html::EndTag(tag);
315 void InsetCaption::getArgument(otexstream & os,
316 OutputParams const & runparams) const
318 InsetLayout const & il = getLayout();
320 if (!il.leftdelim().empty())
321 os << il.leftdelim();
323 OutputParams rp = runparams;
326 if (il.isNeedProtect())
327 rp.moving_arg = true;
329 rp.par_end = paragraphs().size();
331 // Output the contents of the inset
332 if (!paragraphs().empty())
333 os.texrow().forceStart(paragraphs()[0].id(), 0);
334 latexParagraphs(buffer(), text(), os, rp);
335 runparams.encoding = rp.encoding;
337 if (!il.rightdelim().empty())
338 os << il.rightdelim();
342 int InsetCaption::getCaptionAsPlaintext(odocstream & os,
343 OutputParams const & runparams) const
345 os << full_label_ << ' ';
346 odocstringstream ods;
347 int const retval = InsetText::plaintext(ods, runparams);
353 docstring InsetCaption::getCaptionAsHTML(XHTMLStream & xs,
354 OutputParams const & runparams) const
356 xs << full_label_ << ' ';
357 InsetText::XHTMLOptions const opts =
358 InsetText::WriteLabel | InsetText::WriteInnerTag;
359 return InsetText::insetAsXHTML(xs, runparams, opts);
363 void InsetCaption::updateBuffer(ParIterator const & it, UpdateType utype)
365 Buffer const & master = *buffer().masterBuffer();
366 DocumentClass const & tclass = master.params().documentClass();
367 string const & lang = it.paragraph().getParLanguage(master.params())->code();
368 Counters & cnts = tclass.counters();
369 string const & type = cnts.current_float();
370 if (utype == OutputUpdate) {
371 // counters are local to the caption
372 cnts.saveLastCounter();
374 // Memorize type for addToToc().
376 if (type.empty() || type == "senseless")
377 full_label_ = master.B_("Senseless!!! ");
379 // FIXME: life would be _much_ simpler if listings was
380 // listed in Floating.
382 if (type == "listing")
383 name = master.B_("Listing");
385 name = master.B_(tclass.floats().getType(type).name());
386 docstring counter = from_utf8(type);
387 if ((is_subfloat_ = cnts.isSubfloat())) {
388 // only standard captions allowed in subfloats
390 counter = "sub-" + from_utf8(type);
391 name = bformat(_("Sub-%1$s"),
392 master.B_(tclass.floats().getType(type).name()));
395 docstring const lstring = getLayout().labelstring();
396 docstring const labelstring = isAscii(lstring) ?
397 master.B_(to_ascii(lstring)) : lstring;
398 if (cnts.hasCounter(counter)) {
399 // for longtables, we step the counter upstream
400 if (!cnts.isLongtable())
401 cnts.step(counter, utype);
402 sec = cnts.theCounter(counter, lang);
404 if (labelstring != master.B_("standard")) {
406 sec += from_ascii(" ");
407 sec += bformat(from_ascii("(%1$s)"), labelstring);
410 full_label_ = bformat(from_ascii("%1$s %2$s: "), name, sec);
412 full_label_ = bformat(from_ascii("%1$s #: "), name);
415 // Do the real work now.
416 InsetText::updateBuffer(it, utype);
417 if (utype == OutputUpdate)
418 cnts.restoreLastCounter();
422 string InsetCaption::contextMenuName() const
424 return "context-caption";