]> git.lyx.org Git - lyx.git/blob - src/insets/InsetCaption.cpp
Fix bug 4037 and related problems. The patch has been cleaned up a bit
[lyx.git] / src / insets / InsetCaption.cpp
1 /**
2  * \file InsetCaption.cpp
3  * This file is part of LyX, the document processor.
4  * Licence details can be found in the file COPYING.
5  *
6  * \author Lars Gullik Bjønnes
7  *
8  * Full author contact details are available in file CREDITS.
9  */
10
11 #include <config.h>
12
13 #include "InsetCaption.h"
14 #include "InsetFloat.h"
15 #include "InsetWrap.h"
16
17 #include "Buffer.h"
18 #include "BufferParams.h"
19 #include "BufferView.h"
20 #include "Counters.h"
21 #include "Cursor.h"
22 #include "Dimension.h"
23 #include "Floating.h"
24 #include "FloatList.h"
25 #include "FuncRequest.h"
26 #include "FuncStatus.h"
27 #include "support/gettext.h"
28 #include "InsetList.h"
29 #include "MetricsInfo.h"
30 #include "output_latex.h"
31 #include "OutputParams.h"
32 #include "Paragraph.h"
33 #include "paragraph_funcs.h"
34 #include "TextClass.h"
35 #include "TocBackend.h"
36
37 #include "frontends/FontMetrics.h"
38 #include "frontends/Painter.h"
39
40 #include "support/lstrings.h"
41
42 #include <sstream>
43
44 using namespace std;
45 using namespace lyx::support;
46
47 namespace lyx {
48
49
50 InsetCaption::InsetCaption(InsetCaption const & ic)
51         : InsetText(ic), textclass_(ic.textclass_)
52 {
53         setAutoBreakRows(true);
54         setDrawFrame(true);
55         setFrameColor(Color_captionframe);
56 }
57
58
59 InsetCaption::InsetCaption(BufferParams const & bp)
60         : InsetText(bp), textclass_(bp.getTextClass())
61 {
62         setAutoBreakRows(true);
63         setDrawFrame(true);
64         setFrameColor(Color_captionframe);
65         //FIXME Do we need to set all paragraphs here? or will there
66         //always only be one?
67         paragraphs().back().layout(bp.getTextClass().emptyLayout());
68 }
69
70
71 void InsetCaption::write(Buffer const & buf, ostream & os) const
72 {
73         os << "Caption\n";
74         text_.write(buf, os);
75 }
76
77
78 void InsetCaption::read(Buffer const & buf, Lexer & lex)
79 {
80 #if 0
81         // We will enably this check again when the compability
82         // code is removed from Buffer::Read (Lgb)
83         string const token = lex.GetString();
84         if (token != "Caption") {
85                 lyxerr << "InsetCaption::Read: consistency check failed."
86                        << endl;
87         }
88 #endif
89         InsetText::read(buf, lex);
90 }
91
92
93 docstring const InsetCaption::editMessage() const
94 {
95         return _("Opened Caption Inset");
96 }
97
98
99 void InsetCaption::cursorPos(BufferView const & bv,
100                 CursorSlice const & sl, bool boundary, int & x, int & y) const
101 {
102         InsetText::cursorPos(bv, sl, boundary, x, y);
103         x += labelwidth_;
104 }
105
106
107 void InsetCaption::setCustomLabel(docstring const & label)
108 {
109         if (!isAscii(label) || label.empty())
110                 // This must be a user defined layout. We cannot translate
111                 // this, since gettext accepts only ascii keys.
112                 custom_label_ = label;
113         else
114                 custom_label_ = _(to_ascii(label));
115 }
116
117
118 void InsetCaption::addToToc(TocList & toclist, Buffer const & buf, ParConstIterator const &) const
119 {
120         if (type_.empty())
121                 return;
122
123         ParConstIterator pit = par_const_iterator_begin(*this);
124
125         Toc & toc = toclist[type_];
126         docstring const str = full_label_ + ". " + pit->asString(buf, false);
127         toc.push_back(TocItem(pit, 0, str));
128 }
129
130
131 void InsetCaption::metrics(MetricsInfo & mi, Dimension & dim) const
132 {
133         FontInfo tmpfont = mi.base.font;
134         mi.base.font = mi.base.bv->buffer().params().getFont().fontInfo();
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_;
139         Dimension textdim;
140         // Correct for button and label width
141         mi.base.textwidth -= dim.wid;
142         InsetText::metrics(mi, textdim);
143         mi.base.font = tmpfont;
144         mi.base.textwidth += dim.wid;
145         dim.des = max(dim.des - textdim.asc + dim.asc, textdim.des);
146         dim.asc = textdim.asc;
147         dim.wid += textdim.wid;
148 }
149
150
151 void InsetCaption::draw(PainterInfo & pi, int x, int y) const
152 {
153         // We must draw the label, we should get the label string
154         // from the enclosing float inset.
155         // The question is: Who should draw the label, the caption inset,
156         // the text inset or the paragraph?
157         // We should also draw the float number (Lgb)
158
159         // Answer: the text inset (in buffer_funcs.cpp: setCaption).
160
161         FontInfo tmpfont = pi.base.font;
162         pi.base.font = pi.base.bv->buffer().params().getFont().fontInfo();
163         pi.pain.text(x, y, full_label_, pi.base.font);
164         InsetText::draw(pi, x + labelwidth_, y);
165         pi.base.font = tmpfont;
166 }
167
168
169 void InsetCaption::edit(Cursor & cur, bool front, EntryDirection entry_from)
170 {
171         cur.push(*this);
172         InsetText::edit(cur, front, entry_from);
173 }
174
175
176 Inset * InsetCaption::editXY(Cursor & cur, int x, int y)
177 {
178         cur.push(*this);
179         return InsetText::editXY(cur, x, y);
180 }
181
182
183 bool InsetCaption::insetAllowed(InsetCode code) const
184 {
185         switch (code) {
186         case FLOAT_CODE:
187         case TABULAR_CODE:
188         case WRAP_CODE:
189         case CAPTION_CODE:
190         case NEWPAGE_CODE:
191         case MATHMACRO_CODE:
192                 return false;
193         default:
194                 return InsetText::insetAllowed(code);
195         }
196 }
197
198
199 bool InsetCaption::getStatus(Cursor & cur, FuncRequest const & cmd,
200         FuncStatus & status) const
201 {
202         switch (cmd.action) {
203
204         case LFUN_BREAK_PARAGRAPH:
205         case LFUN_BREAK_PARAGRAPH_SKIP:
206                 status.enabled(false);
207                 return true;
208
209         case LFUN_OPTIONAL_INSERT:
210                 status.enabled(cur.paragraph().insetList().find(OPTARG_CODE) == -1);
211                 return true;
212
213         default:
214                 return InsetText::getStatus(cur, cmd, status);
215         }
216 }
217
218
219 int InsetCaption::latex(Buffer const & buf, odocstream & os,
220                         OutputParams const & runparams_in) const
221 {
222         // This is a bit too simplistic to take advantage of
223         // caption options we must add more later. (Lgb)
224         // This code is currently only able to handle the simple
225         // \caption{...}, later we will make it take advantage
226         // of the one of the caption packages. (Lgb)
227         OutputParams runparams = runparams_in;
228         // FIXME: actually, it is moving only when there is no
229         // optional argument.
230         runparams.moving_arg = true;
231         os << "\\caption";
232         int l = latexOptArgInsets(buf, paragraphs()[0], os, runparams, 1);
233         os << '{';
234         l += InsetText::latex(buf, os, runparams);
235         os << "}\n";
236         runparams_in.encoding = runparams.encoding;
237         return l + 1;
238 }
239
240
241 int InsetCaption::plaintext(Buffer const & buf, odocstream & os,
242                             OutputParams const & runparams) const
243 {
244         os << '[' << full_label_ << "\n";
245         InsetText::plaintext(buf, os, runparams);
246         os << "\n]";
247
248         return PLAINTEXT_NEWLINE + 1; // one char on a separate line
249 }
250
251
252 int InsetCaption::docbook(Buffer const & buf, odocstream & os,
253                           OutputParams const & runparams) const
254 {
255         int ret;
256         os << "<title>";
257         ret = InsetText::docbook(buf, os, runparams);
258         os << "</title>\n";
259         return ret;
260 }
261
262
263 int InsetCaption::getArgument(Buffer const & buf, odocstream & os,
264                         OutputParams const & runparams) const
265 {
266         return InsetText::latex(buf, os, runparams);
267 }
268
269
270 int InsetCaption::getOptArg(Buffer const & buf, odocstream & os,
271                         OutputParams const & runparams) const
272 {
273         return latexOptArgInsets(buf, paragraphs()[0], os, runparams, 1);
274 }
275
276
277 void InsetCaption::updateLabels(Buffer const & buf, ParIterator const & it)
278 {
279         TextClass const & tclass = buf.params().getTextClass();
280         Counters & cnts = tclass.counters();
281         string const & type = cnts.current_float();
282         // Memorize type for addToToc().
283         type_ = type;
284         if (type.empty())
285                 full_label_ = buf.B_("Senseless!!! ");
286         else {
287                 // FIXME: life would be _much_ simpler if listings was
288                 // listed in Floating.
289                 docstring name;
290                 if (type == "listing")
291                         name = buf.B_("Listing");
292                 else
293                         name = buf.B_(tclass.floats().getType(type).name());
294                 if (cnts.hasCounter(from_utf8(type))) {
295                         cnts.step(from_utf8(type));
296                         full_label_ = bformat(from_ascii("%1$s %2$s:"), 
297                                               name, 
298                                               cnts.theCounter(from_utf8(type)));
299                 } else
300                         full_label_ = bformat(from_ascii("%1$s #:"), name);     
301         }
302
303         // Do the real work now.
304         InsetText::updateLabels(buf, it);
305 }
306
307
308 Inset * InsetCaption::clone() const
309 {
310         return new InsetCaption(*this);
311 }
312
313
314 } // namespace lyx