lyx_mirror/src/frontends/Clipboard.h

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

#ifndef BASE_CLIPBOARD_H
#define BASE_CLIPBOARD_H

#include "support/docstring.h"

namespace lyx {
namespace frontend {

/**
 * A Clipboard class manages the clipboard.
 */
class Clipboard
{
public:
	virtual ~Clipboard() {}

	/**
	 * Get the window system clipboard contents.
	 * This should be called when the user requests to paste from the
	 * clipboard.
	 */
	virtual docstring const get() const = 0;
	/**
	 * Fill the window system clipboard.
	 * This should be called when the user requests to cut or copy to
	 * the clipboard.
	 */
	virtual void put(docstring const &) = 0;

	/// state of clipboard.
	/// \retval true if the system clipboard has been set within LyX.
	virtual bool isInternal() const = 0;
};

} // namespace frontend

/// Implementation is in Application.C
extern frontend::Clipboard & theClipboard();

} // namespace lyx


#endif // BASE_CLIPBOARD_H