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 <boost/scoped_ptr.hpp>
17 #include <boost/shared_ptr.hpp>
18 #include <boost/signal.hpp>
19 #include <boost/signals/trackable.hpp>
20 #include <boost/utility.hpp>
38 class ControlCommandBuffer;
39 } // namespace frontend
44 * LyXView - main LyX window
46 * This class represents the main LyX window and provides
47 * accessor functions to its content.
49 * The eventual intention is that LyX will support a number
50 * of containing LyXViews. Currently a lot of code still
51 * relies on there being a single top-level view.
53 * Additionally we would like to support multiple views
54 * in a single LyXView.
56 class LyXView : public boost::signals::trackable, boost::noncopyable {
59 LyXView(lyx::frontend::Gui & owner);
63 void setBufferView(BufferView * buffer_view);
66 * This is called after the concrete view has been created.
67 * We have to have the toolbar and the other stuff created
68 * before we can populate it with this call.
73 virtual void busy(bool) const = 0;
75 //@{ generic accessor functions
77 /** return the current buffer view
78 Returned as a shared_ptr so that anything wanting to cache the
79 buffer view can do so safely using a boost::weak_ptr.
81 BufferView * view() const;
83 /// return the buffer currently shown in this window
84 Buffer * buffer() const;
86 /// return the LyX function handler for this view
87 LyXFunc & getLyXFunc() { return *lyxfunc_.get(); }
89 LyXFunc const & getLyXFunc() const { return *lyxfunc_.get(); }
91 /// return the toolbar for this view
92 Toolbars & getToolbars() { return *toolbars_.get(); }
94 Toolbars const & getToolbars() const { return *toolbars_.get(); }
96 /// return the menubar for this view
97 Menubar & getMenubar() { return *menubar_.get(); }
99 Menubar const & getMenubar() const { return *menubar_.get(); }
101 /// get access to the dialogs
102 Dialogs & getDialogs() { return *dialogs_.get(); }
104 Dialogs const & getDialogs() const { return *dialogs_.get(); }
106 /// get this view's keyboard map handler
107 Intl & getIntl() { return *intl_.get(); }
109 Intl const & getIntl() const { return *intl_.get(); }
113 /// sets the layout in the toolbar layout selection
114 void setLayout(std::string const & layout);
115 /// updates the possible layouts selectable
116 void updateLayoutChoice();
118 /// update the toolbar
119 void updateToolbars();
120 /// update the menubar
121 void updateMenubar();
123 /// focus the command buffer (minibuffer)
124 boost::signal<void()> focus_command_buffer;
126 /// view state string changed
127 boost::signal<void()> view_state_changed;
129 /// display a message in the view
130 virtual void message(std::string const &) = 0;
132 /// clear any temporary message and replace with current status
133 virtual void clearMessage() = 0;
135 /// updates the title of the window
136 void updateWindowTitle();
138 /// reset autosave timer
139 void resetAutosaveTimer();
141 /// dispatch to current BufferView
142 void dispatch(FuncRequest const & cmd);
144 /** redraw \c inset in all the BufferViews in which it is currently
145 * visible. If successful return a pointer to the owning Buffer.
147 Buffer const * const updateInset(InsetBase const *) const;
149 /// returns true if this view has the focus.
150 virtual bool hasFocus() const = 0;
153 virtual lyx::frontend::Gui & gui();
156 /// current bufferview (view of a buffer).
158 \todo FIXME: this should be moved out of LyXView.
160 BufferView * bufferview_;
163 boost::scoped_ptr<Menubar> menubar_;
166 lyx::frontend::Gui & owner_;
168 * setWindowTitle - set title of window
169 * @param t main window title
170 * @param it iconified (short) title
172 virtual void setWindowTitle(std::string const & t, std::string const & it) = 0;
174 /// called on timeout
178 boost::scoped_ptr<Toolbars> toolbars_;
179 /// keyboard mapping object
180 boost::scoped_ptr<Intl> const intl_;
181 /// auto-saving of buffers
182 boost::scoped_ptr<Timeout> const autosave_timeout_;
183 /// our function handler
184 boost::scoped_ptr<LyXFunc> lyxfunc_;
185 /// dialogs for this view
186 boost::scoped_ptr<Dialogs> dialogs_;
189 /// view's command buffer controller
190 // this has to be declared _after_ lyxfunc_ as its initialization depends
192 typedef boost::scoped_ptr<lyx::frontend::ControlCommandBuffer>
195 CommandBufferPtr const controlcommand_;