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 /** update for a particular inset. Gets a pointer and not a
90 * reference because we really need the pointer information
91 * to find it in the buffer.
93 void updateInset(InsetOld const *);
94 /// reset the scrollbar to reflect current view position
95 void updateScrollbar();
97 void redoCurrentBuffer();
100 bool available() const;
103 void beforeChange(LyXText *);
105 /// Save the current position as bookmark i
106 void savePosition(unsigned int i);
107 /// Restore the position from bookmark i
108 void restorePosition(unsigned int i);
109 /// does the given bookmark have a saved position ?
110 bool isSavedPosition(unsigned int i);
112 /// return the current change at the cursor
113 Change const getCurrentChange();
116 * This holds the mapping between buffer paragraphs and screen rows.
117 * This should be private...but not yet. (Lgb)
120 /// return the lyxtext we are using
121 LyXText * getLyXText() const;
123 /// Return the current inset we are "locked" in
124 UpdatableInset * theLockingInset() const;
125 /// lock the given inset FIXME: return value ?
126 bool lockInset(UpdatableInset * inset);
127 /// unlock the given inset
128 int unlockInset(UpdatableInset * inset);
129 /// unlock the currently locked inset
132 /// return the current encoding at the cursor
133 Encoding const * getEncoding() const;
135 /// return the parent language of the given inset
136 Language const * getParentLanguage(InsetOld * inset) const;
138 /// Select the "current" word
139 void selectLastWord();
140 /// replace the currently selected word
141 void replaceWord(std::string const & replacestring);
142 /// Update after spellcheck finishes
143 void endOfSpellCheck();
144 /// return the next word
145 WordLangTuple const nextWord(float & value);
147 /// move cursor to the named label
148 void gotoLabel(std::string const & label);
155 /// get the stored error list
156 ErrorList const & getErrorList() const;
157 /// show the error list to the user
158 void showErrorList(std::string const &) const;
159 /// set the cursor based on the given TeX source row
160 void setCursorFromRow(int row);
163 * Insert an inset into the buffer.
164 * Place it in a layout of lout,
166 bool insertInset(InsetOld * inset, std::string const & lout = std::string());
168 /// Inserts a lyx file at cursor position. return false if it fails
169 bool insertLyXFile(std::string const & file);
172 bool fitLockedInsetCursor(int x, int y, int asc, int desc);
174 /// hide the cursor if it is visible
177 /// center the document view around the cursor
179 /// scroll document by the given number of lines of default height
180 void scroll(int lines);
181 /// Scroll the view by a number of pixels
182 void scrollDocView(int);
184 /// return the pixel width of the document view
185 int workWidth() const;
186 /// return the pixel height of the document view
187 int workHeight() const;
189 /// switch between primary and secondary keymaps for RTL entry
193 bool ChangeRefsIfUnique(std::string const & from, std::string const & to);
195 /// get the contents of the window system clipboard
196 std::string const getClipboard() const;
197 /// fill the window system clipboard
198 void stuffClipboard(std::string const &) const;
199 /// tell the window system we have a selection
200 void haveSelection(bool sel);
202 /// execute the given function
203 bool dispatch(FuncRequest const & argument);
206 /// Set the current locking inset
207 void theLockingInset(UpdatableInset * inset);
210 friend struct BufferView::Pimpl;
215 #endif // BUFFERVIEW_H