InsetInfo: enable inset dissolve

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

diff --git a/src/insets/InsetIndex.h b/src/insets/InsetIndex.h
index 58d9c1269b103fb016ab6c7447b7c0efe7eb7e5e..01bf7096b08b5d0b8f074b92103df8f2d2eb53e2 100644 (file)
--- a/src/insets/InsetIndex.h
+++ b/src/insets/InsetIndex.h
@@ -13,69 +13,137 @@
 #define INSET_INDEX_H
 
 
-#include "InsetCollapsable.h"
+#include "InsetCollapsible.h"
 #include "InsetCommand.h"
 
 
 namespace lyx {
 
+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 {
+class InsetIndex : public InsetCollapsible {
 public:
        ///
-       InsetIndex(Buffer const &);
+       InsetIndex(Buffer *, InsetIndexParams const &);
+       ///
+       static std::string params2string(InsetIndexParams const &);
+       ///
+       static void string2params(std::string const &, InsetIndexParams &);
 private:
        ///
-       EDITABLE editable() const { return HIGHLY_EDITABLE; }
+       bool hasSettings() const;
        ///
        InsetCode lyxCode() const { return INDEX_CODE; }
        ///
-       docstring name() const { return from_ascii("Index"); }
+       docstring layoutName() const { return from_ascii("Index"); }
+       ///
+       ColorCode labelColor() const;
        ///
        void write(std::ostream & os) const;
        ///
+       void read(Lexer & lex);
+       ///
        int docbook(odocstream &, OutputParams const &) const;
        ///
-       int latex(odocstream &, OutputParams const &) const;
+       docstring xhtml(XHTMLStream &, OutputParams const &) const;
+       ///
+       void latex(otexstream &, 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() const { return true; }
-       /// should paragraphs be forced to use the empty layout?
-       virtual bool forcePlainLayout(idx_type = 0) const { return true; }
-       /// should the user be allowed to customize alignment, etc.?
-       virtual bool allowParagraphCustomization(idx_type = 0) const { return false; }
        ///
-       void addToToc(DocIterator const &);
+       void addToToc(DocIterator const & di, bool output_active,
+                                 UpdateType utype, TocBackend & backend) const;
+       ///
+       docstring toolTip(BufferView const & bv, int x, int y) const;
+       ///
+       docstring const buttonLabel(BufferView const & bv) const;
+       /// Updates needed features for this inset.
+       void validate(LaTeXFeatures & features) const;
+       ///
+       std::string contextMenuName() const;
        ///
        Inset * clone() const { return new InsetIndex(*this); }
+       /// Is the content of this inset part of the immediate text sequence?
+       bool isPartOfTextSequence() const { return false; }
+
+       ///
+       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
+       //@{
        ///
-       static ParamInfo const & findInfo(std::string const &);
+       InsetCode lyxCode() const { return INDEX_PRINT_CODE; }
        ///
-       static std::string defaultCommand() { return "printindex"; };
+       void latex(otexstream &, OutputParams const &) const;
        ///
-       static bool isCompatibleCommand(std::string const & s) 
-               { return s == "printindex"; }
-private:
+       docstring xhtml(XHTMLStream &, OutputParams const &) const;
+       ///
+       void doDispatch(Cursor & cur, FuncRequest & cmd);
+       ///
+       bool getStatus(Cursor &, FuncRequest const &, FuncStatus &) const;
+       ///
+       void updateBuffer(ParIterator const & it, UpdateType);
+       ///
+       std::string 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 screenLabel() const;
+       static ParamInfo const & findInfo(std::string const &);
+       ///
+       static std::string defaultCommand() { return "printindex"; }
+       ///
+       static bool isCompatibleCommand(std::string const & s);
+       //@}
+
+private:
+       /// \name Private functions inherited from Inset class
+       //@{
        ///
        Inset * clone() const { return new InsetPrintIndex(*this); }
+       //@}
+
+       /// \name Private functions inherited from InsetCommand class
+       //@{
+       ///
+       docstring screenLabel() const;
+       //@}
 };