src/CutAndPaste.h

   1 // -*- C++ -*-
   2 /**
   3  * \file CutAndPaste.h
   4  * This file is part of LyX, the document processor.
   5  * Licence details can be found in the file COPYING.
   6  *
   7  * \author Jürgen Vigna
   8  * \author Lars Gullik Bjønnes
   9  * \author Alfredo Braunstein
  10  *
  11  * Full author contact details are available in file CREDITS.
  12  */
  13
  14 #ifndef CUTANDPASTE_H
  15 #define CUTANDPASTE_H
  16
  17 #include "ParagraphList_fwd.h"
  18
  19 #include "support/docstring.h"
  20
  21 #include <vector>
  22
  23 namespace lyx {
  24
  25 class Buffer;
  26 class ErrorList;
  27 class InsetText;
  28 class LyXTextClass;
  29 class LCursor;
  30
  31 namespace cap {
  32
  33 /// Get all elements of the cut buffer in plain text format.
  34 std::vector<docstring> const availableSelections(Buffer const & buffer);
  35 /// Get the number of available elements in the cut buffer.
  36 size_type numberOfSelections();
  37 /// Get the sel_index-th element of the cut buffer in plain text format.
  38 docstring getSelection(Buffer const & buffer, size_t sel_index);
  39
  40 /**
  41  * Replace using the font of the first selected character and select
  42  * the new string. When \c backwards == false, set anchor before
  43  * cursor; otherwise set cursor before anchor.
  44  * Does handle undo.
  45  */
  46 void replaceSelectionWithString(LCursor & cur, docstring const & str,
  47                                 bool backwards);
  48 /// If a selection exists, cut it and push it to the cut buffer.
  49 /// Does handle undo.
  50 void replaceSelection(LCursor & cur);
  51
  52 /**
  53  * Cut the current selection and possibly push it to the cut buffer and
  54  * system clipboard.
  55  * Does handle undo.
  56  * \param doclear If this is true: Delete leading spaces in paragraphs before
  57  *                they get merged.
  58  * \param realcut If this is true: Push the selection to the cut buffer and
  59  *                system clipboard. Set this to false for internal cuts that
  60  *                do not directly originate from the user.
  61  */
  62 void cutSelection(LCursor & cur, bool doclear = true, bool realcut = true);
  63 /// Push the current selection to the cut buffer and the system clipboard.
  64 void copySelection(LCursor & cur);
  65 /**
  66  * Push the current selection to the cut buffer and the system clipboard.
  67  * \param plaintext plain text version of the selection for the system
  68  *        clipboard
  69  */
  70 void copySelection(LCursor & cur, docstring const & plaintext);
  71 /// Push the current selection to the cut buffer.
  72 void copySelectionToStack(LCursor & cur);
  73 /// Replace the current selection with the clipboard contents (internal or
  74 /// external: which is newer)
  75 /// Does handle undo. Does only work in text, not mathed.
  76 void pasteClipboard(LCursor & cur, ErrorList & errorList, bool asParagraphs = true);
  77 /// Replace the current selection with cut buffer \c sel_index
  78 /// Does handle undo. Does only work in text, not mathed.
  79 void pasteSelection(LCursor & cur, ErrorList &, size_t sel_index = 0);
  80
  81 /// Paste the paragraph list \p parlist at the position given by \p cur.
  82 /// Does not handle undo. Does only work in text, not mathed.
  83 void pasteParagraphList(LCursor & cur, ParagraphList const & parlist,
  84                         textclass_type textclass, ErrorList & errorList);
  85
  86
  87 /** Needed to switch between different classes. This works
  88  *  for a list of paragraphs beginning with the specified par.
  89  *  It changes layouts and character styles.
  90  */
  91 void switchBetweenClasses(textclass_type c1, textclass_type c2,
  92                           InsetText & in, ErrorList &);
  93
  94 /// Get the current selection as a string. Does not change the selection.
  95 /// Does only work if the whole selection is in mathed.
  96 docstring grabSelection(LCursor const & cur);
  97 /// Erase the current selection.
  98 /// Does not handle undo. Does only work if the whole selection is in mathed.
  99 void eraseSelection(LCursor & cur);
 100 /// Erase the selection and return it as a string.
 101 /// Does not handle undo. Does only work if the whole selection is in mathed.
 102 docstring grabAndEraseSelection(LCursor & cur);
 103 // other selection methods
 104 /// Erase the selection if one exists.
 105 /// Does not handle undo. Does only work if the whole selection is in mathed.
 106 void selDel(LCursor & cur);
 107 /// Clear or delete the selection if one exists, depending on lyxrc setting.
 108 /// Does not handle undo. Does only work if the whole selection is in mathed.
 109 void selClearOrDel(LCursor & cur);
 110
 111 /** Tabular has its own paste stack for multiple cells
 112  *  but it needs to know whether there is a more recent
 113  *  ordinary paste. Therefore which one is newer.
 114  */
 115 //FIXME: this is a workaround for bug 1919. Replace this by
 116 //an all-for-one-paste mechanism in 1.5
 117 /// store whether tabular or ordinary paste stack is newer
 118 void dirtyTabularStack(bool b);
 119 /// is the tabular paste stack newer than the ordinary one?
 120 bool tabularStackDirty();
 121 } // namespace cap
 122 } // namespce lyx
 123
 124 #endif