4 * This file is part of LyX, the document processor.
5 * Licence details can be found in the file COPYING.
9 * Full author contact details are available in file CREDITS.
15 #include "dispatchresult.h"
16 #include "dociterator.h"
27 class MathUnknownInset;
32 /// The cursor class describes the position of a cursor within a document.
34 // The public inheritance should go in favour of a suitable data member
35 // (or maybe private inheritance) at some point of time.
36 class LCursor : public DocumentIterator {
38 /// create the cursor of a BufferView
39 explicit LCursor(BufferView & bv);
41 /// dispatch from innermost inset upwards
42 DispatchResult dispatch(FuncRequest const & cmd);
43 /// are we willing to handle this event?
44 bool getStatus(FuncRequest const & cmd, FuncStatus & flag);
46 /// add a new cursor slice
47 void push(InsetBase & inset);
48 /// add a new cursor slice, place cursor on left end
49 void pushLeft(InsetBase & inset);
50 /// pop one level off the cursor
52 /// pop one slice off the cursor stack and go left
54 /// pop one slice off the cursor stack and go right
57 void setCursor(DocumentIterator const & it, bool sel);
63 bool selection() const { return selection_; }
65 bool & selection() { return selection_; }
66 /// did we place the anchor?
67 bool mark() const { return mark_; }
68 /// did we place the anchor?
69 bool & mark() { return mark_; }
72 /// set selection at given position
73 void setSelection(DocumentIterator const & where, size_t n);
75 void clearSelection();
76 /// access start of selection
77 CursorSlice & selBegin();
78 /// access start of selection
79 CursorSlice const & selBegin() const;
80 /// access end of selection
81 CursorSlice & selEnd();
82 /// access end of selection
83 CursorSlice const & selEnd() const;
85 std::string grabSelection();
87 void eraseSelection();
89 std::string grabAndEraseSelection();
90 // other selection methods
97 /// pastes n-th element of cut buffer
98 void selPaste(size_t n);
100 void selHandle(bool selecting);
105 /// clears or deletes selection depending on lyxrc setting
106 void selClearOrDel();
108 std::string selectionAsString(bool label) const;
110 void paste(std::string const & data);
112 std::string currentState();
114 /// auto-correct mode
115 bool autocorrect() const { return autocorrect_; }
116 /// auto-correct mode
117 bool & autocorrect() { return autocorrect_; }
118 /// are we entering a macro name?
119 bool macromode() const { return macromode_; }
120 /// are we entering a macro name?
121 bool & macromode() { return macromode_; }
122 /// returns x,y position
123 void getPos(int & x, int & y) const;
124 /// returns cursor dimension
125 void getDim(int & asc, int & desc) const;
130 /// move one step to the left
132 /// move one step to the right
136 void insert(InsetBase *);
137 /// insert a single char
140 void insert(std::string const & str);
142 /// write acess to target x position of cursor
144 /// return target x position of cursor
145 int x_target() const;
146 /// clear target x position of cursor
149 /// access to selection anchor
150 CursorSlice & anchor();
151 /// access to selection anchor
152 CursorSlice const & anchor() const;
153 /// cache the absolute coordinate from the top inset
155 /// sets anchor to cursor position
157 /// access to owning BufferView
158 BufferView & bv() const;
159 /// get some interesting description of top position
160 void info(std::ostream & os) const;
161 /// are we in math mode (2), text mode (1) or unsure (0)?
165 /// for spellchecking
166 void replaceWord(std::string const & replacestring);
169 /// set dispatch result
170 void dispatched(dispatch_result_t res);
171 /// assume event was not (yet) dispatched
173 /// don't call update() when done
175 /// don't pop cursor to the level where the LFUN was handled
179 friend std::ostream & operator<<(std::ostream & os, LCursor const & cur);
185 /// the anchor position
186 DocumentIterator anchor_;
189 DispatchResult disp_;
195 * The target x position of the cursor. This is used for when
196 * we have text like :
198 * blah blah blah blah| blah blah blah
200 * blah blah blah blah blah blah
202 * When we move onto row 3, we would like to be vertically aligned
203 * with where we were in row 1, despite the fact that row 2 is
207 // do we have a selection?
209 // are we on the way to get one?
215 // math specific stuff that could be promoted to "global" later
217 /// do we allow autocorrection
219 /// are we entering a macro name?
223 ///////////////////////////////////////////////////////////////////
225 // The part below is the non-integrated rest of the original math
226 // cursor. This should be either generalized for texted or moved
227 // back to the math insets.
229 ///////////////////////////////////////////////////////////////////
233 void insert(MathAtom const &);
235 void insert(MathArray const &);
236 /// return false for empty math insets
238 /// return false for empty math insets
240 /// called for LFUN_UP etc
242 /// called for LFUN_DOWN etc
247 void plainInsert(MathAtom const & at);
249 void niceInsert(MathAtom const & at);
251 void niceInsert(std::string const & str);
253 /// in pixels from top of screen
254 void setScreenPos(int x, int y);
255 /// in pixels from left of screen
257 /// return the next enclosing grid inset and the cursor's index in it
258 MathGridInset * enclosingGrid(idx_type & idx) const;
259 /// adjust anchor position after deletions/insertions
260 void adjust(pos_type from, int diff);
262 MathHullInset * formula() const;
263 /// current offset in the top cell
264 /// interpret name a name of a macro
265 void macroModeClose();
266 /// are we currently typing the name of a macro?
267 bool inMacroMode() const;
268 /// get access to the macro we are currently typing
269 MathUnknownInset * activeMacro();
270 /// are we currently typing '#1' or '#2' or...?
271 bool inMacroArgMode() const;
273 /// replace selected stuff with at, placing the former
274 // selection in given cell of atom
275 void handleNest(MathAtom const & at, int cell = 0);
276 /// remove this as soon as LyXFunc::getStatus is "localized"
277 //inline std::string getLastCode() { return "mathnormal"; }
279 bool isInside(InsetBase const *);
285 /// make sure cursor position is valid
287 /// mark current cursor trace for redraw
290 /// returns the normalized anchor of the selection
291 CursorSlice normalAnchor();
293 /// hack for reveal codes
296 /// injects content of a cell into parent
298 /// split font inset etc
299 void handleFont(std::string const & font);
301 /// display a message
302 void message(std::string const & msg) const;
303 /// display an error message
304 void errorMessage(std::string const & msg) const;
306 std::string getPossibleLabel();
308 /// moves position somehow up or down
309 bool goUpDown(bool up);
310 /// moves position closest to (x, y) in given box
311 bool bruteFind(int x, int y, int xlow, int xhigh, int ylow, int yhigh);
312 /// moves position closest to (x, y) in current cell
313 void bruteFind2(int x, int y);
315 /// the name of the macro we are currently inputting
316 std::string macroName();
317 /// where in the curent cell does the macro name start?
319 /// can we enter the inset?
320 bool openable(MathAtom const &) const;
322 Encoding const * getEncoding() const;
325 #endif // LYXCURSOR_H