3 * This file is part of LyX, the document processor.
4 * Licence details can be found in the file COPYING.
9 * Full author contact details are available in file CREDITS.
14 #include "InsetLine.h"
17 #include "Dimension.h"
18 #include "DispatchResult.h"
19 #include "FuncRequest.h"
20 #include "FuncStatus.h"
21 #include "LaTeXFeatures.h"
23 #include "MetricsInfo.h"
24 #include "OutputParams.h"
25 #include "output_xhtml.h"
28 #include "frontends/FontMetrics.h"
29 #include "frontends/Painter.h"
31 #include "support/debug.h"
32 #include "support/docstream.h"
33 #include "support/gettext.h"
34 #include "support/lstrings.h"
40 using frontend::Painter;
43 InsetLine::InsetLine(Buffer * buf, InsetCommandParams const & p)
44 : InsetCommand(buf, p, "line")
48 ParamInfo const & InsetLine::findInfo(string const & /* cmdName */)
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);
60 docstring InsetLine::screenLabel() const
62 return _("Horizontal line");
66 void InsetLine::doDispatch(Cursor & cur, FuncRequest & cmd)
68 switch (cmd.action()) {
70 case LFUN_INSET_MODIFY: {
71 InsetCommandParams p(LINE_CODE);
73 InsetCommand::string2params("line",
74 to_utf8(cmd.argument()), p);
75 if (p.getCmdName().empty()) {
84 InsetCommand::doDispatch(cur, cmd);
90 bool InsetLine::getStatus(Cursor & cur, FuncRequest const & cmd,
91 FuncStatus & status) const
93 switch (cmd.action()) {
94 case LFUN_INSET_DIALOG_UPDATE:
95 case LFUN_INSET_MODIFY:
96 status.setEnabled(true);
99 return InsetCommand::getStatus(cur, cmd, status);
104 void InsetLine::metrics(MetricsInfo & mi, Dimension & dim) const
106 frontend::FontMetrics const & fm = theFontMetrics(mi.base.font);
107 dim.asc = fm.maxAscent();
108 dim.des = fm.maxDescent();
110 Length const width(to_ascii(getParam("width")));
111 int w = width.inPixels(mi.base.textwidth,
112 fm.width(char_type('M')));
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;
119 // set a minimal width
120 int const minw = (w < 0) ? 24 : 4;
121 dim.wid = max(minw, max(w, -w));
123 // Cache the inset dimension
124 setDimCache(mi, dim);
128 void InsetLine::draw(PainterInfo & pi, int x, int y) const
130 frontend::FontMetrics const & fm = theFontMetrics(pi.base.font);
132 // get the length of the parameters in pixels
133 Length offset = Length(to_ascii(getParam("offset")));
135 offset.inPixels(pi.base.textwidth,
136 fm.width(char_type('M')));
137 Length width = Length(to_ascii(getParam("width")));
139 width.inPixels(pi.base.textwidth,
140 fm.width(char_type('M')));
141 Length height = Length(to_ascii(getParam("height")));
143 height.inPixels(pi.base.textwidth,
144 fm.width(char_type('M')));
146 // get the surrounding text color
147 FontInfo f = pi.base.font;
148 Color Line_color = f.realColor();
150 // assure that the drawn line is not outside of the window
151 // check that it doesn't exceed the outer boundary
152 if (x + w - h/2 - 2 > pi.base.textwidth)
153 w = pi.base.textwidth - x + h/2 + 2;
154 // check that it doesn't exceed the upper boundary
158 // the offset is a vertical one
159 pi.pain.line(x + h/2 + 1, y - o - h/2, x + w - h/2 - 2, y - o - h/2,
160 Line_color, Painter::line_solid, float(h));
164 int InsetLine::latex(odocstream & os, OutputParams const &) const
166 bool have_offset = true;
167 Length offset_len = Length(to_ascii(getParam("offset")));
168 if (offset_len.value() == 0)
171 string const offset =
172 Length(to_ascii(getParam("offset"))).asLatexString();
174 Length(to_ascii(getParam("width"))).asLatexString();
175 string const height =
176 Length(to_ascii(getParam("height"))).asLatexString();
179 // only output the optional parameter if the offset is not 0
181 os << "[" << from_ascii(offset) << "]";
182 os << "{" << from_ascii(width) << "}{" << from_ascii(height) << '}';
188 int InsetLine::plaintext(odocstream & os, OutputParams const &) const
190 os << "\n-------------------------------------------\n";
191 return PLAINTEXT_NEWLINE;
195 int InsetLine::docbook(odocstream & os, OutputParams const &) const
202 docstring InsetLine::xhtml(XHTMLStream & xs, OutputParams const &) const
204 xs << html::CompTag("hr");