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<EFBFBD>nnes
 * \author John Levon
 *
 * Full author contact details are available in file CREDITS.
 */

#ifndef LYXVIEW_H
#define LYXVIEW_H

#include "frontends/Delegates.h"
#include "support/strfwd.h"

#include <vector>

namespace lyx {

namespace support { class FileName; }

class Buffer;
class BufferView;
class FuncRequest;
class Inset;
class ToolbarInfo;

namespace frontend {

class Dialogs;
class WorkArea;

/**
 * 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 GuiBufferViewDelegate, public GuiBufferDelegate
{
public:
	///
	LyXView(int id) : id_(id) {}
	///
	virtual ~LyXView();
	///
	int id() const { return id_; }
	///
	virtual void close() = 0;
	///
	virtual void setFocus() = 0;

	///
	virtual WorkArea * workArea(Buffer & buffer) = 0;
	///
	virtual WorkArea * addWorkArea(Buffer & buffer) = 0;
	///
	virtual void setCurrentWorkArea(WorkArea * work_area) = 0;
	///
	virtual void removeWorkArea(WorkArea * work_area) = 0;
	/// return the current WorkArea (the one that has the focus).
	virtual WorkArea const * currentWorkArea() const = 0;
	/// FIXME: This non-const access is needed because of
	/// a mis-designed \c ControlSpellchecker.
	virtual WorkArea * currentWorkArea() = 0;

	/**
	 * 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 setBusy(bool) = 0;

	//@{ generic accessor functions

	/// \return the current buffer view.
	virtual BufferView * view() = 0;

	/// \return the buffer currently shown in this window
	virtual Buffer * buffer() = 0;
	virtual Buffer const * buffer() const = 0;
	/// set a buffer to the current workarea.
	virtual void setBuffer(Buffer * b) = 0; ///< \c Buffer to set.

	///
	virtual void openLayoutList() = 0;
	///
	virtual bool isToolbarVisible(std::string const & id) = 0;
	///
	virtual void showMiniBuffer(bool visible) = 0;
	virtual void openMenu(docstring const & name) = 0;

	/// get access to the dialogs
	virtual Dialogs & getDialogs() = 0;
	///
	virtual Dialogs const & getDialogs() const = 0;

	//@}

	/// load a buffer into the current workarea.
	virtual Buffer * loadLyXFile(support::FileName const &  name, ///< File to load.
		bool tolastfiles = true) = 0;  ///< append to the "Open recent" menu?

	/// updates the possible layouts selectable
	virtual void updateLayoutChoice(bool force) = 0;

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

	/// 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;

	/// reset autosave timer
	virtual void resetAutosaveTimer() = 0;

	/// dispatch to current BufferView
	virtual void dispatch(FuncRequest const & cmd) = 0;

	/** redraw \c inset in all the BufferViews in which it is currently
	 *  visible. If successful return a pointer to the owning Buffer.
	 */
	virtual Buffer const * updateInset(Inset const *) = 0;

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

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

	
	//
	// GuiBufferDelegate
	//
	/// This function is called when the buffer structure is changed.
	virtual void structureChanged() = 0;
	/// This function is called when some parsing error shows up.
	void errors(std::string const & err) { showErrorList(err); }
	/// Reset autosave timers for all users.
	void resetAutosaveTimers() { resetAutosaveTimer(); }

	/// connect to signals in the given BufferView
	virtual void connectBufferView(BufferView & bv) = 0;
	/// disconnect from signals in the given BufferView
	virtual void disconnectBufferView() = 0;
	/// connect to signals in the given buffer
	virtual void connectBuffer(Buffer & buf) = 0;
	/// disconnect from signals in the given buffer
	virtual void disconnectBuffer() = 0;

private:
	/// noncopyable
	LyXView(LyXView const &);
	void operator=(LyXView const &);

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

private:
	int id_;
};

} // namespace frontend
} // namespace lyx

#endif // LYXVIEW_H