X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2FCutAndPaste.h;h=6375530580bd6be7c5bff1b5b6edb7ff7c883a7f;hb=e53e4d06726919c0fbf386bbe8f9d62a640b74d7;hp=7702de319ea2b9f086f9fc0c22c4e480ce3b4427;hpb=da439a4b198bfa88488930c860928e388b3170b9;p=lyx.git

diff --git a/src/CutAndPaste.h b/src/CutAndPaste.h
index 7702de319e..6375530580 100644
--- a/src/CutAndPaste.h
+++ b/src/CutAndPaste.h
@@ -30,28 +30,62 @@ class LCursor;
 
 namespace cap {
 
-///
+/// Get all elements of the cut buffer in plain text format.
 std::vector<docstring> const availableSelections(Buffer const & buffer);
-///
+/// Get the number of available elements in the cut buffer.
 size_type numberOfSelections();
-///
+/// Get the sel_index-th element of the cut buffer in plain text format.
 docstring getSelection(Buffer const & buffer, size_t sel_index);
 
-/* Replace using the font of the first selected character and select
+/**
+ * Replace using the font of the first selected character and select
  * the new string. When \c backwards == false, set anchor before
  * cursor; otherwise set cursor before anchor.
+ * Does handle undo.
  */
 void replaceSelectionWithString(LCursor & cur, docstring const & str,
 				bool backwards);
-/// replace selection helper
+/// If a selection exists, delete it without pushing it to the cut buffer.
+/// Does handle undo.
 void replaceSelection(LCursor & cur);
 
-///
+/**
+ * Cut the current selection and possibly push it to the cut buffer and
+ * system clipboard.
+ * Does handle undo.
+ * \param doclear If this is true: Delete leading spaces in paragraphs before
+ *                they get merged.
+ * \param realcut If this is true: Push the selection to the cut buffer and
+ *                system clipboard. Set this to false to only delete the
+ *                selection. 
+ */
 void cutSelection(LCursor & cur, bool doclear = true, bool realcut = true);
-///
+/// Push the current selection to the cut buffer and the system clipboard.
 void copySelection(LCursor & cur);
-///
-void pasteSelection(LCursor & cur, ErrorList &, size_t sel_index = 0);
+/**
+ * Push the current selection to the cut buffer and the system clipboard.
+ * \param plaintext plain text version of the selection for the system
+ *        clipboard
+ */
+void copySelection(LCursor & cur, docstring const & plaintext);
+/// Push the selection buffer to the cut buffer.
+void copySelectionToStack();
+/// Store the current selection in the internal selection buffer
+void saveSelection(LCursor & cur);
+/// Is a selection available in our selection buffer?
+bool selection();
+/// Clear our selection buffer
+void clearSelection();
+/// Paste the current selection at \p cur
+/// Does handle undo. Does only work in text, not mathed.
+void pasteSelection(LCursor & cur, ErrorList &);
+/// Replace the current selection with the clipboard contents (internal or
+/// external: which is newer)
+/// Does handle undo. Does only work in text, not mathed.
+void pasteClipboard(LCursor & cur, ErrorList & errorList, bool asParagraphs = true);
+/// Replace the current selection with cut buffer \c sel_index
+/// Does handle undo. Does only work in text, not mathed.
+void pasteFromStack(LCursor & cur, ErrorList & errorList, size_t sel_index);
 
 /// Paste the paragraph list \p parlist at the position given by \p cur.
 /// Does not handle undo. Does only work in text, not mathed.
@@ -66,16 +100,21 @@ void pasteParagraphList(LCursor & cur, ParagraphList const & parlist,
 void switchBetweenClasses(textclass_type c1, textclass_type c2,
                           InsetText & in, ErrorList &);
 
-///
+/// Get the current selection as a string. Does not change the selection.
+/// Does only work if the whole selection is in mathed.
 docstring grabSelection(LCursor const & cur);
-///
+/// Erase the current selection.
+/// Does not handle undo. Does only work if the whole selection is in mathed.
 void eraseSelection(LCursor & cur);
-///
+/// Erase the selection and return it as a string.
+/// Does not handle undo. Does only work if the whole selection is in mathed.
 docstring grabAndEraseSelection(LCursor & cur);
 // other selection methods
-///
+/// Erase the selection if one exists.
+/// Does not handle undo. Does only work if the whole selection is in mathed.
 void selDel(LCursor & cur);
-/// clears or deletes selection depending on lyxrc setting
+/// Clear or delete the selection if one exists, depending on lyxrc setting.
+/// Does not handle undo. Does only work if the whole selection is in mathed.
 void selClearOrDel(LCursor & cur);
 
 /** Tabular has its own paste stack for multiple cells