#include "DispatchResult.h"
#include "DocIterator.h"
+#include "Font.h"
+#include "Undo.h"
-#include <iosfwd>
#include <vector>
class BufferView;
class FuncStatus;
class FuncRequest;
-class LyXFont;
class Row;
// these should go
DispatchResult result() const;
/// add a new cursor slice
void push(Inset & inset);
- /// add a new cursor slice, place cursor on left end
- void pushLeft(Inset & inset);
+ /// add a new cursor slice, place cursor at front (move backwards)
+ void pushBackward(Inset & inset);
/// pop one level off the cursor
void pop();
- /// pop one slice off the cursor stack and go left
- bool popLeft();
- /// pop one slice off the cursor stack and go right
- bool popRight();
+ /// pop one slice off the cursor stack and go backwards
+ bool popBackward();
+ /// pop one slice off the cursor stack and go forward
+ bool popForward();
/// make sure we are outside of given inset
void leaveInset(Inset const & inset);
/// sets cursor part
void setCursor(DocIterator const & it);
+ ///
+ void setCurrentFont();
+
//
// selection
//
bool selection() const { return selection_; }
/// selection active?
bool & selection() { return selection_; }
+ /// do we have a multicell selection?
+ bool selIsMultiCell() const
+ { return selection_ && selBegin().idx() != selEnd().idx(); }
+ /// do we have a multiline selection?
+ bool selIsMultiLine() const
+ { return selection_ && selBegin().pit() != selEnd().pit(); }
/// did we place the anchor?
bool mark() const { return mark_; }
/// did we place the anchor?
DocIterator selectionBegin() const;
/// access start of selection
DocIterator selectionEnd() const;
- ///
+ /// FIXME: document this
bool selHandle(bool selecting);
- //
+ ///
docstring selectionAsString(bool label) const;
///
- docstring currentState();
+ docstring currentState() const;
/// auto-correct mode
bool autocorrect() const { return autocorrect_; }
bool & macromode() { return macromode_; }
/// returns x,y position
void getPos(int & x, int & y) const;
+ /// return logical positions between which the cursor is situated
+ /**
+ * If the cursor is at the edge of a row, the position which is "over the
+ * edge" will be returned as -1.
+ */
+ void getSurroundingPos(pos_type & left_pos, pos_type & right_pos);
/// the row in the paragraph we're in
Row const & textRow() const;
//
// common part
//
- /// move one step to the left
- bool posLeft();
- /// move one step to the right
- bool posRight();
+ /// move one step backwards
+ bool posBackward();
+ /// move one step forward
+ bool posForward();
+ /// move visually one step to the right
+ /**
+ * @note: This method may move into an inset unless skip_inset == true.
+ * @note: This method may move into a new paragraph.
+ * @note: This method may move out of the current slice.
+ * @return: true if moved, false if not moved
+ */
+ bool posVisRight(bool skip_inset = false);
+ /// move visually one step to the left
+ /**
+ * @note: This method may move into an inset unless skip_inset == true.
+ * @note: This method may move into a new paragraph.
+ * @note: This method may move out of the current slice.
+ * @return: true if moved, false if not moved
+ */
+ bool posVisLeft(bool skip_inset = false);
+ /// move visually to next/previous row
+ /**
+ * Assuming we were to keep moving left (right) from the current cursor
+ * position, place the cursor at the rightmost (leftmost) edge of the
+ * new row to which we would move according to visual-mode cursor movement.
+ * This could be either the next or the previous row, depending on the
+ * direction in which we're moving, and whether we're in an LTR or RTL
+ * paragraph.
+ * @note: The new position may even be in a new paragraph.
+ * @note: This method will not move out of the current slice.
+ * @return: false if not moved (no more rows to move to in given direction)
+ * @return: true if moved
+ */
+ bool posVisToNewRow(bool movingLeft);
+ /// move to right or left extremity of the current row
+ void posVisToRowExtremity(bool left);
/// insert an inset
void insert(Inset *);
/// insert a string
void insert(docstring const & str);
- /// in pixels from left of screen
+ /// FIXME: rename to something sensible showing difference to x_target()
+ /// in pixels from left of screen, set to current position if unset
int targetX() const;
- /// write acess to target x position of cursor
- int & x_target();
- /// return target x position of cursor
+ /// set the targetX to x
+ void setTargetX(int x);
+ /// return targetX or -1 if unset
int x_target() const;
- /// set targetX in current position
+ /// set targetX to current position
void setTargetX();
- /// clear target x position of cursor
+ /// clear targetX, i.e. set it to -1
void clearTargetX();
+ /// set offset to actual position - targetX
+ void updateTextTargetOffset();
+ /// distance between actual and targeted position during last up/down in text
+ int textTargetOffset() const;
/// access to normalized selection anchor
CursorSlice anchor() const;
* Not using noUpdate() should never be wrong.
*/
void noUpdate();
- /// fix cursor in circumstances that should never happen
- void fixIfBroken();
+ /// fix cursor in circumstances that should never happen.
+ /// \retval true if a fix occured.
+ bool fixIfBroken();
/// output
friend std::ostream & operator<<(std::ostream & os, Cursor const & cur);
+ friend LyXErr & operator<<(LyXErr & os, Cursor const & cur);
+
+ ///
+ bool textUndo();
+ ///
+ bool textRedo();
+
+ /// makes sure the next operation will be stored
+ void finishUndo() const;
+
+ /// open a new group of undo operations. Groups can be nested.
+ void beginUndoGroup() const;
+
+ /// end the current undo group
+ void endUndoGroup() const;
+
+ /// The general case: prepare undo for an arbitrary range.
+ void recordUndo(UndoKind kind, pit_type from, pit_type to) const;
+
+ /// Convenience: prepare undo for the range between 'from' and cursor.
+ void recordUndo(UndoKind kind, pit_type from) const;
+
+ /// Convenience: prepare undo for the single paragraph or cell
+ /// containing the cursor
+ void recordUndo(UndoKind kind = ATOMIC_UNDO) const;
+
+ /// Convenience: prepare undo for the inset containing the cursor
+ void recordUndoInset(UndoKind kind = ATOMIC_UNDO) const;
+
+ /// Convenience: prepare undo for the whole buffer
+ void recordUndoFullDocument() const;
+
+ /// Convenience: prepare undo for the selected paragraphs or cells
+ void recordUndoSelection() const;
+
+ ///
+ void checkBufferStructure();
public:
///
//private:
/// the anchor position
DocIterator anchor_;
-
+
///
DispatchResult disp_;
-
-
+ ///
+ DocIterator const & beforeDispatchCursor() { return beforeDispatchCursor_; }
+
private:
/**
* The target x position of the cursor. This is used for when
* shorter than x()
*/
int x_target_;
+ /// if a x_target cannot be hit exactly in a text, put the difference here
+ int textTargetOffset_;
/// do we have a selection?
bool selection_;
/// are we on the way to get one?
// of a big inset spanning a whole row and computing coordinates for
// displaying the cursor.
bool logicalpos_;
+ /// position before dispatch started
+ DocIterator beforeDispatchCursor_;
+
+// FIXME: make them private.
+public:
+ /// the current font settings
+ Font current_font;
+ /// the current font
+ Font real_current_font;
private:
bool erase();
/// return false for empty math insets
bool backspace();
- /// called for LFUN_UP etc
+ /// move the cursor up by sending an internal LFUN_UP
+ /// return true if fullscreen update is needed
bool up();
- /// called for LFUN_DOWN etc
+ /// move the cursor up by sending an internal LFUN_DOWN,
+ /// return true if fullscreen update is needed
bool down();
+ /// move up/down in a text inset, called for LFUN_UP/DOWN,
+ /// return true if successful, updateNeeded set to true if fullscreen
+ /// update is needed, otherwise it's not touched
+ bool upDownInText(bool up, bool & updateNeeded);
+ /// move up/down in math or any non text inset, call for LFUN_UP/DOWN
+ /// return true if successful
+ bool upDownInMath(bool up);
///
void plainErase();
///
bool inMacroMode() const;
/// get access to the macro we are currently typing
InsetMathUnknown * activeMacro();
+ /// get access to the macro we are currently typing
+ InsetMathUnknown const * activeMacro() const;
/// replace selected stuff with at, placing the former
// selection in given cell of atom
void handleNest(MathAtom const & at, int cell = 0);
///
- bool isInside(Inset const *);
+ bool isInside(Inset const *) const;
/// make sure cursor position is valid
+ /// FIXME: It does a subset of fixIfBroken. Maybe merge them?
void normalize();
/// mark current cursor trace for redraw
void touch();
/// display an error message
void errorMessage(docstring const & msg) const;
///
- docstring getPossibleLabel();
-
- /// moves position somehow up or down
- bool goUpDown(bool up);
+ docstring getPossibleLabel() const;
/// the name of the macro we are currently inputting
docstring macroName();
///
Encoding const * getEncoding() const;
/// font at cursor position
- LyXFont getFont() const;
- ///
- bool isRTL() const;
+ Font getFont() const;
};
+/**
+ * Notifies all insets which appear in old, but not in cur. Make
+ * Sure that the cursor old is valid, i.e. all inset pointers
+ * point to valid insets! Use Cursor::fixIfBroken if necessary.
+ */
+bool notifyCursorLeaves(Cursor const & old, Cursor & cur);
+
} // namespace lyx
projects / lyx.git / blobdiff