X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2Finsets%2FInsetNote.cpp;h=77323e6efe741fa159419fd6faa595544f21b4d6;hb=3cc3ff39a044a484faaaefbecf2a2937f7f102ef;hp=5431712447862e4eb43b5756321217729f5a89f8;hpb=7b9bfecb2f141413f29d7986aa5eb33a8bfb6459;p=lyx.git diff --git a/src/insets/InsetNote.cpp b/src/insets/InsetNote.cpp index 5431712447..77323e6efe 100644 --- a/src/insets/InsetNote.cpp +++ b/src/insets/InsetNote.cpp @@ -5,7 +5,7 @@ * * \author Angus Leeming * \author Martin Vermeer - * \author Jürgen Spitzmüller + * \author Jürgen Spitzmüller * * Full author contact details are available in file CREDITS. */ @@ -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" @@ -27,7 +28,7 @@ #include "InsetIterator.h" #include "LaTeXFeatures.h" #include "Lexer.h" -#include "MetricsInfo.h" +#include "LyXRC.h" #include "OutputParams.h" #include "ParIterator.h" #include "TextClass.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 NoteTranslator; -typedef Translator 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) {} @@ -111,11 +95,11 @@ void InsetNoteParams::read(Lexer & lex) ///////////////////////////////////////////////////////////////////// // -// InsetNode +// InsetNote // ///////////////////////////////////////////////////////////////////// -InsetNote::InsetNote(Buffer const & buf, string const & label) +InsetNote::InsetNote(Buffer * buf, string const & label) : InsetCollapsable(buf) { params_.type = notetranslator().find(label); @@ -128,13 +112,7 @@ InsetNote::~InsetNote() } -docstring InsetNote::editMessage() const -{ - return _("Opened Note Inset"); -} - - -docstring InsetNote::name() const +docstring InsetNote::layoutName() const { return from_ascii("Note:" + notetranslator().find(params_.type)); } @@ -160,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()), @@ -177,13 +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_); - // get a bp from cur: - setLayout(cur.buffer().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())); @@ -199,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 @@ -222,21 +208,6 @@ bool InsetNote::getStatus(Cursor & cur, FuncRequest const & cmd, } -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 @@ -247,10 +218,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) { @@ -259,8 +230,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: @@ -272,19 +241,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; @@ -296,7 +264,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 @@ -327,21 +295,57 @@ int InsetNote::docbook(odocstream & os, OutputParams const & runparams_in) const } +docstring InsetNote::xhtml(XHTMLStream & xs, OutputParams const & rp) const +{ + if (params_.type == InsetNoteParams::Note) + return docstring(); + + return InsetCollapsable::xhtml(xs, rp); +} + + void InsetNote::validate(LaTeXFeatures & features) const { - if (params_.type == InsetNoteParams::Comment) - features.require("verbatim"); - if (params_.type == InsetNoteParams::Greyedout) { - features.require("color"); - features.require("lyxgreyedout"); + switch (params_.type) { + case InsetNoteParams::Comment: + 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: + InsetCollapsable::validate(features); + break; + case InsetNoteParams::Note: + break; } - InsetText::validate(features); } -docstring InsetNote::contextMenu(BufferView const &, int, int) const +string InsetNote::contextMenuName() const { - return from_ascii("context-note"); + return "context-note"; +} + +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; } @@ -365,42 +369,16 @@ void InsetNote::string2params(string const & in, InsetNoteParams & params) Lexer lex; lex.setStream(data); lex.setContext("InsetNote::string2params"); - lex >> "note" >> "Note"; + lex >> "note"; + // There are cases, such as when we are called via getStatus() from + // Dialog::canApply(), where we are just called with "note" rather + // than a full "note Note TYPE". + if (!lex.isOK()) + return; + lex >> "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(*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