X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2Finsets%2FInsetIndex.h;h=b1aa9b4c5f6ee473c1247a96b9a272e75667ca74;hb=dc8c4f3eab6e01f3767de765423fda5e4d6c5124;hp=c3c5fb7a7ef0662ad722cffe3713909cba8e74fd;hpb=f7b1c86393d890d5d473279d88e26bb78f8c1275;p=lyx.git diff --git a/src/insets/InsetIndex.h b/src/insets/InsetIndex.h index c3c5fb7a7e..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. */ @@ -19,63 +19,127 @@ 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 InsetCollapsable { public: /// - InsetIndex(BufferParams const &); + InsetIndex(Buffer *, InsetIndexParams const &); + /// + static std::string params2string(InsetIndexParams const &); + /// + static void string2params(std::string const &, InsetIndexParams &); +private: + /// + bool hasSettings() const; + /// + InsetCode lyxCode() const { return INDEX_CODE; } /// - InsetIndex(InsetIndex const &); + docstring layoutName() const { return from_ascii("Index"); } /// - EDITABLE editable() const { return IS_EDITABLE; } + ColorCode labelColor() const; /// - InsetCode lyxCode() const; + void write(std::ostream & os) const; /// + void read(Lexer & lex); /// - void metrics(MetricsInfo &, Dimension &) const; + int docbook(odocstream &, OutputParams const &) const; /// - void draw(PainterInfo &, int, int) const; + docstring xhtml(XHTMLStream &, OutputParams const &) const; /// - docstring name() const { return from_ascii("Index"); } + void latex(otexstream &, OutputParams const &) const; /// - void getDrawFont(Font &) const; + bool showInsetDialog(BufferView *) const; /// - void write(Buffer const & buf, std::ostream & os) const; + bool getStatus(Cursor &, FuncRequest const &, FuncStatus &) const; /// - int docbook(Buffer const &, odocstream &, - OutputParams const &) const; + void doDispatch(Cursor & cur, FuncRequest & cmd); /// should paragraph indendation be omitted in any case? - bool neverIndent(Buffer const &) const { return true; } + 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); } -private: /// - bool getStatus(Cursor & cur, FuncRequest const & cmd, FuncStatus &) const; + friend class InsetIndexParams; /// - virtual Inset * clone() const; + 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; } - /// - InsetCode 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 &); + /// + static std::string defaultCommand() { return "printindex"; } /// - docstring const getScreenLabel(Buffer const &) const; + 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 { return new InsetPrintIndex(*this); } + //@} + + /// \name Private functions inherited from InsetCommand class + //@{ + /// + docstring screenLabel() const; + //@} };