X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2Finsets%2FInsetIndex.h;h=6a74b796016404b68f9b7a29ac7643c66c8d8374;hb=f352a375;hp=4391c4f003234e5e76678c878b5cc873e2a81ffb;hpb=f9e0957eb8c6bed09cbcf828ec308223d394b419;p=lyx.git diff --git a/src/insets/InsetIndex.h b/src/insets/InsetIndex.h index 4391c4f003..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,71 +13,181 @@ #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), 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 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 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"); } /// - void write(std::ostream & os) const; + 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; /// - int docbook(odocstream &, OutputParams const &) const; + void getSortkey(otexstream &, OutputParams const &) const; /// - int latex(odocstream &, OutputParams const &) const; - /// 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; } + docstring getSortkeyAsText(OutputParams const &) const; /// - void textString(odocstream &) const; + void getSubentries(otexstream &, OutputParams const &) const; /// - void addToToc(DocIterator const &); + std::vector getSubentriesAsText(OutputParams const &) const; /// - Inset * clone() const { return new InsetIndex(*this); } + docstring getMainSubentryAsText(OutputParams const & runparams) const; + /// + void getSeeRefs(otexstream &, OutputParams const &) const; + /// + docstring getSeeAsText(OutputParams const & runparams) const; + /// + std::vector 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 &); + InsetPrintIndex(Buffer * buf, InsetCommandParams const &); + /// \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) - { return s == "printindex"; } -private: + 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; /// - EDITABLE editable() const { return NOT_EDITABLE; } + bool hasSettings() const override; /// - InsetCode lyxCode() const; + int rowFlags() const override { return Display; } + //@} + + /// \name Static public methods obligated for InsetCommand derived classes + //@{ + /// + static ParamInfo const & findInfo(std::string const &); /// - DisplayType display() const { return AlignCenter; } + static std::string defaultCommand() { return "printindex"; } /// - docstring screenLabel() const; + 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; + //@} };