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
  32 namespace lyx {
  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(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 docstring const InsetVSpace::label() const
 108 {
 109         static docstring const label = _("Vertical Space");
 110         return label + " (" + space_.asGUIName() + ')';
 111 }
 112
 113
 114 namespace {
 115 int const arrow_size = 4;
 116 }
 117
 118
 119 bool InsetVSpace::metrics(MetricsInfo & mi, Dimension & dim) const
 120 {
 121         int height = 3 * arrow_size;
 122         if (space_.length().len().value() >= 0.0)
 123                 height = max(height, space_.inPixels(*mi.base.bv));
 124
 125         LyXFont font;
 126         font.decSize();
 127         font.decSize();
 128
 129         int w = 0;
 130         int a = 0;
 131         int d = 0;
 132         theFontMetrics(font).rectText(label(), w, a, d);
 133
 134         height = max(height, a + d);
 135
 136         dim.asc = height / 2 + (a - d) / 2; // align cursor with the
 137         dim.des = height - dim.asc;         // label text
 138         dim.wid = ADD_TO_VSPACE_WIDTH + 2 * arrow_size + 5 + w;
 139         bool const changed = dim_ != dim;
 140         dim_ = dim;
 141         return changed;
 142 }
 143
 144
 145 void InsetVSpace::draw(PainterInfo & pi, int x, int y) const
 146 {
 147         setPosCache(pi, x, y);
 148
 149         x += ADD_TO_VSPACE_WIDTH;
 150
 151         int const start = y - dim_.asc;
 152         int const end   = y + dim_.des;
 153
 154         // y-values for top arrow
 155         int ty1, ty2;
 156         // y-values for bottom arrow
 157         int by1, by2;
 158
 159         if (space_.kind() == VSpace::VFILL) {
 160                 ty1 = ty2 = start;
 161                 by1 = by2 = end;
 162         } else {
 163                 // adding or removing space
 164                 bool const added = space_.kind() != VSpace::LENGTH ||
 165                                    space_.length().len().value() >= 0.0;
 166                 ty1 = added ? (start + arrow_size) : start;
 167                 ty2 = added ? start : (start + arrow_size);
 168                 by1 = added ? (end - arrow_size) : end;
 169                 by2 = added ? end : (end - arrow_size);
 170         }
 171
 172         int const midx = x + arrow_size;
 173         int const rightx = midx + arrow_size;
 174
 175         // first the string
 176         int w = 0;
 177         int a = 0;
 178         int d = 0;
 179
 180         LyXFont font;
 181         font.setColor(LColor::added_space);
 182         font.decSize();
 183         font.decSize();
 184         docstring const lab = label();
 185         theFontMetrics(font).rectText(lab, w, a, d);
 186
 187         pi.pain.rectText(x + 2 * arrow_size + 5,
 188                          start + (end - start) / 2 + (a - d) / 2,
 189                          lab, font, LColor::none, LColor::none);
 190
 191         // top arrow
 192         pi.pain.line(x, ty1, midx, ty2, LColor::added_space);
 193         pi.pain.line(midx, ty2, rightx, ty1, LColor::added_space);
 194
 195         // bottom arrow
 196         pi.pain.line(x, by1, midx, by2, LColor::added_space);
 197         pi.pain.line(midx, by2, rightx, by1, LColor::added_space);
 198
 199         // joining line
 200         pi.pain.line(midx, ty2, midx, by2, LColor::added_space);
 201 }
 202
 203
 204 int InsetVSpace::latex(Buffer const & buf, odocstream & os,
 205                           OutputParams const &) const
 206 {
 207         os << from_ascii(space_.asLatexCommand(buf.params())) << '\n';
 208         return 1;
 209 }
 210
 211
 212 int InsetVSpace::plaintext(Buffer const &, odocstream & os,
 213                            OutputParams const &) const
 214 {
 215         os << "\n\n";
 216         return 2;
 217 }
 218
 219
 220 int InsetVSpace::docbook(Buffer const &, odocstream & os,
 221                          OutputParams const &) const
 222 {
 223         os << '\n';
 224         return 1;
 225 }
 226
 227
 228 string const InsetVSpaceMailer::name_ = "vspace";
 229
 230
 231 InsetVSpaceMailer::InsetVSpaceMailer(InsetVSpace & inset)
 232         : inset_(inset)
 233 {}
 234
 235
 236 string const InsetVSpaceMailer::inset2string(Buffer const &) const
 237 {
 238         return params2string(inset_.space());
 239 }
 240
 241
 242 void InsetVSpaceMailer::string2params(string const & in, VSpace & vspace)
 243 {
 244         vspace = VSpace();
 245         if (in.empty())
 246                 return;
 247
 248         istringstream data(in);
 249         LyXLex lex(0,0);
 250         lex.setStream(data);
 251
 252         string name;
 253         lex >> name;
 254         if (!lex || name != name_)
 255                 return print_mailer_error("InsetVSpaceMailer", in, 1, name_);
 256
 257         string vsp;
 258         lex >> vsp;
 259         if (lex)
 260                 vspace = VSpace(vsp);
 261 }
 262
 263
 264 string const InsetVSpaceMailer::params2string(VSpace const & vspace)
 265 {
 266         ostringstream data;
 267         data << name_ << ' ' << vspace.asLyXCommand();
 268         return data.str();
 269 }
 270
 271
 272 } // namespace lyx