X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;ds=sidebyside;f=src%2Finsets%2FInsetIndex.h;h=a89a684974fa39e1ec9d4df81a44bc54981884b3;hb=975f304185eca53d62de8b36e6fc5f95b2da4fd9;hp=d0b0d1da29856f9f7d89fa1baec4857fb4ef0847;hpb=5282dc14ca0ee1a80e4367384c801a237b6dcf18;p=features.git

diff --git a/src/insets/InsetIndex.h b/src/insets/InsetIndex.h
index d0b0d1da29..a89a684974 100644
--- a/src/insets/InsetIndex.h
+++ b/src/insets/InsetIndex.h
@@ -13,29 +13,40 @@
 #define INSET_INDEX_H
 
 
-#include "InsetCollapsable.h"
+#include "InsetCollapsible.h"
 #include "InsetCommand.h"
 
 
 namespace lyx {
 
+class IndexEntry;
+
 class InsetIndexParams {
 public:
+	enum PageRange {
+		None,
+		Start,
+		End
+	};
 	///
 	explicit InsetIndexParams(docstring const & b = docstring())
-		: index(b) {}
+		: 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(Buffer *, InsetIndexParams const &);
@@ -43,50 +54,94 @@ public:
 	static std::string params2string(InsetIndexParams const &);
 	///
 	static void string2params(std::string const &, InsetIndexParams &);
+	///
+	const InsetIndexParams& params() const { return params_; }
+	///
+	int rowFlags() const override { return CanBreakBefore | CanBreakAfter; }
 private:
 	///
-	bool hasSettings() const;
+	bool hasSettings() const override;
 	///
-	InsetCode lyxCode() const { return INDEX_CODE; }
+	InsetCode lyxCode() const override { return INDEX_CODE; }
 	///
-	docstring name() const { return from_ascii("Index"); }
+	docstring layoutName() const override { return from_ascii("Index"); }
 	///
-	ColorCode labelColor() const;
+	ColorCode labelColor() const override;
 	///
-	void write(std::ostream & os) const;
+	void write(std::ostream & os) const override;
 	///
-	void read(Lexer & lex);
+	void read(Lexer & lex) override;
+	///
+	void docbook(XMLStream &, OutputParams const &) const override;
 	///
-	int docbook(odocstream &, OutputParams const &) const;
-	/// At the moment, this does nothing. See development/HTML.notes
-	/// for some remarks on what could be done.
-	docstring xhtml(XHTMLStream &, OutputParams const &) const;
+	docstring xhtml(XMLStream &, OutputParams const &) const override;
 	///
-	int latex(odocstream &, OutputParams const &) const;
+	void latex(otexstream &, OutputParams const &) const override;
 	///
-	bool showInsetDialog(BufferView *) const;
+	void processLatexSorting(otexstream &, OutputParams const &,
+				 docstring const, docstring const) const;
 	///
-	bool getStatus(Cursor &, FuncRequest const &, FuncStatus &) const;
+	bool showInsetDialog(BufferView *) const override;
 	///
-	void doDispatch(Cursor & cur, FuncRequest & cmd);
-	/// should paragraph indendation be omitted in any case?
-	bool neverIndent() const { return true; }
+	bool getStatus(Cursor &, FuncRequest const &, FuncStatus &) const override;
 	///
-	void addToToc(DocIterator const &);
+	void doDispatch(Cursor & cur, FuncRequest & cmd) override;
+	/// should paragraph indentation be omitted in any case?
+	bool neverIndent() const override { return true; }
 	///
-	docstring const buttonLabel(BufferView const & bv) const;
+	void addToToc(DocIterator const & di, bool output_active,
+				  UpdateType utype, TocBackend & backend) const override;
 	///
-	docstring toolTip(BufferView const & bv, int x, int y) const;
+	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;
+	void validate(LaTeXFeatures & features) const override;
+	///
+	void getSortkey(otexstream &, OutputParams const &) const;
+	///
+	docstring getSortkeyAsText(OutputParams const &) const;
+	///
+	void emptySubentriesWarning(docstring const & mainentry) const;
+	///
+	void getSubentries(otexstream &, OutputParams const &, docstring const &) const;
+	///
+	std::vector<docstring> getSubentriesAsText(OutputParams const &,
+						   bool const asLabel = false) const;
+	///
+	docstring getMainSubentryAsText(OutputParams const & runparams) const;
+	///
+	void getSeeRefs(otexstream &, OutputParams const &) const;
+	///
+	docstring getSeeAsText(OutputParams const & runparams,
+			       bool const asLabel = false) const;
+	///
+	std::vector<docstring> getSeeAlsoesAsText(OutputParams const & runparams,
+						  bool const asLabel = false) const;
+	///
+	bool hasSubentries() const;
+	///
+	bool hasSeeRef() const;
 	///
-	docstring contextMenu(BufferView const & bv, int x, int y) const;
+	bool hasSortKey() const;
 	///
-	Inset * clone() const { return new InsetIndex(*this); }
+	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_;
 };
 
@@ -95,37 +150,53 @@ class InsetPrintIndex : public InsetCommand {
 public:
 	///
 	InsetPrintIndex(Buffer * buf, InsetCommandParams const &);
-	///
-	InsetCode lyxCode() const { return INDEX_PRINT_CODE; }
 
+	/// \name Public functions inherited from Inset class
+	//@{
 	///
-	static ParamInfo const & findInfo(std::string const &);
+	InsetCode lyxCode() const override { return INDEX_PRINT_CODE; }
 	///
-	static std::string defaultCommand() { return "printindex"; }
+	void latex(otexstream &, OutputParams const &) const override;
 	///
-	static bool isCompatibleCommand(std::string const & s);
+	docstring xhtml(XMLStream &, OutputParams const &) const override;
 	///
-	int latex(odocstream &, OutputParams const &) const;
-	/// Does nothing yet.
-	docstring xhtml(XHTMLStream &, OutputParams const &) const;
+	void doDispatch(Cursor & cur, FuncRequest & cmd) override;
 	///
-	void doDispatch(Cursor & cur, FuncRequest & cmd);
+	bool getStatus(Cursor &, FuncRequest const &, FuncStatus &) const override;
 	///
-	bool getStatus(Cursor &, FuncRequest const &, FuncStatus &) const;
+	void updateBuffer(ParIterator const & it, UpdateType, bool const deleted = false) override;
 	///
-	virtual docstring contextMenu(BufferView const & bv, int x, int y) const;
-private:
+	std::string contextMenuName() const override;
 	/// Updates needed features for this inset.
-	void validate(LaTeXFeatures & features) const;
+	void validate(LaTeXFeatures & features) const override;
 	///
-	bool hasSettings() const;
+	bool hasSettings() const override;
+	///
+	int rowFlags() const override { return Display; }
+	//@}
 
+	/// \name Static public methods obligated for InsetCommand derived classes
+	//@{
 	///
-	DisplayType display() const { return AlignCenter; }
+	static ParamInfo const & findInfo(std::string const &);
 	///
-	docstring screenLabel() 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 override { return new InsetPrintIndex(*this); }
+	//@}
+
+	/// \name Private functions inherited from InsetCommand class
+	//@{
 	///
-	Inset * clone() const { return new InsetPrintIndex(*this); }
+	docstring screenLabel() const override;
+	//@}
 };