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>
38 * A buffer view encapsulates a view onto a particular
39 * buffer, and allows access to operate upon it. A view
40 * is a sliding window of the entire document rendering.
42 * Eventually we will allow several views onto a single
43 * buffer, but not yet.
45 class BufferView : boost::noncopyable {
48 * Create a view with the given owner main window,
49 * of the given dimensions.
51 BufferView(LyXView * owner, int x, int y, int w, int h);
55 /// set the buffer we are viewing
56 void buffer(Buffer * b);
57 /// return the buffer being viewed
58 Buffer * buffer() const;
60 /// return the painter object for drawing onto the view
61 Painter & painter() const;
62 /// return the screen object for handling re-drawing
63 LyXScreen & screen() const;
64 /// return the owning main view
65 LyXView * owner() const;
67 /// return the visible top y
70 /// set the visible top y
73 /// resize event has happened
76 /// reload the contained buffer
78 /// create a new buffer based on template
79 bool newFile(std::string const & fname, std::string const & tname,
81 /// load a buffer into the view
82 bool loadLyXFile(std::string const & name, bool tolastfiles = true);
84 /// fit the user cursor within the visible view
86 /// perform pending painting updates
88 /** update for a particular inset. Gets a pointer and not a
89 * reference because we really need the pointer information
90 * to find it in the buffer.
92 void updateInset(InsetOld const *);
93 /// reset the scrollbar to reflect current view position
94 void updateScrollbar();
96 void redoCurrentBuffer();
99 bool available() const;
102 void beforeChange(LyXText *);
104 /// Save the current position as bookmark i
105 void savePosition(unsigned int i);
106 /// Restore the position from bookmark i
107 void restorePosition(unsigned int i);
108 /// does the given bookmark have a saved position ?
109 bool isSavedPosition(unsigned int i);
111 /// return the current change at the cursor
112 Change const getCurrentChange();
115 * This holds the mapping between buffer paragraphs and screen rows.
116 * This should be private...but not yet. (Lgb)
119 /// return the lyxtext we are using
120 LyXText * getLyXText() const;
122 /// Return the current inset we are "locked" in
123 UpdatableInset * theLockingInset() const;
124 /// lock the given inset FIXME: return value ?
125 bool lockInset(UpdatableInset * inset);
126 /// unlock the given inset
127 int unlockInset(UpdatableInset * inset);
128 /// unlock the currently locked inset
131 /// return the current encoding at the cursor
132 Encoding const * getEncoding() const;
134 /// return the parent language of the given inset
135 Language const * getParentLanguage(InsetOld * inset) const;
137 /// replace the currently selected word
138 void replaceWord(std::string const & replacestring);
140 /// move cursor to the named label
141 void gotoLabel(std::string const & label);
148 /// get the stored error list
149 ErrorList const & getErrorList() const;
150 /// show the error list to the user
151 void showErrorList(std::string const &) const;
152 /// set the cursor based on the given TeX source row
153 void setCursorFromRow(int row);
156 * Insert an inset into the buffer.
157 * Place it in a layout of lout,
159 bool insertInset(InsetOld * inset, std::string const & lout = std::string());
161 /// Inserts a lyx file at cursor position. return false if it fails
162 bool insertLyXFile(std::string const & file);
165 bool fitLockedInsetCursor(int x, int y, int asc, int desc);
167 /// hide the cursor if it is visible
170 /// center the document view around the cursor
172 /// scroll document by the given number of lines of default height
173 void scroll(int lines);
174 /// Scroll the view by a number of pixels
175 void scrollDocView(int);
177 /// return the pixel width of the document view
178 int workWidth() const;
179 /// return the pixel height of the document view
180 int workHeight() const;
182 /// switch between primary and secondary keymaps for RTL entry
186 bool ChangeRefsIfUnique(std::string const & from, std::string const & to);
188 /// get the contents of the window system clipboard
189 std::string const getClipboard() const;
190 /// fill the window system clipboard
191 void stuffClipboard(std::string const &) const;
192 /// tell the window system we have a selection
193 void haveSelection(bool sel);
195 /// execute the given function
196 bool dispatch(FuncRequest const & argument);
198 /// set target x position of cursor
199 void BufferView::x_target(int x);
200 /// return target x position of cursor
201 int BufferView::x_target() const;
204 /// Set the current locking inset
205 void theLockingInset(UpdatableInset * inset);
208 friend struct BufferView::Pimpl;
213 * The target x position of the cursor. This is used for when
214 * we have text like :
216 * blah blah blah blah| blah blah blah
218 * blah blah blah blah blah blah
220 * When we move onto row 3, we would like to be vertically aligned
221 * with where we were in row 1, despite the fact that row 2 is
228 #endif // BUFFERVIEW_H