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;
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 DocIterator {
37 /// create the cursor of a BufferView
38 explicit LCursor(BufferView & bv);
40 /// dispatch from innermost inset upwards
41 void dispatch(FuncRequest const & cmd);
42 /// get the resut of the last dispatch
43 DispatchResult result() const;
44 /// are we willing to handle this event?
45 bool getStatus(FuncRequest const & cmd, FuncStatus & flag);
47 /// add a new cursor slice
48 void push(InsetBase & inset);
49 /// add a new cursor slice, place cursor on left end
50 void pushLeft(InsetBase & inset);
51 /// pop one level off the cursor
53 /// pop one slice off the cursor stack and go left
55 /// pop one slice off the cursor stack and go right
58 void setCursor(DocIterator const & it);
64 bool selection() const { return selection_; }
66 bool & selection() { return selection_; }
67 /// did we place the anchor?
68 bool mark() const { return mark_; }
69 /// did we place the anchor?
70 bool & mark() { return mark_; }
73 /// set selection at given position
74 void setSelection(DocIterator const & where, size_t n);
76 void clearSelection();
77 /// access start of selection
78 CursorSlice selBegin() const;
79 /// access end of selection
80 CursorSlice selEnd() const;
81 /// access start of selection
82 DocIterator selectionBegin() const;
83 /// access start of selection
84 DocIterator selectionEnd() const;
86 void selHandle(bool selecting);
88 std::string selectionAsString(bool label) const;
90 void paste(std::string const & data);
92 std::string currentState();
95 bool autocorrect() const { return autocorrect_; }
97 bool & autocorrect() { return autocorrect_; }
98 /// are we entering a macro name?
99 bool macromode() const { return macromode_; }
100 /// are we entering a macro name?
101 bool & macromode() { return macromode_; }
102 /// returns x,y position
103 void getPos(int & x, int & y) const;
104 /// returns cursor dimension
105 void getDim(int & asc, int & desc) const;
110 /// move one step to the left
112 /// move one step to the right
116 void insert(InsetBase *);
117 /// insert a single char
120 void insert(std::string const & str);
122 /// write acess to target x position of cursor
124 /// return target x position of cursor
125 int x_target() const;
126 /// clear target x position of cursor
129 /// access to normalized selection anchor
130 CursorSlice anchor() const;
131 /// sets anchor to cursor position
133 /// access to owning BufferView
134 BufferView & bv() const;
135 /// access to owning Buffer
136 Buffer & buffer() const;
137 /// get some interesting description of top position
138 void info(std::ostream & os) const;
139 /// are we in math mode (2), text mode (1) or unsure (0)?
141 /// reset cursor bottom to the beginning of the given inset
142 // (sort of 'chroot' environment...)
143 void reset(InsetBase &);
144 /// for spellchecking
145 void replaceWord(std::string const & replacestring);
146 /// the event was not (yet) dispatched
148 /// the event was already dispatched
150 /// call update() when done
152 /// don't call update() when done
156 friend std::ostream & operator<<(std::ostream & os, LCursor const & cur);
162 /// the anchor position
166 DispatchResult disp_;
170 * The target x position of the cursor. This is used for when
171 * we have text like :
173 * blah blah blah blah| blah blah blah
175 * blah blah blah blah blah blah
177 * When we move onto row 3, we would like to be vertically aligned
178 * with where we were in row 1, despite the fact that row 2 is
182 /// do we have a selection?
184 /// are we on the way to get one?
188 // math specific stuff that could be promoted to "global" later
190 /// do we allow autocorrection
192 /// are we entering a macro name?
196 ///////////////////////////////////////////////////////////////////
198 // The part below is the non-integrated rest of the original math
199 // cursor. This should be either generalized for texted or moved
200 // back to the math insets.
202 ///////////////////////////////////////////////////////////////////
206 void insert(MathAtom const &);
208 void insert(MathArray const &);
209 /// return false for empty math insets
211 /// return false for empty math insets
213 /// called for LFUN_UP etc
215 /// called for LFUN_DOWN etc
220 void plainInsert(MathAtom const & at);
222 void niceInsert(MathAtom const & at);
224 void niceInsert(std::string const & str);
226 /// in pixels from top of screen
227 void setScreenPos(int x, int y);
228 /// in pixels from left of screen
230 /// current offset in the top cell
231 /// interpret name a name of a macro
232 void macroModeClose();
233 /// are we currently typing the name of a macro?
234 bool inMacroMode() const;
235 /// get access to the macro we are currently typing
236 MathUnknownInset * activeMacro();
238 /// replace selected stuff with at, placing the former
239 // selection in given cell of atom
240 void handleNest(MathAtom const & at, int cell = 0);
242 bool isInside(InsetBase const *);
244 /// make sure cursor position is valid
246 /// mark current cursor trace for redraw
249 /// hack for reveal codes
252 /// injects content of a cell into parent
254 /// split font inset etc
255 void handleFont(std::string const & font);
257 /// display a message
258 void message(std::string const & msg) const;
259 /// display an error message
260 void errorMessage(std::string const & msg) const;
262 std::string getPossibleLabel();
264 /// moves position somehow up or down
265 bool goUpDown(bool up);
267 /// the name of the macro we are currently inputting
268 std::string macroName();
269 /// where in the curent cell does the macro name start?
271 /// can we enter the inset?
272 bool openable(MathAtom const &) const;
274 Encoding const * getEncoding() const;
277 #endif // LYXCURSOR_H