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 "dispatchresult.h"
19 #include "funcrequest.h"
21 #include "LaTeXFeatures.h"
24 #include "metricsinfo.h"
25 #include "paragraph.h"
27 #include "support/std_sstream.h"
32 using std::istringstream;
34 using std::ostringstream;
37 void InsetNote::init()
44 InsetNote::InsetNote(BufferParams const & bp, string const & label)
45 : InsetCollapsable(bp)
52 InsetNote::InsetNote(InsetNote const & in)
53 : InsetCollapsable(in), params_(in.params_)
59 InsetNote::~InsetNote()
61 InsetNoteMailer("note", *this).hideDialog();
65 auto_ptr<InsetBase> InsetNote::clone() const
67 return auto_ptr<InsetBase>(new InsetNote(*this));
71 string const InsetNote::editMessage() const
73 return _("Opened Note Inset");
77 void InsetNote::write(Buffer const & buf, ostream & os) const
80 InsetCollapsable::write(buf, os);
84 void InsetNote::read(Buffer const & buf, LyXLex & lex)
86 InsetCollapsable::read(buf, lex);
91 void InsetNote::setButtonLabel()
93 LyXFont font(LyXFont::ALL_SANE);
97 if (params_.type == "Note") {
98 setLabel(_("LyX Note"));
99 font.setColor(LColor::note);
100 setBackgroundColor(LColor::notebg);
101 } else if (params_.type == "Comment") {
102 setLabel(_("Comment"));
103 font.setColor(LColor::comment);
104 setBackgroundColor(LColor::commentbg);
106 setLabel(_("Greyed Out"));
107 font.setColor(LColor::greyedout);
108 setBackgroundColor(LColor::greyedoutbg);
114 void InsetNote::metrics(MetricsInfo & mi, Dimension & dim) const
116 InsetCollapsable::metrics(mi, dim);
117 // Contrary to Greyedout, these cannot be construed as part of the
118 // running text: make them stand on their own
119 if (params_.type == "Note" || params_.type == "Comment")
121 dim.wid = mi.base.textwidth;
126 bool InsetNote::showInsetDialog(BufferView * bv) const
128 InsetNoteMailer("note", const_cast<InsetNote &>(*this)).showDialog(bv);
134 InsetNote::priv_dispatch(FuncRequest const & cmd,
135 idx_type & idx, pos_type & pos)
137 BufferView * bv = cmd.view();
139 switch (cmd.action) {
141 case LFUN_INSET_MODIFY: {
142 InsetNoteMailer::string2params(cmd.argument, params_);
144 bv->updateInset(this);
145 return DispatchResult(DISPATCHED);
148 case LFUN_INSET_EDIT:
149 if (cmd.button() == mouse_button::button3)
150 return DispatchResult(UNDISPATCHED);
151 return InsetCollapsable::priv_dispatch(cmd, idx, pos);
153 case LFUN_INSET_DIALOG_UPDATE:
154 InsetNoteMailer("note", *this).updateDialog(bv);
155 return DispatchResult(DISPATCHED);
157 case LFUN_MOUSE_RELEASE:
158 if (cmd.button() == mouse_button::button3 && hitButton(cmd)) {
159 InsetNoteMailer("note", *this).showDialog(bv);
160 return DispatchResult(DISPATCHED);
165 return InsetCollapsable::priv_dispatch(cmd, idx, pos);
170 int InsetNote::latex(Buffer const & buf, ostream & os,
171 LatexRunParams const & runparams) const
173 string const pt = params_.type;
178 os << "%\n\\begin{comment}\n";
179 else if (pt == "Greyedout")
180 // we roll our own macro
181 os << "%\n\\begin{lyxgreyedout}\n";
184 i = inset.latex(buf, os, runparams);
186 if (pt == "Comment") {
187 os << "%\n\\end{comment}\n";
189 } else if (pt == "Greyedout") {
190 os << "%\n\\end{lyxgreyedout}\n";
197 int InsetNote::linuxdoc(Buffer const & buf, std::ostream & os,
198 LatexRunParams const & runparams) const
200 string const pt = params_.type;
207 i = inset.linuxdoc(buf, os, runparams);
209 if (pt == "Comment") {
210 os << "\n</comment>\n";
217 int InsetNote::docbook(Buffer const & buf, std::ostream & os,
218 LatexRunParams const & runparams) const
220 string const pt = params_.type;
227 i = inset.docbook(buf, os, runparams);
229 if (pt == "Comment") {
230 os << "\n</remark>\n";
237 int InsetNote::ascii(Buffer const & buf, std::ostream & os,
238 LatexRunParams const & runparams) const
241 string const pt = params_.type;
244 i = inset.ascii(buf, os, runparams);
251 void InsetNote::validate(LaTeXFeatures & features) const
253 if (params_.type == "Comment")
254 features.require("verbatim");
255 if (params_.type == "Greyedout") {
256 features.require("color");
257 features.require("lyxgreyedout");
259 inset.validate(features);
264 InsetNoteMailer::InsetNoteMailer(string const & name,
266 : name_(name), inset_(inset)
271 string const InsetNoteMailer::inset2string(Buffer const &) const
273 return params2string(name_, inset_.params());
277 string const InsetNoteMailer::params2string(string const & name,
278 InsetNoteParams const & params)
287 void InsetNoteMailer::string2params(string const & in,
288 InsetNoteParams & params)
290 params = InsetNoteParams();
295 istringstream data(in);
302 void InsetNoteParams::write(ostream & os) const
308 void InsetNoteParams::read(LyXLex & lex)
312 string token = lex.getString();
317 type = lex.getString();