]> git.lyx.org Git - lyx.git/blobdiff - src/insets/InsetNote.cpp
Fix bug #6315: counters in insets that don't produce output have ghost values.
[lyx.git] / src / insets / InsetNote.cpp
index 85aa740bc1aaa391b6d682f7117113f0ca836199..d3c1b1e2b49938e7bf4fc4dab8d526502e1e07a2 100644 (file)
@@ -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.
  */
 #include "Exporter.h"
 #include "FuncRequest.h"
 #include "FuncStatus.h"
-#include "support/gettext.h"
+#include "InsetIterator.h"
 #include "LaTeXFeatures.h"
 #include "Lexer.h"
-#include "MetricsInfo.h"
+#include "LyXRC.h"
 #include "OutputParams.h"
 #include "ParIterator.h"
 #include "TextClass.h"
@@ -35,6 +35,7 @@
 
 #include "support/debug.h"
 #include "support/docstream.h"
+#include "support/gettext.h"
 #include "support/Translator.h"
 
 #include "frontends/Application.h"
@@ -110,11 +111,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);
@@ -127,12 +128,6 @@ InsetNote::~InsetNote()
 }
 
 
-docstring InsetNote::editMessage() const
-{
-       return _("Opened Note Inset");
-}
-
-
 docstring InsetNote::name() const 
 {
        return from_ascii("Note:" + notetranslator().find(params_.type));
@@ -176,12 +171,15 @@ bool InsetNote::showInsetDialog(BufferView * bv) const
 
 void InsetNote::doDispatch(Cursor & cur, FuncRequest & cmd)
 {
-       switch (cmd.action) {
+       switch (cmd.action()) {
 
        case LFUN_INSET_MODIFY:
+               cur.recordUndoInset(ATOMIC_UNDO, 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:
@@ -198,11 +196,11 @@ 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
-               flag.enabled(!cur.paragraph().layout().isCommand() ||
+               flag.setEnabled(!cur.paragraph().layout().isCommand() ||
                                cmd.getArg(2) == "Note");
                if (cmd.getArg(0) == "note") {
                        InsetNoteParams params;
@@ -212,7 +210,7 @@ bool InsetNote::getStatus(Cursor & cur, FuncRequest const & cmd,
                return true;
 
        case LFUN_INSET_DIALOG_UPDATE:
-               flag.enabled(true);
+               flag.setEnabled(true);
                return true;
 
        default:
@@ -221,25 +219,18 @@ bool InsetNote::getStatus(Cursor & cur, FuncRequest const & cmd,
 }
 
 
-void InsetNote::updateLabels(ParIterator const & it)
-{
-       DocumentClass const & tclass = buffer().params().documentClass();
-       Counters savecnt = tclass.counters();
-       InsetCollapsable::updateLabels(it);
-       tclass.counters() = savecnt;
-}
-
-
-void InsetNote::addToToc(ParConstIterator const & cpit) const
+void InsetNote::addToToc(DocIterator const & cpit)
 {
-       ParConstIterator pit = cpit;
-       pit.push_back(*this);
+       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));
+               + text().getPar(0).asString();
+       toc.push_back(TocItem(pit, 0, str, toolTipText()));
+       // Proceed with the rest of the inset.
+       InsetCollapsable::addToToc(cpit);
 }
 
 
@@ -333,15 +324,29 @@ 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)
+       switch (params_.type) {
+       case InsetNoteParams::Comment:
                features.require("verbatim");
-       if (params_.type == InsetNoteParams::Greyedout) {
+               break;
+       case InsetNoteParams::Greyedout:
                features.require("color");
                features.require("lyxgreyedout");
+               InsetCollapsable::validate(features);
+               break;
+       case InsetNoteParams::Note:
+               break;
        }
-       InsetText::validate(features);
 }
 
 
@@ -350,6 +355,11 @@ docstring InsetNote::contextMenu(BufferView const &, int, int) const
        return from_ascii("context-note");
 }
 
+bool InsetNote::allowSpellCheck() const
+{
+       return (params_.type == InsetNoteParams::Greyedout || lyxrc.spellcheck_notes);
+}
+
 
 string InsetNote::params2string(InsetNoteParams const & params)
 {
@@ -368,24 +378,16 @@ void InsetNote::string2params(string const & in, InsetNoteParams & params)
                return;
 
        istringstream data(in);
-       Lexer lex(0,0);
+       Lexer lex;
        lex.setStream(data);
-
-       string name;
-       lex >> name;
-       if (!lex || name != "note") {
-               LYXERR0("Expected arg 1 to be \"note\" in " << in);
+       lex.setContext("InsetNote::string2params");
+       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;
-       }
-
-       // This is part of the inset proper that is usually swallowed
-       // by Text::readInset
-       string id;
-       lex >> id;
-       if (!lex || id != "Note") {
-               LYXERR0("Expected arg 1 to be \"Note\" in " << in);
-               return;
-       }
+       lex >> "Note";
 
        params.read(lex);
 }