3 * \file BufferView_pimpl.h
4 * This file is part of LyX, the document processor.
5 * Licence details can be found in the file COPYING.
7 * \author Asger Alstrup
8 * \author Alfredo Braustein
9 * \author Lars Gullik Bjønnes
11 * \author André Pönitz
13 * \author Jürgen Vigna
15 * Full author contact details are available in file CREDITS.
18 #ifndef BUFFERVIEW_PIMPL_H
19 #define BUFFERVIEW_PIMPL_H
21 #include "BufferView.h"
23 #include "errorlist.h"
25 #include "insets/inset.h"
27 #include "frontends/key_state.h"
28 #include "frontends/LyXKeySym.h"
29 #include "frontends/Timeout.h"
31 #include "support/types.h"
33 #include <boost/scoped_ptr.hpp>
34 #include <boost/shared_ptr.hpp>
35 #include <boost/signals/trackable.hpp>
43 class ViewMetricsInfo;
57 class BufferView::Pimpl : public boost::signals::trackable {
60 Pimpl(BufferView & bv, LyXView * owner, lyx::frontend::WorkArea * workArea);
62 lyx::frontend::Painter & painter() const;
64 void setBuffer(Buffer * buf);
66 void resizeCurrentBuffer();
72 void update(Update::flags flags = Update::Force);
74 void newFile(std::string const &, std::string const &, bool);
76 bool loadLyXFile(std::string const &, bool);
78 void workAreaResize(int width, int height);
80 void updateScrollbar();
82 ScrollbarParameters const & scrollbarParameters() const;
84 void scrollDocView(int value);
85 /// Wheel mouse scroll, move by multiples of text->defaultRowHeight().
86 void scroll(int lines);
88 void workAreaKeyPress(LyXKeySymPtr key, key_modifier::state state);
90 void selectionRequested();
96 bool available() const;
97 /// get the change at the cursor position
98 Change const getCurrentChange();
100 void savePosition(unsigned int i);
102 void restorePosition(unsigned int i);
104 bool isSavedPosition(unsigned int i);
105 /// save bookmarks to .lyx/session
106 void saveSavedPositions();
111 /// a function should be executed from the workarea
112 bool workAreaDispatch(FuncRequest const & ev);
113 /// return true for events that will handle
114 FuncStatus getStatus(FuncRequest const & cmd);
115 /// a function should be executed
116 bool dispatch(FuncRequest const & ev);
117 /// Flag: do a full redraw of inside text of inset
118 bool repaintAll() { return refresh_inside_; }
120 void repaintAll(bool r) {refresh_inside_ = r; }
123 lyx::frontend::Gui & gui() const;
125 lyx::frontend::WorkArea & workarea() const;
127 lyx::frontend::Clipboard & clipboard() const;
129 /// Width and height of the BufferView in Pixels
131 This is set externally by the workAreaResize method.
134 /// Height of the BufferView in Pixels
136 This is set externally by the workAreaResize method.
146 ScrollbarParameters scrollbarParameters_;
148 /// An error list (replaces the error insets)
149 ErrorList errorlist_;
150 /// add an error to the list
151 void addError(ErrorItem const &);
152 /// buffer errors signal connection
153 boost::signals::connection errorConnection_;
154 /// buffer messages signal connection
155 boost::signals::connection messageConnection_;
156 /// buffer busy status signal connection
157 boost::signals::connection busyConnection_;
158 /// buffer title changed signal connection
159 boost::signals::connection titleConnection_;
160 /// buffer reset timers signal connection
161 boost::signals::connection timerConnection_;
162 /// buffer readonly status changed signal connection
163 boost::signals::connection readonlyConnection_;
164 /// buffer closing signal connection
165 boost::signals::connection closingConnection_;
166 /// connect to signals in the given buffer
167 void connectBuffer(Buffer & buf);
168 /// disconnect from signals in the given buffer
169 void disconnectBuffer();
170 /// track changes for the document
172 /// notify readonly status
173 void showReadonly(bool);
177 friend class BufferView;
186 /// Estimated average par height for scrollbar
189 Timeout cursor_timeout;
191 void stuffClipboard(std::string const &) const;
193 bool using_xterm_cursor;
198 std::string filename;
199 /// Cursor paragraph Id
202 lyx::pos_type par_pos;
204 Position() : par_id(0), par_pos(0) {}
206 Position(std::string const & f, int id, lyx::pos_type pos)
207 : filename(f), par_id(id), par_pos(pos) {}
210 std::vector<Position> saved_positions;
212 void menuInsertLyXFile(std::string const & filen);
214 lyx::frontend::WorkArea * workArea_;
216 /// this is used to handle XSelection events in the right manner
225 bool multiparsel_cache_;
227 lyx::pit_type anchor_ref_;
231 ViewMetricsInfo metrics(bool singlepar = false);
232 /// Working variable indicating a full screen refresh
233 mutable bool refresh_inside_;
236 #endif // BUFFERVIEW_PIMPL_H