X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2Finsets%2FInsetIndex.h;h=3ee17509dcf45e4fd5fcc22733617479191ad861;hb=50060053e36b3e9dfe03bc33ed3abac1eacc54b0;hp=5f4492884f2300d9cecf496a27a15379d3891e8a;hpb=4804b60f1c63e66ab20947a4291d40aff288493d;p=lyx.git diff --git a/src/insets/InsetIndex.h b/src/insets/InsetIndex.h index 5f4492884f..3ee17509dc 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,131 @@ namespace lyx { +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(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; /// InsetCode lyxCode() const { return INDEX_CODE; } /// - docstring name() const { return from_ascii("Index"); } + 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; /// - int latex(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; } - /// 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; } /// - void addToToc(DocIterator const &); + 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; + /// + std::string contextMenuName() 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 + //@{ /// - static ParamInfo const & findInfo(std::string const &); + InsetCode lyxCode() const { return INDEX_PRINT_CODE; } /// - static std::string defaultCommand() { return "printindex"; }; + void latex(otexstream &, OutputParams const &) const; /// - static bool isCompatibleCommand(std::string const & s) - { return s == "printindex"; } -private: + docstring xhtml(XHTMLStream &, OutputParams const &) const; + /// + void doDispatch(Cursor & cur, FuncRequest & cmd); + /// + bool getStatus(Cursor &, FuncRequest const &, FuncStatus &) const; + /// + void updateBuffer(ParIterator const & it, UpdateType); + /// + 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 screenLabel() const; + static ParamInfo const & findInfo(std::string const &); + /// + static std::string defaultCommand() { return "printindex"; } + /// + static bool isCompatibleCommand(std::string const & s); + //@} + +private: + /// \name Private functions inherited from Inset class + //@{ /// Inset * clone() const { return new InsetPrintIndex(*this); } + //@} + + /// \name Private functions inherited from InsetCommand class + //@{ + /// + docstring screenLabel() const; + //@} };