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 "frontends/Painter.h"
  15 #include "frontends/font_metrics.h"
  16 #include "BufferView.h"
  17 #include "buffer.h"
  18 #include "FloatList.h"
  19 #include "insets/insetfloat.h"
  20 #include "insets/insetwrap.h"
  21 #include "debug.h"
  22 #include "gettext.h"
  23 #include "Lsstream.h"
  24 #include "support/lstrings.h"
  25 #include "support/LAssert.h"
  26 #include "support/BoostFormat.h"
  27
  28 using std::ostream;
  29 using std::endl;
  30
  31 InsetCaption::InsetCaption(BufferParams const & bp)
  32         : InsetText(bp)
  33 {
  34         setAutoBreakRows(true);
  35         setDrawFrame(0, InsetText::LOCKED);
  36         setFrameColor(0, LColor::captionframe);
  37 }
  38
  39
  40 void InsetCaption::write(Buffer const * buf, ostream & os) const
  41 {
  42         os << "Caption\n";
  43         writeParagraphData(buf, os);
  44 }
  45
  46
  47
  48 void InsetCaption::read(Buffer const * buf, LyXLex & lex)
  49 {
  50 #if 0
  51         // We will enably this check again when the compability
  52         // code is removed from Buffer::Read (Lgb)
  53         string const token = lex.GetString();
  54         if (token != "Caption") {
  55                 lyxerr << "InsetCaption::Read: consistency check failed."
  56                        << endl;
  57         }
  58 #endif
  59         InsetText::read(buf, lex);
  60 }
  61
  62
  63 string const InsetCaption::editMessage() const
  64 {
  65         return _("Opened Caption Inset");
  66 }
  67
  68
  69 void InsetCaption::draw(BufferView * bv, LyXFont const & f,
  70                         int baseline, float & x) const
  71 {
  72         // We must draw the label, we should get the label string
  73         // from the enclosing float inset.
  74         // The question is: Who should draw the label, the caption inset,
  75         // the text inset or the paragraph?
  76         // We should also draw the float number (Lgb)
  77
  78         // See if we can find the name of the float this caption
  79         // belongs to.
  80         Inset * i1 = owner();
  81         Inset * i2 = i1 ? i1->owner() : 0;
  82         string type;
  83         if (i2->lyxCode() == FLOAT_CODE)
  84                 type = static_cast<InsetFloat *>(i2)->params().type;
  85         else if (i2->lyxCode() == WRAP_CODE)
  86                 type = static_cast<InsetWrap *>(i2)->params().type;
  87         else
  88                 lyx::Assert(0);
  89
  90         FloatList const & floats =
  91                 bv->buffer()->params.getLyXTextClass().floats();
  92         string const fl = i2 ? floats.getType(type).name() : N_("Float");
  93
  94         // Discover the number...
  95         string const num = "#";
  96
  97         // Generate the label
  98         string const label = bformat("%1$s %2$s:", _(fl), num);
  99         Painter & pain = bv->painter();
 100         int const w = font_metrics::width(label, f);
 101         pain.text(int(x), baseline, label, f);
 102         x += w;
 103
 104         InsetText::draw(bv, f, baseline, x);
 105 }
 106
 107
 108 int InsetCaption::latex(Buffer const * buf, ostream & os,
 109                         bool fragile, bool free_spc) const
 110 {
 111         // This is a bit too simplistic to take advantage of
 112         // caption options we must add more later. (Lgb)
 113         // This code is currently only able to handle the simple
 114         // \caption{...}, later we will make it take advantage
 115         // of the one of the caption packages. (Lgb)
 116         ostringstream ost;
 117         int const l = InsetText::latex(buf, ost, fragile, free_spc);
 118         os << "\\caption{" << ost.str() << "}\n";
 119         return l + 1;
 120 }
 121
 122
 123 int InsetCaption::ascii(Buffer const * /*buf*/,
 124                         ostream & /*os*/, int /*linelen*/) const
 125 {
 126         // FIX: Implement me!
 127         return 0;
 128 }
 129
 130
 131 int InsetCaption::docbook(Buffer const * buf, ostream & os, bool mixcont) const
 132 {
 133         int ret;
 134         os << "<title>";
 135         ret = InsetText::docbook(buf, os, mixcont);
 136         os << "</title>\n";
 137         return ret;
 138 }