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 /// scroll down document by the given number of pixels.
138 void scrollDown(int pixels);
139 /// scroll up document by the given number of pixels.
140 void scrollUp(int pixels);
141 /// scroll document by the given number of pixels.
142 void scroll(int pixels);
143 /// Scroll the view by a number of pixels.
144 void scrollDocView(int pixels);
145 /// Set the cursor position based on the scrollbar one.
146 void setCursorFromScrollbar();
148 /// return the pixel width of the document view.
149 int workWidth() const;
150 /// return the pixel height of the document view.
151 int workHeight() const;
154 /// translate and insert a character, using the correct keymap.
155 void translateAndInsert(char_type c, Text * t, Cursor & cur);
157 /// return true for events that will handle.
158 FuncStatus getStatus(FuncRequest const & cmd);
159 /// execute the given function.
160 /// \return true if the function has been processed.
161 bool dispatch(FuncRequest const & argument);
163 /// request an X11 selection.
164 /// \return the selected string.
165 docstring const requestSelection();
166 /// clear the X11 selection.
167 void clearSelection();
169 /// resize the BufferView.
171 void resize(int width, int height);
173 /// dispatch method helper for \c WorkArea
175 void mouseEventDispatch(FuncRequest const & ev);
177 /// access to anchor.
178 pit_type anchor_ref() const;
181 CursorStatus cursorStatus(DocIterator const & dit) const;
182 /// access to full cursor.
184 /// access to full cursor.
185 Cursor const & cursor() const;
187 /// This will also open all relevant collapsable insets.
188 void setCursor(DocIterator const &);
189 /// Check deleteEmptyParagraphMechanism and update metrics if needed.
190 /// \retval true if an update was needed.
191 bool checkDepm(Cursor & cur, Cursor & old);
193 /// This is used when handling LFUN_MOUSE_PRESS.
194 bool mouseSetCursor(Cursor & cur, bool select = false);
196 /// sets the selection.
197 /* When \c backwards == false, set anchor
198 * to \c cur and cursor to \c cur + \c length. When \c
199 * backwards == true, set anchor to \c cur and cursor to \c
202 void putSelectionAt(DocIterator const & cur,
203 int length, bool backwards);
205 /// update the internal \c ViewMetricsInfo.
206 void updateMetrics();
209 TextMetrics const & textMetrics(Text const * t) const;
210 TextMetrics & textMetrics(Text const * t);
212 ParagraphMetrics const & parMetrics(Text const *, pit_type) const;
215 CoordCache & coordCache();
217 CoordCache const & coordCache() const;
220 Point getPos(DocIterator const & dit, bool boundary) const;
224 void draw(frontend::Painter & pain);
226 /// get this view's keyboard map handler.
229 Intl const & getIntl() const;
232 // Messages to the GUI
234 /// This signal is emitted when some message shows up.
235 void message(docstring const & msg);
237 /// This signal is emitted when some dialog needs to be shown.
238 void showDialog(std::string const & name);
240 /// This signal is emitted when some dialog needs to be shown with
242 void showDialog(std::string const & name, std::string const & data,
245 /// This signal is emitted when some dialogs needs to be updated.
246 void updateDialog(std::string const & name, std::string const & data);
249 void setGuiDelegate(frontend::GuiBufferViewDelegate *);
252 docstring contentsOfPlaintextFile(support::FileName const & f);
253 // Insert plain text file (if filename is empty, prompt for one)
254 void insertPlaintextFile(support::FileName const & f, bool asParagraph);
256 void insertLyXFile(support::FileName const & f);
260 BufferView(BufferView const &);
261 void operator=(BufferView const &);
263 // the position relative to (0, baseline) of outermost paragraph
264 Point coordOffset(DocIterator const & dit, bool boundary) const;
265 /// Update current paragraph metrics.
266 /// \return true if no further update is needed.
267 bool singleParUpdate();
269 /// Search recursively for the the innermost inset that covers (x, y) position.
270 /// \retval 0 if no inset is found.
271 Inset const * getCoveringInset(
272 Text const & text, //< The Text where we start searching.
273 int x, //< x-coordinate on screen
274 int y //< y-coordinate on screen
288 /// some space for drawing the 'nested' markers (in pixel)
289 inline int nestMargin() { return 15; }
291 /// margin for changebar
292 inline int changebarMargin() { return 12; }
295 inline int rightMargin() { return 10; }
299 #endif // BUFFERVIEW_H