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 /// return the current encoding at the cursor
115 Encoding const * getEncoding() const;
117 /// return the parent language of the given inset
118 Language const * getParentLanguage(InsetOld * inset) const;
120 /// simple replacing. Use the font of the first selected character
121 void replaceSelectionWithString(std::string const & str);
123 /// move cursor to the named label
124 void gotoLabel(std::string const & label);
126 /// get the stored error list
127 ErrorList const & getErrorList() const;
128 /// show the error list to the user
129 void showErrorList(std::string const &) const;
130 /// set the cursor based on the given TeX source row
131 void setCursorFromRow(int row);
133 /// Inserts a lyx file at cursor position. return false if it fails
134 bool insertLyXFile(std::string const & file);
137 bool fitLockedInsetCursor(int x, int y, int asc, int desc);
139 /// hide the cursor if it is visible
142 /// center the document view around the cursor
144 /// scroll document by the given number of lines of default height
145 void scroll(int lines);
146 /// Scroll the view by a number of pixels
147 void scrollDocView(int);
149 /// return the pixel width of the document view
150 int workWidth() const;
151 /// return the pixel height of the document view
152 int workHeight() const;
154 /// switch between primary and secondary keymaps for RTL entry
157 /// get the contents of the window system clipboard
158 std::string const getClipboard() const;
159 /// fill the window system clipboard
160 void stuffClipboard(std::string const &) const;
161 /// tell the window system we have a selection
162 void haveSelection(bool sel);
164 /// execute the given function
165 bool dispatch(FuncRequest const & argument);
167 /// clear the X selection
170 /// access to full cursor
172 /// access to full cursor
173 LCursor const & cursor() const;
175 LyXText * text() const;
177 void setCursor(ParIterator const & par, lyx::pos_type pos);
179 void putSelectionAt(PosIterator const & cur, int length, bool backwards);
185 friend struct BufferView::Pimpl;
190 #endif // BUFFERVIEW_H