]> git.lyx.org Git - lyx.git/blobdiff - src/insets/InsetNote.cpp
This optional argument to the InsetCollapsable constructor
[lyx.git] / src / insets / InsetNote.cpp
index 1a0cadc5feb81cd378243db50320e8613d8e3c0f..5431712447862e4eb43b5756321217729f5a89f8 100644 (file)
 #include "InsetNote.h"
 
 #include "Buffer.h"
+#include "BufferParams.h"
 #include "BufferView.h"
+#include "BufferParams.h"
+#include "Counters.h"
 #include "Cursor.h"
-#include "debug.h"
 #include "DispatchResult.h"
 #include "Exporter.h"
 #include "FuncRequest.h"
 #include "FuncStatus.h"
-#include "gettext.h"
+#include "InsetIterator.h"
 #include "LaTeXFeatures.h"
-#include "Color.h"
 #include "Lexer.h"
 #include "MetricsInfo.h"
 #include "OutputParams.h"
-#include "Paragraph.h"
+#include "ParIterator.h"
+#include "TextClass.h"
+#include "TocBackend.h"
 
-#include "support/lyxalgo.h"
+#include "support/debug.h"
+#include "support/docstream.h"
+#include "support/gettext.h"
 #include "support/Translator.h"
 
+#include "frontends/Application.h"
+
+#include <algorithm>
 #include <sstream>
 
+using namespace std;
 
 namespace lyx {
 
-using std::string;
-using std::auto_ptr;
-using std::istringstream;
-using std::ostream;
-using std::ostringstream;
-
-
 namespace {
 
-typedef Translator<std::string, InsetNoteParams::Type> NoteTranslator;
+typedef Translator<string, InsetNoteParams::Type> NoteTranslator;
 typedef Translator<docstring, InsetNoteParams::Type> NoteTranslatorLoc;
 
 NoteTranslator const init_notetranslator()
@@ -55,19 +57,15 @@ NoteTranslator const init_notetranslator()
        NoteTranslator translator("Note", InsetNoteParams::Note);
        translator.addPair("Comment", InsetNoteParams::Comment);
        translator.addPair("Greyedout", InsetNoteParams::Greyedout);
-       translator.addPair("Framed", InsetNoteParams::Framed);
-       translator.addPair("Shaded", InsetNoteParams::Shaded);
        return translator;
 }
 
 
 NoteTranslatorLoc const init_notetranslator_loc()
 {
-       NoteTranslatorLoc translator(_("Note"), InsetNoteParams::Note);
+       NoteTranslatorLoc translator(_("Note[[InsetNote]]"), InsetNoteParams::Note);
        translator.addPair(_("Comment"), InsetNoteParams::Comment);
        translator.addPair(_("Greyed out"), InsetNoteParams::Greyedout);
-       translator.addPair(_("Framed"), InsetNoteParams::Framed);
-       translator.addPair(_("Shaded"), InsetNoteParams::Shaded);
        return translator;
 }
 
@@ -111,69 +109,54 @@ void InsetNoteParams::read(Lexer & lex)
 }
 
 
-void InsetNote::init()
-{
-       setButtonLabel();
-}
-
+/////////////////////////////////////////////////////////////////////
+//
+// InsetNode
+//
+/////////////////////////////////////////////////////////////////////
 
-InsetNote::InsetNote(BufferParams const & bp, string const & label)
-       : InsetCollapsable(bp)
+InsetNote::InsetNote(Buffer const & buf, string const & label)
+       : InsetCollapsable(buf)
 {
        params_.type = notetranslator().find(label);
-       init();
-}
-
-
-InsetNote::InsetNote(InsetNote const & in)
-       : InsetCollapsable(in), params_(in.params_)
-{
-       init();
 }
 
 
 InsetNote::~InsetNote()
 {
-       InsetNoteMailer(*this).hideDialog();
+       hideDialogs("note", this);
 }
 
 
-auto_ptr<Inset> InsetNote::doClone() const
+docstring InsetNote::editMessage() const
 {
-       return auto_ptr<Inset>(new InsetNote(*this));
+       return _("Opened Note Inset");
 }
 
 
-docstring const InsetNote::editMessage() const
+docstring InsetNote::name() const 
 {
-       return _("Opened Note Inset");
+       return from_ascii("Note:" + notetranslator().find(params_.type));
 }
 
 
 Inset::DisplayType InsetNote::display() const
 {
-       switch (params_.type) {
-       case InsetNoteParams::Framed:
-       case InsetNoteParams::Shaded:
-               return AlignLeft;
-       default:
-               return Inline;
-       }
+       return Inline;
 }
 
 
-void InsetNote::write(Buffer const & buf, ostream & os) const
+void InsetNote::write(ostream & os) const
 {
        params_.write(os);
-       InsetCollapsable::write(buf, os);
+       InsetCollapsable::write(os);
 }
 
 
-void InsetNote::read(Buffer const & buf, Lexer & lex)
+void InsetNote::read(Lexer & lex)
 {
        params_.read(lex);
-       InsetCollapsable::read(buf, lex);
-       setButtonLabel();
+       InsetCollapsable::read(lex);
 }
 
 
@@ -181,40 +164,13 @@ void InsetNote::setButtonLabel()
 {
        docstring const label = notetranslator_loc().find(params_.type);
        setLabel(label);
-
-       Font font(Font::ALL_SANE);
-       font.decSize();
-       font.decSize();
-
-       switch (params_.type) {
-       case InsetNoteParams::Note:
-               font.setColor(Color::note);
-               setBackgroundColor(Color::notebg);
-               break;
-       case InsetNoteParams::Comment:
-               font.setColor(Color::comment);
-               setBackgroundColor(Color::commentbg);
-               break;
-       case InsetNoteParams::Greyedout:
-               font.setColor(Color::greyedout);
-               setBackgroundColor(Color::greyedoutbg);
-               break;
-       case InsetNoteParams::Framed:
-               font.setColor(Color::greyedout);
-               setBackgroundColor(Color::greyedoutbg);
-               break;
-       case InsetNoteParams::Shaded:
-               font.setColor(Color::greyedout);
-               setBackgroundColor(Color::shadedbg);
-               break;
-       }
-       setLabelFont(font);
 }
 
 
 bool InsetNote::showInsetDialog(BufferView * bv) const
 {
-       InsetNoteMailer(const_cast<InsetNote &>(*this)).showDialog(bv);
+       bv->showDialog("note", params2string(params()),
+               const_cast<InsetNote *>(this));
        return true;
 }
 
@@ -224,19 +180,13 @@ void InsetNote::doDispatch(Cursor & cur, FuncRequest & cmd)
        switch (cmd.action) {
 
        case LFUN_INSET_MODIFY:
-               InsetNoteMailer::string2params(to_utf8(cmd.argument()), params_);
-               setButtonLabel();
+               string2params(to_utf8(cmd.argument()), params_);
+               // get a bp from cur:
+               setLayout(cur.buffer().params());
                break;
 
        case LFUN_INSET_DIALOG_UPDATE:
-               InsetNoteMailer(*this).updateDialog(&cur.bv());
-               break;
-
-       case LFUN_MOUSE_RELEASE:
-               if (cmd.button() == mouse_button::button3 && hitButton(cmd))
-                       InsetNoteMailer(*this).showDialog(&cur.bv());
-               else
-                       InsetCollapsable::doDispatch(cur, cmd);
+               cur.bv().updateDialog("note", params2string(params()));
                break;
 
        default:
@@ -252,8 +202,18 @@ bool InsetNote::getStatus(Cursor & cur, FuncRequest const & cmd,
        switch (cmd.action) {
 
        case LFUN_INSET_MODIFY:
+               // disallow comment and greyed out in commands
+               flag.setEnabled(!cur.paragraph().layout().isCommand() ||
+                               cmd.getArg(2) == "Note");
+               if (cmd.getArg(0) == "note") {
+                       InsetNoteParams params;
+                       string2params(to_utf8(cmd.argument()), params);
+                       flag.setOnOff(params_.type == params.type);
+               }
+               return true;
+
        case LFUN_INSET_DIALOG_UPDATE:
-               flag.enabled(true);
+               flag.setEnabled(true);
                return true;
 
        default:
@@ -262,30 +222,45 @@ bool InsetNote::getStatus(Cursor & cur, FuncRequest const & cmd,
 }
 
 
-int InsetNote::latex(Buffer const & buf, odocstream & os,
-                    OutputParams const & runparams_in) const
+void InsetNote::addToToc(DocIterator const & cpit)
+{
+       DocIterator pit = cpit;
+       pit.push_back(CursorSlice(*this));
+
+       Toc & toc = buffer().tocBackend().toc("note");
+       docstring str;
+       str = notetranslator_loc().find(params_.type) + from_ascii(": ")
+               + getNewLabel(str);
+       toc.push_back(TocItem(pit, 0, str));
+       // Proceed with the rest of the inset.
+       InsetCollapsable::addToToc(cpit);
+}
+
+
+bool InsetNote::isMacroScope() const
+{
+       // LyX note has no latex output
+       if (params_.type == InsetNoteParams::Note)
+               return true;
+
+       return InsetCollapsable::isMacroScope();
+}
+
+
+int InsetNote::latex(odocstream & os, OutputParams const & runparams_in) const
 {
        if (params_.type == InsetNoteParams::Note)
                return 0;
 
        OutputParams runparams(runparams_in);
-       string type;
        if (params_.type == InsetNoteParams::Comment) {
-               type = "comment";
                runparams.inComment = true;
                // Ignore files that are exported inside a comment
                runparams.exportdata.reset(new ExportData);
-       } else if (params_.type == InsetNoteParams::Greyedout)
-               type = "lyxgreyedout";
-       else if (params_.type == InsetNoteParams::Framed)
-               type = "framed";
-       else if (params_.type == InsetNoteParams::Shaded)
-               type = "shaded";
+       } 
 
        odocstringstream ss;
-       ss << "%\n\\begin{" << from_ascii(type) << "}\n";
-       InsetText::latex(buf, ss, runparams);
-       ss << "\n\\end{" << from_ascii(type) << "}\n";
+       InsetCollapsable::latex(ss, runparams);
        // the space after the comment in 'a[comment] b' will be eaten by the
        // comment environment since the space before b is ignored with the
        // following latex output:
@@ -304,11 +279,11 @@ int InsetNote::latex(Buffer const & buf, odocstream & os,
        os << str;
        runparams_in.encoding = runparams.encoding;
        // Return how many newlines we issued.
-       return int(lyx::count(str.begin(), str.end(), '\n'));
+       return int(count(str.begin(), str.end(), '\n'));
 }
 
 
-int InsetNote::plaintext(Buffer const & buf, odocstream & os,
+int InsetNote::plaintext(odocstream & os,
                         OutputParams const & runparams_in) const
 {
        if (params_.type == InsetNoteParams::Note)
@@ -320,16 +295,15 @@ int InsetNote::plaintext(Buffer const & buf, odocstream & os,
                // Ignore files that are exported inside a comment
                runparams.exportdata.reset(new ExportData);
        }
-       os << '[' << buf.B_("note") << ":\n";
-       InsetText::plaintext(buf, os, runparams);
+       os << '[' << buffer().B_("note") << ":\n";
+       InsetText::plaintext(os, runparams);
        os << "\n]";
 
        return PLAINTEXT_NEWLINE + 1; // one char on a separate line
 }
 
 
-int InsetNote::docbook(Buffer const & buf, odocstream & os,
-                      OutputParams const & runparams_in) const
+int InsetNote::docbook(odocstream & os, OutputParams const & runparams_in) const
 {
        if (params_.type == InsetNoteParams::Note)
                return 0;
@@ -342,7 +316,7 @@ int InsetNote::docbook(Buffer const & buf, odocstream & os,
                runparams.exportdata.reset(new ExportData);
        }
 
-       int const n = InsetText::docbook(buf, os, runparams);
+       int const n = InsetText::docbook(os, runparams);
 
        if (params_.type == InsetNoteParams::Comment)
                os << "\n</remark>\n";
@@ -361,41 +335,26 @@ void InsetNote::validate(LaTeXFeatures & features) const
                features.require("color");
                features.require("lyxgreyedout");
        }
-       if (params_.type == InsetNoteParams::Shaded) {
-               features.require("color");
-               features.require("framed");
-       }
-       if (params_.type == InsetNoteParams::Framed)
-               features.require("framed");
        InsetText::validate(features);
 }
 
 
-
-string const InsetNoteMailer::name_("note");
-
-InsetNoteMailer::InsetNoteMailer(InsetNote & inset)
-       : inset_(inset)
-{}
-
-
-string const InsetNoteMailer::inset2string(Buffer const &) const
+docstring InsetNote::contextMenu(BufferView const &, int, int) const
 {
-       return params2string(inset_.params());
+       return from_ascii("context-note");
 }
 
 
-string const InsetNoteMailer::params2string(InsetNoteParams const & params)
+string InsetNote::params2string(InsetNoteParams const & params)
 {
        ostringstream data;
-       data << name_ << ' ';
+       data << "note" << ' ';
        params.write(data);
        return data.str();
 }
 
 
-void InsetNoteMailer::string2params(string const & in,
-                                   InsetNoteParams & params)
+void InsetNote::string2params(string const & in, InsetNoteParams & params)
 {
        params = InsetNoteParams();
 
@@ -403,23 +362,45 @@ void InsetNoteMailer::string2params(string const & in,
                return;
 
        istringstream data(in);
-       Lexer lex(0,0);
+       Lexer lex;
        lex.setStream(data);
-
-       string name;
-       lex >> name;
-       if (!lex || name != name_)
-               return print_mailer_error("InsetNoteMailer", in, 1, name_);
-
-       // This is part of the inset proper that is usually swallowed
-       // by Text::readInset
-       string id;
-       lex >> id;
-       if (!lex || id != "Note")
-               return print_mailer_error("InsetBoxMailer", in, 2, "Note");
+       lex.setContext("InsetNote::string2params");
+       lex >> "note" >> "Note";
 
        params.read(lex);
 }
 
+bool mutateNotes(Cursor & cur, string const & source, string const &target)
+{
+       InsetNoteParams::Type typeSrc = notetranslator().find(source);
+       InsetNoteParams::Type typeTrt = notetranslator().find(target);
+       // syntax check of arguments
+       string sSrc = notetranslator().find(typeSrc);
+       string sTrt = notetranslator().find(typeTrt);
+       if ((sSrc != source) || (sTrt != target))
+               return false;
+
+       // did we found some conforming inset?
+       bool ret = false;
+
+       cur.beginUndoGroup();
+       Inset & inset = cur.buffer().inset();
+       InsetIterator it  = inset_iterator_begin(inset);
+       InsetIterator const end = inset_iterator_end(inset);
+       for (; it != end; ++it) {
+               if (it->lyxCode() == NOTE_CODE) {
+                       InsetNote & ins = static_cast<InsetNote &>(*it);
+                       if (ins.params().type == typeSrc) {
+                               cur.buffer().undo().recordUndo(it);
+                               FuncRequest fr(LFUN_INSET_MODIFY, "note Note " + target);
+                               ins.dispatch(cur, fr);
+                               ret = true;
+                       }
+               }
+       }
+       cur.endUndoGroup();
+
+       return ret;
+}
 
 } // namespace lyx