Rename InsetXXX::contextMenu to InsetXXX::contextMenuName. Now this function doesn...

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

diff --git a/src/insets/InsetIndex.h b/src/insets/InsetIndex.h
index ccf8ba59488dc2bdcadc25f723804bf39d3e7467..26d4fc5e32b15dcb74efa5d1b1a3c7e8ba50dc15 100644 (file)
--- a/src/insets/InsetIndex.h
+++ b/src/insets/InsetIndex.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
  *
  * Full author contact details are available in file CREDITS.
  */
@@ -19,62 +19,126 @@
 
 namespace lyx {
 
-class LaTeXFeatures;
+class InsetIndexParams {
+public:
+       ///
+       explicit InsetIndexParams(docstring const & b = docstring())
+               : index(b) {}
+       ///
+       void write(std::ostream & os) const;
+       ///
+       void read(Lexer & lex);
+       ///
+       docstring index;
+};
+
 
 /** Used to insert index labels
   */
 class InsetIndex : public InsetCollapsable {
 public:
        ///
-       InsetIndex(BufferParams const &);
+       InsetIndex(Buffer *, InsetIndexParams const &);
        ///
-       InsetIndex(InsetIndex const &);
+       static std::string params2string(InsetIndexParams const &);
        ///
-       EDITABLE editable() const { return IS_EDITABLE; }
+       static void string2params(std::string const &, InsetIndexParams &);
+private:
+       ///
+       bool hasSettings() const;
        ///
        InsetCode lyxCode() const { return INDEX_CODE; }
        ///
        docstring name() const { return from_ascii("Index"); }
        ///
-       void write(Buffer const & buf, std::ostream & os) const;
+       ColorCode labelColor() const;
+       ///
+       void write(std::ostream & os) const;
        ///
-       int docbook(Buffer const &, odocstream &,
-                   OutputParams const &) const;
+       void read(Lexer & lex);
+       ///
+       int docbook(odocstream &, OutputParams const &) const;
+       /// 
+       docstring xhtml(XHTMLStream &, OutputParams const &) const;
+       ///
+       int latex(odocstream &, OutputParams const &) const;
+       ///
+       bool showInsetDialog(BufferView *) const;
+       ///
+       bool getStatus(Cursor &, FuncRequest const &, FuncStatus &) const;
+       ///
+       void doDispatch(Cursor & cur, FuncRequest & cmd);
        /// should paragraph indendation be omitted in any case?
-       bool neverIndent(Buffer const &) const { return true; }
+       bool neverIndent() const { return true; }
        ///
-       void addToToc(TocList &, Buffer const &, ParConstIterator const &) const;
-private:
+       void addToToc(DocIterator const &);
+       ///
+       docstring toolTip(BufferView const & bv, int x, int y) const;
        ///
-       virtual Inset * clone() const;
+       docstring const buttonLabel(BufferView const & bv) const;
+       /// Updates needed features for this inset.
+       void validate(LaTeXFeatures & features) const;
+       ///
+       docstring contextMenuName() const;
+       ///
+       Inset * clone() const { return new InsetIndex(*this); }
+
+       ///
+       friend class InsetIndexParams;
+       ///
+       InsetIndexParams params_;
 };
 
 
 class InsetPrintIndex : public InsetCommand {
 public:
        ///
-       InsetPrintIndex(InsetCommandParams const &);
+       InsetPrintIndex(Buffer * buf, InsetCommandParams const &);
+
+       /// \name Public functions inherited from Inset class
+       //@{
+       ///
+       InsetCode lyxCode() const { return INDEX_PRINT_CODE; }
+       ///
+       int latex(odocstream &, OutputParams const &) const;
+       /// 
+       docstring xhtml(XHTMLStream &, OutputParams const &) const;
+       ///
+       void doDispatch(Cursor & cur, FuncRequest & cmd);
+       ///
+       bool getStatus(Cursor &, FuncRequest const &, FuncStatus &) const;
+       ///
+       docstring contextMenuName() const;
        /// Updates needed features for this inset.
        void validate(LaTeXFeatures & features) const;
        ///
-       EDITABLE editable() const { return NOT_EDITABLE; }
-       ///
-       InsetCode lyxCode() const;
+       bool hasSettings() const;
        ///
        DisplayType display() const { return AlignCenter; }
+       //@}
+
+       /// \name Static public methods obligated for InsetCommand derived classes
+       //@{
        ///
-       docstring const getScreenLabel(Buffer const &) const;
-       ///
-       static CommandInfo const * findInfo(std::string const & cmdName = "");
+       static ParamInfo const & findInfo(std::string const &);
        ///
-       static std::string defaultCommand() { return "printindex"; };
+       static std::string defaultCommand() { return "printindex"; }
        ///
-       static bool isCompatibleCommand(std::string const & s) 
-               { return s == "printindex"; }
+       static bool isCompatibleCommand(std::string const & s);
+       //@}
+
 private:
-       virtual Inset * clone() const {
-               return new InsetPrintIndex(params());
-       }
+       /// \name Private functions inherited from Inset class
+       //@{
+       ///
+       Inset * clone() const { return new InsetPrintIndex(*this); }
+       //@}
+
+       /// \name Private functions inherited from InsetCommand class
+       //@{
+       ///
+       docstring screenLabel() const;
+       //@}
 };