- /// the string that is passed to the TOC
- virtual void tocString(odocstream &) const {}
-
- /// what appears in the minibuffer when opening
- virtual docstring editMessage() const;
+ /// XHTML output
+ /// the inset is expected to write XHTML to the XHTMLStream
+ /// \return any "deferred" material that should be written outside the
+ /// normal stream, and which will in fact be written after the current
+ /// paragraph closes. this is appropriate e.g. for floats.
+ virtual docstring xhtml(XHTMLStream & xs, OutputParams const &) const;
+
+ /// Writes a string representation of the inset to the odocstream.
+ /// This one should be called when you want the whole contents of
+ /// the inset.
+ virtual void toString(odocstream &) const {}
+ /// Appends a potentially abbreviated version of the inset to
+ /// \param str. Intended for use by the TOC.
+ virtual void forOutliner(docstring & str,
+ size_t const maxlen = TOC_ENTRY_LENGTH,
+ bool const shorten = true) const;
+
+ /// Can a cursor be put in there ?
+ /// Forced to false for insets that have hidden contents, like
+ /// InsetMathCommand and InsetInfo.
+ virtual bool isActive() const { return nargs() > 0; }