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;
96 HorizontallyMaximized,
101 virtual void setGeometry(
106 unsigned int iconSizeXY,
107 const std::string & geometryArg) = 0;
109 /// save the geometry state in the session manager.
110 virtual void saveGeometry() = 0;
113 virtual void busy(bool) = 0;
115 virtual Toolbars::ToolbarPtr makeToolbar(ToolbarInfo const & tbinfo, bool newline) = 0;
117 //@{ generic accessor functions
119 /** return the current buffer view
120 Returned as a shared_ptr so that anything wanting to cache the
121 buffer view can do so safely using a boost::weak_ptr.
123 BufferView * view() const;
125 /// return the buffer currently shown in this window
126 Buffer * buffer() const;
128 /// return the toolbar for this view
129 Toolbars & getToolbars() { return *toolbars_.get(); }
131 Toolbars const & getToolbars() const { return *toolbars_.get(); }
133 /// return the menubar for this view
134 Menubar & getMenubar() { return *menubar_.get(); }
136 Menubar const & getMenubar() const { return *menubar_.get(); }
138 /// get access to the dialogs
139 Dialogs & getDialogs() { return *dialogs_.get(); }
141 Dialogs const & getDialogs() const { return *dialogs_.get(); }
145 /// load a buffer into the current workarea.
146 bool loadLyXFile(support::FileName const & name, ///< File to load.
147 bool tolastfiles = true, ///< append to the "Open recent" menu?
148 bool child_document = false, ///< Is this a child document?
149 bool auto_open = false); ///< Is this being opened by LyX itself?
151 /// set a buffer to the current workarea.
152 void setBuffer(Buffer * b, ///< \c Buffer to set.
153 bool child_document = false); ///< Is this a child document?
155 /// updates the possible layouts selectable
156 void updateLayoutChoice();
158 /// update the toolbar
159 void updateToolbars();
161 ToolbarInfo * getToolbarInfo(std::string const & name);
162 /// toggle toolbar state
163 void toggleToolbarState(std::string const & name, bool allowauto);
164 /// update the menubar
165 void updateMenubar();
166 /// update the status bar
167 virtual void updateStatusBar() = 0;
169 /// focus the command buffer (minibuffer)
170 boost::signal<void()> focus_command_buffer;
172 /// display a message in the view
173 virtual void message(docstring const &) = 0;
175 /// clear any temporary message and replace with current status
176 virtual void clearMessage() = 0;
178 /// updates the title of the window
179 void updateWindowTitle();
181 /// updates the tab view
182 virtual void updateTab() = 0;
184 /// reset autosave timer
185 void resetAutosaveTimer();
187 /// dispatch to current BufferView
188 void dispatch(FuncRequest const & cmd);
190 /** redraw \c inset in all the BufferViews in which it is currently
191 * visible. If successful return a pointer to the owning Buffer.
193 Buffer const * const updateInset(Inset const *) const;
195 /// returns true if this view has the focus.
196 virtual bool hasFocus() const = 0;
198 /// show the error list to the user
199 void showErrorList(std::string const &);
201 /// connect to signals in the given BufferView
202 void connectBufferView(BufferView & bv);
203 /// disconnect from signals in the given BufferView
204 void disconnectBufferView();
207 /// current work area (screen view of a BufferView).
209 \todo FIXME: there is only one workArea per LyXView for now.
211 frontend::WorkArea * work_area_;
214 boost::scoped_ptr<Menubar> menubar_;
218 * setWindowTitle - set title of window
219 * @param t main window title
220 * @param it iconified (short) title
222 virtual void setWindowTitle(docstring const & t, docstring const & it) = 0;
224 /// called on timeout
228 boost::scoped_ptr<Toolbars> toolbars_;
229 /// auto-saving of buffers
230 boost::scoped_ptr<Timeout> const autosave_timeout_;
231 /// our function handler
232 boost::scoped_ptr<LyXFunc> lyxfunc_;
233 /// dialogs for this view
234 boost::scoped_ptr<Dialogs> dialogs_;
236 /// buffer changed signal connection
237 boost::signals::connection bufferChangedConnection_;
238 /// buffer structure changed signal connection
239 boost::signals::connection bufferStructureChangedConnection_;
240 /// buffer errors signal connection
241 boost::signals::connection errorsConnection_;
242 /// buffer messages signal connection
243 boost::signals::connection messageConnection_;
244 /// buffer busy status signal connection
245 boost::signals::connection busyConnection_;
246 /// buffer title changed signal connection
247 boost::signals::connection titleConnection_;
248 /// buffer reset timers signal connection
249 boost::signals::connection timerConnection_;
250 /// buffer readonly status changed signal connection
251 boost::signals::connection readonlyConnection_;
252 /// buffer closing signal connection
253 boost::signals::connection closingConnection_;
254 /// connect to signals in the given buffer
255 void connectBuffer(Buffer & buf);
256 /// disconnect from signals in the given buffer
257 void disconnectBuffer();
259 /// BufferView messages signal connection
261 boost::signals::connection message_connection_;
262 boost::signals::connection show_dialog_connection_;
263 boost::signals::connection show_dialog_with_data_connection_;
264 boost::signals::connection show_inset_dialog_connection_;
265 boost::signals::connection update_dialog_connection_;
266 boost::signals::connection layout_changed_connection_;
269 /// Bind methods for BufferView messages signal connection
271 void showDialog(std::string const & name);
272 void showDialogWithData(std::string const & name,
273 std::string const & data);
274 void showInsetDialog(std::string const & name,
275 std::string const & data, Inset * inset);
276 void updateDialog(std::string const & name,
277 std::string const & data);
280 /// notify readonly status
281 void showReadonly(bool);
287 /// view's command buffer controller
288 // this has to be declared _after_ lyxfunc_ as its initialization depends
290 typedef boost::scoped_ptr<frontend::ControlCommandBuffer>
293 CommandBufferPtr const controlcommand_;
297 std::vector<int> work_area_ids_;