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; }
46 class ParagraphMetrics;
59 /// Scrollbar Parameters.
60 struct ScrollbarParameters
62 // These parameters are normalized against the screen geometry and pixel
63 // coordinates. Position 0 corresponds to the top the the screen.
65 : min(0), max(0), single_step(1), page_step(1)
67 /// Minimum scrollbar position in pixels.
69 /// Maximum scrollbar position in pixels.
71 /// Line-scroll amount in pixels.
73 /// Page-scroll amount in pixels.
77 /// Screen view of a Buffer.
79 * A BufferView encapsulates a view onto a particular
80 * buffer, and allows access to operate upon it. A view
81 * is a sliding window of the entire document rendering.
82 * It is the official interface between the LyX core and
83 * the frontend WorkArea.
92 explicit BufferView(Buffer & buffer);
96 /// return the buffer being viewed.
98 Buffer const & buffer() const;
101 void setFullScreen(bool full_screen) { full_screen_ = full_screen; }
104 int rightMargin() const;
107 int leftMargin() const;
109 /// return the on-screen size of this length
111 * This is a wrapper around Length::inPixels that uses the
112 * bufferview width as width and the EM value of the default
115 int inPixels(Length const & len) const;
117 /// \return true if the BufferView is at the top of the document.
118 bool isTopScreen() const;
120 /// \return true if the BufferView is at the bottom of the document.
121 bool isBottomScreen() const;
123 /// perform pending metrics updates.
124 /** \c Update::FitCursor means first to do a FitCursor, and to
125 * force an update if screen position changes.
126 * \c Update::Force means to force an update in any case.
127 * \retval true if a screen redraw is needed
129 void processUpdateFlags(Update::flags flags);
131 /// return true if one shall move the screen to fit the cursor.
132 /// Only to be called with good y coordinates (after a bv::metrics)
133 bool needsFitCursor() const;
135 /// returns true if this row needs to be repainted (to erase caret)
136 bool needRepaint(Text const * text, Row const & row) const;
138 // Returns the amount of horizontal scrolling applied to the
139 // top-level row where the cursor lies
140 int horizScrollOffset() const;
141 // Returns the amount of horizontal scrolling applied to the
142 // row of text starting at (pit, pos)
143 int horizScrollOffset(Text const * text,
144 pit_type pit, pos_type pos) const;
146 // Returns true if the row of text starting at (pit, pos) was scrolled
147 // at the last draw event.
148 bool hadHorizScrollOffset(Text const * text,
149 pit_type pit, pos_type pos) const;
151 /// reset the scrollbar to reflect current view position.
152 void updateScrollbar();
153 /// return the Scrollbar Parameters.
154 ScrollbarParameters const & scrollbarParameters() const;
155 /// \return Tool tip for the given position.
156 docstring toolTip(int x, int y) const;
157 /// \return the context menu for the given position.
158 std::string contextMenu(int x, int y) const;
160 /// Save the current position as bookmark.
161 /// if idx == 0, save to temp_bookmark
162 void saveBookmark(unsigned int idx);
163 /// goto a specified position, try top_id first, and then bottom_pit.
164 /// \return true if success
166 pit_type bottom_pit, ///< Paragraph pit, used when par_id is zero or invalid.
167 pos_type bottom_pos, ///< Paragraph pit, used when par_id is zero or invalid.
168 int top_id, ///< Paragraph ID, \sa Paragraph
169 pos_type top_pos ///< Position in the \c Paragraph
171 /// return the current change at the cursor.
172 Change const getCurrentChange() const;
174 /// move cursor to the named label.
175 void gotoLabel(docstring const & label);
177 /// set the cursor based on the given TeX source row.
178 bool setCursorFromRow(int row);
179 /// set the cursor based on the given start and end TextEntries.
180 bool setCursorFromEntries(TexRow::TextEntry start, TexRow::TextEntry end);
182 /// set cursor to the given inset. Return true if found.
183 bool setCursorFromInset(Inset const *);
184 /// Recenters the BufferView such that the passed cursor
185 /// is in the center.
187 /// Ensure that the BufferView cursor is visible.
188 /// This method will automatically scroll and update the BufferView
189 /// (metrics+drawing) if needed.
191 /// Ensure the passed cursor \p dit is visible.
192 /// This method will automatically scroll and update the BufferView
193 /// (metrics+drawing) if needed.
194 /// \param recenter Whether the cursor should be centered on screen
195 void showCursor(DocIterator const & dit, bool recenter,
197 /// Scroll to the cursor.
198 void scrollToCursor();
199 /// Scroll to the cursor.
200 /// \param recenter Whether the cursor should be centered on screen
201 bool scrollToCursor(DocIterator const & dit, bool recenter);
202 /// scroll down document by the given number of pixels.
203 int scrollDown(int pixels);
204 /// scroll up document by the given number of pixels.
205 int scrollUp(int pixels);
206 /// scroll document by the given number of pixels.
207 int scroll(int pixels);
208 /// Scroll the view by a number of pixels.
209 void scrollDocView(int pixels, bool update);
210 /// Set the cursor position based on the scrollbar one.
211 void setCursorFromScrollbar();
213 /// return the pixel width of the document view.
214 int workWidth() const;
215 /// return the pixel height of the document view.
216 int workHeight() const;
218 /// return the inline completion postfix.
219 docstring const & inlineCompletion() const;
220 /// return the number of unique characters in the inline completion.
221 size_t const & inlineCompletionUniqueChars() const;
222 /// return the position in the buffer of the inline completion postfix.
223 DocIterator const & inlineCompletionPos() const;
224 /// make sure inline completion position is OK
225 void resetInlineCompletionPos();
226 /// set the inline completion postfix and its position in the buffer.
227 /// Updates the updateFlags in \c cur.
228 void setInlineCompletion(Cursor const & cur, DocIterator const & pos,
229 docstring const & completion, size_t uniqueChars = 0);
231 /// translate and insert a character, using the correct keymap.
232 void translateAndInsert(char_type c, Text * t, Cursor & cur);
234 /// \return true if we've made a decision
235 bool getStatus(FuncRequest const & cmd, FuncStatus & flag);
236 /// execute the given function.
237 void dispatch(FuncRequest const & cmd, DispatchResult & dr);
239 /// request an X11 selection.
240 /// \return the selected string.
241 docstring const requestSelection();
242 /// clear the X11 selection.
243 void clearSelection();
245 /// resize the BufferView.
247 void resize(int width, int height);
249 /// dispatch method helper for \c WorkArea
251 void mouseEventDispatch(FuncRequest const & ev);
253 /// access to anchor.
254 pit_type anchor_ref() const;
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 collapsable 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 Point getPos(DocIterator const & dit) const;
306 /// is the paragraph of the cursor visible ?
307 bool paragraphVisible(DocIterator const & dit) const;
308 /// is the cursor currently visible in the view
309 bool cursorInView(Point const & p, int h) const;
310 /// get the position and height of the caret
311 void caretPosAndHeight(Point & p, int & h) const;
314 void draw(frontend::Painter & pain, bool paint_caret);
316 /// get this view's keyboard map handler.
319 Intl const & getIntl() const;
322 // Messages to the GUI
324 /// This signal is emitted when some message shows up.
325 void message(docstring const & msg);
327 /// This signal is emitted when some dialog needs to be shown.
328 void showDialog(std::string const & name);
330 /// This signal is emitted when some dialog needs to be shown with
332 void showDialog(std::string const & name, std::string const & data,
335 /// This signal is emitted when some dialogs needs to be updated.
336 void updateDialog(std::string const & name, std::string const & data);
339 void setGuiDelegate(frontend::GuiBufferViewDelegate *);
342 docstring contentsOfPlaintextFile(support::FileName const & f);
343 // Insert plain text file (if filename is empty, prompt for one)
344 void insertPlaintextFile(support::FileName const & f, bool asParagraph);
346 void insertLyXFile(support::FileName const & f);
347 /// save temporary bookmark for jump back navigation
348 void bookmarkEditPosition();
349 /// Find and return the inset associated with given dialog name.
350 Inset * editedInset(std::string const & name) const;
351 /// Associate an inset associated with given dialog name.
352 void editInset(std::string const & name, Inset * inset);
354 void clearLastInset(Inset * inset) const;
355 /// Is the mouse hovering a clickable inset or element?
356 bool clickableInset() const;
358 void makeDocumentClass();
362 BufferView(BufferView const &);
363 void operator=(BufferView const &);
365 /// the position relative to (0, baseline) of outermost paragraph
366 Point coordOffset(DocIterator const & dit) const;
367 /// Update current paragraph metrics.
368 /// \return true if no further update is needed.
369 bool singleParUpdate();
371 // Set the row on which the cursor lives.
372 void setCurrentRowSlice(CursorSlice const & rowSlice);
374 // Check whether the row where the cursor lives needs to be scrolled.
375 // Update the drawing strategy if needed.
376 void checkCursorScrollOffset();
378 /// The minimal size of the document that is visible. Used
379 /// when it is allowed to scroll below the document.
380 int minVisiblePart();
382 /// Search recursively for the innermost inset that covers (x, y) position.
383 /// \retval 0 if no inset is found.
384 Inset const * getCoveringInset(
385 Text const & text, //< The Text where we start searching.
386 int x, //< x-coordinate on screen
387 int y //< y-coordinate on screen
390 /// Update the hovering status of the insets. This is called when
391 /// either the screen is updated or when the buffer has scolled.
392 void updateHoveredInset() const;
395 void updateDocumentClass(DocumentClassConstPtr olddc);
409 /// some space for drawing the 'nested' markers (in pixel)
410 inline int nestMargin() { return 15; }
412 /// margin for changebar
413 inline int changebarMargin() { return 12; }
417 #endif // BUFFERVIEW_H