]> 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 9ffd68e8d468e19bceecfb7bae8cc69345d711f8..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"
 
 #include "support/debug.h"
 #include "support/docstream.h"
+#include "support/gettext.h"
 #include "support/Translator.h"
 
+#include "frontends/Application.h"
+
 #include <algorithm>
 #include <sstream>
 
@@ -106,33 +109,22 @@ void InsetNoteParams::read(Lexer & lex)
 }
 
 
-InsetNote::InsetNote(Buffer const & buf, string const & label)
+/////////////////////////////////////////////////////////////////////
+//
+// InsetNote
+//
+/////////////////////////////////////////////////////////////////////
+
+InsetNote::InsetNote(Buffer * buf, string const & label)
        : InsetCollapsable(buf)
 {
        params_.type = notetranslator().find(label);
 }
 
 
-InsetNote::InsetNote(InsetNote const & in)
-       : InsetCollapsable(in), params_(in.params_)
-{}
-
-
 InsetNote::~InsetNote()
 {
-       InsetNoteMailer(*this).hideDialog();
-}
-
-
-Inset * InsetNote::clone() const
-{
-       return new InsetNote(*this);
-}
-
-
-docstring InsetNote::editMessage() const
-{
-       return _("Opened Note Inset");
+       hideDialogs("note", this);
 }
 
 
@@ -171,24 +163,29 @@ void InsetNote::setButtonLabel()
 
 bool InsetNote::showInsetDialog(BufferView * bv) const
 {
-       InsetNoteMailer(const_cast<InsetNote &>(*this)).showDialog(bv);
+       bv->showDialog("note", params2string(params()),
+               const_cast<InsetNote *>(this));
        return true;
 }
 
 
 void InsetNote::doDispatch(Cursor & cur, FuncRequest & cmd)
 {
-       switch (cmd.action) {
+       switch (cmd.action()) {
 
        case LFUN_INSET_MODIFY:
-               InsetNoteMailer::string2params(to_utf8(cmd.argument()), params_);
-               // get a bp from cur:
-               setLayout(cur.buffer().params());
+               cur.recordUndoInset(ATOMIC_UNDO, 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:
-               InsetNoteMailer(*this).updateDialog(&cur.bv());
+               cur.bv().updateDialog("note", params2string(params()));
                break;
+
        default:
                InsetCollapsable::doDispatch(cur, cmd);
                break;
@@ -199,11 +196,21 @@ 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.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:
@@ -211,25 +218,19 @@ 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);
 }
 
 
@@ -323,43 +324,53 @@ 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);
 }
 
 
+docstring InsetNote::contextMenu(BufferView const &, int, int) const
+{
+       return from_ascii("context-note");
+}
 
-string const InsetNoteMailer::name_("note");
-
-InsetNoteMailer::InsetNoteMailer(InsetNote & inset)
-       : inset_(inset)
-{}
-
-
-string const InsetNoteMailer::inset2string(Buffer const &) const
+bool InsetNote::allowSpellCheck() const
 {
-       return params2string(inset_.params());
+       return (params_.type == InsetNoteParams::Greyedout || lyxrc.spellcheck_notes);
 }
 
 
-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();
 
@@ -367,20 +378,16 @@ 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";
+       // 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);
 }