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"
22 #include "lyxlayout_ptr_fwd.h"
23 #include "ParagraphList_fwd.h"
24 #include "RowList_fwd.h"
48 /// This class encapsulates the main text data and operations in LyX
52 LyXText(BufferView *, bool ininset);
54 void init(BufferView *);
56 /// update y coordinate cache of all paragraphs
57 void updateParPositions();
59 LyXFont getFont(ParagraphList::iterator pit, lyx::pos_type pos) const;
61 LyXFont getLayoutFont(ParagraphList::iterator pit) const;
63 LyXFont getLabelFont(ParagraphList::iterator pit) const;
65 void setCharFont(ParagraphList::iterator pit,
66 lyx::pos_type pos, LyXFont const & font);
67 void setCharFont(ParagraphList::iterator pit,
69 LyXFont const & font, bool toggleall);
71 /// what you expect when pressing <enter> at cursor position
72 void breakParagraph(ParagraphList & paragraphs, char keep_layout = 0);
74 /** set layout over selection and make a total rebreak of
77 ParagraphList::iterator
78 setLayout(ParagraphList::iterator start,
79 ParagraphList::iterator end,
80 std::string const & layout);
82 void setLayout(std::string const & layout);
84 /// Increase or decrease the nesting depth of the selected paragraph(s)
85 void changeDepth(bv_funcs::DEPTH_CHANGE type);
87 /// Returns whether something would be changed by changeDepth
88 bool changeDepthAllowed(bv_funcs::DEPTH_CHANGE type);
90 /// get the depth at current cursor position
93 /** set font over selection and make a total rebreak of those
95 toggleall defaults to false.
97 void setFont(LyXFont const &, bool toggleall = false);
99 /// rebreaks all paragaphs between the given pars.
100 void redoParagraphs(ParagraphList::iterator begin,
101 ParagraphList::iterator end);
102 /// rebreaks the given par
103 void redoParagraph(ParagraphList::iterator pit);
104 /// rebreaks the cursor par
105 void redoParagraph();
108 void toggleFree(LyXFont const &, bool toggleall = false);
111 std::string getStringToIndex();
113 /// insert a character at cursor position
114 void insertChar(char c);
115 /// insert an inset at cursor position
116 void insertInset(InsetBase * inset);
118 /// a full rebreak of the whole text
120 /// compute text metrics
121 void metrics(MetricsInfo & mi, Dimension & dim);
122 /// draw text (only used for insets)
123 void draw(PainterInfo & pi, int x, int y) const;
124 /// draw textselection
125 void drawSelection(PainterInfo & pi, int x, int y) const;
127 /// try to handle that request
128 DispatchResult dispatch(LCursor & cur, FuncRequest const & cmd);
129 /// access to out BufferView. This should go...
131 /// access to out BufferView. This should go...
132 BufferView * bv() const;
134 /// returns an iterator pointing to a cursor paragraph
135 ParagraphList::iterator getPar(CursorSlice const & cursor) const;
137 ParagraphList::iterator getPar(lyx::paroffset_type par) const;
139 int parOffset(ParagraphList::iterator pit) const;
141 ParagraphList::iterator cursorPar() const;
143 RowList::iterator cursorRow() const;
145 /** returns an iterator pointing to the row near the specified
146 * y-coordinate (relative to the whole text). y is set to the
147 * real beginning of this row
149 RowList::iterator getRowNearY(int y,
150 ParagraphList::iterator & pit) const;
152 /** returns the column near the specified x-coordinate of the row
153 x is set to the real beginning of this column
155 lyx::pos_type getColumnNearX(ParagraphList::iterator pit,
156 Row const & row, int & x, bool & boundary) const;
158 /** Find the word under \c from in the relative location
159 * defined by \c word_location.
160 * @param from return here the start of the word
161 * @param to return here the end of the word
163 void getWord(CursorSlice & from, CursorSlice & to, lyx::word_location const);
164 /// just selects the word the cursor is in
165 void selectWord(lyx::word_location loc);
167 /// accept selected change
169 /// reject selected change
173 void setCursor(ParagraphList::iterator pit, lyx::pos_type pos);
174 /// returns true if par was empty and was removed
175 bool setCursor(lyx::paroffset_type par, lyx::pos_type pos,
176 bool setfont = true, bool boundary = false);
178 void setCursor(CursorSlice &, lyx::paroffset_type par,
179 lyx::pos_type pos, bool boundary = false);
181 void setCursorIntern(lyx::paroffset_type par, lyx::pos_type pos,
182 bool setfont = true, bool boundary = false);
184 void setCurrentFont();
187 void recUndo(lyx::paroffset_type first, lyx::paroffset_type last) const;
189 void recUndo(lyx::paroffset_type first) const;
191 void setCursorFromCoordinates(int x, int y);
193 void setCursorFromCoordinates(CursorSlice &, int x, int y);
195 void edit(LCursor & cur, int x, int y);
197 void cursorUp(bool selecting = false);
199 void cursorDown(bool selecting = false);
201 bool cursorLeft(bool internal = true);
203 bool cursorRight(bool internal = true);
205 void cursorLeftOneWord();
207 void cursorRightOneWord();
209 void cursorUpParagraph();
211 void cursorDownParagraph();
217 void cursorPrevious();
229 bool selectWordWhenUnderCursor(lyx::word_location);
235 text_capitalization = 1,
239 /// Change the case of the word at cursor position.
240 void changeCase(TextCase action);
245 void cutSelection(bool doclear = true, bool realcut = true);
247 void copySelection();
249 void pasteSelection(size_t sel_index = 0);
251 /** the DTP switches for paragraphs. LyX will store the top settings
252 always in the first physical paragraph, the bottom settings in the
253 last. When a paragraph is broken, the top settings rest, the bottom
254 settings are given to the new one.
257 Spacing const & spacing,
259 std::string const & labelwidthstring,
262 /* these things are for search and replace */
265 * Sets the selection from the current cursor position to length
266 * characters to the right. No safety checks.
268 void setSelectionRange(lyx::pos_type length);
269 /** simple replacing. The font of the first selected character
272 void replaceSelectionWithString(std::string const & str);
274 /// needed to insert the selection
275 void insertStringAsLines(std::string const & str);
276 /// needed to insert the selection
277 void insertStringAsParagraphs(std::string const & str);
279 /// Find next inset of some specified type.
280 bool gotoNextInset(std::vector<InsetOld_code> const & codes,
281 std::string const & contents = std::string());
283 void gotoInset(std::vector<InsetOld_code> const & codes,
286 void gotoInset(InsetOld_code code, bool same_content);
288 /// current max text width
289 int textWidth() const;
291 /// updates all counters
292 void updateCounters();
293 /// Returns an inset if inset was hit, or 0 if not.
294 InsetBase * checkInsetHit(int x, int y);
297 int singleWidth(ParagraphList::iterator pit, lyx::pos_type pos) const;
299 int singleWidth(ParagraphList::iterator pit,
300 lyx::pos_type pos, char c, LyXFont const & Font) const;
302 /// return the color of the canvas
303 LColor_color backgroundColor() const;
306 * Returns the left beginning of the text.
307 * This information cannot be taken from the layout object, because
308 * in LaTeX the beginning of the text fits in some cases
309 * (for example sections) exactly the label-width.
311 int leftMargin(ParagraphList::iterator pit, lyx::pos_type pos) const;
312 int leftMargin(ParagraphList::iterator pit) const;
314 int rightMargin(Paragraph const & par) const;
316 /** this calculates the specified parameters. needed when setting
317 * the cursor and when creating a visible row */
318 void prepareToPrint(ParagraphList::iterator pit, Row & row) const;
320 /// access to our paragraphs
321 ParagraphList & paragraphs() const;
322 /// return true if this is owned by an inset.
323 bool isInInset() const;
325 /// return first row of text
326 RowList::iterator firstRow() const;
327 /// return last row of text
328 RowList::iterator lastRow() const;
329 /// return row "behind" last row of text
330 RowList::iterator endRow() const;
331 /// return next row crossing paragraph boundaries
332 void nextRow(ParagraphList::iterator & pit,
333 RowList::iterator & rit) const;
334 /// return previous row crossing paragraph boundaries
335 void previousRow(ParagraphList::iterator & pit,
336 RowList::iterator & rit) const;
338 /// is this row the last in the text?
339 bool isLastRow(ParagraphList::iterator pit, Row const & row) const;
340 /// is this row the first in the text?
341 bool isFirstRow(ParagraphList::iterator pit, Row const & row) const;
344 std::string selectionAsString(Buffer const & buffer, bool label) const;
346 double spacing(Paragraph const &) const;
348 void cursorLeftOneWord(CursorSlice &);
350 void cursorRightOneWord(CursorSlice &);
353 DispatchResult moveRight();
355 DispatchResult moveLeft();
357 DispatchResult moveRightIntern(bool front,
358 bool activate_inset, bool selecting);
360 DispatchResult moveLeftIntern(bool front,
361 bool activate_inset, bool selecting);
363 DispatchResult moveUp();
365 DispatchResult moveDown();
367 bool checkAndActivateInset(bool front);
370 void write(Buffer const & buf, std::ostream & os) const;
371 /// returns whether we've seen our usual 'end' marker
372 bool read(Buffer const & buf, LyXLex & lex);
379 int cursorX(CursorSlice const & cursor) const;
381 int cursorY(CursorSlice const & cursor) const;
383 /// the current cursor slice
384 CursorSlice & cursor();
385 /// the current cursor slice
386 CursorSlice const & cursor() const;
388 friend class LyXScreen;
397 /// the current font settings
398 LyXFont current_font;
400 LyXFont real_current_font;
401 /// our buffer's default layout font
402 LyXFont defaultfont_;
404 int background_color_;
406 /// only the top-level LyXText has this non-zero
407 BufferView * bv_owner;
414 ParagraphList paragraphs_;
416 /// absolute document pixel coordinates of this LyXText
420 /// our 'outermost' Font
425 /// return past-the-last paragraph influenced by a layout
427 ParagraphList::iterator undoSpan(ParagraphList::iterator pit);
429 /// rebreaks the given par
430 void redoParagraphInternal(ParagraphList::iterator pit);
431 /// used in setlayout
432 void makeFontEntriesLayoutSpecific(BufferParams const &, Paragraph & par);
434 /// Calculate and set the height of the row
435 void setHeightOfRow(ParagraphList::iterator, Row & row);
437 // fix the cursor `cur' after a characters has been deleted at `where'
438 // position. Called by deleteEmptyParagraphMechanism
439 void fixCursorAfterDelete(CursorSlice & cur, CursorSlice const & where);
441 /// delete double space (false) or empty paragraphs (true) around old_cursor
442 bool deleteEmptyParagraphMechanism(CursorSlice const & old_cursor);
445 void setCounter(Buffer const &, ParagraphList::iterator pit);
447 void deleteWordForward();
449 void deleteWordBackward();
451 void deleteLineForward();
453 /// sets row.end to the pos value *after* which a row should break.
454 /// for example, the pos after which isNewLine(pos) == true
455 void rowBreakPoint(ParagraphList::iterator pit, Row & row) const;
456 /// sets row.witdh to the minimum space a row needs on the screen in pixel
457 void fill(ParagraphList::iterator pit, Row & row, int workwidth) const;
458 /// the minimum space a manual label needs on the screen in pixels
459 int labelFill(ParagraphList::iterator pit, Row const & row) const;
461 int labelEnd(ParagraphList::iterator pit) const;
465 /// set 'number' font property
467 /// is the cursor paragraph right-to-left?
471 /// return the default height of a row in pixels, considering font zoom
472 int defaultRowHeight();
475 std::string expandLabel(LyXTextClass const & textclass,
476 LyXLayout_ptr const & layout, bool appendix);