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"
29 class MathUnknownInset;
33 /// The cursor class describes the position of a cursor within a document.
35 // The public inheritance should go in favour of a suitable data member
36 // (or maybe private inheritance) at some point of time.
37 class LCursor : public DocIterator {
39 /// create the cursor of a BufferView
40 explicit LCursor(BufferView & bv);
42 /// dispatch from innermost inset upwards
43 void dispatch(FuncRequest const & cmd);
44 /// get the resut of the last dispatch
45 DispatchResult result() const;
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
56 /// make sure we are outside of given inset
57 void leaveInset(InsetBase const & inset);
59 void setCursor(DocIterator const & it);
65 bool selection() const { return selection_; }
67 bool & selection() { return selection_; }
68 /// did we place the anchor?
69 bool mark() const { return mark_; }
70 /// did we place the anchor?
71 bool & mark() { return mark_; }
74 /// set selection at given position
75 void setSelection(DocIterator const & where, size_t n);
77 void clearSelection();
78 /// access start of selection
79 CursorSlice selBegin() const;
80 /// access end of selection
81 CursorSlice selEnd() const;
82 /// access start of selection
83 DocIterator selectionBegin() const;
84 /// access start of selection
85 DocIterator selectionEnd() const;
87 void selHandle(bool selecting);
89 std::string selectionAsString(bool label) const;
91 void paste(std::string const & data);
93 std::string currentState();
96 bool autocorrect() const { return autocorrect_; }
98 bool & autocorrect() { return autocorrect_; }
99 /// are we entering a macro name?
100 bool macromode() const { return macromode_; }
101 /// are we entering a macro name?
102 bool & macromode() { return macromode_; }
103 /// returns x,y position
104 void getPos(int & x, int & y) const;
109 /// move one step to the left
111 /// move one step to the right
115 void insert(InsetBase *);
116 /// insert a single char
119 void insert(std::string const & str);
121 /// in pixels from left of screen
123 /// write acess to target x position of cursor
125 /// return target x position of cursor
126 int x_target() const;
127 /// set targetX in current position
129 /// clear target x position of cursor
132 /// access to normalized selection anchor
133 CursorSlice anchor() const;
134 /// sets anchor to cursor position
136 /// access to owning BufferView
137 BufferView & bv() const;
138 /// access to owning Buffer
139 Buffer & buffer() const;
140 /// get some interesting description of top position
141 void info(std::ostream & os) const;
142 /// are we in math mode (2), text mode (1) or unsure (0)?
144 /// reset cursor bottom to the beginning of the given inset
145 // (sort of 'chroot' environment...)
146 void reset(InsetBase &);
147 /// for spellchecking
148 void replaceWord(std::string const & replacestring);
150 * the event was not (yet) dispatched.
152 * Should only be called by an inset's doDispatch() method. It means:
153 * I, the doDispatch() method of InsetFoo, hereby declare that I am
154 * not able to handle that request and trust my parent will do the
155 * Right Thing (even if my getStatus partner said that I can do it).
156 * It is sort of a kludge that should be used only rarely...
159 /// the event was already dispatched
161 /// call update() when done
164 * don't call update() when done
166 * Should only be called by an inset's doDispatch() method. It means:
167 * I handled that request and I can reassure you that the screen does
168 * not need to be re-drawn and all entries in the coord cache stay
169 * valid (and there are no other things to put in the coord cache).
170 * This is a fairly rare event as well and only some optimization.
171 * Not using noUpdate() should never be wrong.
174 /// fix cursor in circumstances that should never happen
178 friend std::ostream & operator<<(std::ostream & os, LCursor const & cur);
184 /// the anchor position
188 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?
209 /// If true, we are behind the previous char, otherwise we are in front
210 // of the next char. This only make a difference when we are in front
211 // of a big inset spanning a whole row and computing coordinates for
212 // displaying the cursor.
218 // math specific stuff that could be promoted to "global" later
220 /// do we allow autocorrection
222 /// are we entering a macro name?
226 ///////////////////////////////////////////////////////////////////
228 // The part below is the non-integrated rest of the original math
229 // cursor. This should be either generalized for texted or moved
230 // back to the math insets.
232 ///////////////////////////////////////////////////////////////////
236 void insert(MathAtom const &);
238 void insert(MathArray const &);
239 /// return false for empty math insets
241 /// return false for empty math insets
243 /// called for LFUN_UP etc
245 /// called for LFUN_DOWN etc
250 void plainInsert(MathAtom const & at);
252 void niceInsert(MathAtom const & at);
254 void niceInsert(std::string const & str);
256 /// in pixels from top of screen
257 void setScreenPos(int x, int y);
258 /// current offset in the top cell
259 /// interpret name a name of a macro
260 void macroModeClose();
261 /// are we currently typing the name of a macro?
262 bool inMacroMode() const;
263 /// get access to the macro we are currently typing
264 MathUnknownInset * activeMacro();
266 /// replace selected stuff with at, placing the former
267 // selection in given cell of atom
268 void handleNest(MathAtom const & at, int cell = 0);
270 bool isInside(InsetBase const *);
272 /// make sure cursor position is valid
274 /// mark current cursor trace for redraw
277 /// hack for reveal codes
280 /// injects content of a cell into parent
282 /// split font inset etc
283 void handleFont(std::string const & font);
285 /// display a message
286 void message(std::string const & msg) const;
287 /// display an error message
288 void errorMessage(std::string const & msg) const;
290 std::string getPossibleLabel();
292 /// moves position somehow up or down
293 bool goUpDown(bool up);
295 /// the name of the macro we are currently inputting
296 std::string macroName();
297 /// where in the curent cell does the macro name start?
299 /// can we enter the inset?
300 bool openable(MathAtom const &) const;
302 Encoding const * getEncoding() const;
303 /// font at cursor position
304 LyXFont getFont() const;
308 #endif // LYXCURSOR_H