src/insets/insetvspace.C

   1 /**
   2  * \file insetvspace.C
   3  * This file is part of LyX, the document processor.
   4  * Licence details can be found in the file COPYING.
   5  *
   6  * \author various
   7  * \author André Pönitz
   8  *
   9  * Full author contact details are available in file CREDITS.
  10  */
  11
  12 #include <config.h>
  13
  14 #include "insetvspace.h"
  15
  16 #include "buffer.h"
  17 #include "cursor.h"
  18 #include "dispatchresult.h"
  19 #include "funcrequest.h"
  20 #include "gettext.h"
  21 #include "LColor.h"
  22 #include "lyxlex.h"
  23 #include "lyxtext.h"
  24 #include "metricsinfo.h"
  25
  26 #include "frontends/FontMetrics.h"
  27 #include "frontends/Painter.h"
  28
  29 #include <sstream>
  30
  31 using lyx::docstring;
  32 using lyx::odocstream;
  33
  34 using std::istringstream;
  35 using std::ostream;
  36 using std::ostringstream;
  37 using std::string;
  38 using std::max;
  39
  40
  41 namespace {
  42
  43 int const ADD_TO_VSPACE_WIDTH = 5;
  44
  45 } // namespace anon
  46
  47
  48 InsetVSpace::InsetVSpace(VSpace const & space)
  49         : space_(space)
  50 {}
  51
  52
  53 InsetVSpace::~InsetVSpace()
  54 {
  55         InsetVSpaceMailer(*this).hideDialog();
  56 }
  57
  58
  59 std::auto_ptr<InsetBase> InsetVSpace::doClone() const
  60 {
  61         return std::auto_ptr<InsetBase>(new InsetVSpace(*this));
  62 }
  63
  64
  65 void InsetVSpace::doDispatch(LCursor & cur, FuncRequest & cmd)
  66 {
  67         switch (cmd.action) {
  68
  69         case LFUN_INSET_MODIFY: {
  70                 InsetVSpaceMailer::string2params(lyx::to_utf8(cmd.argument()), space_);
  71                 break;
  72         }
  73
  74         case LFUN_MOUSE_RELEASE:
  75                 InsetVSpaceMailer(*this).showDialog(&cur.bv());
  76                 break;
  77
  78         default:
  79                 InsetBase::doDispatch(cur, cmd);
  80                 break;
  81         }
  82 }
  83
  84
  85 void InsetVSpace::read(Buffer const &, LyXLex & lex)
  86 {
  87         BOOST_ASSERT(lex.isOK());
  88         string vsp;
  89         lex >> vsp;
  90         if (lex)
  91                 space_ = VSpace(vsp);
  92
  93         string end_token;
  94         lex >> end_token;
  95         if (end_token != "\\end_inset")
  96                 lex.printError("Missing \\end_inset at this point. "
  97                                "Read: `$$Token'");
  98 }
  99
 100
 101 void InsetVSpace::write(Buffer const &, ostream & os) const
 102 {
 103         os << "VSpace " << space_.asLyXCommand();
 104 }
 105
 106
 107 string const InsetVSpace::label() const
 108 {
 109         // FIXME UNICODE
 110         static string const label = lyx::to_utf8(_("Vertical Space"));
 111         return label + " (" + space_.asGUIName() + ')';
 112 }
 113
 114
 115 namespace {
 116 int const arrow_size = 4;
 117 }
 118
 119
 120 void InsetVSpace::metrics(MetricsInfo & mi, Dimension & dim) const
 121 {
 122         int height = 3 * arrow_size;
 123         if (space_.length().len().value() >= 0.0)
 124                 height = max(height, space_.inPixels(*mi.base.bv));
 125
 126         LyXFont font;
 127         font.decSize();
 128         font.decSize();
 129
 130         int w = 0;
 131         int a = 0;
 132         int d = 0;
 133         string lab = label();
 134         docstring dlab(lab.begin(), lab.end());
 135         theFontMetrics(font).rectText(dlab, w, a, d);
 136
 137         height = max(height, a + d);
 138
 139         dim.asc = height / 2 + (a - d) / 2; // align cursor with the
 140         dim.des = height - dim.asc;         // label text
 141         dim.wid = ADD_TO_VSPACE_WIDTH + 2 * arrow_size + 5 + w;
 142         dim_ = dim;
 143 }
 144
 145
 146 void InsetVSpace::draw(PainterInfo & pi, int x, int y) const
 147 {
 148         setPosCache(pi, x, y);
 149
 150         x += ADD_TO_VSPACE_WIDTH;
 151
 152         int const start = y - dim_.asc;
 153         int const end   = y + dim_.des;
 154
 155         // y-values for top arrow
 156         int ty1, ty2;
 157         // y-values for bottom arrow
 158         int by1, by2;
 159
 160         if (space_.kind() == VSpace::VFILL) {
 161                 ty1 = ty2 = start;
 162                 by1 = by2 = end;
 163         } else {
 164                 // adding or removing space
 165                 bool const added = space_.kind() != VSpace::LENGTH ||
 166                                    space_.length().len().value() >= 0.0;
 167                 ty1 = added ? (start + arrow_size) : start;
 168                 ty2 = added ? start : (start + arrow_size);
 169                 by1 = added ? (end - arrow_size) : end;
 170                 by2 = added ? end : (end - arrow_size);
 171         }
 172
 173         int const midx = x + arrow_size;
 174         int const rightx = midx + arrow_size;
 175
 176         // first the string
 177         int w = 0;
 178         int a = 0;
 179         int d = 0;
 180
 181         LyXFont font;
 182         font.setColor(LColor::added_space);
 183         font.decSize();
 184         font.decSize();
 185         string lab = label();
 186         docstring dlab(lab.begin(), lab.end());
 187         theFontMetrics(font).rectText(dlab, w, a, d);
 188
 189         pi.pain.rectText(x + 2 * arrow_size + 5,
 190                          start + (end - start) / 2 + (a - d) / 2,
 191                          dlab, font, LColor::none, LColor::none);
 192
 193         // top arrow
 194         pi.pain.line(x, ty1, midx, ty2, LColor::added_space);
 195         pi.pain.line(midx, ty2, rightx, ty1, LColor::added_space);
 196
 197         // bottom arrow
 198         pi.pain.line(x, by1, midx, by2, LColor::added_space);
 199         pi.pain.line(midx, by2, rightx, by1, LColor::added_space);
 200
 201         // joining line
 202         pi.pain.line(midx, ty2, midx, by2, LColor::added_space);
 203 }
 204
 205
 206 int InsetVSpace::latex(Buffer const & buf, odocstream & os,
 207                           OutputParams const &) const
 208 {
 209         os << lyx::from_ascii(space_.asLatexCommand(buf.params())) << '\n';
 210         return 1;
 211 }
 212
 213
 214 int InsetVSpace::plaintext(Buffer const &, odocstream & os,
 215                            OutputParams const &) const
 216 {
 217         os << "\n\n";
 218         return 2;
 219 }
 220
 221
 222 int InsetVSpace::docbook(Buffer const &, odocstream & os,
 223                          OutputParams const &) const
 224 {
 225         os << '\n';
 226         return 1;
 227 }
 228
 229
 230 string const InsetVSpaceMailer::name_ = "vspace";
 231
 232
 233 InsetVSpaceMailer::InsetVSpaceMailer(InsetVSpace & inset)
 234         : inset_(inset)
 235 {}
 236
 237
 238 string const InsetVSpaceMailer::inset2string(Buffer const &) const
 239 {
 240         return params2string(inset_.space());
 241 }
 242
 243
 244 void InsetVSpaceMailer::string2params(string const & in, VSpace & vspace)
 245 {
 246         vspace = VSpace();
 247         if (in.empty())
 248                 return;
 249
 250         istringstream data(in);
 251         LyXLex lex(0,0);
 252         lex.setStream(data);
 253
 254         string name;
 255         lex >> name;
 256         if (!lex || name != name_)
 257                 return print_mailer_error("InsetVSpaceMailer", in, 1, name_);
 258
 259         string vsp;
 260         lex >> vsp;
 261         if (lex)
 262                 vspace = VSpace(vsp);
 263 }
 264
 265
 266 string const InsetVSpaceMailer::params2string(VSpace const & vspace)
 267 {
 268         ostringstream data;
 269         data << name_ << ' ' << vspace.asLyXCommand();
 270         return data.str();
 271 }