* 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_NESTINSET_H
#include "InsetMath.h"
+#include "MathData.h"
+#include <map>
namespace lyx {
-
/** Abstract base class for all math objects that contain nested items.
This is basically everything that is not a single character or a
single symbol.
class InsetMathNest : public InsetMath {
public:
/// nestinsets have a fixed size to start with
- explicit InsetMathNest(idx_type ncells);
+ InsetMathNest(Buffer * buf, idx_type ncells);
+ ///
+ virtual ~InsetMathNest();
///
- virtual ~InsetMathNest() {}
+ void setBuffer(Buffer &) override;
- /// the size is usually some sort of convex hull of the cells
- /// hides inset::metrics() intentionally!
- void metrics(MetricsInfo const & mi) const;
+ /// Update the cells metrics
+ void cellsMetrics(MetricsInfo const & mi) const;
/// draw background if locked
- void draw(PainterInfo & pi, int x, int y) const;
- /// draw selection background
- void drawSelection(PainterInfo & pi, int x, int y) const;
- /// draw decorations.
- void drawDecoration(PainterInfo & pi, int x, int y) const
- { drawMarkers(pi, x, y); }
+ void draw(PainterInfo & pi, int x, int y) const override;
+ ///
+ void updateBuffer(ParIterator const &, UpdateType, bool const deleted = false) override;
/// identifies NestInsets
- InsetMathNest * asNestInset() { return this; }
+ InsetMathNest * asNestInset() override { return this; }
/// identifies NestInsets
- InsetMathNest const * asNestInset() const { return this; }
+ InsetMathNest const * asNestInset() const override { return this; }
/// get cursor position
void cursorPos(BufferView const & bv, CursorSlice const & sl,
- bool boundary, int & x, int & y) const;
+ bool boundary, int & x, int & y) const override;
///
- void edit(Cursor & cur, bool front,
- EntryDirectionType entry_from = IGNORE_ENTRY_DIRECTION);
+ void edit(Cursor & cur, bool front,
+ EntryDirection entry_from = ENTRY_DIRECTION_IGNORE) override;
///
- Inset * editXY(Cursor & cur, int x, int y);
+ Inset * editXY(Cursor & cur, int x, int y) override;
/// order of movement through the cells when moving backwards
- bool idxBackward(Cursor &) const;
+ bool idxBackward(Cursor &) const override;
/// order of movement through the cells when moving forward
- bool idxForward(Cursor &) const;
+ bool idxForward(Cursor &) const override;
/// move to next cell
- bool idxNext(Cursor &) const;
+ bool idxNext(Cursor &) const override;
/// move to previous cell
- bool idxPrev(Cursor &) const;
+ bool idxPrev(Cursor &) const override;
+
+ // The index of the cell entered while moving forward
+ virtual idx_type firstIdx() const { return 0; }
+ // The index of the cell entered while moving backward
+ virtual idx_type lastIdx() const { return nargs() - 1; }
/// target pos when we enter the inset while moving forward
- bool idxFirst(Cursor &) const;
+ bool idxFirst(Cursor &) const override;
/// target pos when we enter the inset while moving backwards
- bool idxLast(Cursor &) const;
+ bool idxLast(Cursor &) const override;
/// number of cells currently governed by us
- idx_type nargs() const;
+ idx_type nargs() const override;
/// access to the lock
- bool lock() const;
+ bool lock() const override;
/// access to the lock
- void lock(bool);
+ void lock(bool) override;
/// get notification when the cursor leaves this inset
- bool notifyCursorLeaves(Cursor & cur);
+ bool notifyCursorLeaves(Cursor const & old, Cursor & cur) override;
- /// direct access to the cell.
- /// inlined because shows in profile.
//@{
- MathData & cell(idx_type i) { return cells_[i]; }
- MathData const & cell(idx_type i) const { return cells_[i]; }
+ /// direct access to the cell.
+ /// Inlined because of performance reasons.
+ MathData & cell(idx_type i) override { return cells_[i]; }
+ MathData const & cell(idx_type i) const override { return cells_[i]; }
//@}
/// can we move into this cell (see macroarg.h)
- bool isActive() const;
+ bool isActive() const override;
/// request "external features"
- void validate(LaTeXFeatures & features) const;
+ void validate(LaTeXFeatures & features) const override;
/// replace in all cells
- void replace(ReplaceData &);
+ void replace(ReplaceData &) override;
/// do we contain a given pattern?
- bool contains(MathData const &) const;
+ bool contains(MathData const &) const override;
/// glue everything to a single cell
MathData glue() const;
/// debug helper
- void dump() const;
+ void dump() const override;
/// writes \\, name(), and args in braces and '\\lyxlock' if necessary
- void write(WriteStream & os) const;
+ void write(TeXMathStream & os) const override;
/// writes [, name(), and args in []
- void normalize(NormalStream & os) const;
+ void normalize(NormalStream & os) const override;
+ ///
+ void latex(otexstream & os, OutputParams const & runparams) const override;
+ ///
+ bool setMouseHover(BufferView const * bv, bool mouse_hover) const override;
+ ///
+ bool mouseHovered(BufferView const * bv) const override
+ { return mouse_hover_[bv]; }
+
+ ///
+ bool completionSupported(Cursor const &) const override;
+ ///
+ bool inlineCompletionSupported(Cursor const & cur) const override;
+ ///
+ bool automaticInlineCompletion() const override;
+ ///
+ bool automaticPopupCompletion() const override;
///
- int latex(Buffer const &, odocstream & os,
- OutputParams const & runparams) const;
+ CompletionList const * createCompletionList(Cursor const & cur) const override;
///
- bool setMouseHover(bool mouse_hover);
+ docstring completionPrefix(Cursor const & cur) const override;
+ ///
+ bool insertCompletion(Cursor & cur, docstring const & s, bool finished) override;
+ ///
+ void completionPosAndDim(Cursor const &, int & x, int & y, Dimension & dim) const override;
+ ///
+ InsetCode lyxCode() const override { return MATH_NEST_CODE; }
+
///
- bool mouseHovered() const { return mouse_hover_; }
+ bool confirmDeletion() const override { return nargs() > 0; }
protected:
///
InsetMathNest & operator=(InsetMathNest const &);
///
- virtual void doDispatch(Cursor & cur, FuncRequest & cmd);
+ void doDispatch(Cursor & cur, FuncRequest & cmd) override;
/// do we want to handle this event?
bool getStatus(Cursor & cur, FuncRequest const & cmd,
- FuncStatus & status) const;
+ FuncStatus & status) const override;
///
void handleFont(Cursor & cur,
docstring const & arg, docstring const & font);
docstring const & arg, char const * const font);
///
void handleFont2(Cursor & cur, docstring const & arg);
+ /// Grab and erase selection and insert the InsetMathNest atom in every
+ /// previously selected cell, insert the grabbed former data and \c arg
+ /// in the first cell of the inserted atom.
+ void handleNest(Cursor & cur, MathAtom const & nest);
+ void handleNest(Cursor & cur, MathAtom const & nest, docstring const & arg);
/// interpret \p c and insert the result at the current position of
/// of \p cur. Return whether the cursor should stay in the formula.
bool interpretChar(Cursor & cur, char_type c);
///
- bool script(Cursor & cur, bool,
- docstring const & save_selection = docstring());
+ bool script(Cursor & cur, bool);
+ bool script(Cursor & cur, bool, docstring const & save_selection);
public:
/// interpret \p str and insert the result at the current position of
/// \p cur if it is something known. Return whether \p cur was
- /// inserted.
- bool interpretString(Cursor & cur, docstring const & str);
+ /// inserted. Handles undo.
+ virtual bool interpretString(Cursor & cur, docstring const & str);
private:
/// lfun handler
/// Find a macro to fold or unfold, starting at searchCur and searchCur.nextInset() pointing to a macro
/// afterwards if found
bool findMacroToFoldUnfold(Cursor & searchCur, bool fold) const;
+ /// move cursor forward
+ bool cursorMathForward(Cursor & cur, bool enter = true);
+ /// move cursor backwards
+ bool cursorMathBackward(Cursor & cur, bool enter = true);
protected:
/// we store the cells in a vector
/// if the inset is locked, it can't be entered with the cursor
bool lock_;
///
- bool mouse_hover_;
+ mutable std::map<BufferView const *, bool> mouse_hover_;
};