X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2Finsets%2FInsetIndex.h;h=6a74b796016404b68f9b7a29ac7643c66c8d8374;hb=f352a375;hp=1d70c08b2366c8e4c4a1f435eca396e1bd0497de;hpb=8e9410b3d034178f5e391c6cfffca3d65afe59ff;p=lyx.git

diff --git a/src/insets/InsetIndex.h b/src/insets/InsetIndex.h
index 1d70c08b23..6a74b79601 100644
--- 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.
  */
@@ -13,68 +13,181 @@
 #define INSET_INDEX_H
 
 
-#include "InsetCollapsable.h"
+#include "InsetCollapsible.h"
 #include "InsetCommand.h"
 
 
 namespace lyx {
 
-class LaTeXFeatures;
+class IndexEntry;
+
+class InsetIndexParams {
+public:
+	enum PageRange {
+		None,
+		Start,
+		End
+	};
+	///
+	explicit InsetIndexParams(docstring const & b = docstring())
+		: index(b), range(None), pagefmt("default") {}
+	///
+	void write(std::ostream & os) const;
+	///
+	void read(Lexer & lex);
+	///
+	docstring index;
+	///
+	PageRange range;
+	///
+	std::string pagefmt;
+};
+
 
 /** 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;
+	///
+	void docbook(XMLStream &, OutputParams const &) const override;
+	///
+	docstring xhtml(XMLStream &, OutputParams const &) const override;
+	///
+	void latex(otexstream &, OutputParams const &) const override;
+	///
+	void processLatexSorting(otexstream &, OutputParams const &,
+				 docstring const, docstring const) const;
+	///
+	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;
+	///
+	void getSortkey(otexstream &, OutputParams const &) const;
+	///
+	docstring getSortkeyAsText(OutputParams const &) const;
+	///
+	void getSubentries(otexstream &, OutputParams const &) const;
+	///
+	std::vector<docstring> getSubentriesAsText(OutputParams const &) const;
 	///
-	virtual Inset * clone() const;
+	docstring getMainSubentryAsText(OutputParams const & runparams) const;
+	///
+	void getSeeRefs(otexstream &, OutputParams const &) const;
+	///
+	docstring getSeeAsText(OutputParams const & runparams) const;
+	///
+	std::vector<docstring> getSeeAlsoesAsText(OutputParams const & runparams) const;
+	///
+	bool hasSubentries() const;
+	///
+	bool hasSeeRef() const;
+	///
+	bool hasSortKey() const;
+	///
+	bool macrosPossible(std::string const type) const;
+	///
+	std::string contextMenuName() const override;
+	///
+	std::string contextMenu(BufferView const &, int, int) 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; }
+	///
+	bool insetAllowed(InsetCode code) const override;
+
+	///
+	friend class InsetIndexParams;
+	///
+	friend class IndexEntry;
+	///
+	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;
+	///
+	docstring xhtml(XMLStream &, OutputParams const &) const override;
+	///
+	void doDispatch(Cursor & cur, FuncRequest & cmd) override;
 	///
-	EDITABLE editable() const { return NOT_EDITABLE; }
+	bool getStatus(Cursor &, FuncRequest const &, FuncStatus &) const override;
 	///
-	InsetCode lyxCode() const;
+	void updateBuffer(ParIterator const & it, UpdateType, bool const deleted = false) override;
 	///
-	DisplayType display() const { return AlignCenter; }
+	std::string contextMenuName() const override;
+	/// Updates needed features for this inset.
+	void validate(LaTeXFeatures & features) const override;
+	///
+	bool hasSettings() const override;
 	///
-	docstring const getScreenLabel(Buffer const &) const;
+	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;
+	//@}
 };