Add LFUN_NOTES_MUTATE for global change of note insets type.

[lyx.git] / src / insets / InsetNote.h

diff --git a/src/insets/InsetNote.h b/src/insets/InsetNote.h
index a9ca313b8767968eb843363dd6df5db38d3b2c5f..70faf4c03df691be7fe3c2b8d8682684eaaba266 100644 (file)
--- a/src/insets/InsetNote.h
+++ b/src/insets/InsetNote.h
@@ -9,16 +9,16 @@
  * Full author contact details are available in file CREDITS.
  */
 
-#ifndef INSETNOTE_H
-#define INSETNOTE_H
+#ifndef INSET_NOTE_H
+#define INSET_NOTE_H
 
 #include "InsetCollapsable.h"
-#include "MailInset.h"
 
 
 namespace lyx {
 
-class InsetNoteParams {
+class InsetNoteParams
+{
 public:
        enum Type {
                Note,
@@ -36,16 +36,25 @@ public:
 };
 
 
-/** The PostIt note inset, and other annotations
+/////////////////////////////////////////////////////////////////////////
+//
+// InsetNote
+//
+/////////////////////////////////////////////////////////////////////////
 
-*/
-class InsetNote : public InsetCollapsable {
+/// The PostIt note inset, and other annotations
+class InsetNote : public InsetCollapsable
+{
 public:
        ///
        InsetNote(Buffer const &, std::string const &);
        ///
        ~InsetNote();
        ///
+       static std::string params2string(InsetNoteParams const &);
+       ///
+       static void string2params(std::string const &, InsetNoteParams &);
+       ///
        InsetNoteParams const & params() const { return params_; }
 private:
        ///
@@ -55,9 +64,16 @@ private:
        ///
        docstring name() const;
        ///
-       virtual DisplayType display() const;
+       DisplayType display() const;
        ///
        bool noFontChange() const { return params_.type != InsetNoteParams::Note; }
+       /*!
+        * Is the content of this inset part of the output document?
+        *
+        * Note that Note insets are not considered part of the
+        * document, even in their 'greyed out' incarnation.
+        */
+       bool producesOutput() const { return false; }
        ///
        void write(std::ostream &) const;
        ///
@@ -78,10 +94,8 @@ private:
        void validate(LaTeXFeatures &) const;
        ///
        bool getStatus(Cursor &, FuncRequest const &, FuncStatus &) const;
-       // Update the counters of this inset and of its contents
-       void updateLabels(ParIterator const &);
        ///
-       void addToToc(ParConstIterator const &) const;
+       void addToToc(DocIterator const &);
        ///
        void doDispatch(Cursor & cur, FuncRequest & cmd);
        ///
@@ -89,36 +103,22 @@ private:
        /// used by the constructors
        void init();
        ///
+       docstring contextMenu(BufferView const & bv, int x, int y) const;
+       ///
        friend class InsetNoteParams;
 
        ///
        InsetNoteParams params_;
 };
 
+class BufferView;
 
-class InsetNoteMailer : public MailInset {
-public:
-       ///
-       InsetNoteMailer(InsetNote & inset);
-       ///
-       virtual Inset & inset() const { return inset_; }
-       ///
-       virtual std::string const & name() const { return name_; }
-       ///
-       virtual std::string const inset2string(Buffer const &) const;
-       ///
-       static std::string const params2string(InsetNoteParams const &);
-       ///
-       static void string2params(std::string const &, InsetNoteParams &);
-
-private:
-       ///
-       static std::string const name_;
-       ///
-       InsetNote & inset_;
-};
-
+/**
+ * Mutate all NoteInsets of "source" type to the "target" type in the document.
+ * Returns true when some inset was changed.
+ */
+bool mutateNotes(lyx::BufferView * view, std::string const & source, std::string const &target);
 
 } // namespace lyx
 
-#endif
+#endif // INSET_NOTE_H