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 width = Length(to_ascii(getParam("width")));
112 width.inPixels(mi.base.textwidth,
113 fm.width(char_type('M')));
115 // assure that the line inset is not outside of the window
116 // check that it doesn't exceed the outer boundary
117 if (w > mi.base.textwidth)
118 w = mi.base.textwidth;
120 // set a minimal width
121 int const minw = (w < 0) ? 3 * 8 : 4;
122 dim.wid = max(minw, max(w, -w));
124 // Cache the inset dimension
125 setDimCache(mi, dim);
129 void InsetLine::draw(PainterInfo & pi, int x, int y) const
131 Dimension const dim = dimension(*pi.base.bv);
133 frontend::FontMetrics const & fm = theFontMetrics(pi.base.font);
135 // get the length of the parameters in pixels
136 Length offset = Length(to_ascii(getParam("offset")));
138 offset.inPixels(pi.base.textwidth,
139 fm.width(char_type('M')));
140 Length width = Length(to_ascii(getParam("width")));
142 width.inPixels(pi.base.textwidth,
143 fm.width(char_type('M')));
144 Length height = Length(to_ascii(getParam("height")));
146 height.inPixels(pi.base.textwidth,
147 fm.width(char_type('M')));
149 // get the surrounding text color
150 FontInfo f = pi.base.font;
151 Color Line_color = f.realColor();
153 // assure that the drawn line is not outside of the window
154 // check that it doesn't exceed the outer boundary
155 if (x + w - h/2 - 2 > pi.base.textwidth)
156 w = pi.base.textwidth - x + h/2 + 2;
157 // check that it doesn't exceed the upper boundary
161 // the offset is a vertical one
162 pi.pain.line(x + h/2 + 1, y - o - h/2, x + w - h/2 - 2, y - o - h/2,
163 Line_color, Painter::line_solid, float(h));
167 int InsetLine::latex(odocstream & os, OutputParams const &) const
169 bool have_offset = true;
170 Length offset_len = Length(to_ascii(getParam("offset")));
171 if (offset_len.value() == 0)
174 string const offset =
175 Length(to_ascii(getParam("offset"))).asLatexString();
177 Length(to_ascii(getParam("width"))).asLatexString();
178 string const height =
179 Length(to_ascii(getParam("height"))).asLatexString();
182 // only output the optional parameter if the offset is not 0
184 os << "[" << from_ascii(offset) << "]";
185 os << "{" << from_ascii(width) << "}{" << from_ascii(height) << '}';
191 int InsetLine::plaintext(odocstream & os, OutputParams const &) const
193 os << "\n-------------------------------------------\n";
194 return PLAINTEXT_NEWLINE;
198 int InsetLine::docbook(odocstream & os, OutputParams const &) const
205 docstring InsetLine::xhtml(XHTMLStream & xs, OutputParams const &) const
207 xs << html::CompTag("hr");