src/insets/insetcaption.C

   1 /**
   2  * \file insetcaption.C
   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 "counters.h"
  20 #include "cursor.h"
  21 #include "BufferView.h"
  22 #include "Floating.h"
  23 #include "FloatList.h"
  24 #include "gettext.h"
  25 #include "LColor.h"
  26 #include "metricsinfo.h"
  27 #include "paragraph.h"
  28
  29 #include "frontends/FontMetrics.h"
  30 #include "frontends/Painter.h"
  31
  32 #include "support/lstrings.h"
  33 #include "support/convert.h"
  34
  35 #include <sstream>
  36
  37
  38 namespace lyx {
  39
  40 using support::bformat;
  41
  42 using std::auto_ptr;
  43 using std::endl;
  44 using std::string;
  45 using std::ostream;
  46
  47
  48 InsetCaption::InsetCaption(BufferParams const & bp)
  49         : InsetText(bp), textclass_(bp.getLyXTextClass())
  50 {
  51         setAutoBreakRows(true);
  52         setDrawFrame(true);
  53         setFrameColor(LColor::captionframe);
  54 }
  55
  56
  57 void InsetCaption::write(Buffer const & buf, ostream & os) const
  58 {
  59         os << "Caption\n";
  60         text_.write(buf, os);
  61 }
  62
  63
  64 void InsetCaption::read(Buffer const & buf, LyXLex & lex)
  65 {
  66 #if 0
  67         // We will enably this check again when the compability
  68         // code is removed from Buffer::Read (Lgb)
  69         string const token = lex.GetString();
  70         if (token != "Caption") {
  71                 lyxerr << "InsetCaption::Read: consistency check failed."
  72                        << endl;
  73         }
  74 #endif
  75         InsetText::read(buf, lex);
  76 }
  77
  78
  79 docstring const InsetCaption::editMessage() const
  80 {
  81         return _("Opened Caption Inset");
  82 }
  83
  84
  85 void InsetCaption::cursorPos(BufferView const & bv,
  86                 CursorSlice const & sl, bool boundary, int & x, int & y) const
  87 {
  88         InsetText::cursorPos(bv, sl, boundary, x, y);
  89         x += labelwidth_;
  90 }
  91
  92
  93 void InsetCaption::setLabel(LCursor & cur) const
  94 {
  95         // Set caption label _only_ if the cursor is in _this_ float:
  96         if (cur.top().text() == &text_) {
  97                 string s;
  98                 size_t i = cur.depth();
  99                 while (i > 0) {
 100                         --i;
 101                         InsetBase * const in = &cur[i].inset();
 102                         if (in->lyxCode() == InsetBase::FLOAT_CODE ||
 103                             in->lyxCode() == InsetBase::WRAP_CODE) {
 104                                 s = to_utf8(in->getInsetName());
 105                                 break;
 106                         }
 107                 }
 108                 Floating const & fl = textclass_.floats().getType(s);
 109                 s = fl.name();
 110                 docstring num;
 111                 if (s.empty())
 112                         s = "Senseless";
 113                 else
 114                         num = convert<docstring>(counter_);
 115
 116                 // Generate the label
 117                 label = bformat(from_ascii("%1$s %2$s:"), _(s), num);
 118         }
 119 }
 120
 121
 122 bool InsetCaption::metrics(MetricsInfo & mi, Dimension & dim) const
 123 {
 124         mi.base.textwidth -= 2 * TEXT_TO_INSET_OFFSET;
 125         LCursor cur = mi.base.bv->cursor();
 126         setLabel(cur);
 127         labelwidth_ = theFontMetrics(mi.base.font).width(label);
 128         dim.wid = labelwidth_;
 129         Dimension textdim;
 130         InsetText::metrics(mi, textdim);
 131         dim.des = std::max(dim.des - textdim.asc + dim.asc, textdim.des);
 132         dim.asc = textdim.asc;
 133         dim.wid += textdim.wid;
 134         dim.asc += TEXT_TO_INSET_OFFSET;
 135         dim.des += TEXT_TO_INSET_OFFSET;
 136         dim.wid += 2 * TEXT_TO_INSET_OFFSET;
 137         mi.base.textwidth += 2 * TEXT_TO_INSET_OFFSET;
 138         bool const changed = dim_ != dim;
 139         dim_ = dim;
 140         return changed;
 141 }
 142
 143
 144 void InsetCaption::draw(PainterInfo & pi, int x, int y) const
 145 {
 146         // We must draw the label, we should get the label string
 147         // from the enclosing float inset.
 148         // The question is: Who should draw the label, the caption inset,
 149         // the text inset or the paragraph?
 150         // We should also draw the float number (Lgb)
 151
 152         // See if we can find the name of the float this caption
 153         // belongs to.
 154         LCursor cur = pi.base.bv->cursor();
 155         setLabel(cur);
 156         labelwidth_ = pi.pain.text(x, y, label, pi.base.font);
 157         InsetText::draw(pi, x + labelwidth_, y);
 158         setPosCache(pi, x, y);
 159 }
 160
 161
 162 void InsetCaption::edit(LCursor & cur, bool left)
 163 {
 164         cur.push(*this);
 165         InsetText::edit(cur, left);
 166 }
 167
 168
 169 InsetBase * InsetCaption::editXY(LCursor & cur, int x, int y)
 170 {
 171         cur.push(*this);
 172         return InsetText::editXY(cur, x, y);
 173 }
 174
 175
 176 int InsetCaption::latex(Buffer const & buf, odocstream & os,
 177                         OutputParams const & runparams) const
 178 {
 179         // This is a bit too simplistic to take advantage of
 180         // caption options we must add more later. (Lgb)
 181         // This code is currently only able to handle the simple
 182         // \caption{...}, later we will make it take advantage
 183         // of the one of the caption packages. (Lgb)
 184         odocstringstream ost;
 185         int const l = InsetText::latex(buf, ost, runparams);
 186         os << "\\caption{" << ost.str() << "}\n";
 187         return l + 1;
 188 }
 189
 190
 191 int InsetCaption::plaintext(Buffer const & /*buf*/, odocstream & /*os*/,
 192                         OutputParams const & /*runparams*/) const
 193 {
 194         // FIXME: Implement me!
 195         return 0;
 196 }
 197
 198
 199 int InsetCaption::docbook(Buffer const & buf, odocstream & os,
 200                           OutputParams const & runparams) const
 201 {
 202         int ret;
 203         os << "<title>";
 204         ret = InsetText::docbook(buf, os, runparams);
 205         os << "</title>\n";
 206         return ret;
 207 }
 208
 209
 210 auto_ptr<InsetBase> InsetCaption::doClone() const
 211 {
 212         return auto_ptr<InsetBase>(new InsetCaption(*this));
 213 }
 214
 215
 216 } // namespace lyx