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/font_metrics.h"
  30 #include "frontends/Painter.h"
  31
  32 #include "support/lstrings.h"
  33 #include "support/convert.h"
  34
  35 #include <sstream>
  36
  37 using lyx::docstring;
  38 using lyx::support::bformat;
  39
  40 using std::auto_ptr;
  41 using std::endl;
  42 using std::string;
  43 using std::ostream;
  44 using std::ostringstream;
  45
  46
  47 InsetCaption::InsetCaption(BufferParams const & bp)
  48         : InsetText(bp), textclass_(bp.getLyXTextClass())
  49 {
  50         setAutoBreakRows(true);
  51         setDrawFrame(true);
  52         setFrameColor(LColor::captionframe);
  53 }
  54
  55
  56 void InsetCaption::write(Buffer const & buf, ostream & os) const
  57 {
  58         os << "Caption\n";
  59         text_.write(buf, os);
  60 }
  61
  62
  63 void InsetCaption::read(Buffer const & buf, LyXLex & lex)
  64 {
  65 #if 0
  66         // We will enably this check again when the compability
  67         // code is removed from Buffer::Read (Lgb)
  68         string const token = lex.GetString();
  69         if (token != "Caption") {
  70                 lyxerr << "InsetCaption::Read: consistency check failed."
  71                        << endl;
  72         }
  73 #endif
  74         InsetText::read(buf, lex);
  75 }
  76
  77
  78 string const InsetCaption::editMessage() const
  79 {
  80         return _("Opened Caption Inset");
  81 }
  82
  83
  84 void InsetCaption::cursorPos
  85         (CursorSlice const & sl, bool boundary, int & x, int & y) const
  86 {
  87         InsetText::cursorPos(sl, boundary, x, y);
  88         x += labelwidth_;
  89 }
  90
  91
  92 void InsetCaption::setLabel(LCursor & cur) const
  93 {
  94         // Set caption label _only_ if the cursor is in _this_ float:
  95         if (cur.top().text() == &text_) {
  96                 string s;
  97                 size_t i = cur.depth();
  98                         while (i > 0) {
  99                                 --i;
 100                                 InsetBase * const in = &cur[i].inset();
 101                                 if (in->lyxCode() == InsetBase::FLOAT_CODE
 102                                     || in->lyxCode() == InsetBase::WRAP_CODE) {
 103                                         s = in->getInsetName();
 104                                         break;
 105                                 }
 106                         }
 107                 Floating const & fl = textclass_.floats().getType(s);
 108                 s = fl.name();
 109                 string num;
 110                 if (s.empty())
 111                         s = "Senseless";
 112                 else
 113                         num = convert<string>(counter_);
 114
 115                 // Generate the label
 116                 label = bformat("%1$s %2$s:", _(s), num);
 117         }
 118 }
 119
 120
 121 void InsetCaption::metrics(MetricsInfo & mi, Dimension & dim) const
 122 {
 123         mi.base.textwidth -= 2 * TEXT_TO_INSET_OFFSET;
 124         LCursor cur = mi.base.bv->cursor();
 125         setLabel(cur);
 126         docstring dlab(label.begin(), label.end());
 127         labelwidth_ = font_metrics::width(dlab, mi.base.font);
 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         dim_ = dim;
 139 }
 140
 141
 142 void InsetCaption::draw(PainterInfo & pi, int x, int y) const
 143 {
 144         // We must draw the label, we should get the label string
 145         // from the enclosing float inset.
 146         // The question is: Who should draw the label, the caption inset,
 147         // the text inset or the paragraph?
 148         // We should also draw the float number (Lgb)
 149
 150         // See if we can find the name of the float this caption
 151         // belongs to.
 152         LCursor cur = pi.base.bv->cursor();
 153         setLabel(cur);
 154         docstring dlab(label.begin(), label.end());
 155         labelwidth_ = font_metrics::width(dlab, pi.base.font);
 156         pi.pain.text(x, y, dlab, 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, ostream & 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         ostringstream 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*/,ostream & /*os*/,
 192                         OutputParams const & /*runparams*/) const
 193 {
 194         // FIXME: Implement me!
 195         return 0;
 196 }
 197
 198
 199 int InsetCaption::docbook(Buffer const & buf, ostream & 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 }