3 * This file is part of LyX, the document processor.
4 * Licence details can be found in the file COPYING.
7 * \author Lars Gullik Bjønnes
9 * Full author contact details are available in file CREDITS.
14 #include "InsetFoot.h"
18 #include "BufferParams.h"
21 #include "LaTeXFeatures.h"
23 #include "OutputParams.h"
24 #include "output_docbook.h"
25 #include "ParIterator.h"
26 #include "TextClass.h"
27 #include "TocBackend.h"
29 #include "support/debug.h"
30 #include "support/docstream.h"
31 #include "support/gettext.h"
32 #include "support/lstrings.h"
38 InsetFoot::InsetFoot(Buffer * buf)
39 : InsetFootlike(buf), intitle_(false), infloattable_(false)
43 docstring InsetFoot::layoutName() const
46 return from_ascii("Foot:InTitle");
47 else if (infloattable_)
48 return from_ascii("Foot:InFloatTable");
49 return from_ascii("Foot");
53 void InsetFoot::updateBuffer(ParIterator const & it, UpdateType utype, bool const deleted)
55 BufferParams const & bp = buffer().masterBuffer()->params();
56 Counters & cnts = bp.documentClass().counters();
57 if (utype == OutputUpdate) {
58 // the footnote counter is local to this inset
59 cnts.saveLastCounter();
63 infloattable_ = false;
65 if (it.innerInsetOfType(TABULAR_CODE) != 0)
67 if (it.innerInsetOfType(FLOAT_CODE) != 0)
68 infloattable_ = intable;
69 // If we are in a table in a float, but the table is also in a minipage,
70 // we do not use tablefootnote, since minipages provide their own footnotes.
71 if (intable && infloattable_ && it.innerInsetOfType(BOX_CODE) != 0) {
72 InsetBoxParams const & boxp =
73 static_cast<InsetBox*>(it.innerInsetOfType(BOX_CODE))->params();
74 if (boxp.inner_box && !boxp.use_parbox && !boxp.use_makebox)
75 infloattable_ = false;
77 for (size_type sl = 0 ; sl < it.depth() ; ++sl) {
78 if (it[sl].text() && it[sl].paragraph().layout().intitle) {
84 Language const * lang = it.paragraph().getParLanguage(bp);
85 InsetLayout const & il = getLayout();
86 docstring const & count = il.counter();
87 custom_label_ = translateIfPossible(il.labelstring());
89 int val = cnts.value(count);
90 if (cnts.hasCounter(count)) {
91 cnts.step(count, utype);
92 custom_label_ += ' ' + cnts.theCounter(count, lang->code());
94 // un-step after deleted counter
97 custom_label_ += ' ' + from_ascii("#");
98 setLabel(custom_label_);
100 InsetCollapsible::updateBuffer(it, utype, deleted);
101 if (utype == OutputUpdate)
102 cnts.restoreLastCounter();
106 docstring InsetFoot::toolTip(BufferView const & bv, int x, int y) const
109 // this will give us something useful if there is no button
110 return InsetCollapsible::toolTip(bv, x, y);
111 return toolTipText(custom_label_+ ": ");
115 int InsetFoot::plaintext(odocstringstream & os,
116 OutputParams const & runparams, size_t max_length) const
118 os << '[' << buffer().B_("footnote") << ":\n";
119 InsetText::plaintext(os, runparams, max_length);
122 return PLAINTEXT_NEWLINE + 1; // one char on a separate line
126 void InsetFoot::docbook(XMLStream & xs, OutputParams const & runparams) const
128 OutputParams rp = runparams;
129 rp.docbook_force_pars = true;
130 rp.docbook_in_par = false;
131 InsetText::docbook(xs, rp);
135 void InsetFoot::validate(LaTeXFeatures & features) const
137 // Use footnote package to provide footnotes in tables
138 // unless an alternative approach is built in the class.
139 if (!features.saveNoteEnv().empty()
140 && !features.isProvided("footnote-alternative")) {
141 features.require("footnote");
142 features.addPreambleSnippet(
143 from_ascii("\\makesavenoteenv{"
144 + features.saveNoteEnv()
148 InsetText::validate(features);