X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2Ffrontends%2FSelection.h;h=ac902ffc1eaafcaef57e201ddf59fd9ff5d8ab73;hb=ee72e9520a657557676e05add9e24f15cb337b29;hp=94410c498f12c05211794ee016b685a2d43dcde3;hpb=6fcb3fe6a2cab344b2cb15ac5c81cee831c7b886;p=lyx.git

diff --git a/src/frontends/Selection.h b/src/frontends/Selection.h
index 94410c498f..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,22 +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;
-
-	/// state of clipboard.
-	/// \retval true if the system clipboard has been set within LyX.
-	virtual bool isInternal() 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.C
+/// Implementation is in Application.cpp
 extern frontend::Selection & theSelection();
 
 } // namespace lyx
 
 
-#endif // BASE_SELECTION_H
+#endif // SELECTION_H