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/Timeout.h"
30 #include "support/types.h"
32 #include <boost/scoped_ptr.hpp>
33 #include <boost/shared_ptr.hpp>
34 #include <boost/signals/trackable.hpp>
44 class ViewMetricsInfo;
48 struct BufferView::Pimpl : public boost::signals::trackable {
50 Pimpl(BufferView & bv, LyXView * owner, int width, int height);
52 Painter & painter() const;
53 /// return the screen for this bview
54 LyXScreen & screen() const;
56 void setBuffer(Buffer * buf);
58 void resizeCurrentBuffer();
62 void update(bool fitcursor = false, bool forceupdate = true);
64 void newFile(std::string const &, std::string const &, bool);
66 bool loadLyXFile(std::string const &, bool);
68 void workAreaResize();
70 void updateScrollbar();
72 void scrollDocView(int value);
73 /// Wheel mouse scroll, move by multiples of text->defaultRowHeight().
74 void scroll(int lines);
76 typedef boost::shared_ptr<LyXKeySym> LyXKeySymPtr;
78 void workAreaKeyPress(LyXKeySymPtr key, key_modifier::state state);
80 void selectionRequested();
86 bool available() const;
87 /// get the change at the cursor position
88 Change const getCurrentChange();
90 void savePosition(unsigned int i);
92 void restorePosition(unsigned int i);
94 bool isSavedPosition(unsigned int i);
99 /// a function should be executed from the workarea
100 bool workAreaDispatch(FuncRequest const & ev);
101 /// return true for events that will handle
102 FuncStatus getStatus(FuncRequest const & cmd);
103 /// a function should be executed
104 bool dispatch(FuncRequest const & ev);
106 /// An error list (replaces the error insets)
107 ErrorList errorlist_;
108 /// add an error to the list
109 void addError(ErrorItem const &);
110 /// buffer errors signal connection
111 boost::signals::connection errorConnection_;
112 /// buffer messages signal connection
113 boost::signals::connection messageConnection_;
114 /// buffer busy status signal connection
115 boost::signals::connection busyConnection_;
116 /// buffer title changed signal connection
117 boost::signals::connection titleConnection_;
118 /// buffer reset timers signal connection
119 boost::signals::connection timerConnection_;
120 /// buffer readonly status changed signal connection
121 boost::signals::connection readonlyConnection_;
122 /// buffer closing signal connection
123 boost::signals::connection closingConnection_;
124 /// connect to signals in the given buffer
125 void connectBuffer(Buffer & buf);
126 /// disconnect from signals in the given buffer
127 void disconnectBuffer();
128 /// track changes for the document
130 /// notify readonly status
131 void showReadonly(bool);
135 friend class BufferView;
144 boost::scoped_ptr<LyXScreen> screen_;
146 boost::scoped_ptr<WorkArea> workarea_;
148 Timeout cursor_timeout;
150 void stuffClipboard(std::string const &) const;
152 bool using_xterm_cursor;
156 std::string filename;
157 /// Cursor paragraph Id
160 lyx::pos_type par_pos;
162 Position() : par_id(0), par_pos(0) {}
164 Position(std::string const & f, int id, lyx::pos_type pos)
165 : filename(f), par_id(id), par_pos(pos) {}
168 std::vector<Position> saved_positions;
170 void MenuInsertLyXFile(std::string const & filen);
172 WorkArea & workarea() const;
173 /// this is used to handle XSelection events in the right manner
183 lyx::pit_type anchor_ref_;
187 ViewMetricsInfo metrics();
191 #endif // BUFFERVIEW_PIMPL_H