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_fwd.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 LyXFont getLayoutFont(pit_type pit) const;
65 LyXFont getLabelFont(Paragraph const & par) const;
67 void setCharFont(pit_type pit, pos_type pos, LyXFont const & font);
69 void setCharFont(pit_type pit, pos_type pos, LyXFont const & font,
72 /// what you expect when pressing <enter> at cursor position
73 void breakParagraph(LCursor & cur, bool keep_layout = false);
75 /// set layout over selection
76 pit_type setLayout(pit_type start, pit_type end,
77 std::string const & layout);
79 void setLayout(LCursor & cur, std::string const & layout);
81 /// what type of depth change to make
86 /// Increase or decrease the nesting depth of the selected paragraph(s)
87 void changeDepth(LCursor & cur, DEPTH_CHANGE type);
89 /// Returns whether something would be changed by changeDepth
90 bool changeDepthAllowed(LCursor & cur, DEPTH_CHANGE type) const;
92 /// Set font over selection paragraphs and rebreak.
93 void setFont(LCursor & cur, LyXFont const &, bool toggleall = false);
95 /// rebreaks the given par
96 void redoParagraph(pit_type pit);
98 /// returns pos in given par at given x coord
99 pos_type x2pos(pit_type pit, int row, int x) const;
100 int pos2x(pit_type pit, pos_type pos) const;
103 void toggleFree(LCursor & cur, LyXFont const &, bool toggleall = false);
106 std::string getStringToIndex(LCursor & cur);
108 /// insert a character at cursor position
109 void insertChar(LCursor & cur, char c);
110 /// insert an inset at cursor position
111 void insertInset(LCursor & cur, InsetBase * inset);
113 /// compute text metrics
114 void metrics(MetricsInfo & mi, Dimension & dim);
115 /// draw text (only used for insets)
116 void draw(PainterInfo & pi, int x, int y) const;
117 /// draw textselection
118 void drawSelection(PainterInfo & pi, int x, int y) const;
120 /// try to handle that request
121 void dispatch(LCursor & cur, FuncRequest & cmd);
122 /// do we want to handle this event?
123 bool getStatus(LCursor & cur, FuncRequest const & cmd,
124 FuncStatus & status) const;
126 /// access to out BufferView. This should go...
127 // BufferView * bv();
128 /// access to out BufferView. This should go...
129 BufferView * bv() const;
131 /// access to individual paragraphs
132 Paragraph & getPar(pit_type par) const;
133 // Returns the current font and depth as a message.
134 std::string LyXText::currentState(LCursor & cur);
136 /** returns row near the specified
137 * y-coordinate in given paragraph (relative to the screen).
139 Row const & getRowNearY(int y, pit_type pit) const;
140 pit_type getPitNearY(int y) const;
142 /** returns the column near the specified x-coordinate of the row
143 x is set to the real beginning of this column
145 pos_type getColumnNearX(pit_type pit,
146 Row const & row, int & x, bool & boundary) const;
148 /** Find the word under \c from in the relative location
149 * defined by \c word_location.
150 * @param from return here the start of the word
151 * @param to return here the end of the word
153 void getWord(CursorSlice & from, CursorSlice & to, lyx::word_location const);
154 /// just selects the word the cursor is in
155 void selectWord(LCursor & cur, lyx::word_location loc);
157 /// accept selected change
158 void acceptChange(LCursor & cur);
159 /// reject selected change
160 void rejectChange(LCursor & cur);
162 /// returns true if par was empty and was removed
163 bool setCursor(LCursor & cur, pit_type par, pos_type pos,
164 bool setfont = true, bool boundary = false);
166 void setCursor(CursorSlice &, pit_type par,
167 pos_type pos, bool boundary = false);
169 void setCursorIntern(LCursor & cur, pit_type par,
170 pos_type pos, bool setfont = true, bool boundary = false);
172 void setCurrentFont(LCursor & cur);
175 void recUndo(pit_type first, pit_type last) const;
177 void recUndo(pit_type first) const;
179 void setCursorFromCoordinates(LCursor & cur, int x, int y);
181 InsetBase * editXY(LCursor & cur, int x, int y) const;
182 /// Move cursor one line up.
184 * Returns true if an update is needed after the move.
186 bool cursorUp(LCursor & cur);
187 /// Move cursor one line down.
189 * Returns true if an update is needed after the move.
191 bool cursorDown(LCursor & cur);
192 /// Move cursor one position left
194 * Returns true if an update is needed after the move.
196 bool cursorLeft(LCursor & cur);
197 /// Move cursor one position right
199 * Returns true if an update is needed after the move.
201 bool cursorRight(LCursor & cur);
203 bool cursorLeftOneWord(LCursor & cur);
205 bool cursorRightOneWord(LCursor & cur);
207 bool cursorUpParagraph(LCursor & cur);
209 bool cursorDownParagraph(LCursor & cur);
211 void cursorHome(LCursor & cur);
213 void cursorEnd(LCursor & cur);
215 bool cursorPrevious(LCursor & cur);
217 bool cursorNext(LCursor & cur);
219 void cursorTop(LCursor & cur);
221 void cursorBottom(LCursor & cur);
223 void Delete(LCursor & cur);
225 void backspace(LCursor & cur);
227 bool selectWordWhenUnderCursor(LCursor & cur, lyx::word_location);
233 text_capitalization = 1,
237 /// Change the case of the word at cursor position.
238 void changeCase(LCursor & cur, TextCase action);
240 /** the DTP switches for paragraphs. LyX will store the top settings
241 always in the first physical paragraph, the bottom settings in the
242 last. When a paragraph is broken, the top settings rest, the bottom
243 settings are given to the new one.
245 void setParagraph(LCursor & cur,
246 Spacing const & spacing,
248 std::string const & labelwidthstring,
251 /* these things are for search and replace */
253 /// needed to insert the selection
254 void insertStringAsLines(LCursor & cur, std::string const & str);
255 /// needed to insert the selection
256 void insertStringAsParagraphs(LCursor & cur, std::string const & str);
258 /// Find next inset of some specified type.
259 bool gotoNextInset(LCursor & cur,
260 std::vector<InsetBase_code> const & codes,
261 std::string const & contents = std::string());
263 void gotoInset(LCursor & cur,
264 std::vector<InsetBase_code> const & codes, bool same_content);
266 void gotoInset(LCursor & cur, InsetBase_code code, bool same_content);
268 /// current text width
271 /// current text heigth
274 /// updates all counters
275 void updateCounters();
276 /// Returns an inset if inset was hit, or 0 if not.
277 InsetBase * checkInsetHit(int x, int y) const;
280 int singleWidth(Paragraph const & par, pos_type pos) const;
282 int singleWidth(Paragraph const & par,
283 pos_type pos, char c, LyXFont const & Font) const;
285 /// return the color of the canvas
286 LColor_color backgroundColor() const;
289 * Returns the left beginning of the text.
290 * This information cannot be taken from the layout object, because
291 * in LaTeX the beginning of the text fits in some cases
292 * (for example sections) exactly the label-width.
294 int leftMargin(pit_type pit, pos_type pos) const;
295 int leftMargin(pit_type pit) const;
297 int rightMargin(Paragraph const & par) const;
299 /** this calculates the specified parameters. needed when setting
300 * the cursor and when creating a visible row */
301 RowMetrics computeRowMetrics(pit_type pit, Row const & row) const;
303 /// access to our paragraphs
304 ParagraphList & paragraphs() const;
305 /// return true if this is the main text
306 bool isMainText() const;
308 /// return first row of text
309 Row const & firstRow() const;
311 /// is this row the last in the text?
312 bool isLastRow(pit_type pit, Row const & row) const;
313 /// is this row the first in the text?
314 bool isFirstRow(pit_type pit, Row const & row) const;
317 double spacing(Paragraph const & par) const;
318 /// make a suggestion for a label
319 std::string getPossibleLabel(LCursor & cur) const;
320 /// is this paragraph right-to-left?
321 bool isRTL(Paragraph const & par) const;
323 bool checkAndActivateInset(LCursor & cur, bool front);
326 void write(Buffer const & buf, std::ostream & os) const;
327 /// returns whether we've seen our usual 'end' marker
328 bool read(Buffer const & buf, LyXLex & lex);
335 int cursorX(CursorSlice const & cursor) const;
337 int cursorY(CursorSlice const & cursor) const;
340 friend class LyXScreen;
347 /// the current font settings
348 LyXFont current_font;
350 LyXFont real_current_font;
351 /// our buffer's default layout font
352 LyXFont defaultfont_;
354 int background_color_;
356 /// only the top-level LyXText has this non-zero
357 BufferView * bv_owner;
364 /// our 'outermost' Font
370 /// return past-the-last paragraph influenced by a layout
372 pit_type undoSpan(pit_type pit);
374 /// used in setlayout
375 void makeFontEntriesLayoutSpecific(BufferParams const &, Paragraph & par);
377 /// Calculate and set the height of the row
378 void setHeightOfRow(pit_type, Row & row);
380 // fix the cursor `cur' after a characters has been deleted at `where'
381 // position. Called by deleteEmptyParagraphMechanism
382 void fixCursorAfterDelete(CursorSlice & cur, CursorSlice const & where);
384 /// delete double space or empty paragraphs around old cursor
385 bool deleteEmptyParagraphMechanism(LCursor & cur, LCursor const & old);
388 void setCounter(Buffer const &, pit_type pit);
390 void deleteWordForward(LCursor & cur);
392 void deleteWordBackward(LCursor & cur);
394 void deleteLineForward(LCursor & cur);
396 /// sets row.end to the pos value *after* which a row should break.
397 /// for example, the pos after which isNewLine(pos) == true
398 void rowBreakPoint(pit_type pit, Row & row) const;
399 /// sets row.width to the minimum space a row needs on the screen in pixel
400 void setRowWidth(pit_type pit, Row & row) const;
401 /// the minimum space a manual label needs on the screen in pixels
402 int labelFill(Paragraph const & par, Row const & row) const;
404 int labelEnd(pit_type pit) const;
408 /// set 'number' font property
409 void number(LCursor & cur);
412 /// return the default height of a row in pixels, considering font zoom
413 int defaultRowHeight();
416 std::string expandLabel(LyXTextClass const & textclass,
417 LyXLayout_ptr const & layout, bool appendix);