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"
26 class MathUnknownInset;
31 /// The cursor class describes the position of a cursor within a document.
33 // The public inheritance should go in favour of a suitable data member
34 // (or maybe private inheritance) at some point of time.
35 class LCursor : public DocumentIterator {
37 /// create the cursor of a BufferView
38 explicit LCursor(BufferView & bv);
40 /// dispatch from innermost inset upwards
41 DispatchResult dispatch(FuncRequest const & cmd);
42 /// are we willing to handle this event?
43 bool getStatus(FuncRequest const & cmd, FuncStatus & flag);
45 /// add a new cursor slice
46 void push(InsetBase & inset);
47 /// add a new cursor slice, place cursor on left end
48 void pushLeft(InsetBase & inset);
49 /// pop one level off the cursor
51 /// pop one slice off the cursor stack and go left
53 /// pop one slice off the cursor stack and go right
56 void setCursor(DocumentIterator const & it, bool sel);
62 bool selection() const { return selection_; }
64 bool & selection() { return selection_; }
65 /// did we place the anchor?
66 bool mark() const { return mark_; }
67 /// did we place the anchor?
68 bool & mark() { return mark_; }
71 /// set selection at given position
72 void setSelection(DocumentIterator const & where, size_t n);
74 void clearSelection();
75 /// access start of selection
76 CursorSlice const & selBegin() const;
77 /// access end of selection
78 CursorSlice const & selEnd() const;
79 /// access start of selection
80 DocumentIterator selectionBegin() const;
81 /// access start of selection
82 DocumentIterator selectionEnd() const;
84 std::string grabSelection();
86 void eraseSelection();
88 std::string grabAndEraseSelection();
89 // other selection methods
96 /// pastes n-th element of cut buffer
97 void selPaste(size_t n);
99 void selHandle(bool selecting);
104 /// clears or deletes selection depending on lyxrc setting
105 void selClearOrDel();
107 std::string selectionAsString(bool label) const;
109 void paste(std::string const & data);
111 std::string currentState();
113 /// auto-correct mode
114 bool autocorrect() const { return autocorrect_; }
115 /// auto-correct mode
116 bool & autocorrect() { return autocorrect_; }
117 /// are we entering a macro name?
118 bool macromode() const { return macromode_; }
119 /// are we entering a macro name?
120 bool & macromode() { return macromode_; }
121 /// returns x,y position
122 void getPos(int & x, int & y) const;
123 /// returns cursor dimension
124 void getDim(int & asc, int & desc) const;
129 /// move one step to the left
131 /// move one step to the right
135 void insert(InsetBase *);
136 /// insert a single char
139 void insert(std::string const & str);
141 /// write acess to target x position of cursor
143 /// return target x position of cursor
144 int x_target() const;
145 /// clear target x position of cursor
148 /// access to selection anchor
149 CursorSlice & anchor();
150 /// access to selection anchor
151 CursorSlice const & anchor() const;
152 /// cache the absolute coordinate from the top inset
154 /// sets anchor to cursor position
156 /// access to owning BufferView
157 BufferView & bv() const;
158 /// get some interesting description of top position
159 void info(std::ostream & os) const;
160 /// are we in math mode (2), text mode (1) or unsure (0)?
162 /// reset cursor bottom to the beginning of the given inset
163 // (sort of 'chroot' environment...)
164 void reset(InsetBase &);
165 /// for spellchecking
166 void replaceWord(std::string const & replacestring);
169 /// the event was not (yet) dispatched
171 /// the event was already dispatched
173 /// don't call update() when done
177 friend std::ostream & operator<<(std::ostream & os, LCursor const & cur);
183 /// the anchor position
184 DocumentIterator anchor_;
187 DispatchResult disp_;
193 * The target x position of the cursor. This is used for when
194 * we have text like :
196 * blah blah blah blah| blah blah blah
198 * blah blah blah blah blah blah
200 * When we move onto row 3, we would like to be vertically aligned
201 * with where we were in row 1, despite the fact that row 2 is
205 /// do we have a selection?
207 /// are we on the way to get one?
211 // math specific stuff that could be promoted to "global" later
213 /// do we allow autocorrection
215 /// are we entering a macro name?
219 ///////////////////////////////////////////////////////////////////
221 // The part below is the non-integrated rest of the original math
222 // cursor. This should be either generalized for texted or moved
223 // back to the math insets.
225 ///////////////////////////////////////////////////////////////////
229 void insert(MathAtom const &);
231 void insert(MathArray const &);
232 /// return false for empty math insets
234 /// return false for empty math insets
236 /// called for LFUN_UP etc
238 /// called for LFUN_DOWN etc
243 void plainInsert(MathAtom const & at);
245 void niceInsert(MathAtom const & at);
247 void niceInsert(std::string const & str);
249 /// in pixels from top of screen
250 void setScreenPos(int x, int y);
251 /// in pixels from left of screen
253 /// return the next enclosing grid inset and the cursor's index in it
254 MathGridInset * enclosingGrid(idx_type & idx) const;
255 /// adjust anchor position after deletions/insertions
256 void adjust(pos_type from, int diff);
257 /// current offset in the top cell
258 /// interpret name a name of a macro
259 void macroModeClose();
260 /// are we currently typing the name of a macro?
261 bool inMacroMode() const;
262 /// get access to the macro we are currently typing
263 MathUnknownInset * activeMacro();
264 /// are we currently typing '#1' or '#2' or...?
265 bool inMacroArgMode() const;
267 /// replace selected stuff with at, placing the former
268 // selection in given cell of atom
269 void handleNest(MathAtom const & at, int cell = 0);
270 /// remove this as soon as LyXFunc::getStatus is "localized"
271 //inline std::string getLastCode() { return "mathnormal"; }
273 bool isInside(InsetBase const *);
279 /// make sure cursor position is valid
281 /// mark current cursor trace for redraw
284 /// returns the normalized anchor of the selection
285 CursorSlice normalAnchor();
287 /// hack for reveal codes
290 /// injects content of a cell into parent
292 /// split font inset etc
293 void handleFont(std::string const & font);
295 /// display a message
296 void message(std::string const & msg) const;
297 /// display an error message
298 void errorMessage(std::string const & msg) const;
300 std::string getPossibleLabel();
302 /// moves position somehow up or down
303 bool goUpDown(bool up);
305 /// the name of the macro we are currently inputting
306 std::string macroName();
307 /// where in the curent cell does the macro name start?
309 /// can we enter the inset?
310 bool openable(MathAtom const &) const;
312 Encoding const * getEncoding() const;
315 /// moves position closest to (x, y) in current cell
316 void bruteFind2(int x, int y);
317 /// moves position closest to (x, y) in given box
318 bool bruteFind(int x, int y, int xlow, int xhigh, int ylow, int yhigh);
321 #endif // LYXCURSOR_H