X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2Finsets%2FInsetIndex.h;h=c66be3004913b67d37f753923ba8f5bed1c314c6;hb=bbfc419c10010c1ebf6ab59adf2eaf6f63104a9e;hp=664a47db2de2f79a8de721c33252e57266ed45eb;hpb=07b6198f4c3aa6dfe3245394b660966fd3e85c99;p=features.git diff --git a/src/insets/InsetIndex.h b/src/insets/InsetIndex.h index 664a47db2d..c66be30049 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,48 +19,75 @@ 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 const &, InsetIndexParams const &); /// - InsetIndex(InsetIndex const &); + static std::string params2string(InsetIndexParams const &); + /// + static void string2params(std::string const &, InsetIndexParams &); +private: /// - EDITABLE editable() const { return IS_EDITABLE; } + bool hasSettings() const; /// InsetCode lyxCode() const { return INDEX_CODE; } /// + docstring name() const { return from_ascii("Index"); } /// - void metrics(MetricsInfo &, Dimension &) const; + ColorCode labelColor() const; /// - void draw(PainterInfo &, int, int) const; + void write(std::ostream & os) const; /// - docstring name() const { return from_ascii("Index"); } + void read(Lexer & lex); + /// + 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(odocstream &, OutputParams const &) const; + /// + int latex(odocstream &, 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; } /// - static CommandInfo const * findInfo(std::string const & cmdName = ""); + void addToToc(DocIterator const &); /// - static std::string defaultCommand() { return "index"; }; + docstring const buttonLabel(BufferView const & bv) const; /// - static bool isCompatibleCommand(std::string const & s) - { return s == "index"; } -private: + docstring toolTip(BufferView const & bv, int x, int y) const; + /// Updates needed features for this inset. + void validate(LaTeXFeatures & features) const; + /// + docstring contextMenu(BufferView const & bv, int x, int y) const; /// - bool getStatus(Cursor & cur, FuncRequest const & cmd, FuncStatus &) const; + Inset * clone() const { return new InsetIndex(*this); } + + /// + friend class InsetIndexParams; /// - virtual Inset * clone() const; + InsetIndexParams params_; }; @@ -68,27 +95,37 @@ class InsetPrintIndex : public InsetCommand { public: /// InsetPrintIndex(InsetCommandParams const &); - /// Updates needed features for this inset. - void validate(LaTeXFeatures & features) const; /// - EDITABLE editable() const { return NOT_EDITABLE; } + InsetCode lyxCode() const { return INDEX_PRINT_CODE; } + /// - InsetCode 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); /// - static CommandInfo const * findInfo(std::string const & cmdName = ""); + int latex(odocstream &, OutputParams const &) const; + /// Does nothing yet. + docstring xhtml(odocstream &, OutputParams const &) const; /// - static std::string defaultCommand() { return "printindex"; }; + void doDispatch(Cursor & cur, FuncRequest & cmd); + /// + bool getStatus(Cursor &, FuncRequest const &, FuncStatus &) const; /// - static bool isCompatibleCommand(std::string const & s) - { return s == "printindex"; } + virtual docstring contextMenu(BufferView const & bv, int x, int y) const; private: - virtual Inset * clone() const { - return new InsetPrintIndex(params()); - } + /// Updates needed features for this inset. + void validate(LaTeXFeatures & features) const; + /// + bool hasSettings() const; + + /// + DisplayType display() const { return AlignCenter; } + /// + docstring screenLabel() const; + /// + Inset * clone() const { return new InsetPrintIndex(*this); } };