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"
42 This class holds the mapping between buffer paragraphs and screen rows.
45 // The inheritance from TextCursor should go. It's just there to ease
47 class LyXText : public TextCursor {
50 LyXText(BufferView *);
51 /// sets inset as owner
52 LyXText(BufferView *, InsetText *);
54 void init(BufferView *);
59 /// the current font settings
62 LyXFont real_current_font;
63 /// our buffer's default layout font
66 /** the 'anchor' row: the position of this row remains constant
67 * with respect to the top of the screen
69 RowList::iterator anchor_row_;
70 /** the pixel offset with respect to this row of top_y
72 int anchor_row_offset_;
74 /// update all cached row positions
75 void updateRowPositions();
76 /// get the y coord. of the top of the screen (relative to doc start)
78 /// set the y coord. of the top of the screen (relative to doc start)
80 /// set the anchoring row. top_y will be computed relative to this
81 void anchor_row(RowList::iterator rit);
83 InsetText * inset_owner;
85 UpdatableInset * the_locking_inset;
88 int getRealCursorX() const;
90 LyXFont getFont(ParagraphList::iterator pit, lyx::pos_type pos) const;
92 LyXFont getLayoutFont(ParagraphList::iterator pit) const;
94 LyXFont getLabelFont(ParagraphList::iterator pit) const;
96 void setCharFont(ParagraphList::iterator pit,
97 lyx::pos_type pos, LyXFont const & font);
98 void setCharFont(ParagraphList::iterator pit,
100 LyXFont const & font, bool toggleall);
102 /// what you expect when pressing <enter> at cursor position
103 void breakParagraph(ParagraphList & paragraphs, char keep_layout = 0);
105 /** set layout over selection and make a total rebreak of
108 ParagraphList::iterator
109 setLayout(LyXCursor & actual_cursor,
110 LyXCursor & selection_start,
111 LyXCursor & selection_end,
112 string const & layout);
114 void setLayout(string const & layout);
117 * Increase or decrease the nesting depth of the selected paragraph(s)
118 * if test_only, don't change any depths. Returns whether something
119 * (would have) changed
121 bool changeDepth(bv_funcs::DEPTH_CHANGE type, bool test_only);
123 /// get the depth at current cursor position
124 int getDepth() const;
126 /** set font over selection and make a total rebreak of those
128 toggleall defaults to false.
130 void setFont(LyXFont const &, bool toggleall = false);
132 /// rebreaks all paragaphs between the given pars.
133 void redoParagraphs(ParagraphList::iterator begin,
134 ParagraphList::iterator end);
135 /// rebreaks the given par
136 void redoParagraph(ParagraphList::iterator pit);
137 /// rebreaks the cursor par
138 void redoParagraph();
141 void toggleFree(LyXFont const &, bool toggleall = false);
144 string getStringToIndex();
146 /** insert a character, moves all the following breaks in the
147 same Paragraph one to the right and make a little rebreak
149 void insertChar(char c);
151 void insertInset(InsetOld * inset);
153 /// a full rebreak of the whole text
155 /// compute text metrics
156 void metrics(MetricsInfo & mi, Dimension & dim);
159 InsetOld::RESULT dispatch(FuncRequest const & cmd);
163 BufferView * bv() const;
165 friend class LyXScreen;
168 /// only the top-level LyXText has this non-zero
169 BufferView * bv_owner;
172 /// returns a pointer to a specified row.
174 getRow(ParagraphList::iterator pit, lyx::pos_type pos) const;
176 /// returns a pointer cursor row
177 RowList::iterator getRow(LyXCursor const & cursor) const;
179 RowList::iterator cursorRow() const;
181 * Return the next row, when cursor is at the end of the
182 * previous row, for insets that take a full row.
184 * FIXME: explain why we need this ? especially for y...
186 RowList::iterator cursorIRow() const;
188 /** returns a pointer to the row near the specified y-coordinate
189 (relative to the whole text). y is set to the real beginning
192 RowList::iterator getRowNearY(int & y) const;
194 /** returns the column near the specified x-coordinate of the row
195 x is set to the real beginning of this column
197 lyx::pos_type getColumnNearX(ParagraphList::iterator pit,
198 RowList::iterator rit, int & x, bool & boundary) const;
200 /** returns a pointer to a specified row. y is set to the beginning
204 getRow(ParagraphList::iterator pit, lyx::pos_type pos, int & y) const;
206 RowList & rows() const {
211 /// need the selection cursor:
214 void clearSelection();
216 /// select the word we need depending on word_location
217 void getWord(LyXCursor & from, LyXCursor & to, lyx::word_location const);
218 /// just selects the word the cursor is in
219 void selectWord(lyx::word_location loc);
220 /// returns the inset at cursor (if it exists), 0 otherwise
221 InsetOld * getInset() const;
223 /// accept selected change
226 /// reject selected change
229 /** 'selects" the next word, where the cursor is not in
230 and returns this word as string. THe cursor will be moved
231 to the beginning of this word.
232 With SelectSelectedWord can this be highlighted really
234 WordLangTuple const selectNextWordToSpellcheck(float & value);
236 void selectSelectedWord();
237 /// re-computes the cached coordinates in the cursor
239 /// returns true if par was empty and was removed
240 bool setCursor(ParagraphList::iterator pit,
243 bool boundary = false);
245 void setCursor(LyXCursor &, ParagraphList::iterator pit,
247 bool boundary = false);
249 void setCursorIntern(ParagraphList::iterator pit,
252 bool boundary = false);
254 void setCurrentFont();
257 bool isBoundary(Buffer const *, Paragraph const & par,
258 lyx::pos_type pos) const;
260 bool isBoundary(Buffer const *, Paragraph const & par,
262 LyXFont const & font) const;
265 void setCursorFromCoordinates(int x, int y);
267 void setCursorFromCoordinates(LyXCursor &,
270 void cursorUp(bool selecting = false);
272 void cursorDown(bool selecting = false);
274 void cursorLeft(bool internal = true);
276 void cursorRight(bool internal = true);
278 void cursorLeftOneWord();
280 void cursorRightOneWord();
282 void cursorUpParagraph();
284 void cursorDownParagraph();
290 void cursorPrevious();
302 bool selectWordWhenUnderCursor(lyx::word_location);
308 text_capitalization = 1,
312 /// Change the case of the word at cursor position.
313 void changeCase(TextCase action);
318 void cutSelection(bool doclear = true, bool realcut = true);
320 void copySelection();
322 void pasteSelection(size_t sel_index = 0);
324 /** the DTP switches for paragraphs. LyX will store the top settings
325 always in the first physical paragraph, the bottom settings in the
326 last. When a paragraph is broken, the top settings rest, the bottom
327 settings are given to the new one. So I can make shure, they do not
328 duplicate themself (and you cannnot make dirty things with them! )
330 void setParagraph(bool line_top, bool line_bottom,
331 bool pagebreak_top, bool pagebreak_bottom,
332 VSpace const & space_top,
333 VSpace const & space_bottom,
334 Spacing const & spacing,
336 string const & labelwidthstring,
339 /* these things are for search and replace */
342 * Sets the selection from the current cursor position to length
343 * characters to the right. No safety checks.
345 void setSelectionRange(lyx::pos_type length);
347 /** simple replacing. The font of the first selected character
350 void replaceSelectionWithString(string const & str);
352 /// needed to insert the selection
353 void insertStringAsLines(string const & str);
354 /// needed to insert the selection
355 void insertStringAsParagraphs(string const & str);
357 /// Find next inset of some specified type.
358 bool gotoNextInset(std::vector<InsetOld::Code> const & codes,
359 string const & contents = string());
361 void gotoInset(std::vector<InsetOld::Code> const & codes,
364 void gotoInset(InsetOld::Code code, bool same_content);
367 int workWidth() const;
370 void computeBidiTables(ParagraphList::iterator pit,
371 Buffer const *, RowList::iterator row) const;
372 /// Maps positions in the visual string to positions in logical string.
373 lyx::pos_type log2vis(lyx::pos_type pos) const;
374 /// Maps positions in the logical string to positions in visual string.
375 lyx::pos_type vis2log(lyx::pos_type pos) const;
377 lyx::pos_type bidi_level(lyx::pos_type pos) const;
379 bool bidi_InRange(lyx::pos_type pos) const;
382 mutable RowList rowlist_;
385 float getCursorX(ParagraphList::iterator pit,
386 RowList::iterator rit, lyx::pos_type pos,
387 lyx::pos_type last, bool boundary) const;
388 /// used in setlayout
389 void makeFontEntriesLayoutSpecific(BufferParams const &, Paragraph & par);
391 /** forces the redrawing of a paragraph. Needed when manipulating a
394 void redoDrawingOfParagraph(LyXCursor const & cursor);
396 /// removes the row and reset the touched counters
397 void removeRow(RowList::iterator rit);
399 /// remove all following rows of the paragraph of the specified row.
400 void removeParagraph(RowList::iterator rit);
402 /// insert the specified paragraph behind the specified row
403 void insertParagraph(ParagraphList::iterator pit,
404 RowList::iterator rowit);
406 /// Calculate and set the height of the row
407 void setHeightOfRow(RowList::iterator rit);
409 // fix the cursor `cur' after a characters has been deleted at `where'
410 // position. Called by deleteEmptyParagraphMechanism
411 void fixCursorAfterDelete(LyXCursor & cur,
412 LyXCursor const & where);
414 /// delete double space (false) or empty paragraphs (true) around old_cursor
415 bool deleteEmptyParagraphMechanism(LyXCursor const & old_cursor);
418 /** Updates all counters starting BEHIND the row. Changed paragraphs
419 * with a dynamic left margin will be rebroken. */
420 void updateCounters();
422 * Returns an inset if inset was hit, or 0 if not.
423 * If hit, the coordinates are changed relative to the inset.
425 InsetOld * checkInsetHit(int & x, int & y);
428 int singleWidth(ParagraphList::iterator pit, lyx::pos_type pos) const;
430 int singleWidth(ParagraphList::iterator pit,
431 lyx::pos_type pos, char c) const;
432 /// rebuild row cache
433 void rebuildRows(ParagraphList::iterator pit);
435 /// return the color of the canvas
436 LColor::color backgroundColor() const;
439 mutable bool bidi_same_direction;
441 unsigned char transformChar(unsigned char c, Paragraph const & par,
442 lyx::pos_type pos) const;
445 * Returns the left beginning of the text.
446 * This information cannot be taken from the layout object, because
447 * in LaTeX the beginning of the text fits in some cases
448 * (for example sections) exactly the label-width.
450 int leftMargin(ParagraphList::iterator pit, Row const & row) const;
452 int rightMargin(ParagraphList::iterator pit, Buffer const &, Row const & row) const;
454 /** this calculates the specified parameters. needed when setting
455 * the cursor and when creating a visible row */
457 ParagraphList::iterator pit,
458 RowList::iterator row, double & x,
459 double & fill_separator,
461 double & fill_label_hfill,
462 bool bidi = true) const;
466 void setCounter(Buffer const *, ParagraphList::iterator pit);
468 void deleteWordForward();
470 void deleteWordBackward();
472 void deleteLineForward();
475 * some low level functions
479 /// return the pos value *before* which a row should break.
480 /// for example, the pos at which IsNewLine(pos) == true
481 lyx::pos_type rowBreakPoint(ParagraphList::iterator pit,
482 Row const & row) const;
484 /// returns the minimum space a row needs on the screen in pixel
485 int fill(RowList::iterator row, int workwidth) const;
488 * returns the minimum space a manual label needs on the
491 int labelFill(ParagraphList::iterator pit, Row const & row) const;
494 int labelEnd(ParagraphList::iterator pit, Row const & row) const;
497 mutable std::vector<lyx::pos_type> log2vis_list;
499 mutable std::vector<lyx::pos_type> vis2log_list;
501 mutable std::vector<lyx::pos_type> bidi_levels;
503 mutable lyx::pos_type bidi_start;
505 mutable lyx::pos_type bidi_end;
511 // special owner functions
513 ParagraphList & ownerParagraphs() const;
515 /// return true if this is owned by an inset.
516 bool isInInset() const;
518 /// recreate paragraphlist iterator from rowlist iterator
519 ParagraphList::iterator getPar(RowList::iterator rit) const;
520 /// return first row of par
521 RowList::iterator beginRow(ParagraphList::iterator pit) const;
522 /// return row "behind" last of par
523 RowList::iterator endRow(ParagraphList::iterator pit) const;
526 /** Cursor related data.
527 Later this variable has to be removed. There should be now internal
530 ///TextCursor cursor_;
533 /// return the default height of a row in pixels, considering font zoom
534 extern int defaultRowHeight();