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, int width, int height);
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();
80 void updateScrollbar();
82 void scrollDocView(int value);
83 /// Wheel mouse scroll, move by multiples of text->defaultRowHeight().
84 void scroll(int lines);
86 void workAreaKeyPress(LyXKeySymPtr key, key_modifier::state state);
88 void selectionRequested();
94 bool available() const;
95 /// get the change at the cursor position
96 Change const getCurrentChange();
98 void savePosition(unsigned int i);
100 void restorePosition(unsigned int i);
102 bool isSavedPosition(unsigned int i);
103 /// save bookmarks to .lyx/session
104 void saveSavedPositions();
109 /// a function should be executed from the workarea
110 bool workAreaDispatch(FuncRequest const & ev);
111 /// return true for events that will handle
112 FuncStatus getStatus(FuncRequest const & cmd);
113 /// a function should be executed
114 bool dispatch(FuncRequest const & ev);
115 /// Flag: do a full redraw of inside text of inset
116 bool repaintAll() { return refresh_inside_; }
118 void repaintAll(bool r) {refresh_inside_ = r; }
121 lyx::frontend::Gui & gui() const;
123 lyx::frontend::WorkArea & workarea() const;
125 lyx::frontend::Clipboard & clipboard() const;
128 /// An error list (replaces the error insets)
129 ErrorList errorlist_;
130 /// add an error to the list
131 void addError(ErrorItem const &);
132 /// buffer errors signal connection
133 boost::signals::connection errorConnection_;
134 /// buffer messages signal connection
135 boost::signals::connection messageConnection_;
136 /// buffer busy status signal connection
137 boost::signals::connection busyConnection_;
138 /// buffer title changed signal connection
139 boost::signals::connection titleConnection_;
140 /// buffer reset timers signal connection
141 boost::signals::connection timerConnection_;
142 /// buffer readonly status changed signal connection
143 boost::signals::connection readonlyConnection_;
144 /// buffer closing signal connection
145 boost::signals::connection closingConnection_;
146 /// connect to signals in the given buffer
147 void connectBuffer(Buffer & buf);
148 /// disconnect from signals in the given buffer
149 void disconnectBuffer();
150 /// track changes for the document
152 /// notify readonly status
153 void showReadonly(bool);
157 friend class BufferView;
166 /// Estimated average par height for scrollbar
169 Timeout cursor_timeout;
171 void stuffClipboard(std::string const &) const;
173 bool using_xterm_cursor;
178 std::string filename;
179 /// Cursor paragraph Id
182 lyx::pos_type par_pos;
184 Position() : par_id(0), par_pos(0) {}
186 Position(std::string const & f, int id, lyx::pos_type pos)
187 : filename(f), par_id(id), par_pos(pos) {}
190 std::vector<Position> saved_positions;
192 void menuInsertLyXFile(std::string const & filen);
194 lyx::frontend::WorkArea * workArea_;
197 /// this is used to handle XSelection events in the right manner
206 bool multiparsel_cache_;
208 lyx::pit_type anchor_ref_;
212 ViewMetricsInfo metrics(bool singlepar = false);
213 /// Working variable indicating a full screen refresh
214 mutable bool refresh_inside_;
217 #endif // BUFFERVIEW_PIMPL_H