#ifndef CUTANDPASTE_H
#define CUTANDPASTE_H
-#include "support/types.h"
+#include "support/docstring.h"
-#include <string>
#include <vector>
+namespace lyx {
+
class Buffer;
class ErrorList;
-class LyXTextClass;
-class LCursor;
+class InsetText;
+class TextClass;
+class Cursor;
class ParagraphList;
-///
-namespace lyx {
namespace cap {
-///
-std::vector<std::string> const availableSelections(Buffer const & buffer);
-///
-std::string getSelection(Buffer const & buffer, size_t sel_index);
+/// 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
+ * the new string. When \c backwards == false, set anchor before
+ * cursor; otherwise set cursor before anchor.
+ * Does handle undo.
+ */
+void replaceSelectionWithString(Cursor & cur, docstring const & str,
+ bool backwards);
+/// If a selection exists, delete it without pushing it to the cut buffer.
+/// Does handle undo.
+void replaceSelection(Cursor & cur);
/**
- * Sets the selection from the current cursor position to length
- * characters to the right. No safety checks.
+ * 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 setSelectionRange(LCursor & cur, lyx::pos_type length);
-/// simply replace using the font of the first selected character
-void replaceSelectionWithString(LCursor & cur, std::string const & str);
-/// replace selection helper
-void replaceSelection(LCursor & cur);
+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(Cursor & cur, ParagraphList const & parlist,
+ textclass_type textclass, ErrorList & errorList);
-///
-void cutSelection(LCursor & cur, bool doclear = true, bool realcut = true);
-///
-void copySelection(LCursor & cur);
-///
-void pasteSelection(LCursor & cur, size_t sel_index = 0);
/** Needed to switch between different classes. This works
* for a list of paragraphs beginning with the specified par.
* It changes layouts and character styles.
*/
-void SwitchBetweenClasses(lyx::textclass_type c1,
- lyx::textclass_type c2,
- ParagraphList & par,
- ErrorList &);
-
-// only used by the spellchecker
-void replaceWord(LCursor & cur, std::string const & replacestring);
+void switchBetweenClasses(textclass_type c1, textclass_type c2,
+ InsetText & in, ErrorList &);
-///
-std::string grabSelection(LCursor & cur);
-///
-void eraseSelection(LCursor & cur);
-///
-std::string grabAndEraseSelection(LCursor & cur);
+/// 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.
+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
+ * but it needs to know whether there is a more recent
* ordinary paste. Therefore which one is newer.
*/
//FIXME: this is a workaround for bug 1919. Replace this by
projects / lyx.git / blobdiff