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.
17 #include "bufferview_funcs.h"
19 #include "dispatchresult.h"
20 #include "dimension.h"
23 #include "lyxlayout_ptr_fwd.h"
24 #include "ParagraphList.h"
51 /// This class encapsulates the main text data and operations in LyX
55 explicit LyXText(BufferView * bv = 0);
57 void init(BufferView *);
60 LyXFont getFont(Buffer const & buffer, Paragraph const & par,
63 void applyOuterFont(Buffer const & buffer, LyXFont &) const;
65 LyXFont getLayoutFont(Buffer const & buffer, pit_type pit) const;
67 LyXFont getLabelFont(Buffer const & buffer,
68 Paragraph const & par) const;
70 void setCharFont(Buffer const & buffer, pit_type pit, pos_type pos,
71 LyXFont const & font);
73 void setCharFont(Buffer const & buffer, pit_type pit, pos_type pos,
74 LyXFont const & font, bool toggleall);
76 /// what you expect when pressing <enter> at cursor position
77 void breakParagraph(LCursor & cur, bool keep_layout = false);
79 /// set layout over selection
80 void setLayout(Buffer const & buffer, pit_type start, pit_type end,
81 std::string const & layout);
83 void setLayout(LCursor & cur, std::string const & layout);
85 /// what type of depth change to make
90 /// Increase or decrease the nesting depth of the selected paragraph(s)
91 void changeDepth(LCursor & cur, DEPTH_CHANGE type);
93 /// Returns whether something would be changed by changeDepth
94 bool changeDepthAllowed(LCursor & cur, DEPTH_CHANGE type) const;
96 /// Set font over selection paragraphs and rebreak.
97 void setFont(LCursor & cur, LyXFont const &, bool toggleall = false);
99 /// Rebreaks the given paragraph.
100 /// \retval true if a full screen redraw is needed.
101 /// \retval false if a single paragraph redraw is enough.
102 bool redoParagraph(BufferView &, pit_type pit);
104 /// returns pos in given par at given x coord
105 pos_type x2pos(BufferView const &, pit_type pit, int row, int x) const;
106 int pos2x(pit_type pit, pos_type pos) const;
109 void toggleFree(LCursor & cur, LyXFont const &, bool toggleall = false);
112 docstring getStringToIndex(LCursor const & cur);
114 /// insert a character at cursor position
115 void insertChar(LCursor & cur, char_type c);
116 /// insert an inset at cursor position
117 void insertInset(LCursor & cur, InsetBase * inset);
119 /// compute text metrics
120 void metrics(MetricsInfo & mi, Dimension & dim);
121 /// draw text (only used for insets)
122 void draw(PainterInfo & pi, int x, int y) const;
123 /// draw textselection
124 void drawSelection(PainterInfo & pi, int x, int y) const;
126 /// try to handle that request
127 void dispatch(LCursor & cur, FuncRequest & cmd);
128 /// do we want to handle this event?
129 bool getStatus(LCursor & cur, FuncRequest const & cmd,
130 FuncStatus & status) const;
132 /// read-only access to individual paragraph
133 Paragraph const & getPar(pit_type pit) const { return pars_[pit]; }
134 /// read-write access to individual paragraph
135 Paragraph & getPar(pit_type pit) { return pars_[pit]; }
136 // Returns the current font and depth as a message.
137 std::string currentState(LCursor & cur);
139 /** returns row near the specified
140 * y-coordinate in given paragraph (relative to the screen).
142 Row const & getRowNearY(BufferView const & bv, int y,
144 pit_type getPitNearY(BufferView const & bv, int y) const;
146 /** returns the column near the specified x-coordinate of the row
147 x is set to the real beginning of this column
149 pos_type getColumnNearX(BufferView const & bv, pit_type pit,
150 Row const & row, int & x, bool & boundary) const;
152 /** Find the word under \c from in the relative location
153 * defined by \c word_location.
154 * @param from return here the start of the word
155 * @param to return here the end of the word
157 void getWord(CursorSlice & from, CursorSlice & to, word_location const);
158 /// just selects the word the cursor is in
159 void selectWord(LCursor & cur, word_location loc);
161 /// accept selected change
162 void acceptChange(LCursor & cur);
163 /// reject selected change
164 void rejectChange(LCursor & cur);
166 /// returns true if par was empty and was removed
167 bool setCursor(LCursor & cur, pit_type par, pos_type pos,
168 bool setfont = true, bool boundary = false);
170 void setCursor(CursorSlice &, pit_type par, pos_type pos);
172 void setCursorIntern(LCursor & cur, pit_type par,
173 pos_type pos, bool setfont = true, bool boundary = false);
175 void setCurrentFont(LCursor & cur);
178 void recUndo(LCursor & cur, pit_type first, pit_type last) const;
180 void recUndo(LCursor & cur, pit_type first) const;
181 /// returns true if par was empty and was removed
182 bool setCursorFromCoordinates(LCursor & cur, int x, int y);
184 /// sets cursor recursively descending into nested editable insets
186 \return the inset pointer if x,y is covering that inset
187 \param x,y are absolute screen coordinates.
188 \retval inset is non-null if the cursor is positionned inside
190 InsetBase * editXY(LCursor & cur, int x, int y);
192 /// Move cursor one line up.
194 * Returns true if an update is needed after the move.
196 bool cursorUp(LCursor & cur);
197 /// Move cursor one line down.
199 * Returns true if an update is needed after the move.
201 bool cursorDown(LCursor & cur);
202 /// Move cursor one position left
204 * Returns true if an update is needed after the move.
206 bool cursorLeft(LCursor & cur);
207 /// Move cursor one position right
209 * Returns true if an update is needed after the move.
211 bool cursorRight(LCursor & cur);
213 bool cursorLeftOneWord(LCursor & cur);
215 bool cursorRightOneWord(LCursor & cur);
217 bool cursorUpParagraph(LCursor & cur);
219 bool cursorDownParagraph(LCursor & cur);
221 bool cursorHome(LCursor & cur);
223 bool cursorEnd(LCursor & cur);
225 void cursorPrevious(LCursor & cur);
227 void cursorNext(LCursor & cur);
229 bool cursorTop(LCursor & cur);
231 bool cursorBottom(LCursor & cur);
232 /// Erase character at cursor. Honour change tracking
233 bool erase(LCursor & cur);
234 /** At cursor position 0, merge paragraph with the one before it.
235 * Ignore CT (this is used in \c acceptChange, \c rejectChange for
236 * physical deletion of paragraph break)
238 bool backspacePos0(LCursor & cur);
239 /// Delete character before cursor. Honour CT
240 bool backspace(LCursor & cur);
241 // Dissolve the inset under cursor
242 bool dissolveInset(LCursor & cur);
244 bool selectWordWhenUnderCursor(LCursor & cur, word_location);
250 text_capitalization = 1,
254 /// Change the case of the word at cursor position.
255 void changeCase(LCursor & cur, TextCase action);
256 /// Transposes the character at the cursor with the one before it
257 void charsTranspose(LCursor & cur);
259 /** the DTP switches for paragraphs. LyX will store the top settings
260 always in the first physical paragraph, the bottom settings in the
261 last. When a paragraph is broken, the top settings rest, the bottom
262 settings are given to the new one.
264 void setParagraph(LCursor & cur,
265 Spacing const & spacing,
267 docstring const & labelwidthstring,
270 /* these things are for search and replace */
272 /// needed to insert the selection
273 void insertStringAsLines(LCursor & cur, docstring const & str);
274 /// needed to insert the selection
275 void insertStringAsParagraphs(LCursor & cur, docstring const & str);
277 /// current text width
280 /// current text heigth
283 /// Returns an inset if inset was hit, or 0 if not.
284 InsetBase * checkInsetHit(BufferView const &, int x, int y) const;
287 int singleWidth(Buffer const &, Paragraph const & par,
290 int singleWidth(Paragraph const & par, pos_type pos, char_type c,
291 LyXFont const & Font) const;
293 /// return the color of the canvas
294 LColor_color backgroundColor() const;
297 * Returns the left beginning of the text.
298 * This information cannot be taken from the layout object, because
299 * in LaTeX the beginning of the text fits in some cases
300 * (for example sections) exactly the label-width.
302 int leftMargin(Buffer const &, pit_type pit, pos_type pos) const;
303 int leftMargin(Buffer const &, pit_type pit) const;
305 int rightMargin(Buffer const &, Paragraph const & par) const;
307 /** this calculates the specified parameters. needed when setting
308 * the cursor and when creating a visible row */
309 RowMetrics computeRowMetrics(Buffer const &, pit_type pit,
310 Row const & row) const;
312 /// access to our paragraphs
313 ParagraphList const & paragraphs() const { return pars_; }
314 ParagraphList & paragraphs() { return pars_; }
315 /// return true if this is the main text
316 bool isMainText(Buffer const &) const;
318 /// return first row of text
319 Row const & firstRow() const;
321 /// is this row the last in the text?
322 bool isLastRow(pit_type pit, Row const & row) const;
323 /// is this row the first in the text?
324 bool isFirstRow(pit_type pit, Row const & row) const;
327 double spacing(Buffer const & buffer, Paragraph const & par) const;
328 /// make a suggestion for a label
329 docstring getPossibleLabel(LCursor & cur) const;
330 /// is this paragraph right-to-left?
331 bool isRTL(Buffer const &, Paragraph const & par) const;
333 bool checkAndActivateInset(LCursor & cur, bool front);
336 void write(Buffer const & buf, std::ostream & os) const;
337 /// returns whether we've seen our usual 'end' marker
338 bool read(Buffer const & buf, LyXLex & lex, ErrorList & errorList);
345 int cursorX(Buffer const &, CursorSlice const & cursor,
346 bool boundary) const;
348 int cursorY(CursorSlice const & cursor, bool boundary) const;
350 /// delete double space or empty paragraphs around old cursor
351 bool deleteEmptyParagraphMechanism(LCursor & cur, LCursor & old);
358 /// the current font settings
359 LyXFont current_font;
361 LyXFont real_current_font;
363 int background_color_;
370 /// our 'outermost' font. This is handed down from the surrounding
371 // inset through the pi/mi parameter (pi.base.font)
377 /// return past-the-last paragraph influenced by a layout
379 pit_type undoSpan(pit_type pit);
381 /// Calculate and set the height of the row
382 void setHeightOfRow(BufferView const &, pit_type, Row & row);
384 // fix the cursor `cur' after a characters has been deleted at `where'
385 // position. Called by deleteEmptyParagraphMechanism
386 void fixCursorAfterDelete(CursorSlice & cur, CursorSlice const & where);
389 void deleteWordForward(LCursor & cur);
391 void deleteWordBackward(LCursor & cur);
393 void deleteLineForward(LCursor & cur);
395 /// sets row.end to the pos value *after* which a row should break.
396 /// for example, the pos after which isNewLine(pos) == true
397 void rowBreakPoint(Buffer const &, int right_margin, pit_type pit,
399 /// sets row.width to the minimum space a row needs on the screen in pixel
400 void setRowWidth(Buffer const &, pit_type pit, Row & row) const;
401 /// the minimum space a manual label needs on the screen in pixels
402 int labelFill(Buffer const &, Paragraph const & par, Row const & row) const;
404 int labelEnd(Buffer const &, pit_type pit) const;
408 /// set 'number' font property
409 void number(LCursor & cur);
412 /// return the default height of a row in pixels, considering font zoom
413 int defaultRowHeight();