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 ///
  34 std::vector<docstring> const availableSelections(Buffer const & buffer);
  35 ///
  36 size_type numberOfSelections();
  37 ///
  38 docstring getSelection(Buffer const & buffer, size_t sel_index);
  39
  40 ///
  41 void cutSelection(LCursor & cur, bool doclear, bool realcut);
  42
  43 /* Replace using the font of the first selected character and select
  44  * the new string. When \c backwards == false, set anchor before
  45  * cursor; otherwise set cursor before anchor.
  46  */
  47 void replaceSelectionWithString(LCursor & cur, std::string const & str,
  48                                 bool backwards);
  49 /// replace selection helper
  50 void replaceSelection(LCursor & cur);
  51
  52 ///
  53 void cutSelection(LCursor & cur, bool doclear = true, bool realcut = true);
  54 ///
  55 void copySelection(LCursor & cur);
  56 ///
  57 void pasteSelection(LCursor & cur, ErrorList &, size_t sel_index = 0);
  58
  59 /// Paste the paragraph list \p parlist at the position given by \p cur.
  60 /// Does not handle undo. Does only work in text, not mathed.
  61 void pasteParagraphList(LCursor & cur, ParagraphList const & parlist,
  62                         textclass_type textclass, ErrorList & errorList);
  63
  64
  65 /** Needed to switch between different classes. This works
  66  *  for a list of paragraphs beginning with the specified par.
  67  *  It changes layouts and character styles.
  68  */
  69 void switchBetweenClasses(textclass_type c1, textclass_type c2,
  70                           InsetText & in, ErrorList &);
  71
  72 ///
  73 docstring grabSelection(LCursor const & cur);
  74 ///
  75 void eraseSelection(LCursor & cur);
  76 ///
  77 docstring grabAndEraseSelection(LCursor & cur);
  78 // other selection methods
  79 ///
  80 void selCut(LCursor & cur);
  81 ///
  82 void selDel(LCursor & cur);
  83 /// clears or deletes selection depending on lyxrc setting
  84 void selClearOrDel(LCursor & cur);
  85 /// pastes n-th element of cut buffer
  86 void selPaste(LCursor & cur, size_t n);
  87
  88 /** Tabular has its own paste stack for multiple cells
  89  *  but it needs to know whether there is a more recent
  90  *  ordinary paste. Therefore which one is newer.
  91  */
  92 //FIXME: this is a workaround for bug 1919. Replace this by
  93 //an all-for-one-paste mechanism in 1.5
  94 /// store whether tabular or ordinary paste stack is newer
  95 void dirtyTabularStack(bool b);
  96 /// is the tabular paste stack newer than the ordinary one?
  97 bool tabularStackDirty();
  98 } // namespace cap
  99 } // namespce lyx
 100
 101 #endif