mirror of
https://git.lyx.org/repos/lyx.git
synced 2024-12-18 20:17:36 +00:00
14fa2c7162
The only exceptions are: - The purpose of the header is to drag in the used symbol, e.g. unique_ptr.h - The used symbol is inside a class or a namespace other than lyx The reason for this is that global 'using' statements effectively forbid to use the used symbols in any other namespace in the whole program, since simply adding or removing an #include of the corresponding header subtly changes the name lookup. The namespace lyx is sort of global, so it should not have these statements either.
105 lines
3.1 KiB
C++
105 lines
3.1 KiB
C++
// -*- 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 "Cursor.h"
|
|
|
|
#include "support/strfwd.h"
|
|
|
|
namespace lyx {
|
|
namespace frontend {
|
|
|
|
/**
|
|
* A Clipboard class manages the clipboard.
|
|
*/
|
|
class Clipboard
|
|
{
|
|
public:
|
|
virtual ~Clipboard() {}
|
|
|
|
enum GraphicsType {
|
|
PdfGraphicsType,
|
|
PngGraphicsType,
|
|
JpegGraphicsType,
|
|
LinkBackGraphicsType,
|
|
EmfGraphicsType,
|
|
WmfGraphicsType,
|
|
AnyGraphicsType
|
|
};
|
|
|
|
enum TextType {
|
|
AnyTextType,
|
|
LyXOrPlainTextType,
|
|
PlainTextType,
|
|
HtmlTextType,
|
|
LaTeXTextType,
|
|
LyXTextType,
|
|
};
|
|
|
|
/**
|
|
* Get the system clipboard contents. The format is as written in
|
|
* .lyx files (may even be an older version than ours if it comes
|
|
* from an older LyX).
|
|
* Does not convert plain text to LyX if only plain text is available.
|
|
* This should be called when the user requests to paste from the
|
|
* clipboard.
|
|
*/
|
|
virtual std::string const getAsLyX() const = 0;
|
|
/// Get the contents of the window system clipboard in any text format except LyxTextType.
|
|
virtual docstring const getAsText(TextType type) const = 0;
|
|
/// Get the contents of the window system clipboard as graphics file.
|
|
virtual support::FileName getAsGraphics(Cursor const & cur, GraphicsType type) const = 0;
|
|
|
|
/**
|
|
* Fill the system clipboard. The format of \p lyx is as written in
|
|
* .lyx files, the format of \p text is plain text.
|
|
* We put the clipboard contents in LyX format and plain text into
|
|
* the system clipboard if supported, so that it is useful for other
|
|
* applications as well as other instances of LyX.
|
|
* This should be called when the user requests to cut or copy to
|
|
* the clipboard.
|
|
*/
|
|
virtual void put(std::string const & lyx, docstring const & html, docstring const & text) = 0;
|
|
|
|
/// Put a general string on the system clipboard (not LyX text)
|
|
virtual void put(std::string const & text) const = 0;
|
|
|
|
/// Does the clipboard contain text contents?
|
|
virtual bool hasTextContents(TextType type = AnyTextType) const = 0;
|
|
/// Does the clipboard contain graphics contents of a certain type?
|
|
virtual bool hasGraphicsContents(GraphicsType type = AnyGraphicsType) const = 0;
|
|
/// state of clipboard.
|
|
/// \returns true if the system clipboard has been set within LyX
|
|
/// (document contents, dialogs count as external here).
|
|
virtual bool isInternal() const = 0;
|
|
/// \returns true if the OS has the concept of clipboard ownership,
|
|
/// which is crucial for our concept of internal clipboard.
|
|
virtual bool hasInternal() const = 0;
|
|
/// Is the clipboard empty?
|
|
/// \returns true if both the LyX and the plaintext versions of the
|
|
/// clipboard are empty, and no supported graphics format is available.
|
|
virtual bool empty() const = 0;
|
|
};
|
|
|
|
} // namespace frontend
|
|
|
|
/// Implementation is in Application.cpp
|
|
extern frontend::Clipboard & theClipboard();
|
|
|
|
} // namespace lyx
|
|
|
|
|
|
#endif // BASE_CLIPBOARD_H
|