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 void reset(int h = 0, int p = 0, int l = 0)
62 /// Total document height in pixels.
64 /// Current position in the document in pixels.
66 /// Line-scroll amount in pixels.
70 /// Screen view of a Buffer.
72 * A BufferView encapsulates a view onto a particular
73 * buffer, and allows access to operate upon it. A view
74 * is a sliding window of the entire document rendering.
75 * It is the official interface between the LyX core and
76 * the frontend WorkArea.
85 BufferView(Buffer & buffer);
89 /// return the buffer being viewed.
91 Buffer const & buffer() const;
93 /// perform pending metrics updates.
94 /** \c Update::FitCursor means first to do a FitCursor, and to
95 * force an update if screen position changes.
96 * \c Update::Force means to force an update in any case.
97 * \retval true if a screen redraw is needed
99 void processUpdateFlags(Update::flags flags);
101 /// move the screen to fit the cursor.
102 /// Only to be called with good y coordinates (after a bv::metrics)
104 /// reset the scrollbar to reflect current view position.
105 void updateScrollbar();
106 /// return the Scrollbar Parameters.
107 ScrollbarParameters const & scrollbarParameters() const;
108 /// \return Tool tip for the given position.
109 docstring toolTip(int x, int y) const;
110 /// \return the context menu for the given position.
111 docstring contextMenu(int x, int y) const;
113 /// Save the current position as bookmark.
114 /// if idx == 0, save to temp_bookmark
115 void saveBookmark(unsigned int idx);
116 /// goto a specified position, try top_id first, and then bottom_pit.
117 /// \return true if success
119 pit_type bottom_pit, ///< Paragraph pit, used when par_id is zero or invalid.
120 pos_type bottom_pos, ///< Paragraph pit, used when par_id is zero or invalid.
121 int top_id, ///< Paragraph ID, \sa Paragraph
122 pos_type top_pos ///< Position in the \c Paragraph
124 /// return the current change at the cursor.
125 Change const getCurrentChange() const;
127 /// move cursor to the named label.
128 void gotoLabel(docstring const & label);
130 /// set the cursor based on the given TeX source row.
131 void setCursorFromRow(int row);
133 /// Ensure the cursor is visible.
134 /// This method will automatically scroll and update the BufferView and updated
137 /// LFUN_SCROLL Helper.
138 void lfunScroll(FuncRequest const & cmd);
139 /// scroll down document by the given number of pixels.
140 void scrollDown(int pixels);
141 /// scroll up document by the given number of pixels.
142 void scrollUp(int pixels);
143 /// scroll document by the given number of pixels.
144 void scroll(int pixels);
145 /// Scroll the view by a number of pixels.
146 void scrollDocView(int pixels);
147 /// Set the cursor position based on the scrollbar one.
148 void setCursorFromScrollbar();
150 /// return the pixel width of the document view.
151 int workWidth() const;
152 /// return the pixel height of the document view.
153 int workHeight() const;
156 /// translate and insert a character, using the correct keymap.
157 void translateAndInsert(char_type c, Text * t, Cursor & cur);
159 /// return true for events that will handle.
160 FuncStatus getStatus(FuncRequest const & cmd);
161 /// execute the given function.
162 /// \return true if the function has been processed.
163 bool dispatch(FuncRequest const & argument);
165 /// request an X11 selection.
166 /// \return the selected string.
167 docstring const requestSelection();
168 /// clear the X11 selection.
169 void clearSelection();
171 /// resize the BufferView.
173 void resize(int width, int height);
175 /// dispatch method helper for \c WorkArea
177 void mouseEventDispatch(FuncRequest const & ev);
179 /// access to anchor.
180 pit_type anchor_ref() const;
183 CursorStatus cursorStatus(DocIterator const & dit) const;
184 /// access to full cursor.
186 /// access to full cursor.
187 Cursor const & cursor() const;
189 /// This will also open all relevant collapsable insets.
190 void setCursor(DocIterator const &);
191 /// Check deleteEmptyParagraphMechanism and update metrics if needed.
192 /// \retval true if an update was needed.
193 bool checkDepm(Cursor & cur, Cursor & old);
195 /// This is used when handling LFUN_MOUSE_PRESS.
196 bool mouseSetCursor(Cursor & cur, bool select = false);
198 /// sets the selection.
199 /* When \c backwards == false, set anchor
200 * to \c cur and cursor to \c cur + \c length. When \c
201 * backwards == true, set anchor to \c cur and cursor to \c
204 void putSelectionAt(DocIterator const & cur,
205 int length, bool backwards);
207 /// update the internal \c ViewMetricsInfo.
208 void updateMetrics();
211 TextMetrics const & textMetrics(Text const * t) const;
212 TextMetrics & textMetrics(Text const * t);
214 ParagraphMetrics const & parMetrics(Text const *, pit_type) const;
217 CoordCache & coordCache();
219 CoordCache const & coordCache() const;
222 Point getPos(DocIterator const & dit, bool boundary) const;
226 void draw(frontend::Painter & pain);
228 /// get this view's keyboard map handler.
231 Intl const & getIntl() const;
234 // Messages to the GUI
236 /// This signal is emitted when some message shows up.
237 void message(docstring const & msg);
239 /// This signal is emitted when some dialog needs to be shown.
240 void showDialog(std::string const & name);
242 /// This signal is emitted when some dialog needs to be shown with
244 void showDialog(std::string const & name, std::string const & data,
247 /// This signal is emitted when some dialogs needs to be updated.
248 void updateDialog(std::string const & name, std::string const & data);
251 void setGuiDelegate(frontend::GuiBufferViewDelegate *);
254 docstring contentsOfPlaintextFile(support::FileName const & f);
255 // Insert plain text file (if filename is empty, prompt for one)
256 void insertPlaintextFile(support::FileName const & f, bool asParagraph);
258 void insertLyXFile(support::FileName const & f);
262 BufferView(BufferView const &);
263 void operator=(BufferView const &);
265 // the position relative to (0, baseline) of outermost paragraph
266 Point coordOffset(DocIterator const & dit, bool boundary) const;
267 /// Update current paragraph metrics.
268 /// \return true if no further update is needed.
269 bool singleParUpdate();
271 /// Search recursively for the the innermost inset that covers (x, y) position.
272 /// \retval 0 if no inset is found.
273 Inset const * getCoveringInset(
274 Text const & text, //< The Text where we start searching.
275 int x, //< x-coordinate on screen
276 int y //< y-coordinate on screen
290 /// some space for drawing the 'nested' markers (in pixel)
291 inline int nestMargin() { return 15; }
293 /// margin for changebar
294 inline int changebarMargin() { return 12; }
297 inline int rightMargin() { return 10; }
301 #endif // BUFFERVIEW_H