4 * This file is part of LyX, the document processor.
5 * Licence details can be found in the file COPYING.
9 * \author Abdelrazak Younes
11 * Full author contact details are available in file CREDITS.
14 #ifndef BASE_CLIPBOARD_H
15 #define BASE_CLIPBOARD_H
19 #include "support/strfwd.h"
21 using lyx::support::FileName;
27 * A Clipboard class manages the clipboard.
32 virtual ~Clipboard() {}
54 * Get the system clipboard contents. The format is as written in
55 * .lyx files (may even be an older version than ours if it comes
57 * Does not convert plain text to LyX if only plain text is available.
58 * This should be called when the user requests to paste from the
61 virtual std::string const getAsLyX() const = 0;
62 /// Get the contents of the window system clipboard in any text format except LyxTextType.
63 virtual docstring const getAsText(TextType type) const = 0;
64 /// Get the contents of the window system clipboard as graphics file.
65 virtual FileName getAsGraphics(Cursor const & cur, GraphicsType type) const = 0;
68 * Fill the system clipboard. The format of \p lyx is as written in
69 * .lyx files, the format of \p text is plain text.
70 * We put the clipboard contents in LyX format and plain text into
71 * the system clipboard if supported, so that it is useful for other
72 * applications as well as other instances of LyX.
73 * This should be called when the user requests to cut or copy to
76 virtual void put(std::string const & lyx, docstring const & html, docstring const & text) = 0;
78 /// Does the clipboard contain text contents?
79 virtual bool hasTextContents(TextType type = AnyTextType) const = 0;
80 /// Does the clipboard contain graphics contents of a certain type?
81 virtual bool hasGraphicsContents(GraphicsType type = AnyGraphicsType) const = 0;
82 /// state of clipboard.
83 /// \returns true if the system clipboard has been set within LyX
84 /// (document contents, dialogs count as external here).
85 virtual bool isInternal() const = 0;
86 /// \returns true if the OS has the concept of clipboard ownership,
87 /// which is crucial for our concept of internal clipboard.
88 virtual bool hasInternal() const = 0;
89 /// Is the clipboard empty?
90 /// \returns true if both the LyX and the plaintext versions of the
91 /// clipboard are empty, and no supported graphics format is available.
92 virtual bool empty() const = 0;
95 } // namespace frontend
97 /// Implementation is in Application.cpp
98 extern frontend::Clipboard & theClipboard();
103 #endif // BASE_CLIPBOARD_H