* This file is part of LyX, the document processor.
* Licence details can be found in the file COPYING.
*
- * \author André Pönitz
+ * \author André Pönitz
*
* Full author contact details are available in file CREDITS.
*/
#define MATH_HULLINSET_H
#include "InsetMathGrid.h"
-#include <boost/scoped_ptr.hpp>
+
+#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
+ };
+ ///
+ InsetMathHull(Buffer * buf);
+ ///
+ InsetMathHull(Buffer * buf, HullType type);
+ ///
+ virtual ~InsetMathHull();
///
- InsetMathHull();
+ void setBuffer(Buffer &);
///
- explicit InsetMathHull(HullType type);
+ void updateBuffer(ParIterator const &, UpdateType);
///
- ~InsetMathHull();
+ void addToToc(DocIterator const & di, bool output_active,
+ UpdateType utype) const;
///
InsetMathHull & operator=(InsetMathHull const &);
///
mode_type currentMode() const;
///
- bool metrics(MetricsInfo & mi, Dimension & dim) 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 label(row_type row, docstring const & label);
///
- void numbered(row_type row, bool num);
+ 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;
- /// Appends \c list with all labels found within this inset.
- void getLabelList(Buffer const &,
- std::vector<docstring> & list) const;
///
void validate(LaTeXFeatures & features) const;
/// identifies HullInset
/// 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;
+ ///
bool idxFirst(Cursor &) const;
///
bool idxLast(Cursor &) const;
///
void write(WriteStream & os) const;
///
- void mathmlize(MathStream &) const;
- ///
void normalize(NormalStream &) const;
///
void infoize(odocstream & os) const;
///
- void write(Buffer const &, std::ostream & 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;
///
- void read(Buffer const &, Lexer & lex);
+ int docbook(odocstream &, OutputParams const &) const;
///
- int plaintext(Buffer const &, odocstream &,
- OutputParams const &) const;
+ docstring xhtml(XHTMLStream &, OutputParams const &) const;
///
- int docbook(Buffer const &, odocstream &,
- OutputParams const &) const;
- /// the string that is passed to the TOC
- virtual void textString(Buffer const &, odocstream &) 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 & cur);
+ bool notifyCursorLeaves(Cursor const & old, Cursor & cur);
+ ///
+ //bool insetAllowed(InsetCode code) const;
///
- //bool insetAllowed(Code 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 addPreview(graphics::PreviewLoader &) const;
+ void usedMacros(MathData const & md, DocIterator const & pos,
+ MacroNameSet & macros, MacroNameSet & defs) const;
+ ///
+ void initUnicodeMath() const;
///
static int displayMargin() { return 12; }
+
+ /// Force inset into LTR environment if surroundings are RTL
+ virtual bool forceLTR() const { return true; }
+ ///
+ void recordLocation(DocIterator const & di);
+
+ ///
+ std::string contextMenuName() const;
+ ///
+ InsetCode lyxCode() const { return MATH_HULL_CODE; }
protected:
InsetMathHull(InsetMathHull const &);
bool getStatus(Cursor & cur, FuncRequest const & cmd,
FuncStatus & status) const;
///
- docstring eolString(row_type row, bool emptyline, bool fragile) 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);
///
- void header_write(WriteStream &) const;
- ///
- void footer_write(WriteStream &) const;
- ///
docstring nicelabel(row_type row) const;
///
void doExtern(Cursor & cur, FuncRequest & func);
///
- void glueall();
+ void glueall(HullType type);
/*!
* split every row at the first relation operator.
* The number of columns must be 1. One column is added.
/// change number of columns, split or combine columns if necessary.
void changeCols(col_type);
///
- docstring standardFont() const;
+ 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;
/// "none", "simple", "display", "eqnarray",...
HullType type_;
///
- std::vector<int> nonum_;
+ std::vector<Numbered> numbered_;
///
- std::vector<docstring> label_;
+ std::vector<docstring> numbers_;
///
- boost::scoped_ptr<RenderPreview> preview_;
+ std::vector<InsetLabel *> label_;
///
- mutable bool use_preview_;
+ 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:
- /// what appears in the minibuffer when opening
- virtual docstring const editMessage() const;
///
virtual void mutateToText();
///
virtual void revealCodes(Cursor & cur) const;
///
- EDITABLE editable() const { return HIGHLY_EDITABLE; }
+ bool editable() const { return true; }
///
- void edit(Cursor & cur, bool left);
+ void edit(Cursor & cur, bool front,
+ EntryDirection entry_from = ENTRY_DIRECTION_IGNORE);
///
Inset * editXY(Cursor & cur, int x, int y);
///
DisplayType display() const;
- ///
- Code lyxCode() const;
protected:
///
///
void handleFont2(Cursor & cur, docstring const & arg);
///
- bool previewState(BufferView * bv) const;
+ bool previewState(BufferView const * const bv) const;
+ ///
+ bool previewTooSmall(Dimension const & dim) const;
};