]> git.lyx.org Git - lyx.git/blobdiff - src/insets/InsetLine.cpp
Fix InsetLine metrics and drawing.
[lyx.git] / src / insets / InsetLine.cpp
index 481bd446c7c81fc2a2f55c4bbb49f07e3bf714f5..fa3395bac42d09d190e1e7c2070c08eccd973e85 100644 (file)
@@ -3,7 +3,8 @@
  * This file is part of LyX, the document processor.
  * Licence details can be found in the file COPYING.
  *
- * \author André Pönitz
+ * \author André Pönitz
+ * \author Uwe Stöhr
  *
  * Full author contact details are available in file CREDITS.
  */
 
 #include "InsetLine.h"
 
-#include "debug.h"
-#include "LColor.h"
-#include "LyXText.h"
-#include "MetricsInfo.h"
+#include "Buffer.h"
+#include "BufferView.h"
+#include "CoordCache.h"
+#include "Dimension.h"
+#include "DispatchResult.h"
+#include "FuncRequest.h"
+#include "FuncStatus.h"
 #include "LaTeXFeatures.h"
+#include "Length.h"
+#include "MetricsInfo.h"
 #include "OutputParams.h"
+#include "output_xhtml.h"
+#include "Text.h"
 
+#include "frontends/FontMetrics.h"
 #include "frontends/Painter.h"
 
+#include "support/debug.h"
+#include "support/docstream.h"
+#include "support/gettext.h"
+#include "support/lstrings.h"
+
+using namespace std;
 
 namespace lyx {
 
 using frontend::Painter;
 
-using std::endl;
-using std::ostream;
 
+InsetLine::InsetLine(Buffer * buf, InsetCommandParams const & p)
+       : InsetCommand(buf, p, "line")
+{}
 
-void InsetLine::read(Buffer const &, LyXLex &)
+
+ParamInfo const & InsetLine::findInfo(string const & /* cmdName */)
 {
-       /* Nothing to read */
+       static ParamInfo param_info_;
+       if (param_info_.empty()) {
+               param_info_.add("offset", ParamInfo::LYX_INTERNAL);
+               param_info_.add("width", ParamInfo::LYX_INTERNAL);
+               param_info_.add("height", ParamInfo::LYX_INTERNAL);
+       }
+       return param_info_;
 }
 
 
-void InsetLine::write(Buffer const &, ostream & os) const
+docstring InsetLine::screenLabel() const
 {
-       os << "\n\\lyxline\n";
+       return _("Horizontal line");
 }
 
 
-bool InsetLine::metrics(MetricsInfo & mi, Dimension & dim) const
+void InsetLine::doDispatch(Cursor & cur, FuncRequest & cmd)
 {
-       dim.asc = 3;
-       dim.des = 3;
-       dim.wid = mi.base.textwidth;
-       bool const changed = dim_ != dim;
-       dim_ = dim;
-       return changed;
+       switch (cmd.action()) {
+
+       case LFUN_INSET_MODIFY: {
+               InsetCommandParams p(LINE_CODE);
+               // FIXME UNICODE
+               InsetCommand::string2params("line",
+                       to_utf8(cmd.argument()), p);
+               if (p.getCmdName().empty()) {
+                       cur.noScreenUpdate();
+                       break;
+               }
+               setParams(p);
+               break;
+       }
+
+       default:
+               InsetCommand::doDispatch(cur, cmd);
+               break;
+       }
+}
+
+
+bool InsetLine::getStatus(Cursor & cur, FuncRequest const & cmd,
+       FuncStatus & status) const
+{
+       switch (cmd.action()) {
+       case LFUN_INSET_DIALOG_UPDATE:
+       case LFUN_INSET_MODIFY:
+               status.setEnabled(true);
+               return true;
+       default:
+               return InsetCommand::getStatus(cur, cmd, status);
+       }
+}
+
+
+void InsetLine::metrics(MetricsInfo & mi, Dimension & dim) const
+{
+       frontend::FontMetrics const & fm = theFontMetrics(mi.base.font);
+       dim.asc = fm.maxAscent();
+       dim.des = fm.maxDescent();
+
+       Length const width(to_ascii(getParam("width")));
+       int w = width.inPixels(mi.base.textwidth,
+                              fm.width(char_type('M')));
+
+       // assure that the line inset is not outside of the window
+       // check that it doesn't exceed the outer boundary
+       if (w > mi.base.textwidth)
+               w = mi.base.textwidth;
+
+       // set a minimal width
+       int const minw = (w < 0) ? 24 : 4;
+       dim.wid = max(minw, max(w, -w));
+
+       // Cache the inset dimension
+       setDimCache(mi, dim);
 }
 
 
 void InsetLine::draw(PainterInfo & pi, int x, int y) const
 {
-       pi.pain.line(x, y, x + dim_.wid, y, LColor::topline, Painter::line_solid,
-                       Painter::line_thick);
+       // We cannot use InsetCommand::dimension() as this returns the dimension
+       // of the button, which is not used here!
+       Dimension const dim = pi.base.bv->coordCache().getInsets().dim(this);
+       int const max_width = dim.width();
+
+       frontend::FontMetrics const & fm = theFontMetrics(pi.base.font);
+
+       // get the length of the parameters in pixels
+       Length offset = Length(to_ascii(getParam("offset")));
+       int o = offset.inPixels(max_width,
+                               fm.width(char_type('M')));
+       Length const width(to_ascii(getParam("width")));
+       int w = width.inPixels(max_width,
+               fm.width(char_type('M')));
+       Length height = Length(to_ascii(getParam("height")));
+       int h = height.inPixels(max_width,
+               fm.width(char_type('M')));
+
+       // get the surrounding text color
+       FontInfo f = pi.base.font;
+       Color Line_color = f.realColor();
+
+       // assure that the drawn line is not outside of the window
+       // check that it doesn't exceed the outer boundary
+       if (w > max_width)
+               w = max_width;
+       // check that it doesn't exceed the upper boundary
+       if (y - o - h/2 < 0)
+               o = y - h/2 - 2;
+
+       // the offset is a vertical one
+       pi.pain.line(x, y - o - h/2, x + w, y - o - h/2,
+               Line_color, Painter::line_solid, float(h));
 }
 
 
-int InsetLine::latex(Buffer const &, odocstream & os,
-                     OutputParams const & runparams) const
+int InsetLine::latex(odocstream & os, OutputParams const &) const
 {
-       os << "\\lyxline{\\"
-          << from_ascii(runparams.local_font->latexSize()) << '}';
+       bool have_offset = true;
+       Length offset_len = Length(to_ascii(getParam("offset")));
+       if (offset_len.value() == 0)
+               have_offset = false;
+
+       string const offset =
+               Length(to_ascii(getParam("offset"))).asLatexString();
+       string const width =
+               Length(to_ascii(getParam("width"))).asLatexString();
+       string const height =
+               Length(to_ascii(getParam("height"))).asLatexString();
+
+       os << "\\rule";
+       // only output the optional parameter if the offset is not 0
+       if (have_offset)
+               os      << "[" << from_ascii(offset) << "]";
+       os << "{" << from_ascii(width) << "}{" << from_ascii(height) << '}';
+
        return 0;
 }
 
 
-int InsetLine::plaintext(Buffer const &, odocstream & os,
-                         OutputParams const &) const
+int InsetLine::plaintext(odocstream & os, OutputParams const &) const
 {
        os << "\n-------------------------------------------\n";
        return PLAINTEXT_NEWLINE;
 }
 
 
-int InsetLine::docbook(Buffer const &, odocstream & os,
-                      OutputParams const &) const
+int InsetLine::docbook(odocstream & os, OutputParams const &) const
 {
        os << '\n';
        return 0;
 }
 
 
-void InsetLine::validate(LaTeXFeatures & features) const
+docstring InsetLine::xhtml(XHTMLStream & xs, OutputParams const &) const
 {
-       features.require("lyxline");
+       xs << html::CompTag("hr");
+       xs.cr();
+       return docstring();
 }