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
22 #include "support/types.h"
24 #include <boost/utility.hpp>
25 #include <boost/scoped_ptr.hpp>
26 #include <boost/shared_ptr.hpp>
27 #include <boost/signals/trackable.hpp>
28 #include <boost/signals/signal0.hpp>
34 class ControlCommandBuffer;
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 {
64 * This is called after the concrete view has been created.
65 * We have to have the toolbar and the other stuff created
66 * before we can populate it with this call.
70 /// start modal operation
71 virtual void prohibitInput() const = 0;
72 /// end modal operation
73 virtual void allowInput() 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 boost::shared_ptr<BufferView> const & 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 Toolbar & getToolbar() { return *toolbar_.get(); }
94 Toolbar const & getToolbar() const { return *toolbar_.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(string const & layout);
115 /// updates the possible layouts selectable
116 void updateLayoutChoice();
118 /// update the toolbar
119 void updateToolbar();
120 /// update the menubar
121 void updateMenubar();
123 /// focus the command buffer (minibuffer)
124 boost::signal0<void> focus_command_buffer;
126 /// view state string changed
127 boost::signal0<void> view_state_changed;
129 /// display a message in the view
130 virtual void message(string const &) = 0;
132 /// updates the title of the window
133 void updateWindowTitle();
135 /// reset autosave timer
136 void resetAutosaveTimer();
138 /// dispatch to current BufferView
139 void dispatch(FuncRequest const & req);
142 /// view of a buffer. Eventually there will be several.
143 boost::shared_ptr<BufferView> bufferview_;
146 boost::scoped_ptr<Menubar> menubar_;
148 boost::scoped_ptr<Toolbar> toolbar_;
152 * setWindowTitle - set title of window
153 * @param t main window title
154 * @param it iconified (short) title
156 virtual void setWindowTitle(string const & t, string const & it) = 0;
158 /// called on timeout
161 /// keyboard mapping object
162 boost::scoped_ptr<Intl> const intl_;
163 /// auto-saving of buffers
164 boost::scoped_ptr<Timeout> const autosave_timeout_;
165 /// our function handler
166 boost::scoped_ptr<LyXFunc> lyxfunc_;
167 /// dialogs for this view
168 boost::scoped_ptr<Dialogs> dialogs_;
171 /// view's command buffer controller
172 // this has to be declared _after_ lyxfunc_ as its initialization depends
174 boost::scoped_ptr<ControlCommandBuffer> const controlcommand_;