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