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; }
40 class ParagraphMetrics;
51 /// Scrollbar Parameters.
52 struct ScrollbarParameters
55 : min(0), max(0), position(0), single_step(1), page_step(1)
57 /// Minimum scrollbar position in pixels.
59 /// Maximum scrollbar position in pixels.
61 /// Current position in the document in pixels.
63 /// Line-scroll amount in pixels.
65 /// Page-scroll amount in pixels.
69 /// Screen view of a Buffer.
71 * A BufferView encapsulates a view onto a particular
72 * buffer, and allows access to operate upon it. A view
73 * is a sliding window of the entire document rendering.
74 * It is the official interface between the LyX core and
75 * the frontend WorkArea.
84 explicit BufferView(Buffer & buffer);
88 /// return the buffer being viewed.
90 Buffer const & buffer() const;
93 void setFullScreen(bool full_screen) { full_screen_ = full_screen; }
96 int rightMargin() const;
99 int leftMargin() const;
101 /// \return true if the BufferView is at the top of the document.
102 bool isTopScreen() const;
104 /// \return true if the BufferView is at the bottom of the document.
105 bool isBottomScreen() const;
107 /// perform pending metrics updates.
108 /** \c Update::FitCursor means first to do a FitCursor, and to
109 * force an update if screen position changes.
110 * \c Update::Force means to force an update in any case.
111 * \retval true if a screen redraw is needed
113 void processUpdateFlags(Update::flags flags);
115 /// move the screen to fit the cursor.
116 /// Only to be called with good y coordinates (after a bv::metrics)
118 /// reset the scrollbar to reflect current view position.
119 void updateScrollbar();
120 /// return the Scrollbar Parameters.
121 ScrollbarParameters const & scrollbarParameters() const;
122 /// \return Tool tip for the given position.
123 docstring toolTip(int x, int y) const;
124 /// \return the context menu for the given position.
125 docstring contextMenu(int x, int y) const;
127 /// Save the current position as bookmark.
128 /// if idx == 0, save to temp_bookmark
129 void saveBookmark(unsigned int idx);
130 /// goto a specified position, try top_id first, and then bottom_pit.
131 /// \return true if success
133 pit_type bottom_pit, ///< Paragraph pit, used when par_id is zero or invalid.
134 pos_type bottom_pos, ///< Paragraph pit, used when par_id is zero or invalid.
135 int top_id, ///< Paragraph ID, \sa Paragraph
136 pos_type top_pos ///< Position in the \c Paragraph
138 /// return the current change at the cursor.
139 Change const getCurrentChange() const;
141 /// move cursor to the named label.
142 void gotoLabel(docstring const & label);
144 /// set the cursor based on the given TeX source row.
145 void setCursorFromRow(int row);
147 /// set cursor to the given inset. Return true if found.
148 bool setCursorFromInset(Inset const *);
150 /// Ensure that the BufferView cursor is visible.
151 /// This method will automatically scroll and update the BufferView
154 /// Ensure the passed cursor \p dit is visible.
155 /// This method will automatically scroll and update the BufferView
157 void showCursor(DocIterator const & dit);
158 /// LFUN_SCROLL Helper.
159 void lfunScroll(FuncRequest const & cmd);
160 /// scroll down document by the given number of pixels.
161 int scrollDown(int pixels);
162 /// scroll up document by the given number of pixels.
163 int scrollUp(int pixels);
164 /// scroll document by the given number of pixels.
165 int scroll(int pixels);
166 /// Scroll the view by a number of pixels.
167 void scrollDocView(int pixels);
168 /// Set the cursor position based on the scrollbar one.
169 void setCursorFromScrollbar();
171 /// return the pixel width of the document view.
172 int workWidth() const;
173 /// return the pixel height of the document view.
174 int workHeight() const;
176 /// return the inline completion postfix.
177 docstring const & inlineCompletion() const;
178 /// return the number of unique characters in the inline completion.
179 size_t const & inlineCompletionUniqueChars() const;
180 /// return the position in the buffer of the inline completion postfix.
181 DocIterator const & inlineCompletionPos() const;
182 /// set the inline completion postfix and its position in the buffer.
183 /// Updates the updateFlags in \c cur.
184 void setInlineCompletion(Cursor & cur, DocIterator const & pos,
185 docstring const & completion, size_t uniqueChars = 0);
187 /// translate and insert a character, using the correct keymap.
188 void translateAndInsert(char_type c, Text * t, Cursor & cur);
190 /// return true for events that will handle.
191 FuncStatus getStatus(FuncRequest const & cmd);
192 /// execute the given function.
193 /// \return true if the function has been processed.
194 bool dispatch(FuncRequest const & argument);
196 /// request an X11 selection.
197 /// \return the selected string.
198 docstring const requestSelection();
199 /// clear the X11 selection.
200 void clearSelection();
202 /// resize the BufferView.
204 void resize(int width, int height);
206 /// dispatch method helper for \c WorkArea
208 void mouseEventDispatch(FuncRequest const & ev);
210 /// access to anchor.
211 pit_type anchor_ref() const;
214 CursorStatus cursorStatus(DocIterator const & dit) const;
215 /// access to full cursor.
217 /// access to full cursor.
218 Cursor const & cursor() const;
220 /// This will also open all relevant collapsable insets.
221 void setCursor(DocIterator const &);
222 /// Check deleteEmptyParagraphMechanism and update metrics if needed.
223 /// \retval true if an update was needed.
224 bool checkDepm(Cursor & cur, Cursor & old);
226 /// This is used when handling LFUN_MOUSE_PRESS.
227 bool mouseSetCursor(Cursor & cur, bool select = false);
229 /// sets the selection.
230 /* When \c backwards == false, set anchor
231 * to \c cur and cursor to \c cur + \c length. When \c
232 * backwards == true, set anchor to \c cur and cursor to \c
235 void putSelectionAt(DocIterator const & cur,
236 int length, bool backwards);
238 /// update the internal \c ViewMetricsInfo.
239 void updateMetrics();
242 TextMetrics const & textMetrics(Text const * t) const;
243 TextMetrics & textMetrics(Text const * t);
245 ParagraphMetrics const & parMetrics(Text const *, pit_type) const;
248 CoordCache & coordCache();
250 CoordCache const & coordCache() const;
253 Point getPos(DocIterator const & dit, bool boundary) const;
257 void draw(frontend::Painter & pain);
259 /// get this view's keyboard map handler.
262 Intl const & getIntl() const;
265 // Messages to the GUI
267 /// This signal is emitted when some message shows up.
268 void message(docstring const & msg);
270 /// This signal is emitted when some dialog needs to be shown.
271 void showDialog(std::string const & name);
273 /// This signal is emitted when some dialog needs to be shown with
275 void showDialog(std::string const & name, std::string const & data,
278 /// This signal is emitted when some dialogs needs to be updated.
279 void updateDialog(std::string const & name, std::string const & data);
282 void setGuiDelegate(frontend::GuiBufferViewDelegate *);
285 docstring contentsOfPlaintextFile(support::FileName const & f);
286 // Insert plain text file (if filename is empty, prompt for one)
287 void insertPlaintextFile(support::FileName const & f, bool asParagraph);
289 void insertLyXFile(support::FileName const & f);
293 BufferView(BufferView const &);
294 void operator=(BufferView const &);
296 // the position relative to (0, baseline) of outermost paragraph
297 Point coordOffset(DocIterator const & dit, bool boundary) const;
298 /// Update current paragraph metrics.
299 /// \return true if no further update is needed.
300 bool singleParUpdate();
302 /// Search recursively for the the innermost inset that covers (x, y) position.
303 /// \retval 0 if no inset is found.
304 Inset const * getCoveringInset(
305 Text const & text, //< The Text where we start searching.
306 int x, //< x-coordinate on screen
307 int y //< y-coordinate on screen
323 /// some space for drawing the 'nested' markers (in pixel)
324 inline int nestMargin() { return 15; }
326 /// margin for changebar
327 inline int changebarMargin() { return 12; }
331 #endif // BUFFERVIEW_H