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 "support/types.h"
20 #include <boost/utility.hpp>
39 * A buffer view encapsulates a view onto a particular
40 * buffer, and allows access to operate upon it. A view
41 * is a sliding window of the entire document rendering.
43 * Eventually we will allow several views onto a single
44 * buffer, but not yet.
46 class BufferView : boost::noncopyable {
49 * Create a view with the given owner main window,
50 * of the given dimensions.
52 BufferView(LyXView * owner, int w, int h);
56 /// set the buffer we are viewing
57 void setBuffer(Buffer * b);
58 /// return the buffer being viewed
59 Buffer * buffer() const;
61 /// return the painter object for drawing onto the view
62 Painter & painter() const;
63 /// return the screen object for handling re-drawing
64 LyXScreen & screen() const;
65 /// return the owning main view
66 LyXView * owner() const;
68 /// resize event has happened
71 /// reload the contained buffer
73 /// create a new buffer based on template
74 void newFile(std::string const & fname, std::string const & tname,
76 /// load a buffer into the view
77 bool loadLyXFile(std::string const & name, bool tolastfiles = true);
79 /** perform pending painting updates. \c fitcursor means first
80 * to do a fitcursor, and to force an update if screen
81 * position changes. \c forceupdate means to force an update
84 void update(bool fitcursor = true, bool forceupdate = true);
85 /// move the screen to fit the cursor. Only to be called with
86 /// good y coordinates (after a bv::metrics)
88 /// reset the scrollbar to reflect current view position
89 void updateScrollbar();
92 bool available() const;
94 /// Save the current position as bookmark i
95 void savePosition(unsigned int i);
96 /// Restore the position from bookmark i
97 void restorePosition(unsigned int i);
98 /// does the given bookmark have a saved position ?
99 bool isSavedPosition(unsigned int i);
101 /// return the current change at the cursor
102 Change const getCurrentChange();
104 /// return the lyxtext we are using
105 LyXText * getLyXText() const;
107 /// simple replacing. Use the font of the first selected character
108 void replaceSelectionWithString(std::string const & str);
110 /// move cursor to the named label
111 void gotoLabel(std::string const & label);
113 /// get the stored error list
114 ErrorList const & getErrorList() const;
115 /// show the error list to the user
116 void showErrorList(std::string const &) const;
117 /// set the cursor based on the given TeX source row
118 void setCursorFromRow(int row);
120 /// hide the cursor if it is visible
123 /// center the document view around the cursor
125 /// scroll document by the given number of lines of default height
126 void scroll(int lines);
127 /// Scroll the view by a number of pixels
128 void scrollDocView(int pixels);
130 /// return the pixel width of the document view
131 int workWidth() const;
132 /// return the pixel height of the document view
133 int workHeight() const;
135 /// switch between primary and secondary keymaps for RTL entry
138 /// get the contents of the window system clipboard
139 std::string const getClipboard() const;
140 /// fill the window system clipboard
141 void stuffClipboard(std::string const &) const;
142 /// tell the window system we have a selection
143 void haveSelection(bool sel);
145 /// return true for events that will handle
146 FuncStatus getStatus(FuncRequest const & cmd);
147 /// execute the given function
148 bool dispatch(FuncRequest const & argument);
150 /// clear the X selection
154 int offset_ref() const;
156 lyx::pit_type anchor_ref() const;
158 /// access to full cursor
160 /// access to full cursor
161 LCursor const & cursor() const;
163 LyXText * text() const;
165 void setCursor(ParIterator const & par, lyx::pos_type pos);
166 /* Sets the selection. When \c backwards == false, set anchor
167 * to \c cur and cursor to \c cur + \c length. When \c
168 * backwards == true, set anchor to \c cur and cursor to \c
171 void putSelectionAt(DocIterator const & cur,
172 int length, bool backwards);
179 friend struct BufferView::Pimpl;
184 #endif // BUFFERVIEW_H