X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2Finsets%2FInsetIndex.h;h=80d8149bc4cab58a93814baafe6eef8270800343;hb=3391fed36a574fb729f243888258d1b6d45b0251;hp=8ffab82b9c8ac77a73a56e00790abf05ed01cd19;hpb=5ddc612b735317d5b22553a63aad7879503e3950;p=features.git diff --git a/src/insets/InsetIndex.h b/src/insets/InsetIndex.h index 8ffab82b9c..80d8149bc4 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,69 +19,129 @@ 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 &); /// - 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 layoutName() 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); /// - void getDrawFont(FontInfo &) const; + int docbook(odocstream &, OutputParams const &) const; /// - void write(Buffer const & buf, std::ostream & os) const; + docstring xhtml(XHTMLStream &, OutputParams const &) const; /// - int docbook(Buffer const &, odocstream &, - 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(Buffer const &) const { return true; } -private: + bool neverIndent() const { return true; } + /// + void addToToc(DocIterator const & di, bool output_active, + UpdateType utype, TocBackend & backend) 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; /// - bool getStatus(Cursor & cur, FuncRequest const & cmd, FuncStatus &) const; + std::string contextMenuName() const; /// - virtual Inset * clone() const; + Inset * clone() const { return new InsetIndex(*this); } + /// Is the content of this inset part of the immediate text sequence? + bool isPartOfTextSequence() const { return false; } + + /// + 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; } - /// - InsetCode lyxCode() const; + bool hasSettings() const; /// DisplayType display() const { return AlignCenter; } + //@} + + /// \name Static public methods obligated for InsetCommand derived classes + //@{ /// - docstring const getScreenLabel(Buffer const &) const; - /// - static CommandInfo const * findInfo(std::string const & cmdName = ""); + static ParamInfo const & findInfo(std::string const &); /// - static std::string defaultCommand() { return "printindex"; }; + static std::string defaultCommand() { return "printindex"; } /// - static bool isCompatibleCommand(std::string const & s) - { return s == "printindex"; } + 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; + //@} };