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 <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 x, int y, int w, int h);
56 /// set the buffer we are viewing
57 void buffer(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 /// return the visible top y
71 /// set the visible top y
74 /// resize event has happened
77 /// reload the contained buffer
79 /// create a new buffer based on template
80 bool newFile(std::string const & fname, std::string const & tname,
82 /// load a buffer into the view
83 bool loadLyXFile(std::string const & name, bool tolastfiles = true);
85 /// fit the user cursor within the visible view
87 /// perform pending painting updates
89 /// reset the scrollbar to reflect current view position
90 void updateScrollbar();
92 void redoCurrentBuffer();
95 bool available() const;
97 /// Save the current position as bookmark i
98 void savePosition(unsigned int i);
99 /// Restore the position from bookmark i
100 void restorePosition(unsigned int i);
101 /// does the given bookmark have a saved position ?
102 bool isSavedPosition(unsigned int i);
104 /// return the current change at the cursor
105 Change const getCurrentChange();
108 * This holds the mapping between buffer paragraphs and screen rows.
109 * This should be private...but not yet. (Lgb)
112 /// return the lyxtext we are using
113 LyXText * getLyXText() const;
115 /// update paragraph dialogs
116 void updateParagraphDialog();
118 /// return the current encoding at the cursor
119 Encoding const * getEncoding() const;
121 /// return the parent language of the given inset
122 Language const * getParentLanguage(InsetOld * inset) const;
124 /// replace the currently selected word
125 void replaceWord(std::string const & replacestring);
127 /// move cursor to the named label
128 void gotoLabel(std::string const & label);
135 /// get the stored error list
136 ErrorList const & getErrorList() const;
137 /// show the error list to the user
138 void showErrorList(std::string const &) const;
139 /// set the cursor based on the given TeX source row
140 void setCursorFromRow(int row);
143 * Insert an inset into the buffer.
144 * Place it in a layout of lout,
146 bool insertInset(InsetOld * inset, std::string const & lout = std::string());
148 /// Inserts a lyx file at cursor position. return false if it fails
149 bool insertLyXFile(std::string const & file);
152 bool fitLockedInsetCursor(int x, int y, int asc, int desc);
154 /// hide the cursor if it is visible
157 /// center the document view around the cursor
159 /// scroll document by the given number of lines of default height
160 void scroll(int lines);
161 /// Scroll the view by a number of pixels
162 void scrollDocView(int);
164 /// return the pixel width of the document view
165 int workWidth() const;
166 /// return the pixel height of the document view
167 int workHeight() const;
169 /// switch between primary and secondary keymaps for RTL entry
173 bool ChangeRefsIfUnique(std::string const & from, std::string const & to);
175 /// get the contents of the window system clipboard
176 std::string const getClipboard() const;
177 /// fill the window system clipboard
178 void stuffClipboard(std::string const &) const;
179 /// tell the window system we have a selection
180 void haveSelection(bool sel);
182 /// execute the given function
183 bool dispatch(FuncRequest const & argument);
185 /// set target x position of cursor
186 void x_target(int x);
187 /// return target x position of cursor
188 int x_target() const;
193 LCursor const & cursor() const;
195 UpdatableInset * innerInset() const;
199 friend struct BufferView::Pimpl;
204 * The target x position of the cursor. This is used for when
205 * we have text like :
207 * blah blah blah blah| blah blah blah
209 * blah blah blah blah blah blah
211 * When we move onto row 3, we would like to be vertically aligned
212 * with where we were in row 1, despite the fact that row 2 is
219 #endif // BUFFERVIEW_H