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"
21 #include "BufferView.h"
23 #include "FloatList.h"
24 #include "FuncRequest.h"
25 #include "FuncStatus.h"
28 #include "MetricsInfo.h"
29 #include "output_latex.h"
30 #include "OutputParams.h"
31 #include "Paragraph.h"
32 #include "paragraph_funcs.h"
33 #include "TocBackend.h"
35 #include "frontends/FontMetrics.h"
36 #include "frontends/Painter.h"
38 #include "support/lstrings.h"
51 using support::bformat;
53 InsetCaption::InsetCaption(InsetCaption const & ic)
54 : InsetText(ic), textclass_(ic.textclass_)
56 setAutoBreakRows(true);
58 setFrameColor(Color::captionframe);
61 InsetCaption::InsetCaption(BufferParams const & bp)
62 : InsetText(bp), textclass_(bp.getTextClass())
64 setAutoBreakRows(true);
66 setFrameColor(Color::captionframe);
70 void InsetCaption::write(Buffer const & buf, ostream & os) const
77 void InsetCaption::read(Buffer const & buf, Lexer & lex)
80 // We will enably this check again when the compability
81 // code is removed from Buffer::Read (Lgb)
82 string const token = lex.GetString();
83 if (token != "Caption") {
84 lyxerr << "InsetCaption::Read: consistency check failed."
88 InsetText::read(buf, lex);
92 docstring const InsetCaption::editMessage() const
94 return _("Opened Caption Inset");
98 void InsetCaption::cursorPos(BufferView const & bv,
99 CursorSlice const & sl, bool boundary, int & x, int & y) const
101 InsetText::cursorPos(bv, sl, boundary, x, y);
106 void InsetCaption::setCustomLabel(docstring const & label)
108 if (!support::isAscii(label) || label.empty())
109 // This must be a user defined layout. We cannot translate
110 // this, since gettext accepts only ascii keys.
111 custom_label_ = label;
113 custom_label_ = _(to_ascii(label));
117 void InsetCaption::addToToc(TocList & toclist, Buffer const & buf, ParConstIterator const &) const
122 ParConstIterator pit = par_const_iterator_begin(*this);
124 Toc & toc = toclist[type_];
125 docstring const str = full_label_ + ". " + pit->asString(buf, false);
126 toc.push_back(TocItem(pit, 0, str));
130 bool InsetCaption::metrics(MetricsInfo & mi, Dimension & dim) const
132 int const width_offset = TEXT_TO_INSET_OFFSET / 2;
133 mi.base.textwidth -= width_offset;
135 labelwidth_ = theFontMetrics(mi.base.font).width(full_label_);
136 // add some space to separate the label from the inset text
137 labelwidth_ += 2 * TEXT_TO_INSET_OFFSET;
138 dim.wid = labelwidth_;
140 InsetText::metrics(mi, textdim);
141 // Correct for button width, and re-fit
142 mi.base.textwidth -= dim.wid;
143 InsetText::metrics(mi, textdim);
144 dim.des = std::max(dim.des - textdim.asc + dim.asc, textdim.des);
145 dim.asc = textdim.asc;
146 dim.wid += textdim.wid;
147 dim.asc += TEXT_TO_INSET_OFFSET;
148 dim.des += TEXT_TO_INSET_OFFSET;
149 dim.wid += width_offset;
150 mi.base.textwidth += width_offset;
151 bool const changed = dim_ != dim;
157 void InsetCaption::draw(PainterInfo & pi, int x, int y) const
159 // We must draw the label, we should get the label string
160 // from the enclosing float inset.
161 // The question is: Who should draw the label, the caption inset,
162 // the text inset or the paragraph?
163 // We should also draw the float number (Lgb)
165 // Answer: the text inset (in buffer_funcs.cpp: setCaption).
167 labelwidth_ = pi.pain.text(x, y, full_label_, pi.base.font);
168 // add some space to separate the label from the inset text
169 labelwidth_ += 2 * TEXT_TO_INSET_OFFSET;
170 InsetText::draw(pi, x + labelwidth_, y);
171 setPosCache(pi, x, y);
175 void InsetCaption::drawSelection(PainterInfo & pi, int x, int y) const
177 InsetText::drawSelection(pi, x + labelwidth_, y);
181 void InsetCaption::edit(Cursor & cur, bool left)
184 InsetText::edit(cur, left);
188 Inset * InsetCaption::editXY(Cursor & cur, int x, int y)
191 return InsetText::editXY(cur, x, y);
195 bool InsetCaption::insetAllowed(Inset::Code code) const
205 return InsetText::insetAllowed(code);
210 bool InsetCaption::getStatus(Cursor & cur, FuncRequest const & cmd,
211 FuncStatus & status) const
213 switch (cmd.action) {
215 case LFUN_BREAK_PARAGRAPH:
216 case LFUN_BREAK_PARAGRAPH_KEEP_LAYOUT:
217 case LFUN_BREAK_PARAGRAPH_SKIP:
218 status.enabled(false);
221 case LFUN_OPTIONAL_INSERT:
222 status.enabled(numberOfOptArgs(cur.paragraph()) == 0);
226 return InsetText::getStatus(cur, cmd, status);
231 int InsetCaption::latex(Buffer const & buf, odocstream & os,
232 OutputParams const & runparams_in) const
234 // This is a bit too simplistic to take advantage of
235 // caption options we must add more later. (Lgb)
236 // This code is currently only able to handle the simple
237 // \caption{...}, later we will make it take advantage
238 // of the one of the caption packages. (Lgb)
239 OutputParams runparams = runparams_in;
240 // FIXME: actually, it is moving only when there is no
241 // optional argument.
242 runparams.moving_arg = true;
244 int l = latexOptArgInsets(buf, paragraphs()[0], os, runparams, 1);
246 l += InsetText::latex(buf, os, runparams);
248 runparams_in.encoding = runparams.encoding;
253 int InsetCaption::plaintext(Buffer const & buf, odocstream & os,
254 OutputParams const & runparams) const
256 os << '[' << full_label_ << "\n";
257 InsetText::plaintext(buf, os, runparams);
260 return PLAINTEXT_NEWLINE + 1; // one char on a separate line
264 int InsetCaption::docbook(Buffer const & buf, odocstream & os,
265 OutputParams const & runparams) const
269 ret = InsetText::docbook(buf, os, runparams);
275 int InsetCaption::getArgument(Buffer const & buf, odocstream & os,
276 OutputParams const & runparams) const
278 return InsetText::latex(buf, os, runparams);
282 int InsetCaption::getOptArg(Buffer const & buf, odocstream & os,
283 OutputParams const & runparams) const
285 return latexOptArgInsets(buf, paragraphs()[0], os, runparams, 1);
289 void InsetCaption::updateLabels(Buffer const & buf, ParIterator const & it)
291 TextClass const & tclass = buf.params().getTextClass();
292 Counters & cnts = tclass.counters();
293 string const & type = cnts.current_float();
295 full_label_ = buf.B_("Senseless!!! ");
297 // FIXME: life would be _much_ simpler if listings was
298 // listed in Floating.
300 if (type == "listing")
301 name = buf.B_("Listing");
303 name = buf.B_(tclass.floats().getType(type).name());
304 if (cnts.hasCounter(from_utf8(type))) {
305 cnts.step(from_utf8(type));
306 full_label_ = bformat(from_ascii("%1$s %2$s:"),
308 cnts.theCounter(from_utf8(type)));
310 full_label_ = bformat(from_ascii("%1$s #:"), name);
313 // Do the real work now.
314 InsetText::updateLabels(buf, it);
318 auto_ptr<Inset> InsetCaption::doClone() const
320 return auto_ptr<Inset>(new InsetCaption(*this));