mirror of
https://git.lyx.org/repos/lyx.git
synced 2024-11-25 02:49:46 +00:00
3f27f951cb
preparatory to fixing #7080. Note that mathed uses the same routine, but for a completely different purpose, so I did not rename it there. I have seen no difference in behavior after testing, e.g., opening and exporting Math.lyx, and also re-saving it and looking at the diff. git-svn-id: svn://svn.lyx.org/lyx/lyx-devel/trunk@38109 a592a061-630c-0410-9148-cb99ea01b6c8
148 lines
3.3 KiB
C++
148 lines
3.3 KiB
C++
// -*- C++ -*-
|
|
/**
|
|
* \file InsetIndex.h
|
|
* This file is part of LyX, the document processor.
|
|
* Licence details can be found in the file COPYING.
|
|
*
|
|
* \author Lars Gullik Bjønnes
|
|
*
|
|
* Full author contact details are available in file CREDITS.
|
|
*/
|
|
|
|
#ifndef INSET_INDEX_H
|
|
#define INSET_INDEX_H
|
|
|
|
|
|
#include "InsetCollapsable.h"
|
|
#include "InsetCommand.h"
|
|
|
|
|
|
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 *, InsetIndexParams const &);
|
|
///
|
|
static std::string params2string(InsetIndexParams const &);
|
|
///
|
|
static void string2params(std::string const &, InsetIndexParams &);
|
|
private:
|
|
///
|
|
bool hasSettings() const;
|
|
///
|
|
InsetCode lyxCode() const { return INDEX_CODE; }
|
|
///
|
|
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;
|
|
///
|
|
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; }
|
|
///
|
|
void addToToc(DocIterator const &) 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;
|
|
///
|
|
docstring contextMenuName() const;
|
|
///
|
|
Inset * clone() const { return new InsetIndex(*this); }
|
|
|
|
///
|
|
friend class InsetIndexParams;
|
|
///
|
|
InsetIndexParams params_;
|
|
};
|
|
|
|
|
|
class InsetPrintIndex : public InsetCommand {
|
|
public:
|
|
///
|
|
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;
|
|
///
|
|
docstring contextMenuName() const;
|
|
/// Updates needed features for this inset.
|
|
void validate(LaTeXFeatures & features) const;
|
|
///
|
|
bool hasSettings() const;
|
|
///
|
|
DisplayType display() const { return AlignCenter; }
|
|
//@}
|
|
|
|
/// \name Static public methods obligated for InsetCommand derived classes
|
|
//@{
|
|
///
|
|
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;
|
|
//@}
|
|
};
|
|
|
|
|
|
} // namespace lyx
|
|
|
|
#endif
|