4 * This file is part of LyX, the document processor.
5 * Licence details can be found in the file COPYING.
7 * \author Alfredo Braustein
8 * \author Lars Gullik Bjønnes
10 * \author Jürgen Vigna
12 * Full author contact details are available in file CREDITS.
18 #include "DocumentClassPtr.h"
20 #include "update_flags.h"
22 #include "support/strfwd.h"
23 #include "support/types.h"
27 namespace support { class FileName; }
29 namespace frontend { class Painter; }
30 namespace frontend { class GuiBufferViewDelegate; }
48 class ParagraphMetrics;
61 /// Scrollbar Parameters.
62 struct ScrollbarParameters
64 // These parameters are normalized against the screen geometry and pixel
65 // coordinates. Position 0 corresponds to the top the the screen.
67 : min(0), max(0), single_step(1), page_step(1)
69 /// Minimum scrollbar position in pixels.
71 /// Maximum scrollbar position in pixels.
73 /// Line-scroll amount in pixels.
75 /// Page-scroll amount in pixels.
79 /// Screen view of a Buffer.
81 * A BufferView encapsulates a view onto a particular
82 * buffer, and allows access to operate upon it. A view
83 * is a sliding window of the entire document rendering.
84 * It is the official interface between the LyX core and
85 * the frontend WorkArea.
94 explicit BufferView(Buffer & buffer);
98 /// return the buffer being viewed.
100 Buffer const & buffer() const;
103 void setFullScreen(bool full_screen) { full_screen_ = full_screen; }
106 int rightMargin() const;
108 int leftMargin() const;
110 int topMargin() const;
112 int bottomMargin() const;
114 /// return the on-screen size of this length
116 * This is a wrapper around Length::inPixels that uses the
117 * bufferview width as width and the EM value of the default
120 int inPixels(Length const & len) const;
122 /** Return the number of pixels equivalent to \c pix pixels at
123 * 100dpi and 100% zoom.
125 int zoomedPixels(int pix) const;
127 /// \return true if the BufferView is at the top of the document.
128 bool isTopScreen() const;
130 /// \return true if the BufferView is at the bottom of the document.
131 bool isBottomScreen() const;
133 /// Add \p flags to current update flags and trigger an update.
134 /* If this method is invoked several times before the update
135 * actually takes place, the effect is cumulative.
136 * \c Update::FitCursor means first to do a FitCursor, and to
137 * force an update if screen position changes.
138 * \c Update::Force means to force an update in any case.
140 void processUpdateFlags(Update::flags flags);
142 /// return true if one shall move the screen to fit the cursor.
143 /// Only to be called with good y coordinates (after a bv::metrics)
144 bool needsFitCursor() const;
146 // Returns the amount of horizontal scrolling applied to the
147 // top-level row where the cursor lies
148 int horizScrollOffset() const;
149 // Returns the amount of horizontal scrolling applied to the
150 // row of text starting at (pit, pos)
151 int horizScrollOffset(Text const * text,
152 pit_type pit, pos_type pos) const;
154 /// reset the scrollbar to reflect current view position.
155 void updateScrollbar();
156 /// return the Scrollbar Parameters.
157 ScrollbarParameters const & scrollbarParameters() const;
158 /// \return Tool tip for the given position.
159 docstring toolTip(int x, int y) const;
160 /// \return the context menu for the given position.
161 std::string contextMenu(int x, int y) const;
163 /// Save the current position as bookmark.
164 /// if idx == 0, save to temp_bookmark
165 void saveBookmark(unsigned int idx);
166 /// goto a specified position, try top_id first, and then bottom_pit.
167 /// \return true if success
169 pit_type bottom_pit, ///< Paragraph pit, used when par_id is zero or invalid.
170 pos_type bottom_pos, ///< Paragraph pit, used when par_id is zero or invalid.
171 int top_id, ///< Paragraph ID, \sa Paragraph
172 pos_type top_pos ///< Position in the \c Paragraph
174 /// return the current change at the cursor.
175 Change const getCurrentChange() const;
177 /// move cursor to the named label.
178 void gotoLabel(docstring const & label);
180 /// set the cursor based on the given TeX source row.
181 bool setCursorFromRow(int row);
182 /// set the cursor based on the given start and end TextEntries.
183 bool setCursorFromEntries(TexRow::TextEntry start, TexRow::TextEntry end);
185 /// set cursor to the given inset. Return true if found.
186 bool setCursorFromInset(Inset const *);
187 /// Recenters the BufferView such that the passed cursor
188 /// is in the center.
190 /// Ensure that the BufferView cursor is visible.
191 /// This method will automatically scroll and update the BufferView
192 /// (metrics+drawing) if needed.
194 /// Ensure the passed cursor \p dit is visible.
195 /// This method will automatically scroll and update the BufferView
196 /// (metrics+drawing) if needed.
197 /// \param recenter Whether the cursor should be centered on screen
198 void showCursor(DocIterator const & dit, bool recenter,
200 /// Scroll to the cursor.
201 void scrollToCursor();
202 /// Scroll to the cursor.
203 /// \param recenter Whether the cursor should be centered on screen
204 bool scrollToCursor(DocIterator const & dit, bool recenter);
205 /// scroll down document by the given number of pixels.
206 int scrollDown(int pixels);
207 /// scroll up document by the given number of pixels.
208 int scrollUp(int pixels);
209 /// scroll document by the given number of pixels.
210 int scroll(int pixels);
211 /// Scroll the view by a number of pixels.
212 void scrollDocView(int pixels, bool update);
213 /// Set the cursor position based on the scrollbar one.
214 void setCursorFromScrollbar();
216 /// return the pixel width of the document view.
217 int workWidth() const;
218 /// return the pixel height of the document view.
219 int workHeight() const;
221 /// return the inline completion postfix.
222 docstring const & inlineCompletion() const;
223 /// return the number of unique characters in the inline completion.
224 size_t const & inlineCompletionUniqueChars() const;
225 /// return the position in the buffer of the inline completion postfix.
226 DocIterator const & inlineCompletionPos() const;
227 /// make sure inline completion position is OK
228 void resetInlineCompletionPos();
229 /// set the inline completion postfix and its position in the buffer.
230 /// Updates the updateFlags in \c cur.
231 void setInlineCompletion(Cursor const & cur, DocIterator const & pos,
232 docstring const & completion, size_t uniqueChars = 0);
234 /// translate and insert a character, using the correct keymap.
235 void translateAndInsert(char_type c, Text * t, Cursor & cur);
237 /// \return true if we've made a decision
238 bool getStatus(FuncRequest const & cmd, FuncStatus & flag);
239 /// execute the given function.
240 void dispatch(FuncRequest const & cmd, DispatchResult & dr);
242 /// request an X11 selection.
243 /// \return the selected string.
244 docstring requestSelection();
245 /// clear the X11 selection.
246 void clearSelection();
248 /// resize the BufferView.
250 void resize(int width, int height);
252 /// dispatch method helper for \c WorkArea
254 void mouseEventDispatch(FuncRequest const & ev);
257 CursorStatus cursorStatus(DocIterator const & dit) const;
258 /// access to full cursor.
260 /// access to full cursor.
261 Cursor const & cursor() const;
263 /// This will also open all relevant collapsible insets.
264 void setCursor(DocIterator const &);
265 /// set the selection up to dit.
266 void setCursorSelectionTo(DocIterator const & dit);
267 /// Check deleteEmptyParagraphMechanism and update metrics if needed.
268 /// \retval true if an update was needed.
269 bool checkDepm(Cursor & cur, Cursor & old);
271 /// This is used when handling LFUN_MOUSE_PRESS.
272 bool mouseSetCursor(Cursor & cur, bool select = false);
274 /// sets the selection.
275 /* When \c backwards == false, set anchor
276 * to \c cur and cursor to \c cur + \c length. When \c
277 * backwards == true, set anchor to \c cur and cursor to \c
280 void putSelectionAt(DocIterator const & cur,
281 int length, bool backwards);
283 /// selects the item at cursor if its paragraph is empty.
284 bool selectIfEmpty(DocIterator & cur);
286 /// update the internal \c ViewMetricsInfo.
287 void updateMetrics();
289 // this is the "nodraw" drawing stage: only set the positions of the
290 // insets in metrics cache.
291 void updatePosCache();
294 TextMetrics const & textMetrics(Text const * t) const;
295 TextMetrics & textMetrics(Text const * t);
297 ParagraphMetrics const & parMetrics(Text const *, pit_type) const;
300 CoordCache & coordCache();
302 CoordCache const & coordCache() const;
305 MathRow const & mathRow(MathData const * cell) const;
307 void setMathRow(MathData const * cell, MathRow const & mrow);
310 Point getPos(DocIterator const & dit) const;
311 /// is the paragraph of the cursor visible ?
312 bool paragraphVisible(DocIterator const & dit) const;
313 /// is the caret currently visible in the view
314 bool caretInView() const;
315 /// get the position and height of the caret
316 void caretPosAndHeight(Point & p, int & h) const;
319 void draw(frontend::Painter & pain, bool paint_caret);
321 /// get this view's keyboard map handler.
324 Intl const & getIntl() const;
327 // Messages to the GUI
329 /// This signal is emitted when some message shows up.
330 void message(docstring const & msg);
332 /// This signal is emitted when some dialog needs to be shown.
333 void showDialog(std::string const & name);
335 /// This signal is emitted when some dialog needs to be shown with
337 void showDialog(std::string const & name, std::string const & data,
338 Inset * inset = nullptr);
340 /// This signal is emitted when some dialogs needs to be updated.
341 void updateDialog(std::string const & name, std::string const & data);
344 void setGuiDelegate(frontend::GuiBufferViewDelegate *);
347 docstring contentsOfPlaintextFile(support::FileName const & f);
348 // Insert plain text file (if filename is empty, prompt for one)
349 void insertPlaintextFile(support::FileName const & f, bool asParagraph);
351 void insertLyXFile(support::FileName const & f, bool const ignorelang = false);
352 /// save temporary bookmark for jump back navigation
353 void bookmarkEditPosition();
354 /// Find and return the inset associated with given dialog name.
355 Inset * editedInset(std::string const & name) const;
356 /// Associate an inset associated with given dialog name.
357 void editInset(std::string const & name, Inset * inset);
359 void clearLastInset(Inset * inset) const;
360 /// Is the mouse hovering a clickable inset or element?
361 bool clickableInset() const;
363 void makeDocumentClass();
367 BufferView(BufferView const &);
368 void operator=(BufferView const &);
370 /// the position relative to (0, baseline) of outermost paragraph
371 Point coordOffset(DocIterator const & dit) const;
372 /// Update current paragraph metrics.
373 /// \return true if no further update is needed.
374 bool singleParUpdate();
375 /// do the work for the public updateMetrics()
376 void updateMetrics(Update::flags & update_flags);
378 // Set the row on which the cursor lives.
379 void setCurrentRowSlice(CursorSlice const & rowSlice);
381 // Check whether the row where the cursor lives needs to be scrolled.
382 // Update the drawing strategy if needed.
383 void checkCursorScrollOffset();
385 /// The minimal size of the document that is visible. Used
386 /// when it is allowed to scroll below the document.
387 int minVisiblePart();
389 /// Search recursively for the innermost inset that covers (x, y) position.
390 /// \retval 0 if no inset is found.
391 Inset const * getCoveringInset(
392 Text const & text, //< The Text where we start searching.
393 int x, //< x-coordinate on screen
394 int y //< y-coordinate on screen
397 /// Update the hovering status of the insets. This is called when
398 /// either the screen is updated or when the buffer has scolled.
399 void updateHoveredInset() const;
402 void updateDocumentClass(DocumentClassConstPtr olddc);
416 /// some space for drawing the 'nested' markers (in pixel)
417 inline int nestMargin() { return 15; }
419 /// margin for changebar
420 inline int changebarMargin() { return 12; }
424 #endif // BUFFERVIEW_H