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 class BufferView::Pimpl : public boost::signals::trackable {
51 Pimpl(BufferView & bv, LyXView * owner, int width, int height);
53 Painter & painter() const;
54 /// return the screen for this bview
55 LyXScreen & screen() const;
57 void setBuffer(Buffer * buf);
59 void resizeCurrentBuffer();
63 void update(bool fitcursor = false, bool forceupdate = true);
65 void newFile(std::string const &, std::string const &, bool);
67 bool loadLyXFile(std::string const &, bool);
69 void workAreaResize();
71 void updateScrollbar();
73 void scrollDocView(int value);
74 /// Wheel mouse scroll, move by multiples of text->defaultRowHeight().
75 void scroll(int lines);
77 typedef boost::shared_ptr<LyXKeySym> LyXKeySymPtr;
79 void workAreaKeyPress(LyXKeySymPtr key, key_modifier::state state);
81 void selectionRequested();
87 bool available() const;
88 /// get the change at the cursor position
89 Change const getCurrentChange();
91 void savePosition(unsigned int i);
93 void restorePosition(unsigned int i);
95 bool isSavedPosition(unsigned int i);
100 /// a function should be executed from the workarea
101 bool workAreaDispatch(FuncRequest const & ev);
102 /// return true for events that will handle
103 FuncStatus getStatus(FuncRequest const & cmd);
104 /// a function should be executed
105 bool dispatch(FuncRequest const & ev);
107 /// An error list (replaces the error insets)
108 ErrorList errorlist_;
109 /// add an error to the list
110 void addError(ErrorItem const &);
111 /// buffer errors signal connection
112 boost::signals::connection errorConnection_;
113 /// buffer messages signal connection
114 boost::signals::connection messageConnection_;
115 /// buffer busy status signal connection
116 boost::signals::connection busyConnection_;
117 /// buffer title changed signal connection
118 boost::signals::connection titleConnection_;
119 /// buffer reset timers signal connection
120 boost::signals::connection timerConnection_;
121 /// buffer readonly status changed signal connection
122 boost::signals::connection readonlyConnection_;
123 /// buffer closing signal connection
124 boost::signals::connection closingConnection_;
125 /// connect to signals in the given buffer
126 void connectBuffer(Buffer & buf);
127 /// disconnect from signals in the given buffer
128 void disconnectBuffer();
129 /// track changes for the document
131 /// notify readonly status
132 void showReadonly(bool);
136 friend class BufferView;
145 boost::scoped_ptr<LyXScreen> screen_;
147 boost::scoped_ptr<WorkArea> workarea_;
149 Timeout cursor_timeout;
151 void stuffClipboard(std::string const &) const;
153 bool using_xterm_cursor;
158 std::string filename;
159 /// Cursor paragraph Id
162 lyx::pos_type par_pos;
164 Position() : par_id(0), par_pos(0) {}
166 Position(std::string const & f, int id, lyx::pos_type pos)
167 : filename(f), par_id(id), par_pos(pos) {}
170 std::vector<Position> saved_positions;
172 void MenuInsertLyXFile(std::string const & filen);
174 WorkArea & workarea() const;
175 /// this is used to handle XSelection events in the right manner
185 lyx::pit_type anchor_ref_;
189 ViewMetricsInfo metrics();
193 #endif // BUFFERVIEW_PIMPL_H