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"
45 /// This class encapsulates the main text data and operations in LyX
51 /// \return true if there's no content at all.
52 /// \warning a non standard layout on an empty paragraph doesn't
57 Font getFont(Buffer const & buffer, Paragraph const & par,
60 void applyOuterFont(Buffer const & buffer, Font &) const;
62 Font getLayoutFont(Buffer const & buffer, pit_type pit) const;
64 Font getLabelFont(Buffer const & buffer,
65 Paragraph const & par) const;
66 /** Set font of character at position \p pos in paragraph \p pit.
67 * Must not be called if \p pos denotes an inset with text contents,
68 * and the inset is not allowed inside a font change (see below).
70 void setCharFont(Buffer const & buffer, pit_type pit, pos_type pos,
73 /** Needed to propagate font changes to all text cells of insets
74 * that are not allowed inside a font change (bug 1973).
75 * Must not be called if \p pos denotes an ordinary character or an
76 * inset that is alowed inside a font change.
77 * FIXME: This should be removed, see documentation of noFontChange
80 void setInsetFont(Buffer const & buffer, pit_type pit, pos_type pos,
81 Font const & font, bool toggleall = false);
83 /// what you expect when pressing \<enter\> at cursor position
84 void breakParagraph(Cursor & cur, bool keep_layout = false);
86 /// set layout over selection
87 void setLayout(Buffer const & buffer, pit_type start, pit_type end,
88 docstring const & layout);
89 /// Set given layout to current cursor position.
90 /// FIXME: replace Cursor with DocIterator.
91 void setLayout(Cursor & cur, docstring const & layout);
93 /// what type of depth change to make
98 /// Increase or decrease the nesting depth of the selected paragraph(s)
99 /// FIXME: replace Cursor with DocIterator.
100 void changeDepth(Cursor & cur, DEPTH_CHANGE type);
102 /// Returns whether something would be changed by changeDepth
103 /// FIXME: replace Cursor with DocIterator.
104 bool changeDepthAllowed(Cursor & cur, DEPTH_CHANGE type) const;
106 /// Set font over selection paragraphs and rebreak.
107 /// FIXME: replace Cursor with DocIterator.
108 void setFont(Cursor & cur, Font const &, bool toggleall = false);
109 /// Set font from \p begin to \p end and rebreak.
110 void setFont(Buffer const & buffer, CursorSlice const & begin,
111 CursorSlice const & end, Font const &,
112 bool toggleall = false);
115 void toggleFree(Cursor & cur, Font const &, bool toggleall = false);
118 /// FIXME: replace Cursor with DocIterator.
119 docstring getStringToIndex(Cursor const & cur);
121 /// insert a character at cursor position
122 /// FIXME: replace Cursor with DocIterator.
123 void insertChar(Cursor & cur, char_type c);
124 /// insert an inset at cursor position
125 /// FIXME: replace Cursor with DocIterator.
126 void insertInset(Cursor & cur, Inset * inset);
128 /// try to handle that request
129 /// FIXME: replace Cursor with DocIterator.
130 void dispatch(Cursor & cur, FuncRequest & cmd);
131 /// do we want to handle this event?
132 bool getStatus(Cursor & cur, FuncRequest const & cmd,
133 FuncStatus & status) const;
135 /// read-only access to individual paragraph
136 Paragraph const & getPar(pit_type pit) const { return pars_[pit]; }
137 /// read-write access to individual paragraph
138 Paragraph & getPar(pit_type pit) { return pars_[pit]; }
139 // Returns the current font and depth as a message.
140 /// FIXME: replace Cursor with DocIterator.
141 docstring currentState(Cursor & cur);
143 /** returns row near the specified
144 * y-coordinate in given paragraph (relative to the screen).
146 /// FIXME: move to TextMetrics.
147 Row const & getRowNearY(BufferView const & bv, int y,
150 /// returns the paragraph number closest to screen y-coordinate.
151 /// This method uses the BufferView CoordCache to locate the
152 /// paragraph. The y-coodinate is allowed to be off-screen and
153 /// the CoordCache will be automatically updated if needed. This is
154 /// the reason why we need a non const BufferView.
155 /// FIXME: move to TextMetrics.
156 pit_type getPitNearY(BufferView & bv, int y) const;
158 /** Find the word under \c from in the relative location
159 * defined by \c word_location.
160 * @param from return here the start of the word
161 * @param to return here the end of the word
163 void getWord(CursorSlice & from, CursorSlice & to, word_location const);
164 /// just selects the word the cursor is in
165 void selectWord(Cursor & cur, word_location loc);
167 /// what type of change operation to make
172 /// accept or reject the selected change
173 void acceptOrRejectChanges(Cursor & cur, ChangeOp op);
174 /// accept the changes within the complete Text
175 void acceptChanges(BufferParams const & bparams);
176 /// reject the changes within the complete Text
177 void rejectChanges(BufferParams const & bparams);
179 /// returns true if par was empty and was removed
180 bool setCursor(Cursor & cur, pit_type par, pos_type pos,
181 bool setfont = true, bool boundary = false);
183 void setCursor(CursorSlice &, pit_type par, pos_type pos);
185 void setCursorIntern(Cursor & cur, pit_type par,
186 pos_type pos, bool setfont = true, bool boundary = false);
188 void setCurrentFont(Cursor & cur);
191 void recUndo(Cursor & cur, pit_type first, pit_type last) const;
193 void recUndo(Cursor & cur, pit_type first) const;
195 /// sets cursor only within this Text.
196 /// x,y are screen coordinates
197 void setCursorFromCoordinates(Cursor & cur, int x, int y);
199 /// sets cursor recursively descending into nested editable insets
201 \return the inset pointer if x,y is covering that inset
202 \param x,y are absolute screen coordinates.
203 \retval inset is non-null if the cursor is positionned inside
205 /// FIXME: move to TextMetrics.
206 /// FIXME: cleanup to use BufferView::getCoveringInset() and
207 /// setCursorFromCoordinates() instead of checkInsetHit().
208 Inset * editXY(Cursor & cur, int x, int y);
210 /// Move cursor one position left
212 * Returns true if an update is needed after the move.
214 bool cursorLeft(Cursor & cur);
215 /// Move cursor one position right
217 * Returns true if an update is needed after the move.
219 bool cursorRight(Cursor & cur);
221 bool cursorLeftOneWord(Cursor & cur);
223 bool cursorRightOneWord(Cursor & cur);
225 bool cursorUpParagraph(Cursor & cur);
227 bool cursorDownParagraph(Cursor & cur);
229 /// FIXME: move to TextMetrics.
230 bool cursorHome(Cursor & cur);
232 /// FIXME: move to TextMetrics.
233 bool cursorEnd(Cursor & cur);
235 void cursorPrevious(Cursor & cur);
237 void cursorNext(Cursor & cur);
239 bool cursorTop(Cursor & cur);
241 bool cursorBottom(Cursor & cur);
242 /// Erase character at cursor. Honour change tracking
243 /// FIXME: replace Cursor with DocIterator.
244 bool erase(Cursor & cur);
245 /// Delete character before cursor. Honour CT
246 /// FIXME: replace Cursor with DocIterator.
247 bool backspace(Cursor & cur);
248 // Dissolve the inset under cursor
249 /// FIXME: replace Cursor with DocIterator.
250 bool dissolveInset(Cursor & cur);
252 bool selectWordWhenUnderCursor(Cursor & cur, word_location);
258 text_capitalization = 1,
262 /// Change the case of the word at cursor position.
263 void changeCase(Cursor & cur, TextCase action);
264 /// Transposes the character at the cursor with the one before it
265 void charsTranspose(Cursor & cur);
267 /** the DTP switches for paragraphs. LyX will store the top settings
268 always in the first physical paragraph, the bottom settings in the
269 last. When a paragraph is broken, the top settings rest, the bottom
270 settings are given to the new one.
271 This function will handle a multi-paragraph selection.
273 void setParagraphs(Cursor & cur, docstring arg, bool modify = false);
274 /// Sets parameters for current or selected paragraphs
275 void setParagraphs(Cursor & cur, ParagraphParameters const & p);
277 /* these things are for search and replace */
279 /// needed to insert the selection
280 /// FIXME: replace Cursor with DocIterator.
281 void insertStringAsLines(Cursor & cur, docstring const & str);
282 /// needed to insert the selection
283 /// FIXME: replace Cursor with DocIterator.
284 void insertStringAsParagraphs(Cursor & cur, docstring const & str);
286 /// Returns an inset if inset was hit, or 0 if not.
287 /// \warning This method is not recursive! It will return the
288 /// outermost inset within this Text.
289 /// \sa BufferView::getCoveringInset() to get the innermost inset.
290 Inset * checkInsetHit(BufferView &, int x, int y);
292 /// return the color of the canvas
293 Color_color backgroundColor() const;
296 * Returns the left beginning of the text.
297 * This information cannot be taken from the layout object, because
298 * in LaTeX the beginning of the text fits in some cases
299 * (for example sections) exactly the label-width.
301 /// FIXME: move to TextMetrics.
302 int leftMargin(Buffer const &, int max_width, pit_type pit, pos_type pos) const;
303 int leftMargin(Buffer const &, int max_width, pit_type pit) const;
305 /// access to our paragraphs
306 ParagraphList const & paragraphs() const { return pars_; }
307 ParagraphList & paragraphs() { return pars_; }
308 /// return true if this is the main text
309 bool isMainText(Buffer const &) const;
311 /// is this row the last in the text?
312 /// FIXME: move to TextMetrics.
313 bool isLastRow(pit_type pit, Row const & row) const;
314 /// is this row the first in the text?
315 /// FIXME: move to TextMetrics.
316 bool isFirstRow(pit_type pit, Row const & row) const;
319 double spacing(Buffer const & buffer, Paragraph const & par) const;
320 /// make a suggestion for a label
321 /// FIXME: replace Cursor with DocIterator.
322 docstring getPossibleLabel(Cursor & cur) const;
323 /// is this paragraph right-to-left?
324 bool isRTL(Buffer const &, Paragraph const & par) const;
325 /// is this position in the paragraph right-to-left?
326 bool isRTL(Buffer const & buffer, CursorSlice const & sl, bool boundary) const;
327 /// is between pos-1 and pos an RTL<->LTR boundary?
328 bool isRTLBoundary(Buffer const & buffer, Paragraph const & par,
330 /// would be a RTL<->LTR boundary between pos and the given font?
331 bool isRTLBoundary(Buffer const & buffer, Paragraph const & par,
332 pos_type pos, Font const & font) const;
335 bool checkAndActivateInset(Cursor & cur, bool front);
338 void write(Buffer const & buf, std::ostream & os) const;
339 /// returns whether we've seen our usual 'end' marker
340 bool read(Buffer const & buf, Lexer & lex, ErrorList & errorList);
343 /// FIXME: move to TextMetrics.
344 int cursorX(BufferView const &, CursorSlice const & cursor,
345 bool boundary) const;
347 /// FIXME: move to TextMetrics.
348 int cursorY(BufferView const & bv, CursorSlice const & cursor,
349 bool boundary) const;
351 /// delete double spaces, leading spaces, and empty paragraphs around old cursor.
352 /// \retval true if a change has happened and we need a redraw.
353 /// FIXME: replace Cursor with DocIterator. This is not possible right
354 /// now because recordUndo() is called which needs a Cursor.
355 static bool deleteEmptyParagraphMechanism(Cursor & cur,
356 Cursor & old, bool & need_anchor_change);
358 /// delete double spaces, leading spaces, and empty paragraphs
359 /// from \first to \last paragraph
360 void deleteEmptyParagraphMechanism(pit_type first, pit_type last, bool trackChanges);
363 /// the current font settings
366 Font real_current_font;
368 int background_color_;
373 /// our 'outermost' font. This is handed down from the surrounding
374 // inset through the pi/mi parameter (pi.base.font)
380 /// return past-the-last paragraph influenced by a layout
382 pit_type undoSpan(pit_type pit);
384 // fix the cursor `cur' after a characters has been deleted at `where'
385 // position. Called by deleteEmptyParagraphMechanism
386 static void fixCursorAfterDelete(CursorSlice & cur, CursorSlice const & where);
388 // At cursor position 0, try to merge the paragraph with the one before it.
389 // Ignore change tracking, i.e., physically remove the end-of-par character
390 bool backspacePos0(Cursor & cur);
391 /// handle the case where bibitems were deleted
392 bool handleBibitems(Cursor & cur);
395 void deleteWordForward(Cursor & cur);
397 void deleteWordBackward(Cursor & cur);
399 void deleteLineForward(Cursor & cur);
402 /// set 'number' font property
403 void number(Cursor & cur);
405 /// paste plain text at current cursor.
406 /// \param str string to paste
407 /// \param asParagraphs whether to paste as paragraphs or as lines
408 void pasteString(Cursor & cur, docstring const & str,