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
19 #include "support/types.h"
21 #include <boost/utility.hpp>
22 #include <boost/scoped_ptr.hpp>
23 #include <boost/shared_ptr.hpp>
24 #include <boost/signals/trackable.hpp>
25 #include <boost/signals/signal0.hpp>
31 class ControlCommandBuffer;
41 * LyXView - main LyX window
43 * This class represents the main LyX window and provides
44 * accessor functions to its content.
46 * The eventual intention is that LyX will support a number
47 * of containing LyXViews. Currently a lot of code still
48 * relies on there being a single top-level view.
50 * Additionally we would like to support multiple views
51 * in a single LyXView.
53 class LyXView : public boost::signals::trackable, boost::noncopyable {
61 * This is called after the concrete view has been created.
62 * We have to have the toolbar and the other stuff created
63 * before we can populate it with this call.
67 /// start modal operation
68 virtual void prohibitInput() const = 0;
69 /// end modal operation
70 virtual void allowInput() const = 0;
72 //@{ generic accessor functions
74 /** return the current buffer view
75 Returned as a shared_ptr so that anything wanting to cache the
76 buffer view can do so safely using a boost::weak_ptr.
78 boost::shared_ptr<BufferView> const & view() const;
80 /// return the buffer currently shown in this window
81 Buffer * buffer() const;
83 /// return the LyX function handler for this view
84 LyXFunc & getLyXFunc() { return *lyxfunc_.get(); }
86 LyXFunc const & getLyXFunc() const { return *lyxfunc_.get(); }
88 /// return the toolbar for this view
89 Toolbar & getToolbar() { return *toolbar_.get(); }
91 Toolbar const & getToolbar() const { return *toolbar_.get(); }
93 /// return the menubar for this view
94 Menubar & getMenubar() { return *menubar_.get(); }
96 Menubar const & getMenubar() const { return *menubar_.get(); }
98 /// get access to the dialogs
99 Dialogs & getDialogs() { return *dialogs_.get(); }
101 Dialogs const & getDialogs() const { return *dialogs_.get(); }
103 /// get this view's keyboard map handler
104 Intl & getIntl() { return *intl_.get(); }
106 Intl const & getIntl() const { return *intl_.get(); }
110 /// sets the layout in the toolbar layout selection
111 void setLayout(string const & layout);
112 /// updates the possible layouts selectable
113 void updateLayoutChoice();
115 /// update the toolbar
116 void updateToolbar();
117 /// update the menubar
118 void updateMenubar();
120 /// focus the command buffer (minibuffer)
121 boost::signal0<void> focus_command_buffer;
123 /// view state string changed
124 boost::signal0<void> view_state_changed;
126 /// display a message in the view
127 virtual void message(string const &) = 0;
129 /// updates the title of the window
130 void updateWindowTitle();
132 /// reset autosave timer
133 void resetAutosaveTimer();
135 /// dispatch to current BufferView
136 void dispatch(FuncRequest const & req);
139 /// view of a buffer. Eventually there will be several.
140 boost::shared_ptr<BufferView> bufferview_;
143 boost::scoped_ptr<Menubar> menubar_;
145 boost::scoped_ptr<Toolbar> toolbar_;
149 * setWindowTitle - set title of window
150 * @param t main window title
151 * @param it iconified (short) title
153 virtual void setWindowTitle(string const & t, string const & it) = 0;
155 /// called on timeout
158 /// keyboard mapping object
159 boost::scoped_ptr<Intl> const intl_;
160 /// auto-saving of buffers
161 boost::scoped_ptr<Timeout> const autosave_timeout_;
162 /// our function handler
163 boost::scoped_ptr<LyXFunc> lyxfunc_;
164 /// dialogs for this view
165 boost::scoped_ptr<Dialogs> dialogs_;
168 /// view's command buffer controller
169 // this has to be declared _after_ lyxfunc_ as its initialization depends
171 boost::scoped_ptr<ControlCommandBuffer> const controlcommand_;