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"
28 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 DocIterator {
38 /// create the cursor of a BufferView
39 explicit LCursor(BufferView & bv);
41 /// dispatch from innermost inset upwards
42 void dispatch(FuncRequest const & cmd);
43 /// get the resut of the last dispatch
44 DispatchResult result() const;
46 * \returns true if this function made a definitive decision on
47 * whether the inset at this cursor position wants to handle the
48 * request \p cmd or not. The result of this decision is put into
51 bool getStatus(FuncRequest const & cmd, FuncStatus & flag);
53 /// add a new cursor slice
54 void push(InsetBase & inset);
55 /// add a new cursor slice, place cursor on left end
56 void pushLeft(InsetBase & inset);
57 /// pop one level off the cursor
59 /// pop one slice off the cursor stack and go left
61 /// pop one slice off the cursor stack and go right
64 void setCursor(DocIterator const & it);
70 bool selection() const { return selection_; }
72 bool & selection() { return selection_; }
73 /// did we place the anchor?
74 bool mark() const { return mark_; }
75 /// did we place the anchor?
76 bool & mark() { return mark_; }
79 /// set selection at given position
80 void setSelection(DocIterator const & where, size_t n);
82 void clearSelection();
83 /// access start of selection
84 CursorSlice selBegin() const;
85 /// access end of selection
86 CursorSlice selEnd() const;
87 /// access start of selection
88 DocIterator selectionBegin() const;
89 /// access start of selection
90 DocIterator selectionEnd() const;
92 void selHandle(bool selecting);
94 std::string selectionAsString(bool label) const;
96 void paste(std::string const & data);
98 std::string currentState();
100 /// auto-correct mode
101 bool autocorrect() const { return autocorrect_; }
102 /// auto-correct mode
103 bool & autocorrect() { return autocorrect_; }
104 /// are we entering a macro name?
105 bool macromode() const { return macromode_; }
106 /// are we entering a macro name?
107 bool & macromode() { return macromode_; }
108 /// returns x,y position
109 void getPos(int & x, int & y) const;
110 /// returns cursor dimension
111 void getDim(int & asc, int & desc) const;
116 /// move one step to the left
118 /// move one step to the right
122 void insert(InsetBase *);
123 /// insert a single char
126 void insert(std::string const & str);
128 /// in pixels from left of screen
130 /// write acess to target x position of cursor
132 /// return target x position of cursor
133 int x_target() const;
134 /// set targetX in current position
136 /// clear target x position of cursor
139 /// access to normalized selection anchor
140 CursorSlice anchor() const;
141 /// sets anchor to cursor position
143 /// access to owning BufferView
144 BufferView & bv() const;
145 /// access to owning Buffer
146 Buffer & buffer() const;
147 /// get some interesting description of top position
148 void info(std::ostream & os) const;
149 /// are we in math mode (2), text mode (1) or unsure (0)?
151 /// reset cursor bottom to the beginning of the given inset
152 // (sort of 'chroot' environment...)
153 void reset(InsetBase &);
154 /// for spellchecking
155 void replaceWord(std::string const & replacestring);
156 /// the event was not (yet) dispatched
158 /// the event was already dispatched
160 /// call update() when done
162 /// don't call update() when done
166 friend std::ostream & operator<<(std::ostream & os, LCursor const & cur);
172 /// the anchor position
176 DispatchResult disp_;
181 * The target x position of the cursor. This is used for when
182 * we have text like :
184 * blah blah blah blah| blah blah blah
186 * blah blah blah blah blah blah
188 * When we move onto row 3, we would like to be vertically aligned
189 * with where we were in row 1, despite the fact that row 2 is
193 /// do we have a selection?
195 /// are we on the way to get one?
201 // math specific stuff that could be promoted to "global" later
203 /// do we allow autocorrection
205 /// are we entering a macro name?
209 ///////////////////////////////////////////////////////////////////
211 // The part below is the non-integrated rest of the original math
212 // cursor. This should be either generalized for texted or moved
213 // back to the math insets.
215 ///////////////////////////////////////////////////////////////////
219 void insert(MathAtom const &);
221 void insert(MathArray const &);
222 /// return false for empty math insets
224 /// return false for empty math insets
226 /// called for LFUN_UP etc
228 /// called for LFUN_DOWN etc
233 void plainInsert(MathAtom const & at);
235 void niceInsert(MathAtom const & at);
237 void niceInsert(std::string const & str);
239 /// in pixels from top of screen
240 void setScreenPos(int x, int y);
241 /// current offset in the top cell
242 /// interpret name a name of a macro
243 void macroModeClose();
244 /// are we currently typing the name of a macro?
245 bool inMacroMode() const;
246 /// get access to the macro we are currently typing
247 MathUnknownInset * activeMacro();
249 /// replace selected stuff with at, placing the former
250 // selection in given cell of atom
251 void handleNest(MathAtom const & at, int cell = 0);
253 bool isInside(InsetBase const *);
255 /// make sure cursor position is valid
257 /// mark current cursor trace for redraw
260 /// hack for reveal codes
263 /// injects content of a cell into parent
265 /// split font inset etc
266 void handleFont(std::string const & font);
268 /// display a message
269 void message(std::string const & msg) const;
270 /// display an error message
271 void errorMessage(std::string const & msg) const;
273 std::string getPossibleLabel();
275 /// moves position somehow up or down
276 bool goUpDown(bool up);
278 /// the name of the macro we are currently inputting
279 std::string macroName();
280 /// where in the curent cell does the macro name start?
282 /// can we enter the inset?
283 bool openable(MathAtom const &) const;
285 Encoding const * getEncoding() const;
290 #endif // LYXCURSOR_H