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
17 #include "support/strfwd.h"
26 * A Clipboard class manages the clipboard.
31 virtual ~Clipboard() {}
53 * Get the system clipboard contents. The format is as written in
54 * .lyx files (may even be an older version than ours if it comes
56 * Does not convert plain text to LyX if only plain text is available.
57 * This should be called when the user requests to paste from the
60 virtual std::string const getAsLyX() const = 0;
61 /// Get the contents of the window system clipboard in any text format except LyxTextType.
62 virtual docstring const getAsText(TextType type) const = 0;
63 /// Get the contents of the window system clipboard as graphics file.
64 virtual support::FileName getAsGraphics(Cursor const & cur, GraphicsType type) const = 0;
67 * Fill the system clipboard. The format of \p lyx is as written in
68 * .lyx files, the format of \p text is plain text.
69 * We put the clipboard contents in LyX format and plain text into
70 * the system clipboard if supported, so that it is useful for other
71 * applications as well as other instances of LyX.
72 * This should be called when the user requests to cut or copy to
75 virtual void put(std::string const & lyx, docstring const & html, docstring const & text) = 0;
77 /// Put a general string on the system clipboard (not LyX text)
78 virtual void put(std::string const & text) const = 0;
80 /// Does the clipboard contain text contents?
81 virtual bool hasTextContents(TextType type = AnyTextType) const = 0;
82 /// Does the clipboard contain graphics contents of a certain type?
83 virtual bool hasGraphicsContents(GraphicsType type = AnyGraphicsType) const = 0;
84 /// state of clipboard.
85 /// \returns true if the system clipboard has been set within LyX
86 /// (document contents, dialogs count as external here).
87 virtual bool isInternal() const = 0;
88 /// \returns true if the OS has the concept of clipboard ownership,
89 /// which is crucial for our concept of internal clipboard.
90 virtual bool hasInternal() const = 0;
91 /// Is the clipboard empty?
92 /// \returns true if both the LyX and the plaintext versions of the
93 /// clipboard are empty, and no supported graphics format is available.
94 virtual bool empty() const = 0;
97 } // namespace frontend
99 /// Implementation is in Application.cpp
100 extern frontend::Clipboard & theClipboard();
105 #endif // BASE_CLIPBOARD_H