deriving from DocIterator
* A Cursor is a descendant of CursorData that contains interesting
- display-related information, in particular targetX(), the horizontal
- position of the cursor in pixels.
+ display-related information, in particular the BufferView that owns it.
*/
#ifndef LCURSOR_H
///
void setWordSelection(bool set) { word_selection_ = set; }
///
- bool wordSelection() { return word_selection_; }
+ bool wordSelection() const { return word_selection_; }
/// did we place the anchor?
bool mark() const { return mark_; }
/// did we place the anchor?
void setSelection(DocIterator const & where, int n);
///
void clearSelection();
+ /// check whether selection contains specific type of inset
+ /// returns 0 if no selection was made
+ bool insetInSelection(InsetCode const & inset) const;
+ /// count occurences of specific inset type in the selection
+ /// returns 0 if no selection was made
+ int countInsetsInSelection(InsetCode const & inset) const;
/// access to normalized selection anchor
CursorSlice normalAnchor() const;
DocIterator & realAnchor() { return anchor_; }
/// sets anchor to cursor position
void resetAnchor();
- /// access to owning BufferView
/// access start of selection
CursorSlice selBegin() const;
DocIterator selectionEnd() const;
///
- docstring selectionAsString(bool with_label) const;
+ docstring selectionAsString(bool const with_label,
+ bool const skipdelete = false) const;
/// get some interesting description of top position
void info(odocstream & os, bool devel_mode) const;
///
docstring currentState(bool devel_mode) const;
- /// auto-correct mode
- bool autocorrect() const { return autocorrect_; }
- /// auto-correct mode
- bool & autocorrect() { return autocorrect_; }
-
/// fix cursor in circumstances that should never happen.
/// \retval true if a fix occurred.
bool fixIfBroken();
/// Repopulate the slices insets from bottom to top. Useful
/// for stable iterators or Undo data.
void sanitize();
- ///
- bool isInside(Inset const *) const;
- /// make sure we are outside of given inset
- void leaveInset(Inset const & inset);
///
- bool textUndo();
+ bool undoAction();
///
- bool textRedo();
+ bool redoAction();
/// makes sure the next operation will be stored
void finishUndo() const;
void beginUndoGroup() const;
/// end the current undo group
void endUndoGroup() const;
+ /// end abruptly the current group and create a new one wih the same nesting level
+ void splitUndoGroup() const;
/// The general case: prepare undo for an arbitrary range.
void recordUndo(pit_type from, pit_type to) const;
/// containing the cursor
void recordUndo(UndoKind kind = ATOMIC_UNDO) const;
/// Convenience: prepare undo for the inset containing the cursor
- void recordUndoInset(Inset const * inset = 0) const;
+ void recordUndoInset(Inset const * inset = nullptr) const;
/// Convenience: prepare undo for the whole buffer
void recordUndoFullBuffer() const;
/// Convenience: prepare undo for buffer parameters
DocIterator newWord() const { return new_word_; }
/// are we in math mode (2), text mode (1) or unsure (0)?
- int currentMode();
+ int currentMode() const;
/// Return true if the next or previous inset has confirmDeletion depending
/// on the boolean before. If there is a selection, return true if at least
/// one inset in the selection has confirmDeletion.
bool confirmDeletion(bool before = false) const;
-protected:
+private:
/// validate the "new born word" position
void checkNewWordPosition();
/// clear the "new born word" position
/// are we in word-selection mode? This is set when double clicking.
bool word_selection_;
-// FIXME: make them protected.
-public:
- /// the current font settings
- Font current_font;
- /// the current font
- Font real_current_font;
-
-protected:
-
/// the start of the new born word
DocIterator new_word_;
//
// math specific stuff that could be promoted to "global" later
//
- /// do we allow autocorrection
- bool autocorrect_;
+
+ // FIXME: make them private
+public:
+ /// The current font settings. This holds the settings for output.
+ Font current_font;
+ /// The current display font. This holds the settings of the text
+ /// in the workarea.
+ Font real_current_font;
};
void push(Inset & inset);
/// add a new cursor slice, place cursor at front (move backwards)
void pushBackward(Inset & inset);
+ /// try to put cursor in inset before it in entry cell, or next one
+ /// if it is not empty, or exit the slice if there is no next one.
+ void editInsertedInset();
+
/// pop one level off the cursor
void pop();
/// pop one slice off the cursor stack and go backwards
void setCursorData(CursorData const & data);
/// returns true if we made a decision
- bool getStatus(FuncRequest const & cmd, FuncStatus & flag) const;
+ bool getStatus(FuncRequest const & cmd, FuncStatus & status) const;
/// dispatch from innermost inset upwards
void dispatch(FuncRequest const & cmd);
/// display a message
void message(docstring const & msg) const;
/// display an error message
void errorMessage(docstring const & msg) const;
- /// get the resut of the last dispatch
+ /// get the result of the last dispatch
DispatchResult const & result() const;
- ///
+ /// Set the cursor language from current input method language
+ /* Considers first exact math with the codes used in the document,
+ * then approximate match among the same list, and finally exact
+ * or partial match with the whole list of languages.
+ */
+ void setLanguageFromInput();
+ /// Set the current font of the cursor from its location.
void setCurrentFont();
/**
/// distance between actual and targeted position during last up/down in text
int textTargetOffset() const;
+ /// access to owning BufferView
BufferView & bv() const;
/// reset cursor bottom to the beginning of the top inset
// (sort of 'chroot' environment...)
void undispatched() const;
/// the event was already dispatched
void dispatched() const;
- /// Set which screen update should be done
+
+ /// Describe the screen update that should be done
void screenUpdateFlags(Update::flags f) const;
- /// Forces an updateBuffer() call
- void forceBufferUpdate() const;
- /// Removes any pending updateBuffer() call
- void clearBufferUpdate() const;
- /// Do we need to call updateBuffer()?
- bool needBufferUpdate() const;
/**
- * don't call update() when done
+ * Reset update flags to Update::None.
*
* Should only be called by an inset's doDispatch() method. It means:
* I handled that request and I can reassure you that the screen does
*/
void noScreenUpdate() const;
+ /// Forces an updateBuffer() call
+ void forceBufferUpdate() const;
+ /// Removes any pending updateBuffer() call
+ void clearBufferUpdate() const;
+ /// Do we need to call updateBuffer()?
+ bool needBufferUpdate() const;
+
/// Repopulate the slices insets from bottom to top. Useful
/// for stable iterators or Undo data.
void sanitize();
///
void plainInsert(MathAtom const & at);
- /// interpret name of a macro. Returns true if something got
- /// inserted.
- bool macroModeClose();
+ /// interpret name of a macro or ditch it if \c cancel is true.
+ /// Returns true if something got inserted.
+ bool macroModeClose(bool cancel = false);
/// are we currently typing the name of a macro?
bool inMacroMode() const;
/// get access to the macro we are currently typing
/// the name of the macro we are currently inputting
docstring macroName();
-
/// replace selected stuff with at, placing the former
- // selection in given cell of atom
- void handleNest(MathAtom const & at, int cell = 0);
+ // selection in entry cell of atom
+ void handleNest(MathAtom const & at);
/// make sure cursor position is valid
/// FIXME: It does a subset of fixIfBroken. Maybe merge them?
} // namespace lyx
-#endif // LYXLCURSOR_H
+#endif // LCURSOR_H
projects / lyx.git / blobdiff