]> git.lyx.org Git - lyx.git/blob - src/BufferView_pimpl.h
6c6766af2b110bc82d012edca9fbc9bc06b67a29
[lyx.git] / src / BufferView_pimpl.h
1 // -*- C++ -*-
2 /**
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.
6  *
7  * \author Asger Alstrup
8  * \author Alfredo Braustein
9  * \author Lars Gullik Bjønnes
10  * \author John Levon
11  * \author André Pönitz
12  * \author Dekel Tsur
13  * \author Jürgen Vigna
14  *
15  * Full author contact details are available in file CREDITS.
16  */
17
18 #ifndef BUFFERVIEW_PIMPL_H
19 #define BUFFERVIEW_PIMPL_H
20
21 #include "BufferView.h"
22 #include "cursor.h"
23 #include "errorlist.h"
24
25 #include "insets/inset.h"
26
27 #include "frontends/key_state.h"
28 #include "frontends/Timeout.h"
29
30 #include "support/types.h"
31
32 #include <boost/scoped_ptr.hpp>
33 #include <boost/shared_ptr.hpp>
34 #include <boost/signals/trackable.hpp>
35
36
37 class Change;
38 class LyXKeySym;
39 class LyXView;
40 class WorkArea;
41 class LyXScreen;
42 class FuncRequest;
43 class FuncStatus;
44
45
46 ///
47 struct BufferView::Pimpl : public boost::signals::trackable {
48         ///
49         Pimpl(BufferView & bv, LyXView * owner, int width, int height);
50         ///
51         Painter & painter() const;
52         /// return the screen for this bview
53         LyXScreen & screen() const;
54         ///
55         void setBuffer(Buffer * buf);
56         /// Return true if the cursor was fitted.
57         bool fitCursor();
58         ///
59         void redoCurrentBuffer();
60         ///
61         void resizeCurrentBuffer();
62         ///
63         void update();
64         ///
65         void newFile(std::string const &, std::string const &, bool);
66         ///
67         bool loadLyXFile(std::string const &, bool);
68         ///
69         void workAreaResize();
70         ///
71         void updateScrollbar();
72         ///
73         void scrollDocView(int value);
74         /// Wheel mouse scroll, move by multiples of text->defaultRowHeight().
75         void scroll(int lines);
76         ///
77         typedef boost::shared_ptr<LyXKeySym> LyXKeySymPtr;
78         ///
79         void workAreaKeyPress(LyXKeySymPtr key, key_modifier::state state);
80         ///
81         void selectionRequested();
82         ///
83         void selectionLost();
84         ///
85         void cursorToggle();
86         ///
87         bool available() const;
88         /// get the change at the cursor position
89         Change const getCurrentChange();
90         ///
91         void savePosition(unsigned int i);
92         ///
93         void restorePosition(unsigned int i);
94         ///
95         bool isSavedPosition(unsigned int i);
96         ///
97         void switchKeyMap();
98         ///
99         void center();
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);
106         ///
107         int top_y() const;
108         ///
109         void top_y(int y);
110 private:
111         /// the y coordinate of the top of the screen
112         int top_y_;
113         /// An error list (replaces the error insets)
114         ErrorList errorlist_;
115         /// add an error to the list
116         void addError(ErrorItem const &);
117         /// buffer errors signal connection
118         boost::signals::connection errorConnection_;
119         /// buffer messages signal connection
120         boost::signals::connection messageConnection_;
121         /// buffer busy status signal connection
122         boost::signals::connection busyConnection_;
123         /// buffer title changed signal connection
124         boost::signals::connection titleConnection_;
125         /// buffer reset timers signal connection
126         boost::signals::connection timerConnection_;
127         /// buffer readonly status changed signal connection
128         boost::signals::connection readonlyConnection_;
129         /// buffer closing signal connection
130         boost::signals::connection closingConnection_;
131         /// connect to signals in the given buffer
132         void connectBuffer(Buffer & buf);
133         /// disconnect from signals in the given buffer
134         void disconnectBuffer();
135         /// track changes for the document
136         void trackChanges();
137         /// notify readonly status
138         void showReadonly(bool);
139
140
141         ///
142         friend class BufferView;
143
144         ///
145         BufferView * bv_;
146         ///
147         LyXView * owner_;
148         ///
149         Buffer * buffer_;
150         ///
151         boost::scoped_ptr<LyXScreen> screen_;
152         ///
153         boost::scoped_ptr<WorkArea> workarea_;
154         ///
155         Timeout cursor_timeout;
156         ///
157         void stuffClipboard(std::string const &) const;
158         ///
159         bool using_xterm_cursor;
160         ///
161         struct Position {
162                 /// Filename
163                 std::string filename;
164                 /// Cursor paragraph Id
165                 int par_id;
166                 /// Cursor position
167                 lyx::pos_type par_pos;
168                 ///
169                 Position() : par_id(0), par_pos(0) {}
170                 ///
171                 Position(std::string const & f, int id, lyx::pos_type pos)
172                         : filename(f), par_id(id), par_pos(pos) {}
173         };
174         ///
175         std::vector<Position> saved_positions;
176         /// Get next inset of this class from current cursor position
177         InsetBase * getInsetByCode(InsetBase::Code code);
178         ///
179         void MenuInsertLyXFile(std::string const & filen);
180         /// our workarea
181         WorkArea & workarea() const;
182         /// this is used to handle XSelection events in the right manner
183         struct {
184                 CursorSlice cursor;
185                 CursorSlice anchor;
186                 bool set;
187         } xsel_cache_;
188         ///
189         LCursor cursor_;
190 };
191 #endif // BUFFERVIEW_PIMPL_H