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 "update_flags.h"
20 #include "support/strfwd.h"
21 #include "support/types.h"
25 namespace support { class FileName; }
27 namespace frontend { class Painter; }
28 namespace frontend { class GuiBufferViewDelegate; }
41 class ParagraphMetrics;
52 /// Scrollbar Parameters.
53 struct ScrollbarParameters
55 /// Minimum scrollbar position in pixels.
57 /// Maximum scrollbar position in pixels.
59 /// Current position in the document in pixels.
61 /// Line-scroll amount in pixels.
63 /// Page-scroll amount in pixels.
67 /// Screen view of a Buffer.
69 * A BufferView encapsulates a view onto a particular
70 * buffer, and allows access to operate upon it. A view
71 * is a sliding window of the entire document rendering.
72 * It is the official interface between the LyX core and
73 * the frontend WorkArea.
82 explicit BufferView(Buffer & buffer);
86 /// return the buffer being viewed.
88 Buffer const & buffer() const;
91 void setFullScreen(bool full_screen) { full_screen_ = full_screen; }
94 int rightMargin() const;
97 int leftMargin() const;
99 /// perform pending metrics updates.
100 /** \c Update::FitCursor means first to do a FitCursor, and to
101 * force an update if screen position changes.
102 * \c Update::Force means to force an update in any case.
103 * \retval true if a screen redraw is needed
105 void processUpdateFlags(Update::flags flags);
107 /// move the screen to fit the cursor.
108 /// Only to be called with good y coordinates (after a bv::metrics)
110 /// reset the scrollbar to reflect current view position.
111 void updateScrollbar();
112 /// return the Scrollbar Parameters.
113 ScrollbarParameters const & scrollbarParameters() const;
114 /// \return Tool tip for the given position.
115 docstring toolTip(int x, int y) const;
116 /// \return the context menu for the given position.
117 docstring contextMenu(int x, int y) const;
119 /// Save the current position as bookmark.
120 /// if idx == 0, save to temp_bookmark
121 void saveBookmark(unsigned int idx);
122 /// goto a specified position, try top_id first, and then bottom_pit.
123 /// \return true if success
125 pit_type bottom_pit, ///< Paragraph pit, used when par_id is zero or invalid.
126 pos_type bottom_pos, ///< Paragraph pit, used when par_id is zero or invalid.
127 int top_id, ///< Paragraph ID, \sa Paragraph
128 pos_type top_pos ///< Position in the \c Paragraph
130 /// return the current change at the cursor.
131 Change const getCurrentChange() const;
133 /// move cursor to the named label.
134 void gotoLabel(docstring const & label);
136 /// set the cursor based on the given TeX source row.
137 void setCursorFromRow(int row);
139 /// Ensure that the BufferView cursor is visible.
140 /// This method will automatically scroll and update the BufferView
143 /// Ensure the passed cursor \p dit is visible.
144 /// This method will automatically scroll and update the BufferView
146 void showCursor(DocIterator const & dit);
147 /// LFUN_SCROLL Helper.
148 void lfunScroll(FuncRequest const & cmd);
149 /// scroll down document by the given number of pixels.
150 void scrollDown(int pixels);
151 /// scroll up document by the given number of pixels.
152 void scrollUp(int pixels);
153 /// scroll document by the given number of pixels.
154 void scroll(int pixels);
155 /// Scroll the view by a number of pixels.
156 void scrollDocView(int pixels);
157 /// Set the cursor position based on the scrollbar one.
158 void setCursorFromScrollbar();
160 /// return the pixel width of the document view.
161 int workWidth() const;
162 /// return the pixel height of the document view.
163 int workHeight() const;
165 /// return the inline completion postfix.
166 docstring const & inlineCompletion() const;
167 /// return the number of unique characters in the inline completion.
168 size_t const & inlineCompletionUniqueChars() const;
169 /// return the position in the buffer of the inline completion postfix.
170 DocIterator const & inlineCompletionPos() const;
171 /// set the inline completion postfix and its position in the buffer.
172 void setInlineCompletion(DocIterator const & pos, docstring const & completion,
173 size_t uniqueChars = 0);
175 /// translate and insert a character, using the correct keymap.
176 void translateAndInsert(char_type c, Text * t, Cursor & cur);
178 /// return true for events that will handle.
179 FuncStatus getStatus(FuncRequest const & cmd);
180 /// execute the given function.
181 /// \return true if the function has been processed.
182 bool dispatch(FuncRequest const & argument);
184 /// request an X11 selection.
185 /// \return the selected string.
186 docstring const requestSelection();
187 /// clear the X11 selection.
188 void clearSelection();
190 /// resize the BufferView.
192 void resize(int width, int height);
194 /// dispatch method helper for \c WorkArea
196 void mouseEventDispatch(FuncRequest const & ev);
198 /// access to anchor.
199 pit_type anchor_ref() const;
202 CursorStatus cursorStatus(DocIterator const & dit) const;
203 /// access to full cursor.
205 /// access to full cursor.
206 Cursor const & cursor() const;
208 /// This will also open all relevant collapsable insets.
209 void setCursor(DocIterator const &);
210 /// Check deleteEmptyParagraphMechanism and update metrics if needed.
211 /// \retval true if an update was needed.
212 bool checkDepm(Cursor & cur, Cursor & old);
214 /// This is used when handling LFUN_MOUSE_PRESS.
215 bool mouseSetCursor(Cursor & cur, bool select = false);
217 /// sets the selection.
218 /* When \c backwards == false, set anchor
219 * to \c cur and cursor to \c cur + \c length. When \c
220 * backwards == true, set anchor to \c cur and cursor to \c
223 void putSelectionAt(DocIterator const & cur,
224 int length, bool backwards);
226 /// update the internal \c ViewMetricsInfo.
227 void updateMetrics();
230 TextMetrics const & textMetrics(Text const * t) const;
231 TextMetrics & textMetrics(Text const * t);
233 ParagraphMetrics const & parMetrics(Text const *, pit_type) const;
236 CoordCache & coordCache();
238 CoordCache const & coordCache() const;
241 Point getPos(DocIterator const & dit, bool boundary) const;
245 void draw(frontend::Painter & pain);
247 /// get this view's keyboard map handler.
250 Intl const & getIntl() const;
253 // Messages to the GUI
255 /// This signal is emitted when some message shows up.
256 void message(docstring const & msg);
258 /// This signal is emitted when some dialog needs to be shown.
259 void showDialog(std::string const & name);
261 /// This signal is emitted when some dialog needs to be shown with
263 void showDialog(std::string const & name, std::string const & data,
266 /// This signal is emitted when some dialogs needs to be updated.
267 void updateDialog(std::string const & name, std::string const & data);
270 void setGuiDelegate(frontend::GuiBufferViewDelegate *);
273 docstring contentsOfPlaintextFile(support::FileName const & f);
274 // Insert plain text file (if filename is empty, prompt for one)
275 void insertPlaintextFile(support::FileName const & f, bool asParagraph);
277 void insertLyXFile(support::FileName const & f);
281 BufferView(BufferView const &);
282 void operator=(BufferView const &);
284 // the position relative to (0, baseline) of outermost paragraph
285 Point coordOffset(DocIterator const & dit, bool boundary) const;
286 /// Update current paragraph metrics.
287 /// \return true if no further update is needed.
288 bool singleParUpdate();
290 /// Search recursively for the the innermost inset that covers (x, y) position.
291 /// \retval 0 if no inset is found.
292 Inset const * getCoveringInset(
293 Text const & text, //< The Text where we start searching.
294 int x, //< x-coordinate on screen
295 int y //< y-coordinate on screen
311 /// some space for drawing the 'nested' markers (in pixel)
312 inline int nestMargin() { return 15; }
314 /// margin for changebar
315 inline int changebarMargin() { return 12; }
319 #endif // BUFFERVIEW_H