mirror of
https://git.lyx.org/repos/lyx.git
synced 2024-11-16 07:55:41 +00:00
963a0aa466
Move the enum definition RowFlags in its own include file, to avoid loading Inset.h. Document it more thoroughly. Rename RowAfter to AlwaysBreakAfter. Add CanBreakInside (rows that can be themselves broken). This allow to differentiate elements before bodyPos() and allows to remove a parameter to shortenIfNeeded(). Make the Inset::rowFlags() method return int instead of RowFlags, as should be done for all the bitwise flags. Remove the hand-made bitwise operators. Set R::E::row_flags when creating elements. * INSET elements use the inset's rowFLags(); * virtual element forbid breaking before them, and inherit the *After flags from the previous element of the row; * STRING elements usr CanBreakInside, except before bodyPos. More stuff may be added later.
153 lines
3.8 KiB
C++
153 lines
3.8 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 "InsetCollapsible.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 InsetCollapsible {
|
|
public:
|
|
///
|
|
InsetIndex(Buffer *, InsetIndexParams const &);
|
|
///
|
|
static std::string params2string(InsetIndexParams const &);
|
|
///
|
|
static void string2params(std::string const &, InsetIndexParams &);
|
|
private:
|
|
///
|
|
bool hasSettings() const override;
|
|
///
|
|
InsetCode lyxCode() const override { return INDEX_CODE; }
|
|
///
|
|
docstring layoutName() const override { return from_ascii("Index"); }
|
|
///
|
|
ColorCode labelColor() const override;
|
|
///
|
|
void write(std::ostream & os) const override;
|
|
///
|
|
void read(Lexer & lex) override;
|
|
///
|
|
void docbook(XMLStream &, OutputParams const &) const override;
|
|
///
|
|
docstring xhtml(XMLStream &, OutputParams const &) const override;
|
|
///
|
|
void latex(otexstream &, OutputParams const &) const override;
|
|
///
|
|
bool showInsetDialog(BufferView *) const override;
|
|
///
|
|
bool getStatus(Cursor &, FuncRequest const &, FuncStatus &) const override;
|
|
///
|
|
void doDispatch(Cursor & cur, FuncRequest & cmd) override;
|
|
/// should paragraph indentation be omitted in any case?
|
|
bool neverIndent() const override { return true; }
|
|
///
|
|
void addToToc(DocIterator const & di, bool output_active,
|
|
UpdateType utype, TocBackend & backend) const override;
|
|
///
|
|
docstring toolTip(BufferView const & bv, int x, int y) const override;
|
|
///
|
|
docstring const buttonLabel(BufferView const & bv) const override;
|
|
/// Updates needed features for this inset.
|
|
void validate(LaTeXFeatures & features) const override;
|
|
///
|
|
std::string contextMenuName() const override;
|
|
///
|
|
Inset * clone() const override { return new InsetIndex(*this); }
|
|
/// Is the content of this inset part of the immediate text sequence?
|
|
bool isPartOfTextSequence() const override { return false; }
|
|
|
|
///
|
|
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 override { return INDEX_PRINT_CODE; }
|
|
///
|
|
void latex(otexstream &, OutputParams const &) const override;
|
|
///
|
|
docstring xhtml(XMLStream &, OutputParams const &) const override;
|
|
///
|
|
void doDispatch(Cursor & cur, FuncRequest & cmd) override;
|
|
///
|
|
bool getStatus(Cursor &, FuncRequest const &, FuncStatus &) const override;
|
|
///
|
|
void updateBuffer(ParIterator const & it, UpdateType, bool const deleted = false) override;
|
|
///
|
|
std::string contextMenuName() const override;
|
|
/// Updates needed features for this inset.
|
|
void validate(LaTeXFeatures & features) const override;
|
|
///
|
|
bool hasSettings() const override;
|
|
///
|
|
int rowFlags() const override { return Display; }
|
|
//@}
|
|
|
|
/// \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 override { return new InsetPrintIndex(*this); }
|
|
//@}
|
|
|
|
/// \name Private functions inherited from InsetCommand class
|
|
//@{
|
|
///
|
|
docstring screenLabel() const override;
|
|
//@}
|
|
};
|
|
|
|
|
|
} // namespace lyx
|
|
|
|
#endif
|