X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2FCutAndPaste.h;h=4149f1983b135a0465d72e6e6a7041513f0baaa7;hb=0d63bdfc169b253b53afab047d48bfef69cfedbb;hp=3831a04ab73fa2f0f839a49f4803d66c9ff96d16;hpb=9d6cad3fe60696d795280a886623fdc9a89f9de6;p=lyx.git diff --git a/src/CutAndPaste.h b/src/CutAndPaste.h index 3831a04ab7..4149f1983b 100644 --- a/src/CutAndPaste.h +++ b/src/CutAndPaste.h @@ -4,8 +4,8 @@ * This file is part of LyX, the document processor. * Licence details can be found in the file COPYING. * - * \author Jürgen Vigna - * \author Lars Gullik Bjønnes + * \author Jürgen Vigna + * \author Lars Gullik Bjønnes * \author Alfredo Braunstein * * Full author contact details are available in file CREDITS. @@ -14,88 +14,139 @@ #ifndef CUTANDPASTE_H #define CUTANDPASTE_H -#include "ParagraphList_fwd.h" +#include "DocumentClassPtr.h" -#include "support/types.h" +#include "support/docstring.h" + +#include "frontends/Clipboard.h" -#include #include -class Buffer; -class ErrorList; -class LyXTextClass; -class LCursor; +using lyx::frontend::Clipboard; -/// namespace lyx { -namespace cap { -/// -std::vector const availableSelections(Buffer const & buffer); -/// -lyx::size_type numberOfSelections(); -/// -std::string getSelection(Buffer const & buffer, size_t sel_index); +class DocumentClass; +class ErrorList; +class InsetText; +class Cursor; +class ParagraphList; -/// -void cutSelection(LCursor & cur, bool doclear, bool realcut); +namespace cap { + +/// Get all elements of the cut buffer in plain text format. +std::vector availableSelections(Buffer const *); +/// 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 selection(size_t sel_index); /** - * Sets the selection from the current cursor position to length - * characters to the right. No safety checks. + * Replace using the font of the first selected character and select + * the new string. Does handle undo. */ -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(LCursor & cur, bool doclear = true, bool realcut = true); -/// -void copySelection(LCursor & cur); -/// -void pasteSelection(LCursor & cur, size_t sel_index = 0); +void replaceSelectionWithString(Cursor & cur, docstring const & str); +/// If a selection exists, delete it without pushing it to the cut buffer. +/// Does handle undo. +void replaceSelection(Cursor & cur); +/** + * 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 const & cur); /// -void pasteParagraphList(LCursor & cur, ParagraphList const & parlist, - textclass_type textclass); +void copyInset(Cursor const & cur, Inset * inset, docstring const & plaintext); +/** + * 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 const & 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 const & cur); +/// Is a selection available in our selection buffer? +bool selection(); +/// Clear our selection buffer +void clearSelection(); +/// Clear our cut stack. +void clearCutStack(); +/// 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 as text +/// (internal or external: which is newer). +/// Does handle undo. Does only work in text, not mathed. +/// \p asParagraphs is only considered if plain text is pasted. +bool pasteClipboardText(Cursor & cur, ErrorList & errorList, bool asParagraphs, + Clipboard::TextType preferedType = Clipboard::LyXOrPlainTextType); +/// Replace the current selection with the clipboard contents as graphic. +/// Does handle undo. Does only work in text, not mathed. +void pasteClipboardGraphics(Cursor & cur, ErrorList & errorList, + Clipboard::GraphicsType preferedType = Clipboard::AnyGraphicsType); +/// Replace the current selection with cut buffer \c sel_index +/// Does handle undo. Does only work in text, not mathed. +bool pasteFromStack(Cursor & cur, ErrorList & errorList, size_t sel_index); +/// Paste the clipboard as simple text, removing any formatting +void pasteSimpleText(Cursor & cur, bool asParagraphs); + +/// 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, + DocumentClassConstPtr textclass, ErrorList & errorList); /** 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); - -/// -std::string grabSelection(LCursor const & cur); -/// -void eraseSelection(LCursor & cur); -/// -std::string grabAndEraseSelection(LCursor & cur); +void switchBetweenClasses(DocumentClassConstPtr c1, + DocumentClassConstPtr 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(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); +/// Reduce the selected text in mathed to only one cell. If it spans multiple +/// cells, the cursor is moved the end of the current cell and the anchor to the +/// start. If the selection is inside only one cell, nothing is done. Return +/// true if the selection now does not span multiple cells anymore. +bool reduceSelectionToOneCell(Cursor & cur); +/// Returns true if multiple cells are selected in mathed. +bool multipleCellsSelected(Cursor const & 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); +/// Calculate rectangular region of cell between \c i1 and \c i2. +void region(CursorSlice const & i1, CursorSlice const & i2, + Inset::row_type & r1, Inset::row_type & r2, + Inset::col_type & c1, Inset::col_type & c2); /** 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 -//an all-for-one-paste mechanism in 1.5 +//an all-for-one-paste mechanism in 1.7 /// store whether tabular or ordinary paste stack is newer void dirtyTabularStack(bool b); /// is the tabular paste stack newer than the ordinary one?