src/insets/InsetLine.cpp

   1 /**
   2  * \file InsetLine.cpp
   3  * This file is part of LyX, the document processor.
   4  * Licence details can be found in the file COPYING.
   5  *
   6  * \author André Pönitz
   7  * \author Uwe Stöhr
   8  *
   9  * Full author contact details are available in file CREDITS.
  10  */
  11
  12 #include <config.h>
  13
  14 #include "InsetLine.h"
  15
  16 #include "Buffer.h"
  17 #include "Dimension.h"
  18 #include "DispatchResult.h"
  19 #include "FuncRequest.h"
  20 #include "FuncStatus.h"
  21 #include "LaTeXFeatures.h"
  22 #include "Length.h"
  23 #include "MetricsInfo.h"
  24 #include "OutputParams.h"
  25 #include "output_xhtml.h"
  26 #include "Text.h"
  27
  28 #include "frontends/FontMetrics.h"
  29 #include "frontends/Painter.h"
  30
  31 #include "support/debug.h"
  32 #include "support/docstream.h"
  33 #include "support/gettext.h"
  34 #include "support/lstrings.h"
  35
  36 using namespace std;
  37
  38 namespace lyx {
  39
  40 using frontend::Painter;
  41
  42
  43 InsetLine::InsetLine(Buffer * buf, InsetCommandParams const & p)
  44         : InsetCommand(buf, p, "line")
  45 {}
  46
  47
  48 ParamInfo const & InsetLine::findInfo(string const & /* cmdName */)
  49 {
  50         static ParamInfo param_info_;
  51         if (param_info_.empty()) {
  52                 param_info_.add("offset", ParamInfo::LYX_INTERNAL);
  53                 param_info_.add("width", ParamInfo::LYX_INTERNAL);
  54                 param_info_.add("height", ParamInfo::LYX_INTERNAL);
  55         }
  56         return param_info_;
  57 }
  58
  59
  60 docstring InsetLine::screenLabel() const
  61 {
  62         return _("Horizontal line");
  63 }
  64
  65
  66 void InsetLine::doDispatch(Cursor & cur, FuncRequest & cmd)
  67 {
  68         switch (cmd.action()) {
  69
  70         case LFUN_INSET_MODIFY: {
  71                 InsetCommandParams p(LINE_CODE);
  72                 // FIXME UNICODE
  73                 InsetCommand::string2params("line",
  74                         to_utf8(cmd.argument()), p);
  75                 if (p.getCmdName().empty()) {
  76                         cur.noScreenUpdate();
  77                         break;
  78                 }
  79                 setParams(p);
  80                 break;
  81         }
  82
  83         default:
  84                 InsetCommand::doDispatch(cur, cmd);
  85                 break;
  86         }
  87 }
  88
  89
  90 bool InsetLine::getStatus(Cursor & cur, FuncRequest const & cmd,
  91         FuncStatus & status) const
  92 {
  93         switch (cmd.action()) {
  94         case LFUN_INSET_DIALOG_UPDATE:
  95         case LFUN_INSET_MODIFY:
  96                 status.setEnabled(true);
  97                 return true;
  98         default:
  99                 return InsetCommand::getStatus(cur, cmd, status);
 100         }
 101 }
 102
 103
 104 void InsetLine::metrics(MetricsInfo & mi, Dimension & dim) const
 105 {
 106         frontend::FontMetrics const & fm = theFontMetrics(mi.base.font);
 107         dim.asc = fm.maxAscent();
 108         dim.des = fm.maxDescent();
 109
 110         Length const width(to_ascii(getParam("width")));
 111         int w = width.inPixels(mi.base.textwidth,
 112                                fm.width(char_type('M')));
 113
 114         // assure that the line inset is not outside of the window
 115         // check that it doesn't exceed the outer boundary
 116         if (w > mi.base.textwidth)
 117                 w = mi.base.textwidth;
 118
 119         // set a minimal width
 120         int const minw = (w < 0) ? 24 : 4;
 121         dim.wid = max(minw, max(w, -w));
 122
 123         // Cache the inset dimension
 124         setDimCache(mi, dim);
 125 }
 126
 127
 128 void InsetLine::draw(PainterInfo & pi, int x, int y) const
 129 {
 130         frontend::FontMetrics const & fm = theFontMetrics(pi.base.font);
 131
 132         // get the length of the parameters in pixels
 133         Length offset = Length(to_ascii(getParam("offset")));
 134         int o = offset.inPixels(pi.base.textwidth,
 135                 fm.width(char_type('M')));
 136         Length width = Length(to_ascii(getParam("width")));
 137         int w = width.inPixels(pi.base.textwidth,
 138                 fm.width(char_type('M')));
 139         Length height = Length(to_ascii(getParam("height")));
 140         int h = height.inPixels(pi.base.textwidth,
 141                 fm.width(char_type('M')));
 142
 143         // get the surrounding text color
 144         FontInfo f = pi.base.font;
 145         Color Line_color = f.realColor();
 146
 147         // assure that the drawn line is not outside of the window
 148         // check that it doesn't exceed the outer boundary
 149         if (x + w - h/2 - 2 > pi.base.textwidth)
 150                 w = pi.base.textwidth - x + h/2 + 2;
 151         // check that it doesn't exceed the upper boundary
 152         if (y - o - h/2 < 0)
 153                 o = y - h/2 - 2;
 154
 155         // the offset is a vertical one
 156         pi.pain.line(x + h/2 + 1, y - o - h/2, x + w - h/2 - 2, y - o - h/2,
 157                 Line_color, Painter::line_solid, float(h));
 158 }
 159
 160
 161 int InsetLine::latex(odocstream & os, OutputParams const &) const
 162 {
 163         bool have_offset = true;
 164         Length offset_len = Length(to_ascii(getParam("offset")));
 165         if (offset_len.value() == 0)
 166                 have_offset = false;
 167
 168         string const offset =
 169                 Length(to_ascii(getParam("offset"))).asLatexString();
 170         string const width =
 171                 Length(to_ascii(getParam("width"))).asLatexString();
 172         string const height =
 173                 Length(to_ascii(getParam("height"))).asLatexString();
 174
 175         os << "\\rule";
 176         // only output the optional parameter if the offset is not 0
 177         if (have_offset)
 178                 os      << "[" << from_ascii(offset) << "]";
 179         os << "{" << from_ascii(width) << "}{" << from_ascii(height) << '}';
 180
 181         return 0;
 182 }
 183
 184
 185 int InsetLine::plaintext(odocstream & os, OutputParams const &) const
 186 {
 187         os << "\n-------------------------------------------\n";
 188         return PLAINTEXT_NEWLINE;
 189 }
 190
 191
 192 int InsetLine::docbook(odocstream & os, OutputParams const &) const
 193 {
 194         os << '\n';
 195         return 0;
 196 }
 197
 198
 199 docstring InsetLine::xhtml(XHTMLStream & xs, OutputParams const &) const
 200 {
 201         xs << html::CompTag("hr");
 202         xs.cr();
 203         return docstring();
 204 }
 205
 206
 207 } // namespace lyx