4 * This file is part of LyX, the document processor.
5 * Licence details can be found in the file COPYING.
8 * \author Lars Gullik Bjønnes
11 * Full author contact details are available in file CREDITS.
18 #include "dispatchresult.h"
21 #include "lyxlayout_ptr_fwd.h"
22 #include "ParagraphList.h"
47 /// This class encapsulates the main text data and operations in LyX
54 LyXFont getFont(Buffer const & buffer, Paragraph const & par,
57 void applyOuterFont(Buffer const & buffer, LyXFont &) const;
59 LyXFont getLayoutFont(Buffer const & buffer, pit_type pit) const;
61 LyXFont getLabelFont(Buffer const & buffer,
62 Paragraph const & par) const;
64 void setCharFont(Buffer const & buffer, pit_type pit, pos_type pos,
65 LyXFont const & font);
67 void setCharFont(Buffer const & buffer, pit_type pit, pos_type pos,
68 LyXFont const & font, bool toggleall);
70 /// what you expect when pressing <enter> at cursor position
71 void breakParagraph(LCursor & cur, bool keep_layout = false);
73 /// set layout over selection
74 void setLayout(Buffer const & buffer, pit_type start, pit_type end,
75 std::string const & layout);
76 /// Set given layout to current cursor position.
77 /// FIXME: replace LCursor with DocIterator.
78 void setLayout(LCursor & cur, std::string const & layout);
80 /// what type of depth change to make
85 /// Increase or decrease the nesting depth of the selected paragraph(s)
86 /// FIXME: replace LCursor with DocIterator.
87 void changeDepth(LCursor & cur, DEPTH_CHANGE type);
89 /// Returns whether something would be changed by changeDepth
90 /// FIXME: replace LCursor with DocIterator.
91 bool changeDepthAllowed(LCursor & cur, DEPTH_CHANGE type) const;
93 /// Set font over selection paragraphs and rebreak.
94 /// FIXME: replace LCursor with DocIterator.
95 void setFont(LCursor & cur, LyXFont const &, bool toggleall = false);
98 void toggleFree(LCursor & cur, LyXFont const &, bool toggleall = false);
101 /// FIXME: replace LCursor with DocIterator.
102 docstring getStringToIndex(LCursor const & cur);
104 /// insert a character at cursor position
105 /// FIXME: replace LCursor with DocIterator.
106 void insertChar(LCursor & cur, char_type c);
107 /// insert an inset at cursor position
108 /// FIXME: replace LCursor with DocIterator.
109 void insertInset(LCursor & cur, InsetBase * inset);
111 /// draw text (only used for insets)
112 void draw(PainterInfo & pi, int x, int y) const;
113 /// draw textselection
114 void drawSelection(PainterInfo & pi, int x, int y) const;
116 /// try to handle that request
117 /// FIXME: replace LCursor with DocIterator.
118 void dispatch(LCursor & cur, FuncRequest & cmd);
119 /// do we want to handle this event?
120 bool getStatus(LCursor & cur, FuncRequest const & cmd,
121 FuncStatus & status) const;
123 /// read-only access to individual paragraph
124 Paragraph const & getPar(pit_type pit) const { return pars_[pit]; }
125 /// read-write access to individual paragraph
126 Paragraph & getPar(pit_type pit) { return pars_[pit]; }
127 // Returns the current font and depth as a message.
128 /// FIXME: replace LCursor with DocIterator.
129 docstring currentState(LCursor & cur);
131 /** returns row near the specified
132 * y-coordinate in given paragraph (relative to the screen).
134 /// FIXME: move to TextMetrics.
135 Row const & getRowNearY(BufferView const & bv, int y,
138 /// returns the paragraph number closest to screen y-coordinate.
139 /// This method uses the BufferView CoordCache to locate the
140 /// paragraph. The y-coodinate is allowed to be off-screen and
141 /// the CoordCache will be automatically updated if needed. This is
142 /// the reason why we need a non const BufferView and why this
143 /// method is non-const.
144 /// FIXME: move to TextMetrics.
145 pit_type getPitNearY(BufferView & bv, int y);
147 /** Find the word under \c from in the relative location
148 * defined by \c word_location.
149 * @param from return here the start of the word
150 * @param to return here the end of the word
152 void getWord(CursorSlice & from, CursorSlice & to, word_location const);
153 /// just selects the word the cursor is in
154 void selectWord(LCursor & cur, word_location loc);
156 /// what type of change operation to make
161 /// accept or reject the selected change
162 void acceptOrRejectChanges(LCursor & cur, ChangeOp op);
163 /// accept the changes within the complete LyXText
164 void acceptChanges(BufferParams const & bparams);
165 /// reject the changes within the complete LyXText
166 void rejectChanges(BufferParams const & bparams);
168 /// returns true if par was empty and was removed
169 bool setCursor(LCursor & cur, pit_type par, pos_type pos,
170 bool setfont = true, bool boundary = false);
172 void setCursor(CursorSlice &, pit_type par, pos_type pos);
174 void setCursorIntern(LCursor & cur, pit_type par,
175 pos_type pos, bool setfont = true, bool boundary = false);
177 void setCurrentFont(LCursor & cur);
180 void recUndo(LCursor & cur, pit_type first, pit_type last) const;
182 void recUndo(LCursor & cur, pit_type first) const;
184 /// sets cursor only within this LyXText.
185 /// x,y are screen coordinates
186 void setCursorFromCoordinates(LCursor & cur, int x, int y);
188 /// sets cursor recursively descending into nested editable insets
190 \return the inset pointer if x,y is covering that inset
191 \param x,y are absolute screen coordinates.
192 \retval inset is non-null if the cursor is positionned inside
194 /// FIXME: move to TextMetrics.
195 InsetBase * editXY(LCursor & cur, int x, int y);
197 /// Move cursor one line up.
199 * Returns true if an update is needed after the move.
201 /// FIXME: move to TextMetrics.
202 bool cursorUp(LCursor & cur);
203 /// Move cursor one line down.
205 * Returns true if an update is needed after the move.
207 /// FIXME: move to TextMetrics.
208 bool cursorDown(LCursor & cur);
209 /// Move cursor one position left
211 * Returns true if an update is needed after the move.
213 bool cursorLeft(LCursor & cur);
214 /// Move cursor one position right
216 * Returns true if an update is needed after the move.
218 bool cursorRight(LCursor & cur);
220 bool cursorLeftOneWord(LCursor & cur);
222 bool cursorRightOneWord(LCursor & cur);
224 bool cursorUpParagraph(LCursor & cur);
226 bool cursorDownParagraph(LCursor & cur);
228 /// FIXME: move to TextMetrics.
229 bool cursorHome(LCursor & cur);
231 /// FIXME: move to TextMetrics.
232 bool cursorEnd(LCursor & cur);
234 void cursorPrevious(LCursor & cur);
236 void cursorNext(LCursor & cur);
238 bool cursorTop(LCursor & cur);
240 bool cursorBottom(LCursor & cur);
241 /// Erase character at cursor. Honour change tracking
242 /// FIXME: replace LCursor with DocIterator.
243 bool erase(LCursor & cur);
244 /// Delete character before cursor. Honour CT
245 /// FIXME: replace LCursor with DocIterator.
246 bool backspace(LCursor & cur);
247 // Dissolve the inset under cursor
248 /// FIXME: replace LCursor with DocIterator.
249 bool dissolveInset(LCursor & cur);
251 bool selectWordWhenUnderCursor(LCursor & cur, word_location);
257 text_capitalization = 1,
261 /// Change the case of the word at cursor position.
262 void changeCase(LCursor & cur, TextCase action);
263 /// Transposes the character at the cursor with the one before it
264 void charsTranspose(LCursor & cur);
266 /** the DTP switches for paragraphs. LyX will store the top settings
267 always in the first physical paragraph, the bottom settings in the
268 last. When a paragraph is broken, the top settings rest, the bottom
269 settings are given to the new one.
271 void setParagraph(LCursor & cur,
272 Spacing const & spacing,
274 docstring const & labelwidthstring,
277 /* these things are for search and replace */
279 /// needed to insert the selection
280 /// FIXME: replace LCursor with DocIterator.
281 void insertStringAsLines(LCursor & cur, docstring const & str);
282 /// needed to insert the selection
283 /// FIXME: replace LCursor with DocIterator.
284 void insertStringAsParagraphs(LCursor & cur, docstring const & str);
286 /// Returns an inset if inset was hit, or 0 if not.
287 InsetBase * checkInsetHit(BufferView &, int x, int y);
290 /// FIXME: move to TextMetrics.
291 int singleWidth(Buffer const &, Paragraph const & par,
294 /// FIXME: move to TextMetrics.
295 int singleWidth(Paragraph const & par, pos_type pos, char_type c,
296 LyXFont const & Font) const;
298 /// return the color of the canvas
299 LColor_color backgroundColor() const;
302 * Returns the left beginning of the text.
303 * This information cannot be taken from the layout object, because
304 * in LaTeX the beginning of the text fits in some cases
305 * (for example sections) exactly the label-width.
307 /// FIXME: move to TextMetrics.
308 int leftMargin(Buffer const &, int max_width, pit_type pit, pos_type pos) const;
309 int leftMargin(Buffer const &, int max_width, pit_type pit) const;
311 /// access to our paragraphs
312 ParagraphList const & paragraphs() const { return pars_; }
313 ParagraphList & paragraphs() { return pars_; }
314 /// return true if this is the main text
315 bool isMainText(Buffer const &) const;
317 /// is this row the last in the text?
318 /// FIXME: move to TextMetrics.
319 bool isLastRow(pit_type pit, Row const & row) const;
320 /// is this row the first in the text?
321 /// FIXME: move to TextMetrics.
322 bool isFirstRow(pit_type pit, Row const & row) const;
325 double spacing(Buffer const & buffer, Paragraph const & par) const;
326 /// make a suggestion for a label
327 /// FIXME: replace LCursor with DocIterator.
328 docstring getPossibleLabel(LCursor & cur) const;
329 /// is this paragraph right-to-left?
330 bool isRTL(Buffer const &, Paragraph const & par) const;
332 bool checkAndActivateInset(LCursor & cur, bool front);
335 void write(Buffer const & buf, std::ostream & os) const;
336 /// returns whether we've seen our usual 'end' marker
337 bool read(Buffer const & buf, LyXLex & lex, ErrorList & errorList);
340 /// FIXME: move to TextMetrics.
341 int cursorX(BufferView const &, CursorSlice const & cursor,
342 bool boundary) const;
344 /// FIXME: move to TextMetrics.
345 int cursorY(BufferView const & bv, CursorSlice const & cursor,
346 bool boundary) const;
348 /// delete double spaces, leading spaces, and empty paragraphs around old cursor.
349 /// \retval true if a change has happened and we need a redraw.
350 /// FIXME: replace LCursor with DocIterator. This is not possible right
351 /// now because recordUndo() is called which needs a LCursor.
352 bool deleteEmptyParagraphMechanism(LCursor & cur,
353 LCursor & old, bool & need_anchor_change);
355 /// delete double spaces, leading spaces, and empty paragraphs
356 /// from \first to \last paragraph
357 void deleteEmptyParagraphMechanism(pit_type first, pit_type last, bool trackChanges);
360 /// the current font settings
361 LyXFont current_font;
363 LyXFont real_current_font;
365 int background_color_;
372 /// our 'outermost' font. This is handed down from the surrounding
373 // inset through the pi/mi parameter (pi.base.font)
379 /// return past-the-last paragraph influenced by a layout
381 pit_type undoSpan(pit_type pit);
383 // fix the cursor `cur' after a characters has been deleted at `where'
384 // position. Called by deleteEmptyParagraphMechanism
385 void fixCursorAfterDelete(CursorSlice & cur, CursorSlice const & where);
387 // At cursor position 0, try to merge the paragraph with the one before it.
388 // Ignore change tracking, i.e., physically remove the end-of-par character
389 bool backspacePos0(LCursor & cur);
392 void deleteWordForward(LCursor & cur);
394 void deleteWordBackward(LCursor & cur);
396 void deleteLineForward(LCursor & cur);
399 /// set 'number' font property
400 void number(LCursor & cur);
402 /// paste plain text at current cursor.
403 /// \param str string to paste
404 /// \param asParagraphs whether to paste as paragraphs or as lines
405 void pasteString(LCursor & cur, docstring const & str,