// -*- C++ -*-
/**
 * \file DockView.h
 * This file is part of LyX, the document processor.
 * Licence details can be found in the file COPYING.
 *
 * \author Abdelrazak Younes
 *
 * Full author contact details are available in file CREDITS.
 */

#ifndef DOCK_VIEW_H
#define DOCK_VIEW_H

#include "Dialog.h"
#include "GuiView.h"
#include "qt_helpers.h"
#include "debug.h"

#include <QDockWidget>

namespace lyx {
namespace frontend {

/// Dock Widget container for LyX dialogs.
/// This template class that encapsulates a given Widget inside a
/// QDockWidget and presents a Dialog interface
class DockView : public QDockWidget, public Dialog
{
public:
	DockView(
		GuiViewBase & parent, ///< the main window where to dock.
		std::string const & name, ///< dialog identifier.
		Qt::DockWidgetArea area = Qt::LeftDockWidgetArea, ///< Position of the dock (and also drawer)
		Qt::WindowFlags flags = 0
	)
		: QDockWidget(&parent, flags), Dialog(parent), name_(name)
	{
		if (flags & Qt::Drawer)
			setFeatures(QDockWidget::NoDockWidgetFeatures);
		parent.addDockWidget(area, this);
	}

	virtual ~DockView() {}

	/// Dialog inherited methods
	//@{
	void applyView() {}
	void hideView()	{ QDockWidget::hide(); }
	void showData(std::string const & data)
	{
		initialiseParams(data);
		showView();
	}
	void showView()
	{
		updateView();  // make sure its up-to-date
		QDockWidget::show();
	}
	bool isVisibleView() const { return QDockWidget::isVisible(); }
	void checkStatus() { updateView(); }
	void redraw() { redrawView(); }
	void redrawView() {}
	void updateData(std::string const & data)
	{
		initialiseParams(data);
		updateView();
	}
	bool isClosing() const { return false; }
	void partialUpdateView(int /*id*/) {}
	std::string name() const { return name_; }
	//@}
private:
	std::string name_;
};

} // frontend
} // lyx

#endif // DOCK_VIEW_H