lyx_mirror/src/frontends/LyXView.h

// -*- C++ -*-
/**
 * \file LyXView.h
 * This file is part of LyX, the document processor.
 * Licence details can be found in the file COPYING.
 *
 * \author Lars Gullik Bjønnes
 * \author John Levon
 *
 * Full author contact details are available in file CREDITS.
 */

#ifndef LYXVIEW_H
#define LYXVIEW_H

#include "frontends/Application.h"
#include "frontends/Toolbars.h"

#include "LyXFunc.h"
#include <boost/scoped_ptr.hpp>
#include <boost/shared_ptr.hpp>
#include <boost/signal.hpp>
#include <boost/signals/trackable.hpp>
#include <boost/utility.hpp>

#include <vector>

namespace lyx {

namespace support { class FileName; }

class Buffer;
class Inset;
class Menubar;

class BufferView;
class Dialogs;
class LyXFunc;
class Font;
class Timeout;
class FuncRequest;

namespace frontend {
class WorkArea;
class ControlCommandBuffer;
} // namespace frontend


/**
 * LyXView - main LyX window
 *
 * This class represents the main LyX window and provides
 * accessor functions to its content.
 *
 * The eventual intention is that LyX will support a number
 * of containing LyXViews. Currently a lot of code still
 * relies on there being a single top-level view.
 *
 * Additionally we would like to support multiple views
 * in a single LyXView.
 */
class LyXView : public boost::signals::trackable, boost::noncopyable {
public:

	LyXView(int id);

	virtual ~LyXView();

	int const id() const { return id_; }

	virtual void close() = 0;

	virtual void setFocus() = 0;

	std::vector<int> const & workAreaIds() const { return work_area_ids_; }

	/// FIXME: rename to setCurrentWorkArea()
	void setWorkArea(frontend::WorkArea * work_area);

	/// return the current WorkArea (the one that has the focus).
	frontend::WorkArea const * currentWorkArea() const;
	/// FIXME: This non-const access is needed because of
	/// a mis-designed \c ControlSpellchecker.
	frontend::WorkArea * currentWorkArea();

	/**
	 * This is called after the concrete view has been created.
	 * We have to have the toolbar and the other stuff created
	 * before we can populate it with this call.
	 */
	virtual void init() = 0;

	enum Maximized {
		NotMaximized,
		VerticallyMaximized,
		HorizontallyMaximized,
		CompletelyMaximized
	};

	///
	virtual void setGeometry(
		unsigned int width,
		unsigned int height,
		int posx, int posy,
		int maximize,
		unsigned int iconSizeXY,
		const std::string & geometryArg) = 0;

	/// save the geometry state in the session manager.
	virtual void saveGeometry() = 0;

	/// show busy cursor
	virtual void busy(bool) = 0;

	virtual Toolbars::ToolbarPtr makeToolbar(ToolbarInfo const & tbinfo, bool newline) = 0;

	//@{ generic accessor functions

	/** 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.
	 */
	BufferView * view() const;

	/// return the buffer currently shown in this window
	Buffer * buffer() const;

	/// return the toolbar for this view
	Toolbars & getToolbars() { return *toolbars_.get(); }
	///
	Toolbars const & getToolbars() const { return *toolbars_.get(); }

	/// return the menubar for this view
	Menubar & getMenubar() { return *menubar_.get(); }
	///
	Menubar const & getMenubar() const { return *menubar_.get(); }

	/// get access to the dialogs
	Dialogs & getDialogs() { return *dialogs_.get(); }
	///
	Dialogs const & getDialogs() const { return *dialogs_.get(); }

	//@}

	/// load a buffer into the current workarea.
	bool loadLyXFile(support::FileName const &  name, ///< File to load.
		bool tolastfiles = true,  ///< append to the "Open recent" menu?
		bool child_document = false, ///< Is this a child document?
    bool auto_open = false); ///< Is this being opened by LyX itself?

	/// set a buffer to the current workarea.
	void setBuffer(Buffer * b, ///< \c Buffer to set.
		bool child_document = false);  ///< Is this a child document?

	/// updates the possible layouts selectable
	void updateLayoutChoice();

	/// update the toolbar
	void updateToolbars();
	/// get toolbar info
	ToolbarInfo * getToolbarInfo(std::string const & name);
	/// toggle toolbar state
	void toggleToolbarState(std::string const & name, bool allowauto);
	/// update the menubar
	void updateMenubar();
	/// update the status bar
	virtual void updateStatusBar() = 0;

	/// focus the command buffer (minibuffer)
	boost::signal<void()> focus_command_buffer;

	/// display a message in the view
	virtual void message(docstring const &) = 0;

	/// clear any temporary message and replace with current status
	virtual void clearMessage() = 0;

	/// updates the title of the window
	void updateWindowTitle();

	/// updates the tab view
	virtual void updateTab() = 0;

	/// 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(Inset const *) const;

	/// returns true if this view has the focus.
	virtual bool hasFocus() const = 0;

	/// show the error list to the user
	void showErrorList(std::string const &);

	/// connect to signals in the given BufferView
	void connectBufferView(BufferView & bv);
	/// disconnect from signals in the given BufferView
	void disconnectBufferView();

protected:
	/// current work area (screen view of a BufferView).
	/**
	\todo FIXME: there is only one workArea per LyXView for now.
	*/
	frontend::WorkArea * work_area_;

	/// view's menubar
	boost::scoped_ptr<Menubar> menubar_;

private:
	/**
	 * setWindowTitle - set title of window
	 * @param t main window title
	 * @param it iconified (short) title
	 */
	virtual void setWindowTitle(docstring const & t, docstring const & it) = 0;

	/// called on timeout
	void autoSave();

	/// view's toolbar
	boost::scoped_ptr<Toolbars> toolbars_;
	/// 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_;

	/// buffer changed signal connection
	boost::signals::connection bufferChangedConnection_;
	/// buffer structure changed signal connection
	boost::signals::connection bufferStructureChangedConnection_;
	/// buffer errors signal connection
	boost::signals::connection errorsConnection_;
	/// buffer messages signal connection
	boost::signals::connection messageConnection_;
	/// buffer busy status signal connection
	boost::signals::connection busyConnection_;
	/// buffer title changed signal connection
	boost::signals::connection titleConnection_;
	/// buffer reset timers signal connection
	boost::signals::connection timerConnection_;
	/// buffer readonly status changed signal connection
	boost::signals::connection readonlyConnection_;
	/// buffer closing signal connection
	boost::signals::connection closingConnection_;
	/// connect to signals in the given buffer
	void connectBuffer(Buffer & buf);
	/// disconnect from signals in the given buffer
	/// NOTE: Do not call this unless you really want no buffer
	/// to be connected---for example, when closing the last open
	/// buffer. If you are switching buffers, just call 
	/// connectBuffer(), and the old buffer will be disconnected
	/// automatically. This ensures that we do not leave LyX in a
	/// state in which no buffer is connected.
	void disconnectBuffer();

	/// BufferView messages signal connection
	//@{
	boost::signals::connection message_connection_;
	boost::signals::connection show_dialog_connection_;
	boost::signals::connection show_dialog_with_data_connection_;
	boost::signals::connection show_inset_dialog_connection_;
	boost::signals::connection update_dialog_connection_;
	boost::signals::connection layout_changed_connection_;
	//@}

	/// Bind methods for BufferView messages signal connection
	//@{
	void showDialog(std::string const & name);
	void showDialogWithData(std::string const & name,
		std::string const & data);
	void showInsetDialog(std::string const & name,
		std::string const & data, Inset * inset);
	void updateDialog(std::string const & name,
		std::string const & data);
	//@}

	/// notify readonly status
	void showReadonly(bool);

protected:
	///
	void updateToc();

	/// view's command buffer controller
	// this has to be declared _after_ lyxfunc_ as its initialization depends
	// on it!
	typedef boost::scoped_ptr<frontend::ControlCommandBuffer>
	CommandBufferPtr;

	CommandBufferPtr const controlcommand_;

private:
	int id_;
	std::vector<int> work_area_ids_;
};

} // namespace lyx

#endif // LYXVIEW_H