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>
40 class ControlCommandBuffer;
41 } // namespace frontend
46 * LyXView - main LyX window
48 * This class represents the main LyX window and provides
49 * accessor functions to its content.
51 * The eventual intention is that LyX will support a number
52 * of containing LyXViews. Currently a lot of code still
53 * relies on there being a single top-level view.
55 * Additionally we would like to support multiple views
56 * in a single LyXView.
58 class LyXView : public boost::signals::trackable, boost::noncopyable {
65 void setWorkArea(lyx::frontend::WorkArea * work_area);
68 * This is called after the concrete view has been created.
69 * We have to have the toolbar and the other stuff created
70 * before we can populate it with this call.
72 virtual void init() = 0;
74 virtual void setGeometry(
81 virtual void busy(bool) const = 0;
83 virtual Toolbars::ToolbarPtr makeToolbar(ToolbarBackend::Toolbar const & tbb) = 0;
85 //@{ generic accessor functions
87 /** return the current buffer view
88 Returned as a shared_ptr so that anything wanting to cache the
89 buffer view can do so safely using a boost::weak_ptr.
91 BufferView * view() const;
93 /// return the buffer currently shown in this window
94 Buffer * buffer() const;
96 /// return the toolbar for this view
97 Toolbars & getToolbars() { return *toolbars_.get(); }
99 Toolbars const & getToolbars() const { return *toolbars_.get(); }
101 /// return the menubar for this view
102 Menubar & getMenubar() { return *menubar_.get(); }
104 Menubar const & getMenubar() const { return *menubar_.get(); }
106 /// get access to the dialogs
107 Dialogs & getDialogs() { return *dialogs_.get(); }
109 Dialogs const & getDialogs() const { return *dialogs_.get(); }
113 /// load a buffer into the current workarea
114 bool loadLyXFile(std::string const & name, bool tolastfiles = true);
116 /// set a buffer to the current workarea
117 void setBuffer(Buffer * b);
119 /// updates the possible layouts selectable
120 void updateLayoutChoice();
122 /// update the toolbar
123 void updateToolbars();
124 /// update the menubar
125 void updateMenubar();
126 /// update the status bar
127 virtual void updateStatusBar() = 0;
129 /// focus the command buffer (minibuffer)
130 boost::signal<void()> focus_command_buffer;
132 /// display a message in the view
133 virtual void message(lyx::docstring const &) = 0;
135 /// clear any temporary message and replace with current status
136 virtual void clearMessage() = 0;
138 /// updates the title of the window
139 void updateWindowTitle();
141 /// reset autosave timer
142 void resetAutosaveTimer();
144 /// dispatch to current BufferView
145 void dispatch(FuncRequest const & cmd);
147 /** redraw \c inset in all the BufferViews in which it is currently
148 * visible. If successful return a pointer to the owning Buffer.
150 Buffer const * const updateInset(InsetBase const *) const;
152 /// returns true if this view has the focus.
153 virtual bool hasFocus() const = 0;
155 /// Temporary method used by the kernel to redraw the work area.
156 virtual void redrawWorkArea();
158 /// Temporary method to access the current workArea.
159 /// This is needed for the qt3 and gtk frontend.
160 lyx::frontend::WorkArea * workArea();
162 /// show the error list to the user
163 void showErrorList(std::string const &);
165 /// connect to signals in the given BufferView
166 void connectBufferView(BufferView & bv);
167 /// disconnect from signals in the given BufferView
168 void disconnectBufferView();
171 /// current work area (screen view of a BufferView).
173 \todo FIXME: there is only one workArea per LyXView for now.
175 lyx::frontend::WorkArea * work_area_;
178 boost::scoped_ptr<Menubar> menubar_;
182 * setWindowTitle - set title of window
183 * @param t main window title
184 * @param it iconified (short) title
186 virtual void setWindowTitle(lyx::docstring const & t, lyx::docstring const & it) = 0;
188 /// called on timeout
192 boost::scoped_ptr<Toolbars> toolbars_;
193 /// auto-saving of buffers
194 boost::scoped_ptr<Timeout> const autosave_timeout_;
195 /// our function handler
196 boost::scoped_ptr<LyXFunc> lyxfunc_;
197 /// dialogs for this view
198 boost::scoped_ptr<Dialogs> dialogs_;
200 /// buffer errors signal connection
201 boost::signals::connection errorsConnection_;
202 /// buffer messages signal connection
203 boost::signals::connection messageConnection_;
204 /// buffer busy status signal connection
205 boost::signals::connection busyConnection_;
206 /// buffer title changed signal connection
207 boost::signals::connection titleConnection_;
208 /// buffer reset timers signal connection
209 boost::signals::connection timerConnection_;
210 /// buffer readonly status changed signal connection
211 boost::signals::connection readonlyConnection_;
212 /// buffer closing signal connection
213 boost::signals::connection closingConnection_;
214 /// connect to signals in the given buffer
215 void connectBuffer(Buffer & buf);
216 /// disconnect from signals in the given buffer
217 void disconnectBuffer();
219 /// BufferView messages signal connection
221 boost::signals::connection message_connection_;
222 boost::signals::connection show_dialog_connection_;
223 boost::signals::connection show_dialog_with_data_connection_;
224 boost::signals::connection show_inset_dialog_connection_;
225 boost::signals::connection update_dialog_connection_;
226 boost::signals::connection layout_changed_connection_;
229 /// Bind methods for BufferView messages signal connection
231 void showDialog(std::string const & name);
232 void showDialogWithData(std::string const & name,
233 std::string const & data);
234 void showInsetDialog(std::string const & name,
235 std::string const & data, InsetBase * inset);
236 void updateDialog(std::string const & name,
237 std::string const & data);
240 /// notify readonly status
241 void showReadonly(bool);
244 /// view's command buffer controller
245 // this has to be declared _after_ lyxfunc_ as its initialization depends
247 typedef boost::scoped_ptr<lyx::frontend::ControlCommandBuffer>
250 CommandBufferPtr const controlcommand_;