4 * This file is part of LyX, the document processor.
5 * Licence details can be found in the file COPYING.
7 * \author Lars Gullik Bjønnes
10 * Full author contact details are available in file CREDITS.
16 #include "frontends/Application.h"
17 #include "frontends/Toolbars.h"
20 #include <boost/scoped_ptr.hpp>
21 #include <boost/shared_ptr.hpp>
22 #include <boost/signal.hpp>
23 #include <boost/signals/trackable.hpp>
24 #include <boost/utility.hpp>
30 namespace support { class FileName; }
45 class ControlCommandBuffer;
46 } // namespace frontend
50 * LyXView - main LyX window
52 * This class represents the main LyX window and provides
53 * accessor functions to its content.
55 * The eventual intention is that LyX will support a number
56 * of containing LyXViews. Currently a lot of code still
57 * relies on there being a single top-level view.
59 * Additionally we would like to support multiple views
60 * in a single LyXView.
62 class LyXView : public boost::signals::trackable, boost::noncopyable {
69 int const id() const { return id_; }
71 virtual void close() = 0;
73 virtual void setFocus() = 0;
75 std::vector<int> const & workAreaIds() const { return work_area_ids_; }
77 /// FIXME: rename to setCurrentWorkArea()
78 void setWorkArea(frontend::WorkArea * work_area);
80 /// return the current WorkArea (the one that has the focus).
81 frontend::WorkArea const * currentWorkArea() const;
82 /// FIXME: This non-const access is needed because of
83 /// a mis-designed \c ControlSpellchecker.
84 frontend::WorkArea * currentWorkArea();
87 * This is called after the concrete view has been created.
88 * We have to have the toolbar and the other stuff created
89 * before we can populate it with this call.
91 virtual void init() = 0;
94 virtual void setGeometry(
99 unsigned int iconSizeXY,
100 const std::string & geometryArg) = 0;
102 /// save the geometry state in the session manager.
103 virtual void saveGeometry() = 0;
106 virtual void busy(bool) = 0;
108 virtual Toolbars::ToolbarPtr makeToolbar(ToolbarBackend::Toolbar const & tbb) = 0;
110 //@{ generic accessor functions
112 /** return the current buffer view
113 Returned as a shared_ptr so that anything wanting to cache the
114 buffer view can do so safely using a boost::weak_ptr.
116 BufferView * view() const;
118 /// return the buffer currently shown in this window
119 Buffer * buffer() const;
121 /// return the toolbar for this view
122 Toolbars & getToolbars() { return *toolbars_.get(); }
124 Toolbars const & getToolbars() const { return *toolbars_.get(); }
126 /// return the menubar for this view
127 Menubar & getMenubar() { return *menubar_.get(); }
129 Menubar const & getMenubar() const { return *menubar_.get(); }
131 /// get access to the dialogs
132 Dialogs & getDialogs() { return *dialogs_.get(); }
134 Dialogs const & getDialogs() const { return *dialogs_.get(); }
138 /// load a buffer into the current workarea
139 bool loadLyXFile(support::FileName const & name, bool tolastfiles = true);
141 /// set a buffer to the current workarea
142 void setBuffer(Buffer * b);
144 /// updates the possible layouts selectable
145 void updateLayoutChoice();
147 /// update the toolbar
148 void updateToolbars();
149 /// get toolbar state
150 ToolbarBackend::Flags getToolbarState(std::string const & name);
151 /// toggle toolbar state
152 void toggleToolbarState(std::string const & name);
153 /// update the menubar
154 void updateMenubar();
155 /// update the status bar
156 virtual void updateStatusBar() = 0;
158 /// focus the command buffer (minibuffer)
159 boost::signal<void()> focus_command_buffer;
161 /// display a message in the view
162 virtual void message(docstring const &) = 0;
164 /// clear any temporary message and replace with current status
165 virtual void clearMessage() = 0;
167 /// updates the title of the window
168 void updateWindowTitle();
170 /// updates the tab view
171 virtual void updateTab() = 0;
173 /// reset autosave timer
174 void resetAutosaveTimer();
176 /// dispatch to current BufferView
177 void dispatch(FuncRequest const & cmd);
179 /** redraw \c inset in all the BufferViews in which it is currently
180 * visible. If successful return a pointer to the owning Buffer.
182 Buffer const * const updateInset(InsetBase const *) const;
184 /// returns true if this view has the focus.
185 virtual bool hasFocus() const = 0;
187 /// show the error list to the user
188 void showErrorList(std::string const &);
190 /// connect to signals in the given BufferView
191 void connectBufferView(BufferView & bv);
192 /// disconnect from signals in the given BufferView
193 void disconnectBufferView();
196 /// current work area (screen view of a BufferView).
198 \todo FIXME: there is only one workArea per LyXView for now.
200 frontend::WorkArea * work_area_;
203 boost::scoped_ptr<Menubar> menubar_;
207 * setWindowTitle - set title of window
208 * @param t main window title
209 * @param it iconified (short) title
211 virtual void setWindowTitle(docstring const & t, docstring const & it) = 0;
213 /// called on timeout
217 boost::scoped_ptr<Toolbars> toolbars_;
218 /// auto-saving of buffers
219 boost::scoped_ptr<Timeout> const autosave_timeout_;
220 /// our function handler
221 boost::scoped_ptr<LyXFunc> lyxfunc_;
222 /// dialogs for this view
223 boost::scoped_ptr<Dialogs> dialogs_;
225 /// buffer changed signal connection
226 boost::signals::connection bufferChangedConnection_;
227 /// buffer errors signal connection
228 boost::signals::connection errorsConnection_;
229 /// buffer messages signal connection
230 boost::signals::connection messageConnection_;
231 /// buffer busy status signal connection
232 boost::signals::connection busyConnection_;
233 /// buffer title changed signal connection
234 boost::signals::connection titleConnection_;
235 /// buffer reset timers signal connection
236 boost::signals::connection timerConnection_;
237 /// buffer readonly status changed signal connection
238 boost::signals::connection readonlyConnection_;
239 /// buffer closing signal connection
240 boost::signals::connection closingConnection_;
241 /// connect to signals in the given buffer
242 void connectBuffer(Buffer & buf);
243 /// disconnect from signals in the given buffer
244 void disconnectBuffer();
246 /// BufferView messages signal connection
248 boost::signals::connection message_connection_;
249 boost::signals::connection show_dialog_connection_;
250 boost::signals::connection show_dialog_with_data_connection_;
251 boost::signals::connection show_inset_dialog_connection_;
252 boost::signals::connection update_dialog_connection_;
253 boost::signals::connection layout_changed_connection_;
256 /// Bind methods for BufferView messages signal connection
258 void showDialog(std::string const & name);
259 void showDialogWithData(std::string const & name,
260 std::string const & data);
261 void showInsetDialog(std::string const & name,
262 std::string const & data, InsetBase * inset);
263 void updateDialog(std::string const & name,
264 std::string const & data);
267 /// notify readonly status
268 void showReadonly(bool);
271 /// view's command buffer controller
272 // this has to be declared _after_ lyxfunc_ as its initialization depends
274 typedef boost::scoped_ptr<frontend::ControlCommandBuffer>
277 CommandBufferPtr const controlcommand_;
281 std::vector<int> work_area_ids_;