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"
42 using frontend::Painter;
45 InsetLine::InsetLine(Buffer * buf, InsetCommandParams const & p)
46 : InsetCommand(buf, p, "line")
50 ParamInfo const & InsetLine::findInfo(string const & /* cmdName */)
52 static ParamInfo param_info_;
53 if (param_info_.empty()) {
54 param_info_.add("offset", ParamInfo::LYX_INTERNAL);
55 param_info_.add("width", ParamInfo::LYX_INTERNAL);
56 param_info_.add("height", ParamInfo::LYX_INTERNAL);
62 docstring InsetLine::screenLabel() const
64 return _("Horizontal line");
68 void InsetLine::doDispatch(Cursor & cur, FuncRequest & cmd)
70 switch (cmd.action()) {
72 case LFUN_INSET_MODIFY: {
73 InsetCommandParams p(LINE_CODE);
75 InsetCommand::string2params("line",
76 to_utf8(cmd.argument()), p);
77 if (p.getCmdName().empty()) {
86 InsetCommand::doDispatch(cur, cmd);
92 bool InsetLine::getStatus(Cursor & cur, FuncRequest const & cmd,
93 FuncStatus & status) const
95 switch (cmd.action()) {
96 case LFUN_INSET_DIALOG_UPDATE:
97 case LFUN_INSET_MODIFY:
98 status.setEnabled(true);
101 return InsetCommand::getStatus(cur, cmd, status);
106 void InsetLine::metrics(MetricsInfo & mi, Dimension & dim) const
108 frontend::FontMetrics const & fm = theFontMetrics(mi.base.font);
109 dim.asc = fm.maxAscent();
110 dim.des = fm.maxDescent();
112 Length width = Length(to_ascii(getParam("width")));
114 width.inPixels(mi.base.textwidth,
115 fm.width(char_type('M')));
117 // assure that the line inset is not outside of the window
118 // check that it doesn't exceed the outer boundary
119 if (w > mi.base.textwidth)
120 w = mi.base.textwidth;
122 // set a minimal width
123 int const minw = (w < 0) ? 3 * 8 : 4;
124 dim.wid = max(minw, max(w, -w));
126 // Cache the inset dimension
127 setDimCache(mi, dim);
131 void InsetLine::draw(PainterInfo & pi, int x, int y) const
133 Dimension const dim = dimension(*pi.base.bv);
135 frontend::FontMetrics const & fm = theFontMetrics(pi.base.font);
137 // get the length of the parameters in pixels
138 Length offset = Length(to_ascii(getParam("offset")));
140 offset.inPixels(pi.base.textwidth,
141 fm.width(char_type('M')));
142 Length width = Length(to_ascii(getParam("width")));
144 width.inPixels(pi.base.textwidth,
145 fm.width(char_type('M')));
146 Length height = Length(to_ascii(getParam("height")));
148 height.inPixels(pi.base.textwidth,
149 fm.width(char_type('M')));
151 // get the surrounding text color
152 FontInfo f = pi.base.font;
153 Color Line_color = f.realColor();
155 // assure that the drawn line is not outside of the window
156 // check that it doesn't exceed the outer boundary
157 if (x + w - h/2 - 2 > pi.base.textwidth)
158 w = pi.base.textwidth - x + h/2 + 2;
159 // check that it doesn't exceed the upper boundary
163 // the offset is a vertical one
164 pi.pain.line(x + h/2 + 1, y - o - h/2, x + w - h/2 - 2, y - o - h/2,
165 Line_color, Painter::line_solid, float(h));
169 int InsetLine::latex(odocstream & os, OutputParams const &) const
171 bool have_offset = true;
172 Length offset_len = Length(to_ascii(getParam("offset")));
173 if (offset_len.value() == 0)
176 string const offset =
177 Length(to_ascii(getParam("offset"))).asLatexString();
179 Length(to_ascii(getParam("width"))).asLatexString();
180 string const height =
181 Length(to_ascii(getParam("height"))).asLatexString();
184 // only output the optional parameter if the offset is not 0
186 os << "[" << from_ascii(offset) << "]";
187 os << "{" << from_ascii(width) << "}{" << from_ascii(height) << '}';
193 int InsetLine::plaintext(odocstream & os, OutputParams const &) const
195 os << "\n-------------------------------------------\n";
196 return PLAINTEXT_NEWLINE;
200 int InsetLine::docbook(odocstream & os, OutputParams const &) const
207 docstring InsetLine::xhtml(XHTMLStream & xs, OutputParams const &) const
209 xs << html::CompTag("hr");