More requires --> required, for C++2a.

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

diff --git a/src/insets/InsetNomencl.h b/src/insets/InsetNomencl.h
index c76669badf8a65c3cf67ef38764d83f157a58732..4d11a47d793c0bfd7f99f442558440dc300053d0 100644 (file)
--- a/src/insets/InsetNomencl.h
+++ b/src/insets/InsetNomencl.h
@@ -4,7 +4,7 @@
  * This file is part of LyX, the document processor.
  * Licence details can be found in the file COPYING.
  *
- * \author Lars Gullik Bjønnes
+ * \author Lars Gullik Bjønnes
  * \author O. U. Baran
  *
  * Full author contact details are available in file CREDITS.
@@ -21,61 +21,122 @@ namespace lyx {
 
 class LaTeXFeatures;
 
-/** Used to insert glossary labels
+/** Used to insert nomenclature entries
   */
 class InsetNomencl : public InsetCommand {
 public:
        ///
-       InsetNomencl(InsetCommandParams const &);
+       InsetNomencl(Buffer * buf, InsetCommandParams const &);
+
+       ///
+       int docbookGlossary(odocstream &) const;
+
+       /// \name Public functions inherited from Inset class
+       //@{
        ///
-       docstring const getScreenLabel(Buffer const &) const;
+       docstring toolTip(BufferView const & bv, int x, int y) const;
        ///
-       EDITABLE editable() const { return IS_EDITABLE; }
+       bool hasSettings() const { return true; }
        /// Updates needed features for this inset.
        void validate(LaTeXFeatures & features) const;
        ///
-       Inset::Code lyxCode() const;
+       void addToToc(DocIterator const & di, bool output_active,
+                                 UpdateType utype, TocBackend & backend) const;
        ///
-       int docbook(Buffer const &, odocstream &,
-                   OutputParams const &) const;
+       InsetCode lyxCode() const { return NOMENCL_CODE; }
        ///
-       int docbookGlossary(odocstream &) const;
+       int plaintext(odocstringstream & ods, OutputParams const & op,
+                     size_t max_length = INT_MAX) const;
+       ///
+       int docbook(odocstream &, OutputParams const &) const;
+       /// Does nothing at the moment.
+       docstring xhtml(XHTMLStream &, OutputParams const &) const;
+       //@}
+
+       /// \name Static public methods obligated for InsetCommand derived classes
+       //@{
+       ///
+       static ParamInfo const & findInfo(std::string const &);
+       ///
+       static std::string defaultCommand() { return "nomenclature"; }
+       ///
+       static bool isCompatibleCommand(std::string const & s)
+               { return s == "nomenclature"; }
+       //@}
+
 private:
-       virtual std::auto_ptr<Inset> doClone() const {
-               return std::auto_ptr<Inset>(new InsetNomencl(params()));
-       }
-       /// unique id for this glossary entry for docbook export
-       docstring glossary_entry_id;
+       /// \name Private functions inherited from Inset class
+       //@{
+       ///
+       Inset * clone() const { return new InsetNomencl(*this); }
+       //@}
+
+       /// \name Private functions inherited from InsetCommand class
+       //@{
+       ///
+       docstring screenLabel() const;
+       //@}
+
+       /// unique id for this nomenclature entry for docbook export
+       docstring nomenclature_entry_id;
 };
 
 
 class InsetPrintNomencl : public InsetCommand {
 public:
        ///
-       InsetPrintNomencl(InsetCommandParams const &);
+       InsetPrintNomencl(Buffer * buf, InsetCommandParams const &);
+
+       /// \name Public functions inherited from Inset class
+       //@{
        /// Updates needed features for this inset.
        void validate(LaTeXFeatures & features) const;
-       // FIXME: This should be editable to set the label width (stored
-       // in params_["labelwidth"]).
-       // Currently the width can be read from file and written, but not
-       // changed.
        ///
-       EDITABLE editable() const { return NOT_EDITABLE; }
+       int docbook(odocstream &, OutputParams const &) const;
+       ///
+       docstring xhtml(XHTMLStream &, OutputParams const &) const;
+       ///
+       InsetCode lyxCode() const;
+       ///
+       bool hasSettings() const { return true; }
        ///
-       int docbook(Buffer const &, odocstream &,
-                   OutputParams const &) const;
+       DisplayType display() const { return AlignCenter; }
        ///
-       Inset::Code lyxCode() const;
+       void latex(otexstream &, OutputParams const &) const;
        ///
-       bool display() const { return true; }
+       std::string contextMenuName() const;
+       //@}
+
+       /// \name Static public methods obligated for InsetCommand derived classes
+       //@{
+       ///
+       static ParamInfo const & findInfo(std::string const &);
        ///
-       docstring const getScreenLabel(Buffer const &) const;
+       static std::string defaultCommand() { return "printnomenclature"; }
+       ///
+       static bool isCompatibleCommand(std::string const & s)
+               { return s == "printnomenclature"; }
+       //@}
+
 private:
-       virtual std::auto_ptr<Inset> doClone() const {
-               return std::auto_ptr<Inset>(new InsetPrintNomencl(params()));
-       }
-};
+       /// \name Private functions inherited from Inset class
+       //@{
+       ///
+       Inset * clone() const { return new InsetPrintNomencl(*this); }
+       ///
+       bool getStatus(Cursor & cur, FuncRequest const & cmd, FuncStatus & status) const;
+       ///
+       void doDispatch(Cursor & cur, FuncRequest & cmd);
+       ///
+       docstring layoutName() const { return from_ascii("PrintNomencl"); }
+       //@}
 
+       /// \name Private functions inherited from InsetCommand class
+       //@{
+       ///
+       docstring screenLabel() const;
+       //@}
+};
 
 } // namespace lyx