]> git.lyx.org Git - lyx.git/blobdiff - src/insets/InsetNote.cpp
Show symbol name and description in plaintext export of nomenclature entries.
[lyx.git] / src / insets / InsetNote.cpp
index de03d61b6b46a4e95e5f94daa78a9e6472ecf043..3f422774c1215bf7f3c39abfd9fcb07a19196c7e 100644 (file)
@@ -18,6 +18,7 @@
 #include "BufferParams.h"
 #include "BufferView.h"
 #include "BufferParams.h"
+#include "ColorSet.h"
 #include "Counters.h"
 #include "Cursor.h"
 #include "DispatchResult.h"
@@ -36,6 +37,7 @@
 #include "support/debug.h"
 #include "support/docstream.h"
 #include "support/gettext.h"
+#include "support/lstrings.h"
 #include "support/Translator.h"
 
 #include "frontends/Application.h"
@@ -50,7 +52,6 @@ namespace lyx {
 namespace {
 
 typedef Translator<string, InsetNoteParams::Type> NoteTranslator;
-typedef Translator<docstring, InsetNoteParams::Type> NoteTranslatorLoc;
 
 NoteTranslator const init_notetranslator()
 {
@@ -61,33 +62,16 @@ NoteTranslator const init_notetranslator()
 }
 
 
-NoteTranslatorLoc const init_notetranslator_loc()
-{
-       NoteTranslatorLoc translator(_("Note[[InsetNote]]"), InsetNoteParams::Note);
-       translator.addPair(_("Comment"), InsetNoteParams::Comment);
-       translator.addPair(_("Greyed out"), InsetNoteParams::Greyedout);
-       return translator;
-}
-
-
 NoteTranslator const & notetranslator()
 {
-       static NoteTranslator translator = init_notetranslator();
+       static NoteTranslator const translator = init_notetranslator();
        return translator;
 }
 
 
-NoteTranslatorLoc const & notetranslator_loc()
-{
-       static NoteTranslatorLoc translator = init_notetranslator_loc();
-       return translator;
-}
-
 } // anon
 
 
-
-
 InsetNoteParams::InsetNoteParams()
        : type(Note)
 {}
@@ -128,7 +112,7 @@ InsetNote::~InsetNote()
 }
 
 
-docstring InsetNote::name() const 
+docstring InsetNote::layoutName() const
 {
        return from_ascii("Note:" + notetranslator().find(params_.type));
 }
@@ -154,13 +138,6 @@ void InsetNote::read(Lexer & lex)
 }
 
 
-void InsetNote::setButtonLabel()
-{
-       docstring const label = notetranslator_loc().find(params_.type);
-       setLabel(label);
-}
-
-
 bool InsetNote::showInsetDialog(BufferView * bv) const
 {
        bv->showDialog("note", params2string(params()),
@@ -171,12 +148,28 @@ bool InsetNote::showInsetDialog(BufferView * bv) const
 
 void InsetNote::doDispatch(Cursor & cur, FuncRequest & cmd)
 {
-       switch (cmd.action) {
-
-       case LFUN_INSET_MODIFY:
+       switch (cmd.action()) {
+
+       case LFUN_INSET_MODIFY: {
+               // Do not do anything if converting to the same type of Note.
+               // A quick break here is done instead of disabling the LFUN
+               // because disabling the LFUN would lead to a greyed out
+               // entry, which might confuse users.
+               // In the future, we might want to have a radio button for
+               // switching between notes.
+               InsetNoteParams params;
+               string2params(to_utf8(cmd.argument()), params);
+               if (params_.type == params.type)
+                 break;
+
+               cur.recordUndoInset(this);
                string2params(to_utf8(cmd.argument()), params_);
                setButtonLabel();
+               // what we really want here is a TOC update, but that means
+               // a full buffer update
+               cur.forceBufferUpdate();
                break;
+       }
 
        case LFUN_INSET_DIALOG_UPDATE:
                cur.bv().updateDialog("note", params2string(params()));
@@ -192,7 +185,7 @@ void InsetNote::doDispatch(Cursor & cur, FuncRequest & cmd)
 bool InsetNote::getStatus(Cursor & cur, FuncRequest const & cmd,
                FuncStatus & flag) const
 {
-       switch (cmd.action) {
+       switch (cmd.action()) {
 
        case LFUN_INSET_MODIFY:
                // disallow comment and greyed out in commands
@@ -215,18 +208,24 @@ bool InsetNote::getStatus(Cursor & cur, FuncRequest const & cmd,
 }
 
 
-void InsetNote::addToToc(DocIterator const & cpit)
+void InsetNote::addToToc(DocIterator const & cpit, bool output_active,
+                                                UpdateType utype) const
 {
        DocIterator pit = cpit;
-       pit.push_back(CursorSlice(*this));
+       pit.push_back(CursorSlice(const_cast<InsetNote &>(*this)));
+       
+       InsetLayout const & il = getLayout();
+       docstring tooltip;
+       text().forOutliner(tooltip, TOC_ENTRY_LENGTH);
+       docstring str = translateIfPossible(il.labelstring()) + ": " + tooltip;
+       tooltip = support::wrapParas(tooltip, 0, 60, 2);
+       
+       shared_ptr<Toc> toc = buffer().tocBackend().toc("note");
+       toc->push_back(TocItem(pit, 0, str, output_active, tooltip));
 
-       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 doing_output = output_active && producesOutput();
+       InsetCollapsable::addToToc(cpit, doing_output, utype);
 }
 
 
@@ -240,10 +239,10 @@ bool InsetNote::isMacroScope() const
 }
 
 
-int InsetNote::latex(odocstream & os, OutputParams const & runparams_in) const
+void InsetNote::latex(otexstream & os, OutputParams const & runparams_in) const
 {
        if (params_.type == InsetNoteParams::Note)
-               return 0;
+               return;
 
        OutputParams runparams(runparams_in);
        if (params_.type == InsetNoteParams::Comment) {
@@ -252,8 +251,6 @@ int InsetNote::latex(odocstream & os, OutputParams const & runparams_in) const
                runparams.exportdata.reset(new ExportData);
        } 
 
-       odocstringstream ss;
-       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:
@@ -265,19 +262,18 @@ int InsetNote::latex(odocstream & os, OutputParams const & runparams_in) const
        //  b
        //
        // Adding {} before ' b' fixes this.
-       if (params_.type == InsetNoteParams::Comment)
-               ss << "{}";
+       // The {} will be automatically added, but only if needed, for all
+       // insets whose InsetLayout Display tag is false. This is achieved
+       // by telling otexstream to protect an immediately following space
+       // and is done for both comment and greyedout insets.
+       InsetCollapsable::latex(os, runparams);
 
-       docstring const str = ss.str();
-       os << str;
        runparams_in.encoding = runparams.encoding;
-       // Return how many newlines we issued.
-       return int(count(str.begin(), str.end(), '\n'));
 }
 
 
-int InsetNote::plaintext(odocstream & os,
-                        OutputParams const & runparams_in) const
+int InsetNote::plaintext(odocstringstream & os,
+                        OutputParams const & runparams_in, size_t max_length) const
 {
        if (params_.type == InsetNoteParams::Note)
                return 0;
@@ -289,7 +285,7 @@ int InsetNote::plaintext(odocstream & os,
                runparams.exportdata.reset(new ExportData);
        }
        os << '[' << buffer().B_("note") << ":\n";
-       InsetText::plaintext(os, runparams);
+       InsetText::plaintext(os, runparams, max_length);
        os << "\n]";
 
        return PLAINTEXT_NEWLINE + 1; // one char on a separate line
@@ -333,11 +329,15 @@ void InsetNote::validate(LaTeXFeatures & features) const
 {
        switch (params_.type) {
        case InsetNoteParams::Comment:
-               features.require("verbatim");
+               if (features.runparams().flavor == OutputParams::HTML)
+                       // we do output this but set display to "none" by default,
+                       // but people might want to use it.
+                       InsetCollapsable::validate(features);
+               else
+                       // Only do the requires
+                       features.useInsetLayout(getLayout());
                break;
        case InsetNoteParams::Greyedout:
-               features.require("color");
-               features.require("lyxgreyedout");
                InsetCollapsable::validate(features);
                break;
        case InsetNoteParams::Note:
@@ -346,9 +346,9 @@ void InsetNote::validate(LaTeXFeatures & features) const
 }
 
 
-docstring InsetNote::contextMenu(BufferView const &, int, int) const
+string InsetNote::contextMenuName() const
 {
-       return from_ascii("context-note");
+       return "context-note";
 }
 
 bool InsetNote::allowSpellCheck() const
@@ -356,6 +356,19 @@ bool InsetNote::allowSpellCheck() const
        return (params_.type == InsetNoteParams::Greyedout || lyxrc.spellcheck_notes);
 }
 
+FontInfo InsetNote::getFont() const
+{
+       FontInfo font = getLayout().font();
+       // FIXME: This hardcoded color is a hack!
+       if (params_.type == InsetNoteParams::Greyedout
+           && buffer().params().notefontcolor != lyx::rgbFromHexName("#cccccc")) {
+               ColorCode c = lcolor.getFromLyXName("notefontcolor");
+               if (c != Color_none)
+                       font.setColor(c);
+       }
+       return font;
+}
+
 
 string InsetNote::params2string(InsetNoteParams const & params)
 {