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>
46 struct BufferView::Pimpl : public boost::signals::trackable {
48 Pimpl(BufferView & bv, LyXView * owner,
49 int xpos, int ypos, int width, int height);
51 Painter & painter() const;
52 /// return the screen for this bview
53 LyXScreen & screen() const;
55 void buffer(Buffer *);
56 /// Return true if the cursor was fitted.
59 void redoCurrentBuffer();
61 void resizeCurrentBuffer();
65 * Repaint pixmap. Used for when we've made a visible
66 * change but don't need the full update() logic
69 bool newFile(std::string const &, std::string const &, bool);
71 bool loadLyXFile(std::string const &, bool);
73 void workAreaResize();
75 void updateScrollbar();
77 void scrollDocView(int value);
78 /// Wheel mouse scroll, move by multiples of text->defaultRowHeight().
79 void scroll(int lines);
81 typedef boost::shared_ptr<LyXKeySym> LyXKeySymPtr;
83 void workAreaKeyPress(LyXKeySymPtr key, key_modifier::state state);
85 void selectionRequested();
91 bool available() const;
92 /// get the change at the cursor position
93 Change const getCurrentChange();
95 void savePosition(unsigned int i);
97 void restorePosition(unsigned int i);
99 bool isSavedPosition(unsigned int i);
104 /// a function should be executed from the workarea
105 bool workAreaDispatch(FuncRequest const & ev);
106 /// a function should be executed
107 bool dispatch(FuncRequest const & ev);
113 /// the y coordinate of the top of the screen
115 /// An error list (replaces the error insets)
116 ErrorList errorlist_;
117 /// add an error to the list
118 void addError(ErrorItem const &);
119 /// buffer errors signal connection
120 boost::signals::connection errorConnection_;
121 /// buffer messages signal connection
122 boost::signals::connection messageConnection_;
123 /// buffer busy status signal connection
124 boost::signals::connection busyConnection_;
125 /// buffer title changed signal connection
126 boost::signals::connection titleConnection_;
127 /// buffer reset timers signal connection
128 boost::signals::connection timerConnection_;
129 /// buffer readonly status changed signal connection
130 boost::signals::connection readonlyConnection_;
131 /// buffer closing signal connection
132 boost::signals::connection closingConnection_;
133 /// connect to signals in the given buffer
134 void connectBuffer(Buffer & buf);
135 /// disconnect from signals in the given buffer
136 void disconnectBuffer();
137 /// track changes for the document
139 /// notify readonly status
140 void showReadonly(bool);
143 * Change all insets with the given code's contents to a new
144 * string. May only be used with InsetCommand-derived insets
145 * Returns true if a screen update is needed.
147 bool ChangeInsets(InsetBase::Code code, std::string const & from,
148 std::string const & to);
151 friend class BufferView;
160 boost::scoped_ptr<LyXScreen> screen_;
162 boost::scoped_ptr<WorkArea> workarea_;
164 Timeout cursor_timeout;
166 void stuffClipboard(std::string const &) const;
168 bool using_xterm_cursor;
172 std::string filename;
173 /// Cursor paragraph Id
176 lyx::pos_type par_pos;
178 Position() : par_id(0), par_pos(0) {}
180 Position(std::string const & f, int id, lyx::pos_type pos)
181 : filename(f), par_id(id), par_pos(pos) {}
184 std::vector<Position> saved_positions;
185 /// Get next inset of this class from current cursor position
186 InsetBase * getInsetByCode(InsetBase::Code code);
188 void MenuInsertLyXFile(std::string const & filen);
190 WorkArea & workarea() const;
191 /// this is used to handle XSelection events in the right manner
200 #endif // BUFFERVIEW_PIMPL_H