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 "frontends/LyXKeySym.h"
20 #include "support/types.h"
22 #include <boost/utility.hpp>
46 inline flags operator|(flags const f, flags const g)
48 return static_cast<flags>(int(f) | int(g));
51 inline flags operator&(flags const f, flags const g)
53 return static_cast<flags>(int(f) & int(g));
58 /// Scrollbar Parameters
59 struct ScrollbarParameters
61 void reset(int h = 0, int p = 0, int l = 0)
68 /// The total document height in pixels
70 /// The current position in the document, in pixels
72 /// the line-scroll amount, in pixels
77 * A buffer view encapsulates a view onto a particular
78 * buffer, and allows access to operate upon it. A view
79 * is a sliding window of the entire document rendering.
81 * Eventually we will allow several views onto a single
82 * buffer, but not yet.
84 class BufferView : boost::noncopyable {
87 * Create a view with the given owner main window,
88 * of the given dimensions.
90 BufferView(LyXView * owner);
94 /// set the buffer we are viewing
95 void setBuffer(Buffer * b);
96 /// return the buffer being viewed
97 Buffer * buffer() const;
99 /// return the owning main view
100 LyXView * owner() const;
102 /// resize event has happened
105 /// reload the contained buffer
107 /// create a new buffer based on template
108 void newFile(std::string const & fname, std::string const & tname,
110 /// load a buffer into the view
111 bool loadLyXFile(std::string const & name, bool tolastfiles = true);
113 /** perform pending painting updates. \c fitcursor means first
114 * to do a fitcursor, and to force an update if screen
115 * position changes. \c forceupdate means to force an update
119 void update(Update::flags flags = Update::FitCursor | Update::Force);
120 /// move the screen to fit the cursor. Only to be called with
121 /// good y coordinates (after a bv::metrics)
123 /// reset the scrollbar to reflect current view position
124 void updateScrollbar();
125 /// return the Scrollbar Parameters
126 ScrollbarParameters const & scrollbarParameters() const;
129 bool available() const;
131 /// Save the current position as bookmark i
132 void savePosition(unsigned int i);
133 /// Restore the position from bookmark i
134 void restorePosition(unsigned int i);
135 /// does the given bookmark have a saved position ?
136 bool isSavedPosition(unsigned int i);
137 /// save bookmarks to .lyx/session
138 void saveSavedPositions();
140 /// return the current change at the cursor
141 Change const getCurrentChange();
143 /// return the lyxtext we are using
144 LyXText * getLyXText();
146 /// return the lyxtext we are using
147 LyXText const * getLyXText() const;
149 /// simple replacing. Use the font of the first selected character
150 void replaceSelectionWithString(std::string const & str);
152 /// move cursor to the named label
153 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);
162 /// hide the cursor if it is visible
165 /// center the document view around the cursor
167 /// scroll document by the given number of lines of default height
168 void scroll(int lines);
169 /// Scroll the view by a number of pixels
170 void scrollDocView(int pixels);
172 /// return the pixel width of the document view
173 int workWidth() const;
174 /// return the pixel height of the document view
175 int workHeight() const;
177 /// switch between primary and secondary keymaps for RTL entry
180 /// return true for events that will handle
181 FuncStatus getStatus(FuncRequest const & cmd);
182 /// execute the given function
183 bool dispatch(FuncRequest const & argument);
186 void selectionRequested();
188 void selectionLost();
191 void workAreaResize(int width, int height);
193 /// Receive a keypress
194 void workAreaKeyPress(LyXKeySymPtr key, key_modifier::state state);
196 /// a function should be executed from the workarea
197 bool workAreaDispatch(FuncRequest const & ev);
199 /// clear the X selection
203 int offset_ref() const;
205 lyx::pit_type anchor_ref() const;
207 /// access to full cursor
209 /// access to full cursor
210 LCursor const & cursor() const;
212 LyXText * text() const;
213 /// sets cursor and open all relevant collapsable insets.
214 void setCursor(DocIterator const &);
215 /// sets cursor; this is used when handling LFUN_MOUSE_PRESS.
216 void mouseSetCursor(LCursor & cur);
218 /* Sets the selection. When \c backwards == false, set anchor
219 * to \c cur and cursor to \c cur + \c length. When \c
220 * backwards == true, set anchor to \c cur and cursor to \c
223 void putSelectionAt(DocIterator const & cur,
224 int length, bool backwards);
230 friend class BufferView::Pimpl;
235 #endif // BUFFERVIEW_H