X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2Ffrontends%2FSelection.h;h=ac902ffc1eaafcaef57e201ddf59fd9ff5d8ab73;hb=28be7d552f62cc02fa86d7f79201d089bfb2d7b5;hp=c281d72cc5ad8e1723fe9f804e0d4458d04920c7;hpb=28ad9602557a145bfd88c79dddecdc34c95c698c;p=lyx.git

diff --git a/src/frontends/Selection.h b/src/frontends/Selection.h
index c281d72cc5..ac902ffc1e 100644
--- a/src/frontends/Selection.h
+++ b/src/frontends/Selection.h
@@ -11,10 +11,10 @@
  * Full author contact details are available in file CREDITS.
  */
 
-#ifndef BASE_SELECTION_H
-#define BASE_SELECTION_H
+#ifndef SELECTION_H
+#define SELECTION_H
 
-#include "support/docstring.h"
+#include "support/strfwd.h"
 
 namespace lyx {
 namespace frontend {
@@ -27,7 +27,15 @@ class Selection
 public:
 	virtual ~Selection() {}
 
-	/// Tell the window system whether we have a selection.
+	/**
+	 * Tell the window system whether we set or cleared our selection.
+	 * This is a noop on systems that don't have a selection.
+	 * This should be called by the kernel whenever a selection is
+	 * created, changed or cleared.
+	 * \param own
+	 * If true: Tell that we got a valid selection.
+	 * If false: Tell that we cleared our selection.
+	 */
 	virtual void haveSelection(bool) = 0;
 	/**
 	 * Get the X selection contents.
@@ -39,15 +47,30 @@ public:
 	virtual docstring const get() const = 0;
 	/**
 	 * Fill the X selection.
+	 * The format is plain text.
 	 * Does nothing on systems that don't have a selection.
-	 * This should be called whenever some text is highlighted.
+	 * Since the X selection protocol is asyncronous this should never be
+	 * called from the kernel.
+	 * If another application requests the current selection a
+	 * SelectionRequest XEvent will be triggered. The response of the
+	 * frontend to this event should be to retrieve the current selection
+	 * from the kernel and push it to X with this method.
 	 */
 	virtual void put(docstring const &) = 0;
+	/**
+	 * Is the X selection empty?
+	 * This does always return true on systems that don't have a real
+	 * selection.
+	 */
+	virtual bool empty() const = 0;
 };
 
 } // namespace frontend
+
+/// Implementation is in Application.cpp
+extern frontend::Selection & theSelection();
+
 } // namespace lyx
 
-extern lyx::frontend::Selection & theSelection();
 
-#endif // BASE_SELECTION_H
+#endif // SELECTION_H