src/insets/InsetFoot.cpp

   1 /**
   2  * \file InsetFoot.cpp
   3  * This file is part of LyX, the document processor.
   4  * Licence details can be found in the file COPYING.
   5  *
   6  * \author Jürgen Vigna
   7  * \author Lars Gullik Bjønnes
   8  *
   9  * Full author contact details are available in file CREDITS.
  10  */
  11
  12 #include <config.h>
  13
  14 #include "InsetFoot.h"
  15
  16 #include "Buffer.h"
  17 #include "BufferParams.h"
  18 #include "Counters.h"
  19 #include "Language.h"
  20 #include "Layout.h"
  21 #include "OutputParams.h"
  22 #include "ParIterator.h"
  23 #include "TextClass.h"
  24 #include "TocBackend.h"
  25
  26 #include "support/debug.h"
  27 #include "support/docstream.h"
  28 #include "support/gettext.h"
  29
  30 using namespace std;
  31
  32 namespace lyx {
  33
  34 InsetFoot::InsetFoot(Buffer * buf)
  35         : InsetFootlike(buf), intitle_(false)
  36 {}
  37
  38
  39 docstring InsetFoot::layoutName() const
  40 {
  41         return intitle_ ? from_ascii("Foot:InTitle") : from_ascii("Foot");
  42 }
  43
  44
  45 void InsetFoot::updateBuffer(ParIterator const & it, UpdateType utype)
  46 {
  47         BufferParams const & bp = buffer().masterBuffer()->params();
  48         Counters & cnts = bp.documentClass().counters();
  49         if (utype == OutputUpdate) {
  50                 // the footnote counter is local to this inset
  51                 cnts.saveLastCounter();
  52         }
  53
  54         intitle_ = false;
  55         for (size_type sl = 0 ; sl < it.depth() ; ++ sl) {
  56                 if (it[sl].text() && it[sl].paragraph().layout().intitle) {
  57                         intitle_ = true;
  58                         break;
  59                 }
  60         }
  61
  62         Language const * lang = it.paragraph().getParLanguage(bp);
  63         InsetLayout const & il = getLayout();
  64         docstring const & count = il.counter();
  65         custom_label_ = translateIfPossible(il.labelstring());
  66         if (cnts.hasCounter(count))
  67                 cnts.step(count, utype);
  68         custom_label_ += ' ' + cnts.theCounter(count, lang->code());
  69         setLabel(custom_label_);
  70
  71         InsetCollapsable::updateBuffer(it, utype);
  72         if (utype == OutputUpdate)
  73                 cnts.restoreLastCounter();
  74 }
  75
  76
  77 void InsetFoot::addToToc(DocIterator const & cpit, bool output_active,
  78                                                  UpdateType utype) const
  79 {
  80         DocIterator pit = cpit;
  81         pit.push_back(CursorSlice(const_cast<InsetFoot &>(*this)));
  82
  83         shared_ptr<Toc> toc = buffer().tocBackend().toc("footnote");
  84         docstring str = custom_label_ + ": ";
  85         text().forOutliner(str, TOC_ENTRY_LENGTH);
  86         toc->push_back(TocItem(pit, 0, str, output_active, toolTipText(docstring(), 3, 60)));
  87         // Proceed with the rest of the inset.
  88         InsetFootlike::addToToc(cpit, output_active, utype);
  89 }
  90
  91
  92 docstring InsetFoot::toolTip(BufferView const & bv, int x, int y) const
  93 {
  94         if (isOpen(bv))
  95                 // this will give us something useful if there is no button
  96                 return InsetCollapsable::toolTip(bv, x, y);
  97         return toolTipText(custom_label_+ ": ");
  98 }
  99
 100
 101 int InsetFoot::plaintext(odocstringstream & os,
 102         OutputParams const & runparams, size_t max_length) const
 103 {
 104         os << '[' << buffer().B_("footnote") << ":\n";
 105         InsetText::plaintext(os, runparams, max_length);
 106         os << "\n]";
 107
 108         return PLAINTEXT_NEWLINE + 1; // one char on a separate line
 109 }
 110
 111
 112 int InsetFoot::docbook(odocstream & os, OutputParams const & runparams) const
 113 {
 114         os << "<footnote>";
 115         int const i = InsetText::docbook(os, runparams);
 116         os << "</footnote>";
 117
 118         return i;
 119 }
 120
 121 } // namespace lyx