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"
32 class InsetMathUnknown;
36 /// The cursor class describes the position of a cursor within a document.
38 // The public inheritance should go in favour of a suitable data member
39 // (or maybe private inheritance) at some point of time.
40 class LCursor : public DocIterator {
42 /// create the cursor of a BufferView
43 explicit LCursor(BufferView & bv);
45 /// dispatch from innermost inset upwards
46 void dispatch(FuncRequest const & cmd);
47 /// get the resut of the last dispatch
48 DispatchResult result() const;
49 /// add a new cursor slice
50 void push(InsetBase & inset);
51 /// add a new cursor slice, place cursor on left end
52 void pushLeft(InsetBase & inset);
53 /// pop one level off the cursor
55 /// pop one slice off the cursor stack and go left
57 /// pop one slice off the cursor stack and go right
59 /// make sure we are outside of given inset
60 void leaveInset(InsetBase const & inset);
62 void setCursor(DocIterator const & it);
68 bool selection() const { return selection_; }
70 bool & selection() { return selection_; }
71 /// did we place the anchor?
72 bool mark() const { return mark_; }
73 /// did we place the anchor?
74 bool & mark() { return mark_; }
77 /// set selection at given position
78 void setSelection(DocIterator const & where, int n);
80 void clearSelection();
81 /// access start of selection
82 CursorSlice selBegin() const;
83 /// access end of selection
84 CursorSlice selEnd() const;
85 /// access start of selection
86 DocIterator selectionBegin() const;
87 /// access start of selection
88 DocIterator selectionEnd() const;
90 bool selHandle(bool selecting);
92 docstring selectionAsString(bool label) const;
94 docstring currentState();
97 bool autocorrect() const { return autocorrect_; }
99 bool & autocorrect() { return autocorrect_; }
100 /// are we entering a macro name?
101 bool macromode() const { return macromode_; }
102 /// are we entering a macro name?
103 bool & macromode() { return macromode_; }
104 /// returns x,y position
105 void getPos(int & x, int & y) const;
106 /// the row in the paragraph we're in
107 Row const & textRow() const;
112 /// move one step to the left
114 /// move one step to the right
118 void insert(InsetBase *);
119 /// insert a single char
120 void insert(char_type c);
122 void insert(docstring const & str);
124 /// in pixels from left of screen
126 /// write acess to target x position of cursor
128 /// return target x position of cursor
129 int x_target() const;
130 /// set targetX in current position
132 /// clear target x position of cursor
135 /// access to normalized selection anchor
136 CursorSlice anchor() const;
137 /// sets anchor to cursor position
139 /// access to owning BufferView
140 BufferView & bv() const;
141 /// access to owning Buffer
142 Buffer & buffer() const;
143 /// get some interesting description of top position
144 void info(odocstream & os) const;
145 /// are we in math mode (2), text mode (1) or unsure (0)?
147 /// reset cursor bottom to the beginning of the given inset
148 // (sort of 'chroot' environment...)
149 void reset(InsetBase &);
150 /// for spellchecking
151 void replaceWord(std::string const & replacestring);
153 * the event was not (yet) dispatched.
155 * Should only be called by an inset's doDispatch() method. It means:
156 * I, the doDispatch() method of InsetFoo, hereby declare that I am
157 * not able to handle that request and trust my parent will do the
158 * Right Thing (even if my getStatus partner said that I can do it).
159 * It is sort of a kludge that should be used only rarely...
162 /// the event was already dispatched
164 /// Set which update should be done
165 void updateFlags(Update::flags f);
167 * don't call update() when done
169 * Should only be called by an inset's doDispatch() method. It means:
170 * I handled that request and I can reassure you that the screen does
171 * not need to be re-drawn and all entries in the coord cache stay
172 * valid (and there are no other things to put in the coord cache).
173 * This is a fairly rare event as well and only some optimization.
174 * Not using noUpdate() should never be wrong.
177 /// fix cursor in circumstances that should never happen
181 friend std::ostream & operator<<(std::ostream & os, LCursor const & cur);
187 /// the anchor position
191 DispatchResult disp_;
196 * The target x position of the cursor. This is used for when
197 * we have text like :
199 * blah blah blah blah| blah blah blah
201 * blah blah blah blah blah blah
203 * When we move onto row 3, we would like to be vertically aligned
204 * with where we were in row 1, despite the fact that row 2 is
208 /// do we have a selection?
210 /// are we on the way to get one?
212 /// If true, we are behind the previous char, otherwise we are in front
213 // of the next char. This only make a difference when we are in front
214 // of a big inset spanning a whole row and computing coordinates for
215 // displaying the cursor.
221 // math specific stuff that could be promoted to "global" later
223 /// do we allow autocorrection
225 /// are we entering a macro name?
229 ///////////////////////////////////////////////////////////////////
231 // The part below is the non-integrated rest of the original math
232 // cursor. This should be either generalized for texted or moved
233 // back to the math insets.
235 ///////////////////////////////////////////////////////////////////
239 void insert(MathAtom const &);
241 void insert(MathArray const &);
242 /// return false for empty math insets
244 /// return false for empty math insets
246 /// called for LFUN_UP etc
248 /// called for LFUN_DOWN etc
253 void plainInsert(MathAtom const & at);
255 void niceInsert(MathAtom const & at);
257 void niceInsert(docstring const & str);
259 /// in pixels from top of screen
260 void setScreenPos(int x, int y);
261 /// current offset in the top cell
263 /// interpret name a name of a macro. Returns true if
264 /// something got inserted.
265 bool 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 InsetMathUnknown * activeMacro();
271 /// replace selected stuff with at, placing the former
272 // selection in given cell of atom
273 void handleNest(MathAtom const & at, int cell = 0);
275 bool isInside(InsetBase const *);
277 /// make sure cursor position is valid
279 /// mark current cursor trace for redraw
282 /// hack for reveal codes
285 /// injects content of a cell into parent
287 /// split font inset etc
288 void handleFont(std::string const & font);
290 /// display a message
291 void message(docstring const & msg) const;
292 /// display an error message
293 void errorMessage(docstring const & msg) const;
295 docstring getPossibleLabel();
297 /// moves position somehow up or down
298 bool goUpDown(bool up);
300 /// the name of the macro we are currently inputting
301 docstring macroName();
302 /// where in the curent cell does the macro name start?
304 /// can we enter the inset?
305 bool openable(MathAtom const &) const;
307 Encoding const * getEncoding() const;
308 /// font at cursor position
309 LyXFont getFont() const;
316 #endif // LYXCURSOR_H