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>
43 * A buffer view encapsulates a view onto a particular
44 * buffer, and allows access to operate upon it. A view
45 * is a sliding window of the entire document rendering.
47 * Eventually we will allow several views onto a single
48 * buffer, but not yet.
50 class BufferView : boost::noncopyable {
53 * Create a view with the given owner main window,
54 * of the given dimensions.
56 BufferView(LyXView * owner, int x, int y, int w, int h);
60 /// set the buffer we are viewing
61 void buffer(Buffer * b);
62 /// return the buffer being viewed
63 Buffer * buffer() const;
65 /// return the painter object for drawing onto the view
66 Painter & painter() const;
67 /// return the screen object for handling re-drawing
68 LyXScreen & screen() const;
69 /// return the owning main view
70 LyXView * owner() const;
72 /// return the visible top y
75 /// set the visible top y
78 /// resize event has happened
81 /// reload the contained buffer
83 /// create a new buffer based on template
84 bool newFile(std::string const & fname, std::string const & tname,
86 /// load a buffer into the view
87 bool loadLyXFile(std::string const & name, bool tolastfiles = true);
89 /// fit the user cursor within the visible view
91 /// perform pending painting updates
93 /// reset the scrollbar to reflect current view position
94 void updateScrollbar();
96 void redoCurrentBuffer();
99 bool available() const;
101 /// Save the current position as bookmark i
102 void savePosition(unsigned int i);
103 /// Restore the position from bookmark i
104 void restorePosition(unsigned int i);
105 /// does the given bookmark have a saved position ?
106 bool isSavedPosition(unsigned int i);
108 /// return the current change at the cursor
109 Change const getCurrentChange();
111 /// return the lyxtext we are using
112 LyXText * getLyXText() const;
114 /// update paragraph dialogs
115 void updateParagraphDialog();
117 /// return the current encoding at the cursor
118 Encoding const * getEncoding() const;
120 /// return the parent language of the given inset
121 Language const * getParentLanguage(InsetOld * inset) const;
123 /// replace the currently selected word
124 void replaceWord(std::string const & replacestring);
125 /// simple replacing. Use the font of the first selected character
126 void replaceSelectionWithString(std::string const & str);
128 /// move cursor to the named label
129 void gotoLabel(std::string const & label);
136 /// get the stored error list
137 ErrorList const & getErrorList() const;
138 /// show the error list to the user
139 void showErrorList(std::string const &) const;
140 /// set the cursor based on the given TeX source row
141 void setCursorFromRow(int row);
144 * Insert an inset into the buffer.
145 * Place it in a layout of lout,
147 bool insertInset(InsetBase * inset, std::string const & lout = std::string());
149 /// Inserts a lyx file at cursor position. return false if it fails
150 bool insertLyXFile(std::string const & file);
153 bool fitLockedInsetCursor(int x, int y, int asc, int desc);
155 /// hide the cursor if it is visible
158 /// center the document view around the cursor
160 /// scroll document by the given number of lines of default height
161 void scroll(int lines);
162 /// Scroll the view by a number of pixels
163 void scrollDocView(int);
165 /// return the pixel width of the document view
166 int workWidth() const;
167 /// return the pixel height of the document view
168 int workHeight() const;
170 /// switch between primary and secondary keymaps for RTL entry
174 bool ChangeRefsIfUnique(std::string const & from, std::string const & to);
176 /// get the contents of the window system clipboard
177 std::string const getClipboard() const;
178 /// fill the window system clipboard
179 void stuffClipboard(std::string const &) const;
180 /// tell the window system we have a selection
181 void haveSelection(bool sel);
183 /// execute the given function
184 bool dispatch(FuncRequest const & argument);
186 /// clear the X selection
189 /// access to full cursor
191 /// access to full cursor
192 LCursor const & cursor() const;
194 LyXText * text() const;
196 void setCursor(ParIterator const & par, lyx::pos_type pos);
198 void putSelectionAt(PosIterator const & cur, int length, bool backwards);
204 friend struct BufferView::Pimpl;
209 #endif // BUFFERVIEW_H