Indicate see[also] refs in label and outliner

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

diff --git a/src/insets/InsetIndex.h b/src/insets/InsetIndex.h
index cca959a106612e9df34f219f8ed18cade68140ce..a89a684974fa39e1ec9d4df81a44bc54981884b3 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.
  */
@@ -13,53 +13,190 @@
 #define INSET_INDEX_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 InsetCommand {
+class InsetIndex : public InsetCollapsible {
 public:
        ///
-       InsetIndex(InsetCommandParams const &);
+       InsetIndex(Buffer *, InsetIndexParams const &);
        ///
-       docstring const getScreenLabel(Buffer const &) const;
+       static std::string params2string(InsetIndexParams const &);
        ///
-       EDITABLE editable() const { return IS_EDITABLE; }
+       static void string2params(std::string const &, InsetIndexParams &);
        ///
-       Inset::Code lyxCode() const;
+       const InsetIndexParams& params() const { return params_; }
        ///
-       int docbook(Buffer const &, odocstream &,
-                   OutputParams const &) const;
+       int rowFlags() const override { return CanBreakBefore | CanBreakAfter; }
 private:
-       virtual std::auto_ptr<Inset> doClone() const {
-               return std::auto_ptr<Inset>(new InsetIndex(params()));
-       }
+       ///
+       bool hasSettings() const override;
+       ///
+       InsetCode lyxCode() const override { return INDEX_CODE; }
+       ///
+       docstring layoutName() const override { return from_ascii("Index"); }
+       ///
+       ColorCode labelColor() const override;
+       ///
+       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 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;
+       ///
+       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 &);
+       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;
+       ///
+       bool getStatus(Cursor &, FuncRequest const &, FuncStatus &) const override;
+       ///
+       void updateBuffer(ParIterator const & it, UpdateType, bool const deleted = false) override;
+       ///
+       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 override;
        ///
-       EDITABLE editable() const { return NOT_EDITABLE; }
+       int rowFlags() const override { return Display; }
+       //@}
+
+       /// \name Static public methods obligated for InsetCommand derived classes
+       //@{
        ///
-       Inset::Code lyxCode() const;
+       static ParamInfo const & findInfo(std::string const &);
        ///
-       DisplayType display() const { return AlignCenter; }
+       static std::string defaultCommand() { return "printindex"; }
        ///
-       docstring const getScreenLabel(Buffer const &) const;
+       static bool isCompatibleCommand(std::string const & s);
+       //@}
+
 private:
-       virtual std::auto_ptr<Inset> doClone() const {
-               return std::auto_ptr<Inset>(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;
+       //@}
 };