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.
68 virtual void busy(bool) const = 0;
70 //@{ generic accessor functions
72 /** return the current buffer view
73 Returned as a shared_ptr so that anything wanting to cache the
74 buffer view can do so safely using a boost::weak_ptr.
76 boost::shared_ptr<BufferView> const & view() const;
78 /// return the buffer currently shown in this window
79 Buffer * buffer() const;
81 /// return the LyX function handler for this view
82 LyXFunc & getLyXFunc() { return *lyxfunc_.get(); }
84 LyXFunc const & getLyXFunc() const { return *lyxfunc_.get(); }
86 /// return the toolbar for this view
87 Toolbar & getToolbar() { return *toolbar_.get(); }
89 Toolbar const & getToolbar() const { return *toolbar_.get(); }
91 /// return the menubar for this view
92 Menubar & getMenubar() { return *menubar_.get(); }
94 Menubar const & getMenubar() const { return *menubar_.get(); }
96 /// get access to the dialogs
97 Dialogs & getDialogs() { return *dialogs_.get(); }
99 Dialogs const & getDialogs() const { return *dialogs_.get(); }
101 /// get this view's keyboard map handler
102 Intl & getIntl() { return *intl_.get(); }
104 Intl const & getIntl() const { return *intl_.get(); }
108 /// sets the layout in the toolbar layout selection
109 void setLayout(string const & layout);
110 /// updates the possible layouts selectable
111 void updateLayoutChoice();
113 /// update the toolbar
114 void updateToolbar();
115 /// update the menubar
116 void updateMenubar();
118 /// focus the command buffer (minibuffer)
119 boost::signal0<void> focus_command_buffer;
121 /// view state string changed
122 boost::signal0<void> view_state_changed;
124 /// display a message in the view
125 virtual void message(string const &) = 0;
127 /// clear any temporary message and replace with current status
128 virtual void clearMessage() = 0;
130 /// updates the title of the window
131 void updateWindowTitle();
133 /// reset autosave timer
134 void resetAutosaveTimer();
136 /// dispatch to current BufferView
137 void dispatch(FuncRequest const & req);
140 /// view of a buffer. Eventually there will be several.
141 boost::shared_ptr<BufferView> bufferview_;
144 boost::scoped_ptr<Menubar> menubar_;
146 boost::scoped_ptr<Toolbar> toolbar_;
150 * setWindowTitle - set title of window
151 * @param t main window title
152 * @param it iconified (short) title
154 virtual void setWindowTitle(string const & t, string const & it) = 0;
156 /// called on timeout
159 /// keyboard mapping object
160 boost::scoped_ptr<Intl> const intl_;
161 /// auto-saving of buffers
162 boost::scoped_ptr<Timeout> const autosave_timeout_;
163 /// our function handler
164 boost::scoped_ptr<LyXFunc> lyxfunc_;
165 /// dialogs for this view
166 boost::scoped_ptr<Dialogs> dialogs_;
169 /// view's command buffer controller
170 // this has to be declared _after_ lyxfunc_ as its initialization depends
172 boost::scoped_ptr<ControlCommandBuffer> const controlcommand_;