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"
39 #include "support/convert.h"
52 using support::bformat;
54 InsetCaption::InsetCaption(BufferParams const & bp)
55 : InsetText(bp), textclass_(bp.getLyXTextClass())
57 setAutoBreakRows(true);
59 setFrameColor(LColor::captionframe);
63 void InsetCaption::write(Buffer const & buf, ostream & os) const
70 void InsetCaption::read(Buffer const & buf, LyXLex & lex)
73 // We will enably this check again when the compability
74 // code is removed from Buffer::Read (Lgb)
75 string const token = lex.GetString();
76 if (token != "Caption") {
77 lyxerr << "InsetCaption::Read: consistency check failed."
81 InsetText::read(buf, lex);
85 docstring const InsetCaption::editMessage() const
87 return _("Opened Caption Inset");
91 void InsetCaption::cursorPos(BufferView const & bv,
92 CursorSlice const & sl, bool boundary, int & x, int & y) const
94 InsetText::cursorPos(bv, sl, boundary, x, y);
99 void InsetCaption::setCustomLabel(docstring const & label)
101 if (!support::isAscii(label) || label.empty())
102 // This must be a user defined layout. We cannot translate
103 // this, since gettext accepts only ascii keys.
104 custom_label_ = label;
106 custom_label_ = _(to_ascii(label));
110 void InsetCaption::addToToc(TocList & toclist, Buffer const & buf) const
115 ParConstIterator pit = par_const_iterator_begin(*this);
117 Toc & toc = toclist[type_];
118 docstring const str = convert<docstring>(counter_)
119 + ". " + pit->asString(buf, false);
120 toc.push_back(TocItem(pit, 0, str));
124 bool InsetCaption::metrics(MetricsInfo & mi, Dimension & dim) const
126 int const width_offset = TEXT_TO_INSET_OFFSET / 2;
127 mi.base.textwidth -= width_offset;
129 full_label_ = _("Senseless!!! ");
131 docstring const number = convert<docstring>(counter_);
132 docstring label = custom_label_.empty()? _(type_): custom_label_;
133 full_label_ = bformat(from_ascii("%1$s %2$s:"), label, number);
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.C: 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(LCursor & cur, bool left)
184 InsetText::edit(cur, left);
188 InsetBase * InsetCaption::editXY(LCursor & cur, int x, int y)
191 return InsetText::editXY(cur, x, y);
195 bool InsetCaption::insetAllowed(InsetBase::Code code) const
205 return InsetText::insetAllowed(code);
210 bool InsetCaption::getStatus(LCursor & 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);
252 int InsetCaption::plaintext(Buffer const & buf, odocstream & os,
253 OutputParams const & runparams) const
255 os << full_label_ << ' ';
256 return InsetText::plaintext(buf, os, runparams);
260 int InsetCaption::docbook(Buffer const & buf, odocstream & os,
261 OutputParams const & runparams) const
265 ret = InsetText::docbook(buf, os, runparams);
271 auto_ptr<InsetBase> InsetCaption::doClone() const
273 return auto_ptr<InsetBase>(new InsetCaption(*this));