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"
21 #include "lyxtextclass.h"
22 #include "ParagraphList_fwd.h"
23 #include "RowList_fwd.h"
24 #include "textcursor.h"
26 #include "insets/inset.h"
45 This class used to hold the mapping between buffer paragraphs and
46 screen rows. Nowadays, the Paragraphs take care of their rows
47 themselves and this contains just most of the code for manipulating
48 them and interaction with the Cursor.
51 // The inheritance from TextCursor should go. It's just there to ease
53 class LyXText : public TextCursor {
57 LyXText(BufferView *, bool ininset);
59 void init(BufferView *);
62 /// update y coordinate cache of all paragraphs
63 void updateParPositions();
65 LyXFont getFont(ParagraphList::iterator pit, lyx::pos_type pos) const;
67 LyXFont getLayoutFont(ParagraphList::iterator pit) const;
69 LyXFont getLabelFont(ParagraphList::iterator pit) const;
71 void setCharFont(ParagraphList::iterator pit,
72 lyx::pos_type pos, LyXFont const & font);
73 void setCharFont(ParagraphList::iterator pit,
75 LyXFont const & font, bool toggleall);
77 /// what you expect when pressing <enter> at cursor position
78 void breakParagraph(ParagraphList & paragraphs, char keep_layout = 0);
80 /** set layout over selection and make a total rebreak of
83 ParagraphList::iterator
84 setLayout(ParagraphList::iterator start,
85 ParagraphList::iterator end,
86 std::string const & layout);
88 void setLayout(std::string const & layout);
90 /// Increase or decrease the nesting depth of the selected paragraph(s)
91 void changeDepth(bv_funcs::DEPTH_CHANGE type);
93 /// Returns whether something would be changed by changeDepth
94 bool changeDepthAllowed(bv_funcs::DEPTH_CHANGE type);
96 /// get the depth at current cursor position
99 /** set font over selection and make a total rebreak of those
101 toggleall defaults to false.
103 void setFont(LyXFont const &, bool toggleall = false);
105 /// rebreaks all paragaphs between the given pars.
106 void redoParagraphs(ParagraphList::iterator begin,
107 ParagraphList::iterator end);
108 /// rebreaks the given par
109 void redoParagraph(ParagraphList::iterator pit);
111 /// rebreaks the cursor par
112 void redoParagraph();
115 void toggleFree(LyXFont const &, bool toggleall = false);
118 std::string getStringToIndex();
120 /** insert a character, moves all the following breaks in the
121 same Paragraph one to the right and make a little rebreak
123 void insertChar(char c);
125 void insertInset(InsetOld * inset);
127 /// a full rebreak of the whole text
129 /// compute text metrics
130 void metrics(MetricsInfo & mi, Dimension & dim);
131 /// draw text (only used for insets)
132 void draw(PainterInfo & pi, int x, int y) const;
134 /// try to handle that request
135 DispatchResult dispatch(FuncRequest const & cmd);
139 BufferView * bv() const;
141 friend class LyXScreen;
143 /// returns an iterator pointing to a cursor paragraph
144 ParagraphList::iterator getPar(LyXCursor const & cursor) const;
146 ParagraphList::iterator getPar(lyx::paroffset_type par) const;
148 int parOffset(ParagraphList::iterator pit) const;
150 ParagraphList::iterator cursorPar() const;
152 RowList::iterator cursorRow() const;
154 /** returns an iterator pointing to the row near the specified
155 * y-coordinate (relative to the whole text). y is set to the
156 * real beginning of this row
158 RowList::iterator getRowNearY(int y,
159 ParagraphList::iterator & pit) const;
161 /** returns the column near the specified x-coordinate of the row
162 x is set to the real beginning of this column
164 lyx::pos_type getColumnNearX(ParagraphList::iterator pit,
165 Row const & row, int & x, bool & boundary) const;
167 /// need the selection cursor:
170 void clearSelection();
172 /// select the word we need depending on word_location
173 void getWord(LyXCursor & from, LyXCursor & to, lyx::word_location const);
174 /// just selects the word the cursor is in
175 void selectWord(lyx::word_location loc);
176 /// returns the inset at cursor (if it exists), 0 otherwise
177 InsetOld * getInset() const;
179 /// accept selected change
182 /// reject selected change
186 void setCursor(ParagraphList::iterator pit, lyx::pos_type pos);
187 /// returns true if par was empty and was removed
188 bool setCursor(lyx::paroffset_type par, lyx::pos_type pos,
189 bool setfont = true, bool boundary = false);
191 void setCursor(LyXCursor &, lyx::paroffset_type par,
192 lyx::pos_type pos, bool boundary = false);
194 void setCursorIntern(lyx::paroffset_type par, lyx::pos_type pos,
195 bool setfont = true, bool boundary = false);
197 void setCurrentFont();
200 void recUndo(lyx::paroffset_type first, lyx::paroffset_type last) const;
202 void recUndo(lyx::paroffset_type first) const;
204 void setCursorFromCoordinates(int x, int y);
206 void setCursorFromCoordinates(LyXCursor &, int x, int y);
208 void cursorUp(bool selecting = false);
210 void cursorDown(bool selecting = false);
212 bool cursorLeft(bool internal = true);
214 bool cursorRight(bool internal = true);
216 void cursorLeftOneWord();
218 void cursorRightOneWord();
220 void cursorUpParagraph();
222 void cursorDownParagraph();
228 void cursorPrevious();
240 bool selectWordWhenUnderCursor(lyx::word_location);
246 text_capitalization = 1,
250 /// Change the case of the word at cursor position.
251 void changeCase(TextCase action);
256 void cutSelection(bool doclear = true, bool realcut = true);
258 void copySelection();
260 void pasteSelection(size_t sel_index = 0);
262 /** the DTP switches for paragraphs. LyX will store the top settings
263 always in the first physical paragraph, the bottom settings in the
264 last. When a paragraph is broken, the top settings rest, the bottom
265 settings are given to the new one.
268 Spacing const & spacing,
270 std::string const & labelwidthstring,
273 /* these things are for search and replace */
276 * Sets the selection from the current cursor position to length
277 * characters to the right. No safety checks.
279 void setSelectionRange(lyx::pos_type length);
281 /** simple replacing. The font of the first selected character
284 void replaceSelectionWithString(std::string const & str);
286 /// needed to insert the selection
287 void insertStringAsLines(std::string const & str);
288 /// needed to insert the selection
289 void insertStringAsParagraphs(std::string const & str);
291 /// Find next inset of some specified type.
292 bool gotoNextInset(std::vector<InsetOld::Code> const & codes,
293 std::string const & contents = std::string());
295 void gotoInset(std::vector<InsetOld::Code> const & codes,
298 void gotoInset(InsetOld::Code code, bool same_content);
300 /// current max text width
301 int textWidth() const;
303 /// updates all counters
304 void updateCounters();
305 /// Returns an inset if inset was hit, or 0 if not.
306 InsetOld * checkInsetHit(int x, int y);
309 int singleWidth(ParagraphList::iterator pit, lyx::pos_type pos) const;
311 int singleWidth(ParagraphList::iterator pit,
312 lyx::pos_type pos, char c, LyXFont const & Font) const;
314 /// return the color of the canvas
315 LColor_color backgroundColor() const;
318 * Returns the left beginning of the text.
319 * This information cannot be taken from the layout object, because
320 * in LaTeX the beginning of the text fits in some cases
321 * (for example sections) exactly the label-width.
323 int leftMargin(ParagraphList::iterator pit, lyx::pos_type pos) const;
324 int leftMargin(ParagraphList::iterator pit) const;
326 int rightMargin(Paragraph const & par) const;
328 /** this calculates the specified parameters. needed when setting
329 * the cursor and when creating a visible row */
330 void prepareToPrint(ParagraphList::iterator pit, Row & row) const;
333 // special owner functions
335 ParagraphList & paragraphs() const;
337 /// return true if this is owned by an inset.
338 bool isInInset() const;
341 ParagraphList::iterator firstPar() const;
343 ParagraphList::iterator lastPar() const;
345 ParagraphList::iterator endPar() const;
347 /// return first row of text
348 RowList::iterator firstRow() const;
349 /// return last row of text
350 RowList::iterator lastRow() const;
351 /// return row "behind" last row of text
352 RowList::iterator endRow() const;
353 /// return next row crossing paragraph boundaries
354 void nextRow(ParagraphList::iterator & pit,
355 RowList::iterator & rit) const;
356 /// return previous row crossing paragraph boundaries
357 void previousRow(ParagraphList::iterator & pit,
358 RowList::iterator & rit) const;
360 /// is this row the last in the text?
361 bool isLastRow(ParagraphList::iterator pit, Row const & row) const;
362 /// is this row the first in the text?
363 bool isFirstRow(ParagraphList::iterator pit, Row const & row) const;
366 std::string selectionAsString(Buffer const & buffer, bool label) const;
368 double spacing(Paragraph const &) const;
370 void cursorLeftOneWord(LyXCursor &);
372 void cursorRightOneWord(LyXCursor &);
375 DispatchResult moveRight();
377 DispatchResult moveLeft();
379 DispatchResult moveRightIntern(bool front,
380 bool activate_inset, bool selecting);
382 DispatchResult moveLeftIntern(bool front,
383 bool activate_inset, bool selecting);
385 DispatchResult moveUp();
387 DispatchResult moveDown();
389 bool checkAndActivateInset(bool front);
392 void write(Buffer const & buf, std::ostream & os) const;
393 /// returns whether we've seen our usual 'end' marker
394 bool read(Buffer const & buf, LyXLex & lex);
405 int cursorX(LyXCursor const & cursor) const;
407 int cursorY(LyXCursor const & cursor) const;
416 /// the current font settings
417 LyXFont current_font;
419 LyXFont real_current_font;
420 /// our buffer's default layout font
421 LyXFont defaultfont_;
423 int background_color_;
425 /// only the top-level LyXText has this non-zero
426 BufferView * bv_owner;
433 ParagraphList paragraphs_;
435 /// absolute document pixel coordinates of this LyXText
439 /// our 'outermost' Font
444 /// return past-the-last paragraph influenced by a layout
446 ParagraphList::iterator undoSpan(ParagraphList::iterator pit);
448 /// rebreaks the given par
449 void redoParagraphInternal(ParagraphList::iterator pit);
450 /// used in setlayout
451 void makeFontEntriesLayoutSpecific(BufferParams const &, Paragraph & par);
453 /// Calculate and set the height of the row
454 void setHeightOfRow(ParagraphList::iterator, Row & row);
456 // fix the cursor `cur' after a characters has been deleted at `where'
457 // position. Called by deleteEmptyParagraphMechanism
458 void fixCursorAfterDelete(LyXCursor & cur, LyXCursor const & where);
460 /// delete double space (false) or empty paragraphs (true) around old_cursor
461 bool deleteEmptyParagraphMechanism(LyXCursor const & old_cursor);
464 void setCounter(Buffer const &, ParagraphList::iterator pit);
466 void deleteWordForward();
468 void deleteWordBackward();
470 void deleteLineForward();
472 /// sets row.end to the pos value *after* which a row should break.
473 /// for example, the pos after which isNewLine(pos) == true
474 void rowBreakPoint(ParagraphList::iterator pit, Row & row) const;
476 /// sets row.witdh to the minimum space a row needs on the screen in pixel
477 void fill(ParagraphList::iterator pit, Row & row, int workwidth) const;
480 * returns the minimum space a manual label needs on the
483 int labelFill(ParagraphList::iterator pit, Row const & row) const;
486 int labelEnd(ParagraphList::iterator pit) const;
490 /// set 'number' font property
492 /// is the cursor paragraph right-to-left?
496 /// return the default height of a row in pixels, considering font zoom
497 extern int defaultRowHeight();
500 std::string expandLabel(LyXTextClass const & textclass,
501 LyXLayout_ptr const & layout, bool appendix);