]> git.lyx.org Git - lyx.git/blobdiff - src/CutAndPaste.h
* output_plaintext.C: cosmetics in comment: line length cannot be < 0
[lyx.git] / src / CutAndPaste.h
index 4bb4679f220219ea5b6cbc8b436e631b5cfad6a1..a07d04c11810967fe104e34c2e258c87076b3c38 100644 (file)
@@ -30,27 +30,52 @@ 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, cut it and push 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 for internal cuts that
+ *                do not directly originate from the user.
+ */
 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);
-///
+/**
+ * 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 current selection to the cut buffer.
+void copySelectionToStack(LCursor & cur);
+/// 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 pasteSelection(LCursor & cur, ErrorList &, size_t sel_index = 0);
 
 /// Paste the paragraph list \p parlist at the position given by \p cur.
@@ -66,19 +91,22 @@ 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);
-/// pastes n-th element of cut buffer
-void selPaste(LCursor & cur, size_t n);
 
 /** Tabular has its own paste stack for multiple cells
  *  but it needs to know whether there is a more recent