Disable CheckTeX while buffer is processed

[lyx.git] / src / frontends / Clipboard.h

diff --git a/src/frontends/Clipboard.h b/src/frontends/Clipboard.h
index d75f3cf4a4e3b6d84084f7d157f8854ef0ef0b14..af617f5aecc4af11ac5889a35a83f6ea7ac947d5 100644 (file)
--- a/src/frontends/Clipboard.h
+++ b/src/frontends/Clipboard.h
@@ -14,7 +14,9 @@
 #ifndef BASE_CLIPBOARD_H
 #define BASE_CLIPBOARD_H
 
-#include "support/docstring.h"
+#include "Cursor.h"
+
+#include "support/strfwd.h"
 
 namespace lyx {
 namespace frontend {
@@ -27,23 +29,76 @@ class Clipboard
 public:
        virtual ~Clipboard() {}
 
+       enum GraphicsType {
+               PdfGraphicsType,
+               PngGraphicsType,
+               JpegGraphicsType,
+               LinkBackGraphicsType,
+               EmfGraphicsType,
+               WmfGraphicsType,
+               AnyGraphicsType
+       };
+
+       enum TextType {
+               AnyTextType,
+               LyXOrPlainTextType,
+               PlainTextType,
+               HtmlTextType,
+               LaTeXTextType,
+               LyXTextType,
+       };
+
        /**
-        * Get the window system clipboard contents.
+        * 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 docstring const get() const = 0;
+       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 window system clipboard.
+        * 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(docstring const &) = 0;
+       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
 
-extern lyx::frontend::Clipboard & theClipboard();
 
 #endif // BASE_CLIPBOARD_H