X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2Finsets%2FInsetIndex.h;h=b1aa9b4c5f6ee473c1247a96b9a272e75667ca74;hb=0c7bd9a57f2a308bb9659200eda3b7e45f8d5d3c;hp=cca959a106612e9df34f219f8ed18cade68140ce;hpb=73849af5df4d92146bf7c57b489f30d698884401;p=lyx.git diff --git a/src/insets/InsetIndex.h b/src/insets/InsetIndex.h index cca959a106..b1aa9b4c5f 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,53 +13,133 @@ #define INSET_INDEX_H +#include "InsetCollapsable.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 InsetCommand { +class InsetIndex : public InsetCollapsable { 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 &); +private: /// - Inset::Code lyxCode() const; + bool hasSettings() const; /// - int docbook(Buffer const &, odocstream &, - OutputParams const &) const; -private: - virtual std::auto_ptr doClone() const { - return std::auto_ptr(new InsetIndex(params())); - } + InsetCode lyxCode() const { return INDEX_CODE; } + /// + docstring layoutName() const { return from_ascii("Index"); } + /// + ColorCode labelColor() const; + /// + void write(std::ostream & os) const; + /// + void read(Lexer & lex); + /// + int docbook(odocstream &, OutputParams const &) const; + /// + docstring xhtml(XHTMLStream &, OutputParams const &) const; + /// + void latex(otexstream &, OutputParams const &) const; + /// + bool showInsetDialog(BufferView *) const; + /// + bool getStatus(Cursor &, FuncRequest const &, FuncStatus &) const; + /// + void doDispatch(Cursor & cur, FuncRequest & cmd); + /// should paragraph indendation be omitted in any case? + bool neverIndent() const { return true; } + /// + void addToToc(DocIterator const & di, bool output_active, + UpdateType utype) const; + /// + docstring toolTip(BufferView const & bv, int x, int y) const; + /// + docstring const buttonLabel(BufferView const & bv) const; + /// Updates needed features for this inset. + void validate(LaTeXFeatures & features) const; + /// + std::string contextMenuName() const; + /// + Inset * clone() const { return new InsetIndex(*this); } + + /// + friend class InsetIndexParams; + /// + 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 { return INDEX_PRINT_CODE; } + /// + void latex(otexstream &, OutputParams const &) const; + /// + docstring xhtml(XHTMLStream &, OutputParams const &) const; + /// + void doDispatch(Cursor & cur, FuncRequest & cmd); + /// + bool getStatus(Cursor &, FuncRequest const &, FuncStatus &) const; + /// + std::string contextMenuName() const; /// Updates needed features for this inset. void validate(LaTeXFeatures & features) const; /// - EDITABLE editable() const { return NOT_EDITABLE; } - /// - Inset::Code lyxCode() const; + bool hasSettings() const; /// DisplayType display() const { return AlignCenter; } + //@} + + /// \name Static public methods obligated for InsetCommand derived classes + //@{ + /// + static ParamInfo const & findInfo(std::string const &); /// - docstring const getScreenLabel(Buffer const &) const; + static std::string defaultCommand() { return "printindex"; } + /// + static bool isCompatibleCommand(std::string const & s); + //@} + private: - virtual std::auto_ptr doClone() const { - return std::auto_ptr(new InsetPrintIndex(params())); - } + /// \name Private functions inherited from Inset class + //@{ + /// + Inset * clone() const { return new InsetPrintIndex(*this); } + //@} + + /// \name Private functions inherited from InsetCommand class + //@{ + /// + docstring screenLabel() const; + //@} };