* 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.
*/
#define INSET_INDEX_H
+#include "InsetCollapsable.h"
#include "InsetCommand.h"
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 InsetCommand {
+class InsetIndex : public InsetCollapsable {
public:
///
- InsetIndex(InsetCommandParams const &);
+ InsetIndex(Buffer *, InsetIndexParams const &);
///
- docstring const getScreenLabel(Buffer const &) const;
+ static std::string params2string(InsetIndexParams const &);
///
- EDITABLE editable() const { return IS_EDITABLE; }
+ static void string2params(std::string const &, InsetIndexParams &);
+private:
///
- Inset::Code lyxCode() const;
+ bool hasSettings() const;
///
- int docbook(Buffer const &, odocstream &,
- OutputParams const &) const;
-private:
- virtual std::auto_ptr<Inset> doClone() const {
- return std::auto_ptr<Inset>(new InsetIndex(params()));
- }
+ InsetCode lyxCode() const { return INDEX_CODE; }
+ ///
+ docstring name() const { return from_ascii("Index"); }
+ ///
+ ColorCode labelColor() const;
+ ///
+ void write(std::ostream & os) const;
+ ///
+ 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(XHTMLStream &, OutputParams const &) const;
+ ///
+ int latex(odocstream &, 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; }
+ ///
+ void addToToc(DocIterator const &);
+ ///
+ 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;
+ ///
+ Inset * clone() const { return new InsetIndex(*this); }
+
+ ///
+ friend class InsetIndexParams;
+ ///
+ InsetIndexParams params_;
};
class InsetPrintIndex : public InsetCommand {
public:
///
- InsetPrintIndex(InsetCommandParams const &);
+ InsetPrintIndex(Buffer * buf, InsetCommandParams const &);
+ ///
+ InsetCode lyxCode() const { return INDEX_PRINT_CODE; }
+
+ ///
+ static ParamInfo const & findInfo(std::string const &);
+ ///
+ static std::string defaultCommand() { return "printindex"; }
+ ///
+ static bool isCompatibleCommand(std::string const & s);
+ ///
+ int latex(odocstream &, OutputParams const &) const;
+ /// Does nothing yet.
+ docstring xhtml(XHTMLStream &, OutputParams const &) const;
+ ///
+ void doDispatch(Cursor & cur, FuncRequest & cmd);
+ ///
+ bool getStatus(Cursor &, FuncRequest const &, FuncStatus &) const;
+ ///
+ virtual docstring contextMenu(BufferView const & bv, int x, int y) const;
+private:
/// Updates needed features for this inset.
void validate(LaTeXFeatures & features) const;
///
- EDITABLE editable() const { return NOT_EDITABLE; }
+ bool hasSettings() const;
+
///
- Inset::Code lyxCode() const;
+ DisplayType display() const { return AlignCenter; }
///
- bool display() const { return true; }
+ docstring screenLabel() const;
///
- docstring const getScreenLabel(Buffer const &) const;
-private:
- virtual std::auto_ptr<Inset> doClone() const {
- return std::auto_ptr<Inset>(new InsetPrintIndex(params()));
- }
+ Inset * clone() const { return new InsetPrintIndex(*this); }
};