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;
45 /// are we willing to handle this event?
46 bool getStatus(FuncRequest const & cmd, FuncStatus & flag);
48 /// add a new cursor slice
49 void push(InsetBase & inset);
50 /// add a new cursor slice, place cursor on left end
51 void pushLeft(InsetBase & inset);
52 /// pop one level off the cursor
54 /// pop one slice off the cursor stack and go left
56 /// pop one slice off the cursor stack and go right
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;
105 /// returns cursor dimension
106 void getDim(int & asc, int & desc) const;
111 /// move one step to the left
113 /// move one step to the right
117 void insert(InsetBase *);
118 /// insert a single char
121 void insert(std::string const & str);
123 /// in pixels from left of screen
125 /// write acess to target x position of cursor
127 /// return target x position of cursor
128 int x_target() const;
129 /// set targetX in current position
131 /// clear target x position of cursor
134 /// access to normalized selection anchor
135 CursorSlice anchor() const;
136 /// sets anchor to cursor position
138 /// access to owning BufferView
139 BufferView & bv() const;
140 /// access to owning Buffer
141 Buffer & buffer() const;
142 /// get some interesting description of top position
143 void info(std::ostream & os) const;
144 /// are we in math mode (2), text mode (1) or unsure (0)?
146 /// reset cursor bottom to the beginning of the given inset
147 // (sort of 'chroot' environment...)
148 void reset(InsetBase &);
149 /// for spellchecking
150 void replaceWord(std::string const & replacestring);
151 /// the event was not (yet) dispatched
153 /// the event was already dispatched
155 /// call update() when done
157 /// don't call update() when done
161 friend std::ostream & operator<<(std::ostream & os, LCursor const & cur);
167 /// the anchor position
171 DispatchResult disp_;
176 * The target x position of the cursor. This is used for when
177 * we have text like :
179 * blah blah blah blah| blah blah blah
181 * blah blah blah blah blah blah
183 * When we move onto row 3, we would like to be vertically aligned
184 * with where we were in row 1, despite the fact that row 2 is
188 /// do we have a selection?
190 /// are we on the way to get one?
196 // math specific stuff that could be promoted to "global" later
198 /// do we allow autocorrection
200 /// are we entering a macro name?
204 ///////////////////////////////////////////////////////////////////
206 // The part below is the non-integrated rest of the original math
207 // cursor. This should be either generalized for texted or moved
208 // back to the math insets.
210 ///////////////////////////////////////////////////////////////////
214 void insert(MathAtom const &);
216 void insert(MathArray const &);
217 /// return false for empty math insets
219 /// return false for empty math insets
221 /// called for LFUN_UP etc
223 /// called for LFUN_DOWN etc
228 void plainInsert(MathAtom const & at);
230 void niceInsert(MathAtom const & at);
232 void niceInsert(std::string const & str);
234 /// in pixels from top of screen
235 void setScreenPos(int x, int y);
236 /// current offset in the top cell
237 /// interpret name a name of a macro
238 void macroModeClose();
239 /// are we currently typing the name of a macro?
240 bool inMacroMode() const;
241 /// get access to the macro we are currently typing
242 MathUnknownInset * activeMacro();
244 /// replace selected stuff with at, placing the former
245 // selection in given cell of atom
246 void handleNest(MathAtom const & at, int cell = 0);
248 bool isInside(InsetBase const *);
250 /// make sure cursor position is valid
252 /// mark current cursor trace for redraw
255 /// hack for reveal codes
258 /// injects content of a cell into parent
260 /// split font inset etc
261 void handleFont(std::string const & font);
263 /// display a message
264 void message(std::string const & msg) const;
265 /// display an error message
266 void errorMessage(std::string const & msg) const;
268 std::string getPossibleLabel();
270 /// moves position somehow up or down
271 bool goUpDown(bool up);
273 /// the name of the macro we are currently inputting
274 std::string macroName();
275 /// where in the curent cell does the macro name start?
277 /// can we enter the inset?
278 bool openable(MathAtom const &) const;
280 Encoding const * getEncoding() const;
285 #endif // LYXCURSOR_H