3 * This file is part of LyX, the document processor.
4 * Licence details can be found in the file COPYING.
6 * \author Angus Leeming
7 * \author Martin Vermeer
8 * \author Jürgen Spitzmüller
10 * Full author contact details are available in file CREDITS.
15 #include "insetnote.h"
17 #include "BufferView.h"
18 #include "funcrequest.h"
20 #include "LaTeXFeatures.h"
22 #include "metricsinfo.h"
23 #include "paragraph.h"
25 #include "support/std_sstream.h"
28 using std::istringstream;
30 using std::ostringstream;
33 void InsetNote::init()
40 InsetNote::InsetNote(BufferParams const & bp, string const & label)
41 : InsetCollapsable(bp)
49 InsetNote::InsetNote(InsetNote const & in)
50 : InsetCollapsable(in), params_(in.params_)
56 InsetNote::~InsetNote() // MV
58 InsetNoteMailer mailer("note", *this);
63 auto_ptr<InsetBase> InsetNote::clone() const
65 return auto_ptr<InsetBase>(new InsetNote(*this));
69 string const InsetNote::editMessage() const
71 return _("Opened Note Inset");
75 void InsetNote::write(Buffer const & buf, ostream & os) const
78 InsetCollapsable::write(buf, os);
82 void InsetNote::read(Buffer const & buf, LyXLex & lex)
84 InsetCollapsable::read(buf, lex);
89 void InsetNote::setButtonLabel()
91 LyXFont font(LyXFont::ALL_SANE);
95 if (params_.type == "Note") {
96 setLabel(_("LyX Note"));
97 font.setColor(LColor::note);
98 setBackgroundColor(LColor::notebg);
99 } else if (params_.type == "Comment") {
100 setLabel(_("Comment"));
101 font.setColor(LColor::comment);
102 setBackgroundColor(LColor::commentbg);
104 setLabel(_("Greyed Out"));
105 font.setColor(LColor::greyedout);
106 setBackgroundColor(LColor::greyedoutbg);
112 void InsetNote::metrics(MetricsInfo & mi, Dimension & dim) const
114 InsetCollapsable::metrics(mi, dim);
115 // Contrary to Greyedout, these cannot be construed as part of the
116 // running text: make them stand on their own
117 if (params_.type == "Note" || params_.type == "Comment")
119 dim.wid = mi.base.textwidth;
124 bool InsetNote::showInsetDialog(BufferView * bv) const
126 InsetNoteMailer("note", const_cast<InsetNote &>(*this)).showDialog(bv);
131 dispatch_result InsetNote::localDispatch(FuncRequest const & cmd)
133 BufferView * bv = cmd.view();
135 switch (cmd.action) {
137 case LFUN_INSET_MODIFY: {
138 InsetNoteParams params;
139 InsetNoteMailer::string2params(cmd.argument, params);
140 params_.type = params.type;
142 bv->updateInset(this);
146 case LFUN_INSET_EDIT:
147 if (cmd.button() == mouse_button::button3)
149 return InsetCollapsable::localDispatch(cmd);
151 case LFUN_INSET_DIALOG_UPDATE:
152 InsetNoteMailer("note", *this).updateDialog(bv);
155 case LFUN_MOUSE_RELEASE:
156 if (cmd.button() == mouse_button::button3 && hitButton(cmd)) {
157 InsetNoteMailer("note", *this).showDialog(bv);
163 return InsetCollapsable::localDispatch(cmd);
168 int InsetNote::latex(Buffer const & buf, ostream & os,
169 LatexRunParams const & runparams) const
171 string const pt = params_.type;
176 os << "%\n\\begin{comment}\n";
177 else if (pt == "Greyedout")
178 // we roll our own macro
179 os << "%\n\\begin{lyxgreyedout}\n";
182 i = inset.latex(buf, os, runparams);
184 if (pt == "Comment") {
185 os << "%\n\\end{comment}\n";
187 } else if (pt == "Greyedout") {
188 os << "%\n\\end{lyxgreyedout}\n";
195 int InsetNote::linuxdoc(Buffer const & buf, std::ostream & os) const
197 string const pt = params_.type;
204 i = inset.linuxdoc(buf, os);
206 if (pt == "Comment") {
207 os << "\n</comment>\n";
214 int InsetNote::docbook(Buffer const & buf, std::ostream & os, bool mixcont) const
216 string const pt = params_.type;
223 i = inset.docbook(buf, os, mixcont);
225 if (pt == "Comment") {
226 os << "\n</remark>\n";
233 int InsetNote::ascii(Buffer const & buf, std::ostream & os, int ll) const
236 string const pt = params_.type;
239 i = inset.ascii(buf, os, ll);
246 void InsetNote::validate(LaTeXFeatures & features) const
248 if (params_.type == "Comment")
249 features.require("verbatim");
250 if (params_.type == "Greyedout") {
251 features.require("color");
252 features.require("lyxgreyedout");
254 inset.validate(features);
259 InsetNoteMailer::InsetNoteMailer(string const & name,
261 : name_(name), inset_(inset)
266 string const InsetNoteMailer::inset2string(Buffer const &) const
268 return params2string(name_, inset_.params());
272 string const InsetNoteMailer::params2string(string const & name,
273 InsetNoteParams const & params)
278 return STRCONV(data.str());
282 void InsetNoteMailer::string2params(string const & in,
283 InsetNoteParams & params)
285 params = InsetNoteParams();
290 istringstream data(STRCONV(in));
297 void InsetNoteParams::write(ostream & os) const
303 void InsetNoteParams::read(LyXLex & lex)
307 string token = lex.getString();
312 type = lex.getString();