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 "TextClass.h"
35 #include "TextMetrics.h"
36 #include "TocBackend.h"
38 #include "frontends/FontMetrics.h"
39 #include "frontends/Painter.h"
41 #include "support/gettext.h"
42 #include "support/lstrings.h"
47 using namespace lyx::support;
52 InsetCaption::InsetCaption(Buffer * buf)
53 : InsetText(buf, InsetText::PlainLayout)
55 setAutoBreakRows(true);
57 setFrameColor(Color_collapsableframe);
61 void InsetCaption::write(ostream & os) const
68 docstring InsetCaption::layoutName() const
71 return from_ascii("Caption");
72 return from_utf8("Caption:" + type_);
76 void InsetCaption::cursorPos(BufferView const & bv,
77 CursorSlice const & sl, bool boundary, int & x, int & y) const
79 InsetText::cursorPos(bv, sl, boundary, x, y);
84 void InsetCaption::setCustomLabel(docstring const & label)
86 if (!isAscii(label) || label.empty())
87 // This must be a user defined layout. We cannot translate
88 // this, since gettext accepts only ascii keys.
89 custom_label_ = label;
91 custom_label_ = _(to_ascii(label));
95 void InsetCaption::addToToc(DocIterator const & cpit) const
100 DocIterator pit = cpit;
101 pit.push_back(CursorSlice(const_cast<InsetCaption &>(*this)));
103 Toc & toc = buffer().tocBackend().toc(type_);
104 docstring str = full_label_ + ". ";
105 text().forToc(str, TOC_ENTRY_LENGTH);
106 toc.push_back(TocItem(pit, 0, str));
108 // Proceed with the rest of the inset.
109 InsetText::addToToc(cpit);
113 void InsetCaption::metrics(MetricsInfo & mi, Dimension & dim) const
115 FontInfo tmpfont = mi.base.font;
116 mi.base.font = mi.base.bv->buffer().params().getFont().fontInfo();
117 labelwidth_ = theFontMetrics(mi.base.font).width(full_label_);
118 // add some space to separate the label from the inset text
119 labelwidth_ += 2 * TEXT_TO_INSET_OFFSET;
120 dim.wid = labelwidth_;
122 // Correct for button and label width
123 mi.base.textwidth -= dim.wid;
124 InsetText::metrics(mi, textdim);
125 mi.base.font = tmpfont;
126 mi.base.textwidth += dim.wid;
127 dim.des = max(dim.des - textdim.asc + dim.asc, textdim.des);
128 dim.asc = textdim.asc;
129 dim.wid += textdim.wid;
133 void InsetCaption::drawBackground(PainterInfo & pi, int x, int y) const
135 TextMetrics & tm = pi.base.bv->textMetrics(&text());
136 int const h = tm.height() + 2 * TEXT_TO_INSET_OFFSET;
137 int const yy = y - TEXT_TO_INSET_OFFSET - tm.ascent();
138 pi.pain.fillRectangle(x, yy, labelwidth_, h, pi.backgroundColor(this));
142 void InsetCaption::draw(PainterInfo & pi, int x, int y) const
144 // We must draw the label, we should get the label string
145 // from the enclosing float inset.
146 // The question is: Who should draw the label, the caption inset,
147 // the text inset or the paragraph?
148 // We should also draw the float number (Lgb)
150 // Answer: the text inset (in buffer_funcs.cpp: setCaption).
152 FontInfo tmpfont = pi.base.font;
153 pi.base.font = pi.base.bv->buffer().params().getFont().fontInfo();
154 pi.base.font.setColor(pi.textColor(pi.base.font.color()).baseColor);
155 int const xx = x + TEXT_TO_INSET_OFFSET;
156 pi.pain.text(xx, y, full_label_, pi.base.font);
157 InsetText::draw(pi, x + labelwidth_, y);
158 pi.base.font = tmpfont;
162 void InsetCaption::edit(Cursor & cur, bool front, EntryDirection entry_from)
165 InsetText::edit(cur, front, entry_from);
169 Inset * InsetCaption::editXY(Cursor & cur, int x, int y)
172 return InsetText::editXY(cur, x, y);
176 bool InsetCaption::insetAllowed(InsetCode code) const
179 // code that is not allowed in a caption
190 return InsetText::insetAllowed(code);
195 bool InsetCaption::getStatus(Cursor & cur, FuncRequest const & cmd,
196 FuncStatus & status) const
198 switch (cmd.action()) {
200 case LFUN_PARAGRAPH_BREAK:
201 status.setEnabled(false);
204 case LFUN_INSET_TOGGLE:
205 // pass back to owner
210 return InsetText::getStatus(cur, cmd, status);
215 void InsetCaption::latex(otexstream & os,
216 OutputParams const & runparams_in) const
218 if (runparams_in.inFloat == OutputParams::SUBFLOAT)
219 // caption is output as an optional argument
221 // This is a bit too simplistic to take advantage of
222 // caption options we must add more later. (Lgb)
223 // This code is currently only able to handle the simple
224 // \caption{...}, later we will make it take advantage
225 // of the one of the caption packages. (Lgb)
226 OutputParams runparams = runparams_in;
227 // FIXME: actually, it is moving only when there is no
228 // optional argument.
229 runparams.moving_arg = true;
230 InsetText::latex(os, runparams);
231 runparams_in.encoding = runparams.encoding;
235 int InsetCaption::plaintext(odocstream & os,
236 OutputParams const & runparams) const
238 os << '[' << full_label_ << "\n";
239 InsetText::plaintext(os, runparams);
242 return PLAINTEXT_NEWLINE + 1; // one char on a separate line
246 int InsetCaption::docbook(odocstream & os,
247 OutputParams const & runparams) const
251 ret = InsetText::docbook(os, runparams);
257 docstring InsetCaption::xhtml(XHTMLStream & xs, OutputParams const & rp) const
259 if (rp.html_disable_captions)
261 string attr = "class='float-caption";
263 attr += " float-caption-" + type_;
265 xs << html::StartTag("div", attr);
266 docstring def = getCaptionAsHTML(xs, rp);
267 xs << html::EndTag("div");
272 void InsetCaption::getArgument(otexstream & os,
273 OutputParams const & runparams) const
275 InsetLayout const & il = getLayout();
277 if (!il.leftdelim().empty())
278 os << il.leftdelim();
280 OutputParams rp = runparams;
283 if (il.isNeedProtect())
284 rp.moving_arg = true;
286 rp.par_end = paragraphs().size();
288 // Output the contents of the inset
289 latexParagraphs(buffer(), text(), os, rp);
290 runparams.encoding = rp.encoding;
292 if (!il.rightdelim().empty())
293 os << il.rightdelim();
297 int InsetCaption::getCaptionAsPlaintext(odocstream & os,
298 OutputParams const & runparams) const
300 os << full_label_ << ' ';
301 return InsetText::plaintext(os, runparams);
305 docstring InsetCaption::getCaptionAsHTML(XHTMLStream & xs,
306 OutputParams const & runparams) const
308 xs << full_label_ << ' ';
309 InsetText::XHTMLOptions const opts =
310 InsetText::WriteLabel | InsetText::WriteInnerTag;
311 return InsetText::insetAsXHTML(xs, runparams, opts);
315 void InsetCaption::updateBuffer(ParIterator const & it, UpdateType utype)
317 Buffer const & master = *buffer().masterBuffer();
318 DocumentClass const & tclass = master.params().documentClass();
319 string const & lang = it.paragraph().getParLanguage(master.params())->code();
320 Counters & cnts = tclass.counters();
321 string const & type = cnts.current_float();
322 if (utype == OutputUpdate) {
323 // counters are local to the caption
324 cnts.saveLastCounter();
326 // Memorize type for addToToc().
329 full_label_ = master.B_("Senseless!!! ");
331 // FIXME: life would be _much_ simpler if listings was
332 // listed in Floating.
334 if (type == "listing")
335 name = master.B_("Listing");
337 name = master.B_(tclass.floats().getType(type).name());
338 docstring counter = from_utf8(type);
339 if (cnts.isSubfloat()) {
340 counter = "sub-" + from_utf8(type);
341 name = bformat(_("Sub-%1$s"),
342 master.B_(tclass.floats().getType(type).name()));
344 if (cnts.hasCounter(counter)) {
345 cnts.step(counter, utype);
346 full_label_ = bformat(from_ascii("%1$s %2$s:"),
348 cnts.theCounter(counter, lang));
350 full_label_ = bformat(from_ascii("%1$s #:"), name);
353 // Do the real work now.
354 InsetText::updateBuffer(it, utype);
355 if (utype == OutputUpdate)
356 cnts.restoreLastCounter();