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"
19 #include "update_flags.h"
21 #include "support/strfwd.h"
22 #include "support/types.h"
26 namespace support { class FileName; }
28 namespace frontend { class Painter; }
29 namespace frontend { class GuiBufferViewDelegate; }
45 class ParagraphMetrics;
57 /// Scrollbar Parameters.
58 struct ScrollbarParameters
60 // These parameters are normalized against the screen geometry and pixel
61 // coordinates. Position 0 corresponds to the top the the screen.
63 : min(0), max(0), single_step(1), page_step(1)
65 /// Minimum scrollbar position in pixels.
67 /// Maximum scrollbar position in pixels.
69 /// Line-scroll amount in pixels.
71 /// Page-scroll amount in pixels.
75 /// Screen view of a Buffer.
77 * A BufferView encapsulates a view onto a particular
78 * buffer, and allows access to operate upon it. A view
79 * is a sliding window of the entire document rendering.
80 * It is the official interface between the LyX core and
81 * the frontend WorkArea.
90 explicit BufferView(Buffer & buffer);
94 /// return the buffer being viewed.
96 Buffer const & buffer() const;
99 void setFullScreen(bool full_screen) { full_screen_ = full_screen; }
102 int rightMargin() const;
105 int leftMargin() const;
107 /// \return true if the BufferView is at the top of the document.
108 bool isTopScreen() const;
110 /// \return true if the BufferView is at the bottom of the document.
111 bool isBottomScreen() const;
113 /// perform pending metrics updates.
114 /** \c Update::FitCursor means first to do a FitCursor, and to
115 * force an update if screen position changes.
116 * \c Update::Force means to force an update in any case.
117 * \retval true if a screen redraw is needed
119 void processUpdateFlags(Update::flags flags);
121 /// return true if one shall move the screen to fit the cursor.
122 /// Only to be called with good y coordinates (after a bv::metrics)
123 bool needsFitCursor() const;
125 // Returns the amount of horizontal scrolling applied to the
126 // top-level row where the cursor lies
127 int horizScrollOffset() const;
128 // Returns the amount of horizontal scrolling applied to the
129 // row of text starting at (pit, pos)
130 int horizScrollOffset(Text const * text,
131 pit_type pit, pos_type pos) const;
133 // Returns true if the row of text starting at (pit, pos) was scrolled
134 // at the last draw event.
135 bool hadHorizScrollOffset(Text const * text,
136 pit_type pit, pos_type pos) const;
138 /// reset the scrollbar to reflect current view position.
139 void updateScrollbar();
140 /// return the Scrollbar Parameters.
141 ScrollbarParameters const & scrollbarParameters() const;
142 /// \return Tool tip for the given position.
143 docstring toolTip(int x, int y) const;
144 /// \return the context menu for the given position.
145 std::string contextMenu(int x, int y) const;
147 /// Save the current position as bookmark.
148 /// if idx == 0, save to temp_bookmark
149 void saveBookmark(unsigned int idx);
150 /// goto a specified position, try top_id first, and then bottom_pit.
151 /// \return true if success
153 pit_type bottom_pit, ///< Paragraph pit, used when par_id is zero or invalid.
154 pos_type bottom_pos, ///< Paragraph pit, used when par_id is zero or invalid.
155 int top_id, ///< Paragraph ID, \sa Paragraph
156 pos_type top_pos ///< Position in the \c Paragraph
158 /// return the current change at the cursor.
159 Change const getCurrentChange() const;
161 /// move cursor to the named label.
162 void gotoLabel(docstring const & label);
164 /// set the cursor based on the given TeX source row.
165 void setCursorFromRow(int row);
167 void setCursorFromRow(int row, TexRow const & texrow);
169 /// set cursor to the given inset. Return true if found.
170 bool setCursorFromInset(Inset const *);
171 /// Recenters the BufferView such that the passed cursor
172 /// is in the center.
174 /// Ensure that the BufferView cursor is visible.
175 /// This method will automatically scroll and update the BufferView
176 /// (metrics+drawing) if needed.
178 /// Ensure the passed cursor \p dit is visible.
179 /// This method will automatically scroll and update the BufferView
180 /// (metrics+drawing) if needed.
181 /// \param recenter Whether the cursor should be centered on screen
182 void showCursor(DocIterator const & dit, bool recenter,
184 /// Scroll to the cursor.
185 void scrollToCursor();
186 /// Scroll to the cursor.
187 /// \param recenter Whether the cursor should be centered on screen
188 bool scrollToCursor(DocIterator const & dit, bool recenter);
189 /// scroll down document by the given number of pixels.
190 int scrollDown(int pixels);
191 /// scroll up document by the given number of pixels.
192 int scrollUp(int pixels);
193 /// scroll document by the given number of pixels.
194 int scroll(int pixels);
195 /// Scroll the view by a number of pixels.
196 void scrollDocView(int pixels, bool update);
197 /// Set the cursor position based on the scrollbar one.
198 void setCursorFromScrollbar();
200 /// return the pixel width of the document view.
201 int workWidth() const;
202 /// return the pixel height of the document view.
203 int workHeight() const;
205 /// return the inline completion postfix.
206 docstring const & inlineCompletion() const;
207 /// return the number of unique characters in the inline completion.
208 size_t const & inlineCompletionUniqueChars() const;
209 /// return the position in the buffer of the inline completion postfix.
210 DocIterator const & inlineCompletionPos() const;
211 /// make sure inline completion position is OK
212 void resetInlineCompletionPos();
213 /// set the inline completion postfix and its position in the buffer.
214 /// Updates the updateFlags in \c cur.
215 void setInlineCompletion(Cursor const & cur, DocIterator const & pos,
216 docstring const & completion, size_t uniqueChars = 0);
218 /// translate and insert a character, using the correct keymap.
219 void translateAndInsert(char_type c, Text * t, Cursor & cur);
221 /// \return true if we've made a decision
222 bool getStatus(FuncRequest const & cmd, FuncStatus & flag);
223 /// execute the given function.
224 void dispatch(FuncRequest const & cmd, DispatchResult & dr);
226 /// request an X11 selection.
227 /// \return the selected string.
228 docstring const requestSelection();
229 /// clear the X11 selection.
230 void clearSelection();
232 /// resize the BufferView.
234 void resize(int width, int height);
236 /// dispatch method helper for \c WorkArea
238 void mouseEventDispatch(FuncRequest const & ev);
240 /// access to anchor.
241 pit_type anchor_ref() const;
244 CursorStatus cursorStatus(DocIterator const & dit) const;
245 /// access to full cursor.
247 /// access to full cursor.
248 Cursor const & cursor() const;
250 /// This will also open all relevant collapsable insets.
251 void setCursor(DocIterator const &);
252 /// Check deleteEmptyParagraphMechanism and update metrics if needed.
253 /// \retval true if an update was needed.
254 bool checkDepm(Cursor & cur, Cursor & old);
256 /// This is used when handling LFUN_MOUSE_PRESS.
257 bool mouseSetCursor(Cursor & cur, bool select = false);
259 /// sets the selection.
260 /* When \c backwards == false, set anchor
261 * to \c cur and cursor to \c cur + \c length. When \c
262 * backwards == true, set anchor to \c cur and cursor to \c
265 void putSelectionAt(DocIterator const & cur,
266 int length, bool backwards);
268 /// selects the item at cursor if its paragraph is empty.
269 bool selectIfEmpty(DocIterator & cur);
271 /// update the internal \c ViewMetricsInfo.
272 void updateMetrics();
275 TextMetrics const & textMetrics(Text const * t) const;
276 TextMetrics & textMetrics(Text const * t);
278 ParagraphMetrics const & parMetrics(Text const *, pit_type) const;
281 CoordCache & coordCache();
283 CoordCache const & coordCache() const;
286 Point getPos(DocIterator const & dit) const;
287 /// is the paragraph of the cursor visible ?
288 bool paragraphVisible(DocIterator const & dit) const;
289 /// is the cursor currently visible in the view
290 bool cursorInView(Point const & p, int h) const;
291 /// get the position and height of the cursor
292 void cursorPosAndHeight(Point & p, int & h) const;
296 void draw(frontend::Painter & pain);
298 /// get this view's keyboard map handler.
301 Intl const & getIntl() const;
304 // Messages to the GUI
306 /// This signal is emitted when some message shows up.
307 void message(docstring const & msg);
309 /// This signal is emitted when some dialog needs to be shown.
310 void showDialog(std::string const & name);
312 /// This signal is emitted when some dialog needs to be shown with
314 void showDialog(std::string const & name, std::string const & data,
317 /// This signal is emitted when some dialogs needs to be updated.
318 void updateDialog(std::string const & name, std::string const & data);
321 void setGuiDelegate(frontend::GuiBufferViewDelegate *);
324 docstring contentsOfPlaintextFile(support::FileName const & f);
325 // Insert plain text file (if filename is empty, prompt for one)
326 void insertPlaintextFile(support::FileName const & f, bool asParagraph);
328 void insertLyXFile(support::FileName const & f);
329 /// save temporary bookmark for jump back navigation
330 void bookmarkEditPosition();
331 /// Find and return the inset associated with given dialog name.
332 Inset * editedInset(std::string const & name) const;
333 /// Associate an inset associated with given dialog name.
334 void editInset(std::string const & name, Inset * inset);
336 void clearLastInset(Inset * inset) const;
337 /// Is the mouse hovering a clickable inset or element?
338 bool clickableInset() const;
340 void makeDocumentClass();
344 BufferView(BufferView const &);
345 void operator=(BufferView const &);
347 /// the position relative to (0, baseline) of outermost paragraph
348 Point coordOffset(DocIterator const & dit) const;
349 /// Update current paragraph metrics.
350 /// \return true if no further update is needed.
351 bool singleParUpdate();
353 // Set the row on which the cursor lives.
354 void setCurrentRowSlice(CursorSlice const & rowSlice);
356 // Check whether the row where the cursor lives needs to be scrolled.
357 // Update the drawing strategy if needed.
358 void checkCursorScrollOffset(PainterInfo & pi);
360 /// The minimal size of the document that is visible. Used
361 /// when it is allowed to scroll below the document.
362 int minVisiblePart();
364 /// Search recursively for the innermost inset that covers (x, y) position.
365 /// \retval 0 if no inset is found.
366 Inset const * getCoveringInset(
367 Text const & text, //< The Text where we start searching.
368 int x, //< x-coordinate on screen
369 int y //< y-coordinate on screen
372 /// Update the hovering status of the insets. This is called when
373 /// either the screen is updated or when the buffer has scolled.
374 void updateHoveredInset() const;
377 void updateDocumentClass(DocumentClassConstPtr olddc);
391 /// some space for drawing the 'nested' markers (in pixel)
392 inline int nestMargin() { return 15; }
394 /// margin for changebar
395 inline int changebarMargin() { return 12; }
399 #endif // BUFFERVIEW_H