// -*- C++ -*-
/**
* \file LyXView.h
- * Copyright 1995-2002 the LyX Team
- * Read the file COPYING
+ * This file is part of LyX, the document processor.
+ * Licence details can be found in the file COPYING.
*
- * \author Lars Gullik Bjornes <larsbj@lyx.org>
- * \author John Levon <moz@compsoc.man.ac.uk>
+ * \author Lars Gullik Bjønnes
+ * \author John Levon
+ *
+ * Full author contact details are available in file CREDITS.
*/
#ifndef LYXVIEW_H
#define LYXVIEW_H
-#ifdef __GNUG__
-#pragma interface
-#endif
-
-#include "LString.h"
-
-#include "support/types.h"
-
#include <boost/utility.hpp>
#include <boost/scoped_ptr.hpp>
+#include <boost/shared_ptr.hpp>
#include <boost/signals/trackable.hpp>
#include <boost/signals/signal0.hpp>
class Buffer;
-class Toolbar;
+class Toolbars;
+class InsetBase;
class Intl;
class Menubar;
-class ControlCommandBuffer;
class BufferView;
class Dialogs;
class LyXFunc;
class LyXFont;
class Timeout;
+class FuncRequest;
+
+namespace lyx {
+namespace frontend {
+class ControlCommandBuffer;
+} // namespace frontend
+} // namespace lyx
/**
* LyXView - main LyX window
*/
void init();
- /// start modal operation
- virtual void prohibitInput() const = 0;
- /// end modal operation
- virtual void allowInput() const = 0;
+ /// show busy cursor
+ virtual void busy(bool) const = 0;
//@{ generic accessor functions
- /// return the current buffer view
- BufferView * view() const;
-
- /// return the LyX function handler for this view
- LyXFunc * getLyXFunc() const;
+ /** return the current buffer view
+ Returned as a shared_ptr so that anything wanting to cache the
+ buffer view can do so safely using a boost::weak_ptr.
+ */
+ boost::shared_ptr<BufferView> const & view() const;
/// return the buffer currently shown in this window
Buffer * buffer() const;
+ /// return the LyX function handler for this view
+ LyXFunc & getLyXFunc() { return *lyxfunc_.get(); }
+ ///
+ LyXFunc const & getLyXFunc() const { return *lyxfunc_.get(); }
+
/// return the toolbar for this view
- Toolbar * getToolbar() const;
+ Toolbars & getToolbars() { return *toolbars_.get(); }
+ ///
+ Toolbars const & getToolbasr() const { return *toolbars_.get(); }
/// return the menubar for this view
- Menubar * getMenubar() const;
+ Menubar & getMenubar() { return *menubar_.get(); }
+ ///
+ Menubar const & getMenubar() const { return *menubar_.get(); }
/// get access to the dialogs
- Dialogs * getDialogs() { return dialogs_.get(); }
+ Dialogs & getDialogs() { return *dialogs_.get(); }
+ ///
+ Dialogs const & getDialogs() const { return *dialogs_.get(); }
/// get this view's keyboard map handler
- Intl * getIntl() const;
+ Intl & getIntl() { return *intl_.get(); }
+ ///
+ Intl const & getIntl() const { return *intl_.get(); }
//@}
/// sets the layout in the toolbar layout selection
- void setLayout(string const & layout);
+ void setLayout(std::string const & layout);
/// updates the possible layouts selectable
void updateLayoutChoice();
/// update the toolbar
- void updateToolbar();
+ void updateToolbars();
/// update the menubar
void updateMenubar();
/// focus the command buffer (minibuffer)
boost::signal0<void> focus_command_buffer;
-
+
/// view state string changed
boost::signal0<void> view_state_changed;
/// display a message in the view
- virtual void message(string const &) = 0;
+ virtual void message(std::string const &) = 0;
+
+ /// clear any temporary message and replace with current status
+ virtual void clearMessage() = 0;
/// updates the title of the window
void updateWindowTitle();
/// reset autosave timer
void resetAutosaveTimer();
+ /// dispatch to current BufferView
+ void dispatch(FuncRequest const & cmd);
+
+ /** redraw \c inset in all the BufferViews in which it is currently
+ * visible. If successful return a pointer to the owning Buffer.
+ */
+ Buffer const * const updateInset(InsetBase const *) const;
+
protected:
/// view of a buffer. Eventually there will be several.
- boost::scoped_ptr<BufferView> bufferview_;
+ boost::shared_ptr<BufferView> bufferview_;
/// view's menubar
boost::scoped_ptr<Menubar> menubar_;
- /// view's toolbar
- boost::scoped_ptr<Toolbar> toolbar_;
- /// view's command buffer controller
- boost::scoped_ptr<ControlCommandBuffer> controlcommand_;
-
- /// keyboard mapping object
- boost::scoped_ptr<Intl> intl_;
-
- /// auto-saving of buffers
- boost::scoped_ptr<Timeout> autosave_timeout_;
-
- /// called on timeout
- void autoSave();
private:
/**
* @param t main window title
* @param it iconified (short) title
*/
- virtual void setWindowTitle(string const & t, string const & it) = 0;
+ virtual void setWindowTitle(std::string const & t, std::string const & it) = 0;
+
+ /// called on timeout
+ void autoSave();
+ /// view's toolbar
+ boost::scoped_ptr<Toolbars> toolbars_;
+ /// keyboard mapping object
+ boost::scoped_ptr<Intl> const intl_;
+ /// auto-saving of buffers
+ boost::scoped_ptr<Timeout> const autosave_timeout_;
/// our function handler
boost::scoped_ptr<LyXFunc> lyxfunc_;
/// dialogs for this view
boost::scoped_ptr<Dialogs> dialogs_;
+
+protected:
+ /// view's command buffer controller
+ // this has to be declared _after_ lyxfunc_ as its initialization depends
+ // on it!
+ typedef boost::scoped_ptr<lyx::frontend::ControlCommandBuffer>
+ CommandBufferPtr;
+
+ CommandBufferPtr const controlcommand_;
};
#endif // LYXVIEW_H
projects / lyx.git / blobdiff