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"
47 /// This class encapsulates the main text data and operations in LyX
51 typedef lyx::pos_type pos_type;
53 typedef lyx::pit_type pit_type;
56 explicit LyXText(BufferView *);
58 void init(BufferView *);
61 LyXFont getFont(Paragraph const & par, pos_type pos) const;
63 void applyOuterFont(LyXFont &) const;
65 LyXFont getLayoutFont(pit_type pit) const;
67 LyXFont getLabelFont(Paragraph const & par) const;
69 void setCharFont(pit_type pit, pos_type pos, LyXFont const & font);
71 void setCharFont(pit_type pit, pos_type pos, LyXFont const & font,
74 /// what you expect when pressing <enter> at cursor position
75 void breakParagraph(LCursor & cur, bool keep_layout = false);
77 /// set layout over selection
78 void setLayout(pit_type start, pit_type end,
79 std::string const & layout);
81 void setLayout(LCursor & cur, std::string const & layout);
83 /// what type of depth change to make
88 /// Increase or decrease the nesting depth of the selected paragraph(s)
89 void changeDepth(LCursor & cur, DEPTH_CHANGE type);
91 /// Returns whether something would be changed by changeDepth
92 bool changeDepthAllowed(LCursor & cur, DEPTH_CHANGE type) const;
94 /// Set font over selection paragraphs and rebreak.
95 void setFont(LCursor & cur, LyXFont const &, bool toggleall = false);
97 /// rebreaks the given par
98 bool redoParagraph(pit_type pit);
100 /// returns pos in given par at given x coord
101 pos_type x2pos(pit_type pit, int row, int x) const;
102 int pos2x(pit_type pit, pos_type pos) const;
105 void toggleFree(LCursor & cur, LyXFont const &, bool toggleall = false);
108 std::string getStringToIndex(LCursor const & cur);
110 /// insert a character at cursor position
111 void insertChar(LCursor & cur, lyx::char_type c);
112 /// insert an inset at cursor position
113 void insertInset(LCursor & cur, InsetBase * inset);
115 /// compute text metrics
116 void metrics(MetricsInfo & mi, Dimension & dim);
117 /// draw text (only used for insets)
118 void draw(PainterInfo & pi, int x, int y) const;
119 /// draw textselection
120 void drawSelection(PainterInfo & pi, int x, int y) const;
122 /// try to handle that request
123 void dispatch(LCursor & cur, FuncRequest & cmd);
124 /// do we want to handle this event?
125 bool getStatus(LCursor & cur, FuncRequest const & cmd,
126 FuncStatus & status) const;
128 /// access to out BufferView. This should go...
129 BufferView * bv() const;
131 /// read-only access to individual paragraph
132 Paragraph const & getPar(pit_type pit) const { return pars_[pit]; }
133 /// read-write access to individual paragraph
134 Paragraph & getPar(pit_type pit) { return pars_[pit]; }
135 // Returns the current font and depth as a message.
136 std::string currentState(LCursor & cur);
138 /** returns row near the specified
139 * y-coordinate in given paragraph (relative to the screen).
141 Row const & getRowNearY(int y, pit_type pit) const;
142 pit_type getPitNearY(int y) const;
144 /** returns the column near the specified x-coordinate of the row
145 x is set to the real beginning of this column
147 pos_type getColumnNearX(pit_type pit,
148 Row const & row, int & x, bool & boundary) const;
150 /** Find the word under \c from in the relative location
151 * defined by \c word_location.
152 * @param from return here the start of the word
153 * @param to return here the end of the word
155 void getWord(CursorSlice & from, CursorSlice & to, lyx::word_location const);
156 /// just selects the word the cursor is in
157 void selectWord(LCursor & cur, lyx::word_location loc);
159 /// accept selected change
160 void acceptChange(LCursor & cur);
161 /// reject selected change
162 void rejectChange(LCursor & cur);
164 /// returns true if par was empty and was removed
165 bool setCursor(LCursor & cur, pit_type par, pos_type pos,
166 bool setfont = true, bool boundary = false);
168 void setCursor(CursorSlice &, pit_type par, pos_type pos);
170 void setCursorIntern(LCursor & cur, pit_type par,
171 pos_type pos, bool setfont = true, bool boundary = false);
173 void setCurrentFont(LCursor & cur);
176 void recUndo(pit_type first, pit_type last) const;
178 void recUndo(pit_type first) const;
179 /// returns true if par was empty and was removed
180 bool setCursorFromCoordinates(LCursor & cur, int x, int y);
182 InsetBase * editXY(LCursor & cur, int x, int y);
183 /// Move cursor one line up.
185 * Returns true if an update is needed after the move.
187 bool cursorUp(LCursor & cur);
188 /// Move cursor one line down.
190 * Returns true if an update is needed after the move.
192 bool cursorDown(LCursor & cur);
193 /// Move cursor one position left
195 * Returns true if an update is needed after the move.
197 bool cursorLeft(LCursor & cur);
198 /// Move cursor one position right
200 * Returns true if an update is needed after the move.
202 bool cursorRight(LCursor & cur);
204 bool cursorLeftOneWord(LCursor & cur);
206 bool cursorRightOneWord(LCursor & cur);
208 bool cursorUpParagraph(LCursor & cur);
210 bool cursorDownParagraph(LCursor & cur);
212 bool cursorHome(LCursor & cur);
214 bool cursorEnd(LCursor & cur);
216 bool cursorPrevious(LCursor & cur);
218 bool cursorNext(LCursor & cur);
220 bool cursorTop(LCursor & cur);
222 bool cursorBottom(LCursor & cur);
223 /// Erase character at cursor. Honour change tracking
224 bool erase(LCursor & cur);
225 /** At cursor position 0, merge paragraph with the one before it.
226 * Ignore CT (this is used in \c acceptChange, \c rejectChange for
227 * physical deletion of paragraph break)
229 bool backspacePos0(LCursor & cur);
230 /// Delete character before cursor. Honour CT
231 bool backspace(LCursor & cur);
233 bool selectWordWhenUnderCursor(LCursor & cur, lyx::word_location);
239 text_capitalization = 1,
243 /// Change the case of the word at cursor position.
244 void changeCase(LCursor & cur, TextCase action);
246 /** the DTP switches for paragraphs. LyX will store the top settings
247 always in the first physical paragraph, the bottom settings in the
248 last. When a paragraph is broken, the top settings rest, the bottom
249 settings are given to the new one.
251 void setParagraph(LCursor & cur,
252 Spacing const & spacing,
254 std::string const & labelwidthstring,
257 /* these things are for search and replace */
259 /// needed to insert the selection
260 void insertStringAsLines(LCursor & cur, std::string const & str);
261 /// needed to insert the selection
262 void insertStringAsParagraphs(LCursor & cur, std::string const & str);
264 /// current text width
267 /// current text heigth
270 /// Returns an inset if inset was hit, or 0 if not.
271 InsetBase * checkInsetHit(int x, int y) const;
274 int singleWidth(Paragraph const & par, pos_type pos) const;
276 int singleWidth(Paragraph const & par,
277 pos_type pos, char c, LyXFont const & Font) const;
279 /// return the color of the canvas
280 LColor_color backgroundColor() const;
283 * Returns the left beginning of the text.
284 * This information cannot be taken from the layout object, because
285 * in LaTeX the beginning of the text fits in some cases
286 * (for example sections) exactly the label-width.
288 int leftMargin(pit_type pit, pos_type pos) const;
289 int leftMargin(pit_type pit) const;
291 int rightMargin(Paragraph const & par) const;
293 /** this calculates the specified parameters. needed when setting
294 * the cursor and when creating a visible row */
295 RowMetrics computeRowMetrics(pit_type pit, Row const & row) const;
297 /// access to our paragraphs
298 ParagraphList const & paragraphs() const { return pars_; }
299 ParagraphList & paragraphs() { return pars_; }
300 /// return true if this is the main text
301 bool isMainText() const;
303 /// return first row of text
304 Row const & firstRow() const;
306 /// is this row the last in the text?
307 bool isLastRow(pit_type pit, Row const & row) const;
308 /// is this row the first in the text?
309 bool isFirstRow(pit_type pit, Row const & row) const;
312 double spacing(Paragraph const & par) const;
313 /// make a suggestion for a label
314 std::string getPossibleLabel(LCursor & cur) const;
315 /// is this paragraph right-to-left?
316 bool isRTL(Paragraph const & par) const;
318 bool checkAndActivateInset(LCursor & cur, bool front);
321 void write(Buffer const & buf, std::ostream & os) const;
322 /// returns whether we've seen our usual 'end' marker
323 bool read(Buffer const & buf, LyXLex & lex);
330 int cursorX(CursorSlice const & cursor, bool boundary) const;
332 int cursorY(CursorSlice const & cursor, bool boundary) const;
334 /// delete double space or empty paragraphs around old cursor
335 bool deleteEmptyParagraphMechanism(LCursor & cur, LCursor & old);
342 /// the current font settings
343 LyXFont current_font;
345 LyXFont real_current_font;
347 int background_color_;
349 /// only the top-level LyXText has this non-zero
350 BufferView * bv_owner;
357 /// our 'outermost' font. This is handed down from the surrounding
358 // inset through the pi/mi parameter (pi.base.font)
364 /// return past-the-last paragraph influenced by a layout
366 pit_type undoSpan(pit_type pit);
368 /// Calculate and set the height of the row
369 void setHeightOfRow(pit_type, Row & row);
371 // fix the cursor `cur' after a characters has been deleted at `where'
372 // position. Called by deleteEmptyParagraphMechanism
373 void fixCursorAfterDelete(CursorSlice & cur, CursorSlice const & where);
376 void deleteWordForward(LCursor & cur);
378 void deleteWordBackward(LCursor & cur);
380 void deleteLineForward(LCursor & cur);
382 /// sets row.end to the pos value *after* which a row should break.
383 /// for example, the pos after which isNewLine(pos) == true
384 void rowBreakPoint(pit_type pit, Row & row) const;
385 /// sets row.width to the minimum space a row needs on the screen in pixel
386 void setRowWidth(pit_type pit, Row & row) const;
387 /// the minimum space a manual label needs on the screen in pixels
388 int labelFill(Paragraph const & par, Row const & row) const;
390 int labelEnd(pit_type pit) const;
394 /// set 'number' font property
395 void number(LCursor & cur);
398 /// return the default height of a row in pixels, considering font zoom
399 int defaultRowHeight();