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 "lyxcursor.h"
21 #include "insets/inset.h"
23 #include "bufferview_funcs.h"
24 #include "textcursor.h"
40 This class holds the mapping between buffer paragraphs and screen rows.
43 // The inheritance from TextCursor should go. It's just there to ease
45 class LyXText : public TextCursor {
48 LyXText(BufferView *);
49 /// sets inset as owner
50 LyXText(BufferView *, InsetText *);
52 void init(BufferView *);
57 /// the current font settings
60 LyXFont real_current_font;
62 /** the 'anchor' row: the position of this row remains constant
63 * with respect to the top of the screen
65 RowList::iterator anchor_row_;
66 /** the pixel offset with respect to this row of top_y
68 int anchor_row_offset_;
70 /// update all cached row positions
71 void updateRowPositions();
72 /// get the y coord. of the top of the screen (relative to doc start)
74 /// set the y coord. of the top of the screen (relative to doc start)
76 /// set the anchoring row. top_y will be computed relative to this
77 void anchor_row(RowList::iterator rit);
79 InsetText * inset_owner;
81 UpdatableInset * the_locking_inset;
84 int getRealCursorX() const;
86 LyXFont const getFont(Buffer const *, ParagraphList::iterator pit,
87 lyx::pos_type pos) const;
89 LyXFont const getLayoutFont(Buffer const *,
90 ParagraphList::iterator pit) const;
92 LyXFont const getLabelFont(Buffer const *,
93 ParagraphList::iterator pit) const;
95 void setCharFont(Buffer const *, ParagraphList::iterator pit,
96 lyx::pos_type pos, LyXFont const & font);
97 void setCharFont(ParagraphList::iterator pit,
99 LyXFont const & font, bool toggleall);
102 void breakAgainOneRow(RowList::iterator rit);
103 /// what you expect when pressing <enter> at cursor position
104 void breakParagraph(ParagraphList & paragraphs, char keep_layout = 0);
106 /** set layout over selection and make a total rebreak of
109 ParagraphList::iterator
110 setLayout(LyXCursor & actual_cursor,
111 LyXCursor & selection_start,
112 LyXCursor & selection_end,
113 string const & layout);
115 void setLayout(string const & layout);
118 * Increase or decrease the nesting depth of the selected paragraph(s)
119 * if test_only, don't change any depths. Returns whether something
120 * (would have) changed
122 bool changeDepth(bv_funcs::DEPTH_CHANGE type, bool test_only);
124 /// get the depth at current cursor position
125 int getDepth() const;
127 /** set font over selection and make a total rebreak of those
129 toggleall defaults to false.
131 void setFont(LyXFont const &, bool toggleall = false);
133 /** deletes and inserts again all paragaphs between the cursor
134 and the specified par. The Cursor is needed to set the refreshing
136 This function is needed after SetLayout and SetFont etc.
138 void redoParagraphs(LyXCursor const & cursor,
139 ParagraphList::iterator endpit);
141 void redoParagraph();
144 void toggleFree(LyXFont const &, bool toggleall = false);
147 string getStringToIndex();
149 /** recalculates the heights of all previous rows of the
150 specified paragraph. needed, if the last characters font
153 void redoHeightOfParagraph();
155 /** insert a character, moves all the following breaks in the
156 same Paragraph one to the right and make a little rebreak
158 void insertChar(char c);
160 void insertInset(Inset * inset);
162 /// Completes the insertion with a rebreak from 'need_break_row' on
163 void partialRebreak();
164 /// a full rebreak of the whole text
168 RowList::iterator need_break_row;
170 /// clear any pending paints
173 /// submit repaint request
177 Inset::RESULT dispatch(FuncRequest const & cmd);
181 BufferView * bv() const;
183 friend class LyXScreen;
186 * Return the status. This represents what repaints are
187 * pending after some operation (e.g. inserting a char).
189 bool needRefresh() const;
192 // do we need a refresh?
196 /// only the top-level LyXText has this non-zero
197 BufferView * bv_owner;
200 /// returns a pointer to a specified row.
202 getRow(ParagraphList::iterator pit, lyx::pos_type pos) const;
204 /// returns a pointer cursor row
205 RowList::iterator getRow(LyXCursor const & cursor) const;
207 RowList::iterator cursorRow() const;
209 /** returns a pointer to the row near the specified y-coordinate
210 (relative to the whole text). y is set to the real beginning
213 RowList::iterator getRowNearY(int & y) const;
215 /** returns the column near the specified x-coordinate of the row
216 x is set to the real beginning of this column
218 lyx::pos_type getColumnNearX(RowList::iterator rit,
219 int & x, bool & boundary) const;
221 /** returns a pointer to a specified row. y is set to the beginning
225 getRow(ParagraphList::iterator pit, lyx::pos_type pos, int & y) const;
227 RowList & rows() const {
232 /// need the selection cursor:
235 void clearSelection();
237 /// select the word we need depending on word_location
238 void getWord(LyXCursor & from, LyXCursor & to, lyx::word_location const);
239 /// just selects the word the cursor is in
240 void selectWord(lyx::word_location loc);
241 /// returns the inset at cursor (if it exists), 0 otherwise
242 Inset * getInset() const;
244 /// accept selected change
247 /// reject selected change
250 /** 'selects" the next word, where the cursor is not in
251 and returns this word as string. THe cursor will be moved
252 to the beginning of this word.
253 With SelectSelectedWord can this be highlighted really
255 WordLangTuple const selectNextWordToSpellcheck(float & value);
257 void selectSelectedWord();
258 /// returns true if par was empty and was removed
259 bool setCursor(ParagraphList::iterator pit,
262 bool boundary = false);
264 void setCursor(LyXCursor &, ParagraphList::iterator pit,
266 bool boundary = false);
268 void setCursorIntern(ParagraphList::iterator pit,
271 bool boundary = false);
273 void setCurrentFont();
276 bool isBoundary(Buffer const *, Paragraph const & par,
277 lyx::pos_type pos) const;
279 bool isBoundary(Buffer const *, Paragraph const & par,
281 LyXFont const & font) const;
284 void setCursorFromCoordinates(int x, int y);
286 void setCursorFromCoordinates(LyXCursor &,
289 void cursorUp(bool selecting = false);
291 void cursorDown(bool selecting = false);
293 void cursorLeft(bool internal = true);
295 void cursorRight(bool internal = true);
297 void cursorLeftOneWord();
299 void cursorRightOneWord();
301 void cursorUpParagraph();
303 void cursorDownParagraph();
309 void cursorPrevious();
321 bool selectWordWhenUnderCursor(lyx::word_location);
327 text_capitalization = 1,
331 /// Change the case of the word at cursor position.
332 void changeCase(TextCase action);
337 void cutSelection(bool doclear = true, bool realcut = true);
339 void copySelection();
341 void pasteSelection(size_t sel_index = 0);
343 /** the DTP switches for paragraphs. LyX will store the top settings
344 always in the first physical paragraph, the bottom settings in the
345 last. When a paragraph is broken, the top settings rest, the bottom
346 settings are given to the new one. So I can make shure, they do not
347 duplicate themself (and you cannnot make dirty things with them! )
349 void setParagraph(bool line_top, bool line_bottom,
350 bool pagebreak_top, bool pagebreak_bottom,
351 VSpace const & space_top,
352 VSpace const & space_bottom,
353 Spacing const & spacing,
355 string const & labelwidthstring,
358 /* these things are for search and replace */
361 * Sets the selection from the current cursor position to length
362 * characters to the right. No safety checks.
364 void setSelectionRange(lyx::pos_type length);
366 /** simple replacing. The font of the first selected character
369 void replaceSelectionWithString(string const & str);
371 /// needed to insert the selection
372 void insertStringAsLines(string const & str);
373 /// needed to insert the selection
374 void insertStringAsParagraphs(string const & str);
376 /// Find next inset of some specified type.
377 bool gotoNextInset(std::vector<Inset::Code> const & codes,
378 string const & contents = string());
380 void gotoInset(std::vector<Inset::Code> const & codes,
383 void gotoInset(Inset::Code code, bool same_content);
386 /* for the greater insets */
388 /// returns false if inset wasn't found
389 bool updateInset(Inset *);
391 void checkParagraph(ParagraphList::iterator pit, lyx::pos_type pos);
393 int workWidth() const;
394 /// returns width of row containing inset
395 int workWidth(Inset const * inset) const;
398 void computeBidiTables(Buffer const *, RowList::iterator row) const;
399 /// Maps positions in the visual string to positions in logical string.
400 lyx::pos_type log2vis(lyx::pos_type pos) const;
401 /// Maps positions in the logical string to positions in visual string.
402 lyx::pos_type vis2log(lyx::pos_type pos) const;
404 lyx::pos_type bidi_level(lyx::pos_type pos) const;
406 bool bidi_InRange(lyx::pos_type pos) const;
409 mutable RowList rowlist_;
412 float getCursorX(RowList::iterator rit, lyx::pos_type pos,
413 lyx::pos_type last, bool boundary) const;
414 /// used in setlayout
415 void makeFontEntriesLayoutSpecific(Buffer const &, Paragraph & par);
417 /** forces the redrawing of a paragraph. Needed when manipulating a
420 void redoDrawingOfParagraph(LyXCursor const & cursor);
422 /// removes the row and reset the touched counters
423 void removeRow(RowList::iterator rit);
425 /// remove all following rows of the paragraph of the specified row.
426 void removeParagraph(RowList::iterator rit);
428 /// insert the specified paragraph behind the specified row
429 void insertParagraph(ParagraphList::iterator pit,
430 RowList::iterator rowit);
432 /** appends the implizit specified paragraph behind the specified row,
433 * start at the implizit given position */
434 void appendParagraph(RowList::iterator rowit);
437 void breakAgain(RowList::iterator rit);
438 /// Calculate and set the height of the row
439 void setHeightOfRow(RowList::iterator rit);
441 // fix the cursor `cur' after a characters has been deleted at `where'
442 // position. Called by deleteEmptyParagraphMechanism
443 void fixCursorAfterDelete(LyXCursor & cur,
444 LyXCursor const & where);
446 /// delete double space (false) or empty paragraphs (true) around old_cursor
447 bool deleteEmptyParagraphMechanism(LyXCursor const & old_cursor);
450 /** Updates all counters starting BEHIND the row. Changed paragraphs
451 * with a dynamic left margin will be rebroken. */
452 void updateCounters();
456 * Returns an inset if inset was hit, or 0 if not.
457 * If hit, the coordinates are changed relative to the inset.
459 Inset * checkInsetHit(int & x, int & y);
462 int singleWidth(ParagraphList::iterator pit,
463 lyx::pos_type pos) const;
465 int singleWidth(ParagraphList::iterator pit,
466 lyx::pos_type pos, char c) const;
468 /// return the color of the canvas
469 LColor::color backgroundColor() const;
472 mutable bool bidi_same_direction;
474 unsigned char transformChar(unsigned char c, Paragraph const & par,
475 lyx::pos_type pos) const;
478 * Returns the left beginning of the text.
479 * This information cannot be taken from the layout object, because
480 * in LaTeX the beginning of the text fits in some cases
481 * (for example sections) exactly the label-width.
483 int leftMargin(Row const & row) const;
485 int rightMargin(Buffer const &, Row const & row) const;
487 /** this calculates the specified parameters. needed when setting
488 * the cursor and when creating a visible row */
489 void prepareToPrint(RowList::iterator row, float & x,
490 float & fill_separator,
492 float & fill_label_hfill,
493 bool bidi = true) const;
497 void setCounter(Buffer const *, ParagraphList::iterator pit);
499 void deleteWordForward();
501 void deleteWordBackward();
503 void deleteLineForward();
506 * some low level functions
510 /// return the pos value *before* which a row should break.
511 /// for example, the pos at which IsNewLine(pos) == true
512 lyx::pos_type rowBreakPoint(Row const & row) const;
514 /// returns the minimum space a row needs on the screen in pixel
515 int fill(RowList::iterator row, int workwidth) const;
518 * returns the minimum space a manual label needs on the
521 int labelFill(Row const & row) const;
524 int labelEnd(Row const & row) const;
527 mutable std::vector<lyx::pos_type> log2vis_list;
529 mutable std::vector<lyx::pos_type> vis2log_list;
531 mutable std::vector<lyx::pos_type> bidi_levels;
533 mutable lyx::pos_type bidi_start;
535 mutable lyx::pos_type bidi_end;
541 // special owner functions
543 ParagraphList & ownerParagraphs() const;
545 /// return true if this is owned by an inset.
546 bool isInInset() const;
549 /** Cursor related data.
550 Later this variable has to be removed. There should be now internal
553 ///TextCursor cursor_;
556 /// return the default height of a row in pixels, considering font zoom
557 extern int defaultRowHeight();