]> git.lyx.org Git - lyx.git/blobdiff - src/CutAndPaste.h
Group most verbose dbg output into more intuitive categories.
[lyx.git] / src / CutAndPaste.h
index c5c7aa4334c8841929ea2921b1e560cfcbf084d7..d7fec67c176a930b5133531eac25721b75f4134f 100644 (file)
 #ifndef CUTANDPASTE_H
 #define CUTANDPASTE_H
 
-#include "support/docstring.h"
+#include "Author.h"
+#include "DocumentClassPtr.h"
+
+#include "support/strfwd.h"
+#include "support/types.h"
 
 #include "frontends/Clipboard.h"
 
 #include <vector>
 
-using lyx::frontend::Clipboard;
 
 namespace lyx {
 
-class DocumentClass;
+class Buffer;
 class ErrorList;
+class Inset;
 class InsetText;
 class Cursor;
+class CursorData;
+class CursorSlice;
 class ParagraphList;
 
 namespace cap {
@@ -36,8 +42,13 @@ namespace cap {
 std::vector<docstring> 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);
+///
+typedef std::pair<DocumentClassConstPtr, AuthorList > DocInfoPair;
+/**
+ * Get the sel_index-th element of the cut buffer in plain text format
+ * or, if \param for_math is true, in a format suitable for mathed.
+ */
+docstring selection(size_t sel_index, DocInfoPair docinfo, bool for_math = false);
 
 /**
  * Replace using the font of the first selected character and select
@@ -58,11 +69,18 @@ void replaceSelection(Cursor & cur);
  *                system clipboard. Set this to false to only delete the
  *                selection.
  */
-void cutSelection(Cursor & cur, bool doclear = true, bool realcut = true);
+void cutSelection(Cursor & cur, bool realcut = true);
+/// Like cutSelection, but only put to temporary cut buffer
+void cutSelectionToTemp(Cursor & cur, bool realcut = true);
+
 /// Push the current selection to the cut buffer and the system clipboard.
 void copySelection(Cursor const & cur);
+/// Like copySelection, but only put to temporary cut buffer
+void copySelectionToTemp(Cursor const & cur);
 ///
 void copyInset(Cursor const & cur, Inset * inset, docstring const & plaintext);
+///
+void copyInsetToTemp(Cursor const & cur, Inset * inset);
 /**
  * Push the current selection to the cut buffer and the system clipboard.
  * \param plaintext plain text version of the selection for the system
@@ -85,34 +103,50 @@ 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.
-void pasteClipboardText(Cursor & cur, ErrorList & errorList,
-       bool asParagraphs = true);
+/// \p asParagraphs is only considered if plain text is pasted.
+bool pasteClipboardText(Cursor & cur, ErrorList & errorList, bool asParagraphs,
+       frontend::Clipboard::TextType preferedType = frontend::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);
+       frontend::Clipboard::GraphicsType preferedType = frontend::Clipboard::AnyGraphicsType);
 /// 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);
+bool pasteFromStack(Cursor & cur, ErrorList & errorList, size_t sel_index);
+/// Replace the current selection with temporary cut buffer
+/// Does handle undo. Does only work in text, not mathed.
+bool pasteFromTemp(Cursor & cur, ErrorList & errorList);
 /// Paste the clipboard as simple text, removing any formatting
 void pasteSimpleText(Cursor & cur, bool asParagraphs);
 
+// What to do with unknown branches?
+enum BranchAction {
+       BRANCH_ADD, // add the branch unconditionally
+       BRANCH_IGNORE, // leave the branch undefined
+       BRANCH_ASK // ask the user whether the branch should be added
+};
 /// 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,
-                       DocumentClass const * const textclass, ErrorList & errorList);
+                       DocumentClassConstPtr textclass, AuthorList const & authors,
+                       ErrorList & errorList,
+                       BranchAction branchAction = BRANCH_ASK);
 
 
 /** Needed to switch between different classes. This works
  *  for a list of paragraphs beginning with the specified par.
- *  It changes layouts and character styles.
+ *  It changes layouts and character styles. Errors are reported
+ *  in the passed ErrorList.
  */
-void switchBetweenClasses(DocumentClass const * const c1, 
-                       DocumentClass const * const c2, InsetText & in, ErrorList &);
+void switchBetweenClasses(DocumentClassConstPtr oldone,
+            DocumentClassConstPtr newone, InsetText & in, ErrorList & el);
+/// Same but without error reporting.
+void switchBetweenClasses(DocumentClassConstPtr oldone,
+            DocumentClassConstPtr newone, InsetText & in);
 
 /// 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);
+docstring grabSelection(CursorData const & cur);
 /// Erase the current selection.
 /// Does not handle undo. Does only work if the whole selection is in mathed.
 /// Calls saveSelection.
@@ -121,9 +155,9 @@ void eraseSelection(Cursor & cur);
 /// 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);
+bool reduceSelectionToOneCell(CursorData & cur);
 /// Returns true if multiple cells are selected in mathed.
-bool multipleCellsSelected(Cursor const & cur);
+bool multipleCellsSelected(CursorData 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);
@@ -136,8 +170,8 @@ void selDel(Cursor & cur);
 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);
+                       row_type & r1, row_type & r2,
+                       col_type & c1, col_type & c2);
 /** Tabular has its own paste stack for multiple cells
  *  but it needs to know whether there is a more recent
  *  ordinary paste. Therefore which one is newer.
@@ -149,6 +183,6 @@ void dirtyTabularStack(bool b);
 /// is the tabular paste stack newer than the ordinary one?
 bool tabularStackDirty();
 } // namespace cap
-} // namespce lyx
+} // namespace lyx
 
 #endif