X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2FCutAndPaste.h;h=d1162cb16500b13b4f5625aae79cb5c434bc29d2;hb=2515a3bded01e27dcc3b19502e649f01fff5ace0;hp=eb6aded2e23dc70804298cdef429184333ee7d7b;hpb=26460b39ee8b2c8fe88e3f2225486e1b72e59f3f;p=lyx.git

diff --git a/src/CutAndPaste.h b/src/CutAndPaste.h
index eb6aded2e2..d1162cb165 100644
--- a/src/CutAndPaste.h
+++ b/src/CutAndPaste.h
@@ -14,8 +14,6 @@
 #ifndef CUTANDPASTE_H
 #define CUTANDPASTE_H
 
-#include "ParagraphList_fwd.h"
-
 #include "support/docstring.h"
 
 #include <vector>
@@ -25,40 +23,72 @@ namespace lyx {
 class Buffer;
 class ErrorList;
 class InsetText;
-class LyXTextClass;
-class LCursor;
+class TextClass;
+class Cursor;
+class ParagraphList;
 
 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);
 
-///
-void cutSelection(LCursor & cur, bool doclear, bool realcut);
-
-/* 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,
+void replaceSelectionWithString(Cursor & cur, docstring const & str,
 				bool backwards);
-/// replace selection helper
-void replaceSelection(LCursor & cur);
+/// If a selection exists, delete it without pushing it to the cut buffer.
+/// Does handle undo.
+void replaceSelection(Cursor & cur);
 
-///
-void cutSelection(LCursor & cur, bool doclear = true, bool realcut = true);
-///
-void copySelection(LCursor & cur);
-///
-void pasteSelection(LCursor & cur, ErrorList &, size_t sel_index = 0);
+/**
+ * Cut the current selection and possibly push it to the cut buffer and
+ * system clipboard.
+ * Does handle undo. Calls saveSelection.
+ * \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(Cursor & cur, bool doclear = true, bool realcut = true);
+/// Push the current selection to the cut buffer and the system clipboard.
+void copySelection(Cursor & cur);
+/**
+ * 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(Cursor & 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(Cursor & 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(Cursor & 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(Cursor & 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(Cursor & 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.
-void pasteParagraphList(LCursor & cur, ParagraphList const & parlist,
+void pasteParagraphList(Cursor & cur, ParagraphList const & parlist,
 			textclass_type textclass, ErrorList & errorList);
 
 
@@ -67,23 +97,25 @@ void pasteParagraphList(LCursor & cur, ParagraphList const & parlist,
  *  It changes layouts and character styles.
  */
 void switchBetweenClasses(textclass_type c1, textclass_type c2,
-                          InsetText & in, ErrorList &);
-
-///
-docstring grabSelection(LCursor const & cur);
-///
-void eraseSelection(LCursor & cur);
-///
-docstring grabAndEraseSelection(LCursor & cur);
+			  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(Cursor const & cur);
+/// Erase the current selection.
+/// Does not handle undo. Does only work if the whole selection is in mathed.
+/// Calls saveSelection.
+void eraseSelection(Cursor & 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(Cursor & cur);
 // other selection methods
-///
-void selCut(LCursor & cur);
-///
-void selDel(LCursor & cur);
-/// clears or deletes selection depending on lyxrc setting
-void selClearOrDel(LCursor & cur);
-/// pastes n-th element of cut buffer
-void selPaste(LCursor & cur, size_t n);
+/// Erase the selection if one exists.
+/// Does not handle undo. Does only work if the whole selection is in mathed.
+void selDel(Cursor & cur);
+/// 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(Cursor & cur);
 
 /** Tabular has its own paste stack for multiple cells
  *  but it needs to know whether there is a more recent