X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2Ffrontends%2FClipboard.h;h=92e7167708ae9a50adc8093726bb1af1f024f5a6;hb=0425500be524ed87baebea34a5e8b6e58d718bbc;hp=d871b114e704d81c205f11fea56d31392ef31e97;hpb=c9c6ed0b7fbccbbed8b5ef48d05cfefa5acfb99e;p=lyx.git diff --git a/src/frontends/Clipboard.h b/src/frontends/Clipboard.h index d871b114e7..92e7167708 100644 --- a/src/frontends/Clipboard.h +++ b/src/frontends/Clipboard.h @@ -14,7 +14,12 @@ #ifndef BASE_CLIPBOARD_H #define BASE_CLIPBOARD_H -#include +#include "Cursor.h" + +#include "support/FileName.h" +#include "support/strfwd.h" + +using lyx::support::FileName; namespace lyx { namespace frontend { @@ -27,21 +32,66 @@ class Clipboard public: virtual ~Clipboard() {} + enum GraphicsType { + PdfGraphicsType, + PngGraphicsType, + JpegGraphicsType, + LinkBackGraphicsType, + EmfGraphicsType, + WmfGraphicsType, + AnyGraphicsType + }; + /** - * 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 std::string const get() const = 0; + virtual std::string const getAsLyX() const = 0; + /// Get the contents of the window system clipboard in plain text format. + virtual docstring const getAsText() const = 0; + /// Get the contents of the window system clipboard as graphics file. + virtual 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(std::string const &) = 0; + virtual void put(std::string const & lyx, docstring const & text) = 0; + + /// Does the clipboard contain LyX contents? + virtual bool hasLyXContents() const = 0; + /// Does the clipboard contain text contents? + virtual bool hasTextContents() 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