mirror of
https://git.lyx.org/repos/lyx.git
synced 2024-11-16 16:18:22 +00:00
309 lines
7.9 KiB
C++
309 lines
7.9 KiB
C++
// -*- C++ -*-
|
|
/**
|
|
* \file InsetMathHull.h
|
|
* This file is part of LyX, the document processor.
|
|
* Licence details can be found in the file COPYING.
|
|
*
|
|
* \author André Pönitz
|
|
*
|
|
* Full author contact details are available in file CREDITS.
|
|
*/
|
|
|
|
#ifndef MATH_HULLINSET_H
|
|
#define MATH_HULLINSET_H
|
|
|
|
#include "InsetMathGrid.h"
|
|
|
|
#include "DocIterator.h"
|
|
#include "OutputEnums.h"
|
|
|
|
#include "support/unique_ptr.h"
|
|
|
|
|
|
namespace lyx {
|
|
|
|
class InsetLabel;
|
|
class MacroNameSet;
|
|
class ParConstIterator;
|
|
class RenderPreview;
|
|
|
|
|
|
/// This provides an interface between "LyX insets" and "LyX math insets"
|
|
class InsetMathHull : public InsetMathGrid {
|
|
public:
|
|
/// How a line is numbered
|
|
enum Numbered {
|
|
/// not numbered, LaTeX code \\nonumber if line differs from inset
|
|
NONUMBER,
|
|
/// numbered, LaTeX code \\number if line differs from inset
|
|
NUMBER,
|
|
/// not numbered, LaTeX code \\notag if line differs from inset
|
|
NOTAG
|
|
};
|
|
///
|
|
explicit InsetMathHull(Buffer * buf);
|
|
///
|
|
InsetMathHull(Buffer * buf, HullType type);
|
|
///
|
|
virtual ~InsetMathHull();
|
|
///
|
|
void setBuffer(Buffer &);
|
|
///
|
|
void updateBuffer(ParIterator const &, UpdateType, bool const deleted = false);
|
|
///
|
|
void addToToc(DocIterator const & di, bool output_active,
|
|
UpdateType utype, TocBackend & backend) const;
|
|
///
|
|
InsetMathHull & operator=(InsetMathHull const &);
|
|
///
|
|
mode_type currentMode() const;
|
|
///
|
|
void metrics(MetricsInfo & mi, Dimension & dim) const;
|
|
///
|
|
void drawBackground(PainterInfo & pi, int x, int y) const;
|
|
///
|
|
void draw(PainterInfo &, int x, int y) const;
|
|
///
|
|
void metricsT(TextMetricsInfo const & mi, Dimension & dim) const;
|
|
///
|
|
void drawT(TextPainter &, int x, int y) const;
|
|
///
|
|
docstring label(row_type row) const;
|
|
///
|
|
void label(row_type row, docstring const & label);
|
|
///
|
|
std::vector<InsetLabel *> const & getLabels() { return label_; }
|
|
///
|
|
ColorCode backgroundColor(PainterInfo const &) const;
|
|
///
|
|
void numbered(row_type row, bool num) { numbered(row, num ? NUMBER : NONUMBER); }
|
|
///
|
|
void numbered(row_type row, Numbered num);
|
|
///
|
|
bool numbered(row_type row) const;
|
|
///
|
|
bool numberedType() const;
|
|
///
|
|
bool ams() const;
|
|
///
|
|
bool outerDisplay() const;
|
|
///
|
|
OutputParams::CtObject CtObject(OutputParams const &) const;
|
|
///
|
|
void validate(LaTeXFeatures & features) const;
|
|
/// identifies HullInset
|
|
InsetMathHull const * asHullInset() const { return this; }
|
|
/// identifies HullInset
|
|
InsetMathHull * asHullInset() { return this; }
|
|
|
|
/// add a row
|
|
void addRow(row_type row);
|
|
/// delete a row
|
|
void delRow(row_type row);
|
|
/// swap two rows
|
|
void swapRow(row_type row);
|
|
/// add a column
|
|
void addCol(col_type col);
|
|
/// delete a column
|
|
void delCol(col_type col);
|
|
|
|
/// get type
|
|
HullType getType() const;
|
|
/// is mutation implemented for this type?
|
|
static bool isMutable(HullType type);
|
|
/// change type
|
|
void mutate(HullType newtype);
|
|
|
|
///
|
|
int defaultColSpace(col_type col);
|
|
///
|
|
int displayColSpace(col_type col) const;
|
|
///
|
|
char defaultColAlign(col_type col);
|
|
///
|
|
char displayColAlign(idx_type idx) const;
|
|
|
|
///
|
|
void write(WriteStream & os) const;
|
|
///
|
|
void normalize(NormalStream &) const;
|
|
///
|
|
void infoize(odocstream & os) const;
|
|
|
|
///
|
|
void write(std::ostream & os) const;
|
|
///
|
|
void header_write(WriteStream &) const;
|
|
///
|
|
void footer_write(WriteStream &) const;
|
|
///
|
|
void read(Lexer & lex);
|
|
///
|
|
bool readQuiet(Lexer & lex);
|
|
///
|
|
int plaintext(odocstringstream &, OutputParams const &,
|
|
size_t max_length = INT_MAX) const;
|
|
///
|
|
int docbook(odocstream &, OutputParams const &) const;
|
|
///
|
|
docstring xhtml(XMLStream &, OutputParams const &) const;
|
|
///
|
|
void mathmlize(MathStream &) const;
|
|
///
|
|
void htmlize(HtmlStream &) const;
|
|
///
|
|
void mathAsLatex(WriteStream &) const;
|
|
///
|
|
void toString(odocstream &) const;
|
|
///
|
|
void forOutliner(docstring &, size_t const, bool const) const;
|
|
|
|
/// get notification when the cursor leaves this inset
|
|
bool notifyCursorLeaves(Cursor const & old, Cursor & cur);
|
|
///
|
|
//bool insetAllowed(InsetCode code) const;
|
|
///
|
|
void addPreview(DocIterator const & inset_pos,
|
|
graphics::PreviewLoader &) const;
|
|
/// Recreates the preview if preview is enabled.
|
|
void reloadPreview(DocIterator const & pos) const;
|
|
///
|
|
void usedMacros(MathData const & md, DocIterator const & pos,
|
|
MacroNameSet & macros, MacroNameSet & defs) const;
|
|
///
|
|
void initUnicodeMath() const;
|
|
|
|
/// Force inset into LTR environment if surroundings are RTL
|
|
virtual bool forceLTR(OutputParams const &) const { return true; }
|
|
///
|
|
void recordLocation(DocIterator const & di);
|
|
|
|
///
|
|
std::string contextMenuName() const;
|
|
///
|
|
InsetCode lyxCode() const { return MATH_HULL_CODE; }
|
|
///
|
|
bool canPaintChange(BufferView const &) const;
|
|
///
|
|
bool confirmDeletion() const { return nargs() != 1 || !cell(0).empty(); }
|
|
|
|
protected:
|
|
InsetMathHull(InsetMathHull const &);
|
|
|
|
virtual void doDispatch(Cursor & cur, FuncRequest & cmd);
|
|
|
|
/// do we want to handle this event?
|
|
bool getStatus(Cursor & cur, FuncRequest const & cmd,
|
|
FuncStatus & status) const;
|
|
/// override to set to 0 for inline equation
|
|
int leftMargin() const;
|
|
/// override to set to 0 for inline equation
|
|
int rightMargin() const;
|
|
/// override to set to 0 for inline equation
|
|
int border() const;
|
|
///
|
|
docstring eolString(row_type row, bool fragile, bool latex,
|
|
bool last_eoln) const;
|
|
|
|
private:
|
|
virtual Inset * clone() const;
|
|
/// Prepare the preview if preview is enabled.
|
|
/// \param forexport: whether this is intended for export
|
|
/// If so, we ignore LyXRC and wait for the image to be generated.
|
|
void preparePreview(DocIterator const & pos,
|
|
bool forexport = false) const;
|
|
/// like reloadPreview, but forces load
|
|
/// used by image export
|
|
void loadPreview(DocIterator const & pos) const;
|
|
///
|
|
void setType(HullType type);
|
|
///
|
|
void validate1(LaTeXFeatures & features);
|
|
///
|
|
docstring nicelabel(row_type row) const;
|
|
///
|
|
void doExtern(Cursor & cur, FuncRequest & func);
|
|
///
|
|
void glueall(HullType type);
|
|
/*!
|
|
* split every row at the first relation operator.
|
|
* The number of columns must be 1. One column is added.
|
|
* The first relation operator and everything after it goes to the
|
|
* second column.
|
|
*/
|
|
void splitTo2Cols();
|
|
/*!
|
|
* split every row at the first relation operator.
|
|
* The number of columns must be < 3. One or two columns are added.
|
|
* The first relation operator goes to the second column.
|
|
* Everything after it goes to the third column.
|
|
*/
|
|
void splitTo3Cols();
|
|
/// change number of columns, split or combine columns if necessary.
|
|
void changeCols(col_type);
|
|
///
|
|
std::string standardFont() const;
|
|
///
|
|
ColorCode standardColor() const;
|
|
/// consistency check
|
|
void check() const;
|
|
/// does it understand tabular-feature commands?
|
|
bool allowsTabularFeatures() const;
|
|
/// can this change its number of rows?
|
|
bool rowChangeOK() const;
|
|
/// can this change its number of cols?
|
|
bool colChangeOK() const;
|
|
/// are any of the equations numbered?
|
|
bool haveNumbers() const;
|
|
/// draw four angular markers
|
|
virtual void drawMarkers(PainterInfo & pi, int x, int y) const;
|
|
|
|
/// "none", "simple", "display", "eqnarray",...
|
|
HullType type_;
|
|
///
|
|
std::vector<Numbered> numbered_;
|
|
///
|
|
std::vector<docstring> numbers_;
|
|
///
|
|
std::vector<InsetLabel *> label_;
|
|
///
|
|
unique_ptr<RenderPreview> preview_;
|
|
///
|
|
DocIterator docit_;
|
|
///
|
|
typedef std::map<docstring, int> CounterMap;
|
|
/// used to store current values of important counters
|
|
CounterMap counter_map;
|
|
//
|
|
// Incorporate me
|
|
//
|
|
public:
|
|
///
|
|
virtual void mutateToText();
|
|
///
|
|
bool editable() const { return true; }
|
|
///
|
|
void edit(Cursor & cur, bool front,
|
|
EntryDirection entry_from = ENTRY_DIRECTION_IGNORE);
|
|
///
|
|
Inset * editXY(Cursor & cur, int x, int y);
|
|
///
|
|
DisplayType display() const;
|
|
///
|
|
int indent(BufferView const &) const;
|
|
|
|
protected:
|
|
///
|
|
void handleFont(Cursor & cur, docstring const & arg,
|
|
docstring const & font);
|
|
///
|
|
void handleFont2(Cursor & cur, docstring const & arg);
|
|
///
|
|
bool previewState(BufferView const * const bv) const;
|
|
};
|
|
|
|
|
|
|
|
} // namespace lyx
|
|
#endif
|