src/insets/InsetVSpace.cpp

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