]> git.lyx.org Git - lyx.git/blobdiff - src/insets/InsetNote.cpp
Cleanup mouse/selection/context-menu interactions.
[lyx.git] / src / insets / InsetNote.cpp
index f6e278347478a97814007c5cff07394871cc5a6e..624ff4ca2ac57c574aa54a2742dc5feae2195272 100644 (file)
 #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 "support/gettext.h"
 #include "LaTeXFeatures.h"
 #include "Lexer.h"
 #include "MetricsInfo.h"
 #include "OutputParams.h"
+#include "ParIterator.h"
+#include "TextClass.h"
+#include "TocBackend.h"
 
+#include "support/debug.h"
 #include "support/docstream.h"
 #include "support/Translator.h"
 
 #include <algorithm>
 #include <sstream>
 
+using namespace std;
 
 namespace lyx {
 
-using std::string;
-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()
@@ -56,19 +54,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;
 }
 
@@ -112,18 +106,16 @@ void InsetNoteParams::read(Lexer & lex)
 }
 
 
-InsetNote::InsetNote(BufferParams const & bp, string const & label)
-       : InsetCollapsable(bp)
-{
-       params_.type = notetranslator().find(label);
-       setButtonLabel();
-}
-
+/////////////////////////////////////////////////////////////////////
+//
+// InsetNode
+//
+/////////////////////////////////////////////////////////////////////
 
-InsetNote::InsetNote(InsetNote const & in)
-       : InsetCollapsable(in), params_(in.params_)
+InsetNote::InsetNote(Buffer const & buf, string const & label)
+       : InsetCollapsable(buf)
 {
-       setButtonLabel();
+       params_.type = notetranslator().find(label);
 }
 
 
@@ -133,13 +125,7 @@ InsetNote::~InsetNote()
 }
 
 
-Inset * InsetNote::clone() const
-{
-       return new InsetNote(*this);
-}
-
-
-docstring const InsetNote::editMessage() const
+docstring InsetNote::editMessage() const
 {
        return _("Opened Note Inset");
 }
@@ -147,33 +133,27 @@ docstring const InsetNote::editMessage() const
 
 docstring InsetNote::name() const 
 {
-       return from_ascii(string("Note") + string(":") + string(notetranslator().find(params_.type)));
+       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);
+       InsetCollapsable::read(lex);
 }
 
 
@@ -217,6 +197,16 @@ bool InsetNote::getStatus(Cursor & cur, FuncRequest const & cmd,
        switch (cmd.action) {
 
        case LFUN_INSET_MODIFY:
+               // disallow comment and greyed out in commands
+               flag.enabled(!cur.paragraph().layout().isCommand() ||
+                               cmd.getArg(2) == "Note");
+               if (cmd.getArg(0) == "note") {
+                       InsetNoteParams params;
+                       InsetNoteMailer::string2params(to_utf8(cmd.argument()), params);
+                       flag.setOnOff(params_.type == params.type);
+               }
+               return true;
+
        case LFUN_INSET_DIALOG_UPDATE:
                flag.enabled(true);
                return true;
@@ -226,17 +216,40 @@ bool InsetNote::getStatus(Cursor & cur, FuncRequest const & cmd,
        }
 }
 
-void InsetNote::updateLabels(Buffer const & buf, ParIterator const & it)
+
+void InsetNote::updateLabels(ParIterator const & it)
 {
-       TextClass const & tclass = buf.params().getTextClass();
+       DocumentClass const & tclass = buffer().params().documentClass();
        Counters savecnt = tclass.counters();
-       InsetCollapsable::updateLabels(buf, it);
+       InsetCollapsable::updateLabels(it);
        tclass.counters() = savecnt;
 }
 
 
-int InsetNote::latex(Buffer const & buf, odocstream & os,
-                    OutputParams const & runparams_in) const
+void InsetNote::addToToc(ParConstIterator const & cpit) const
+{
+       ParConstIterator pit = cpit;
+       pit.push_back(*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));
+}
+
+
+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;
@@ -249,7 +262,7 @@ int InsetNote::latex(Buffer const & buf, odocstream & os,
        } 
 
        odocstringstream ss;
-       InsetCollapsable::latex(buf, ss, runparams);
+       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:
@@ -268,11 +281,11 @@ int InsetNote::latex(Buffer const & buf, odocstream & os,
        os << str;
        runparams_in.encoding = runparams.encoding;
        // Return how many newlines we issued.
-       return int(std::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)
@@ -284,16 +297,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;
@@ -306,7 +318,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";
@@ -325,16 +337,15 @@ 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);
 }
 
 
+docstring InsetNote::contextMenu(BufferView const &, int, int) const
+{
+       return from_ascii("context-note");
+}
+
 
 string const InsetNoteMailer::name_("note");
 
@@ -380,7 +391,7 @@ void InsetNoteMailer::string2params(string const & in,
        string id;
        lex >> id;
        if (!lex || id != "Note")
-               return print_mailer_error("InsetBoxMailer", in, 2, "Note");
+               return print_mailer_error("InsetNoteMailer", in, 2, "Note");
 
        params.read(lex);
 }