* 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.
*/
#define INSET_INDEX_H
-#include "InsetCollapsable.h"
+#include "InsetCollapsible.h"
#include "InsetCommand.h"
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 {
+class InsetIndex : public InsetCollapsible {
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:
///
- InsetCode lyxCode() const { return INDEX_CODE; }
+ bool hasSettings() const override;
///
- docstring name() const { return from_ascii("Index"); }
+ InsetCode lyxCode() const override { return INDEX_CODE; }
///
- void write(Buffer const & buf, std::ostream & os) const;
+ docstring layoutName() const override { return from_ascii("Index"); }
///
- int docbook(Buffer const &, odocstream &,
- OutputParams const &) const;
- /// should paragraph indendation be omitted in any case?
- bool neverIndent(Buffer const &) const { return true; }
+ ColorCode labelColor() const override;
///
- void addToToc(Buffer const &, ParConstIterator const &) const;
-private:
+ void write(std::ostream & os) const override;
+ ///
+ void read(Lexer & lex) override;
///
- virtual Inset * clone() const;
+ void docbook(XMLStream &, OutputParams const &) const override;
+ ///
+ docstring xhtml(XMLStream &, OutputParams const &) const override;
+ ///
+ void latex(otexstream &, OutputParams const &) const override;
+ ///
+ bool showInsetDialog(BufferView *) const override;
+ ///
+ bool getStatus(Cursor &, FuncRequest const &, FuncStatus &) const override;
+ ///
+ void doDispatch(Cursor & cur, FuncRequest & cmd) override;
+ /// should paragraph indentation be omitted in any case?
+ bool neverIndent() const override { return true; }
+ ///
+ void addToToc(DocIterator const & di, bool output_active,
+ UpdateType utype, TocBackend & backend) const override;
+ ///
+ docstring toolTip(BufferView const & bv, int x, int y) const override;
+ ///
+ docstring const buttonLabel(BufferView const & bv) const override;
+ /// Updates needed features for this inset.
+ void validate(LaTeXFeatures & features) const override;
+ ///
+ std::string contextMenuName() const override;
+ ///
+ Inset * clone() const override { return new InsetIndex(*this); }
+ /// Is the content of this inset part of the immediate text sequence?
+ bool isPartOfTextSequence() const override { return false; }
+
+ ///
+ friend class InsetIndexParams;
+ ///
+ InsetIndexParams params_;
};
class InsetPrintIndex : public InsetCommand {
public:
///
- InsetPrintIndex(InsetCommandParams const &);
- /// Updates needed features for this inset.
- void validate(LaTeXFeatures & features) const;
+ InsetPrintIndex(Buffer * buf, InsetCommandParams const &);
+
+ /// \name Public functions inherited from Inset class
+ //@{
+ ///
+ InsetCode lyxCode() const override { return INDEX_PRINT_CODE; }
+ ///
+ void latex(otexstream &, OutputParams const &) const override;
///
- EDITABLE editable() const { return NOT_EDITABLE; }
+ docstring xhtml(XMLStream &, OutputParams const &) const override;
///
- InsetCode lyxCode() const;
+ void doDispatch(Cursor & cur, FuncRequest & cmd) override;
///
- DisplayType display() const { return AlignCenter; }
+ bool getStatus(Cursor &, FuncRequest const &, FuncStatus &) const override;
///
- docstring const getScreenLabel(Buffer const &) const;
+ void updateBuffer(ParIterator const & it, UpdateType, bool const deleted = false) override;
///
- static CommandInfo const * findInfo(std::string const & cmdName = "");
+ std::string contextMenuName() const override;
+ /// Updates needed features for this inset.
+ void validate(LaTeXFeatures & features) const override;
+ ///
+ bool hasSettings() const override;
+ ///
+ int rowFlags() const override { return Display; }
+ //@}
+
+ /// \name Static public methods obligated for InsetCommand derived classes
+ //@{
+ ///
+ 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 override { return new InsetPrintIndex(*this); }
+ //@}
+
+ /// \name Private functions inherited from InsetCommand class
+ //@{
+ ///
+ docstring screenLabel() const override;
+ //@}
};