]> git.lyx.org Git - features.git/blobdiff - src/mathed/math_cursor.h
Replace LString.h with support/std_string.h,
[features.git] / src / mathed / math_cursor.h
index 9791bdb2ef8736f64315e243ba845874287714ef..4df0b822d8eec69a7a87ab539c53ad663990070e 100644 (file)
@@ -1,42 +1,34 @@
 // -*- C++ -*-
 /**
- *  File:        math_cursor.h
- *  Purpose:     Declaration of interaction classes for mathed
- *  Author:      Alejandro Aguilar Sierra <asierra@servidor.unam.mx>
- *  Created:     January 1996
- *  Description: MathCursor control all user interaction
+ * \file math_cursor.h
+ * This file is part of LyX, the document processor.
+ * Licence details can be found in the file COPYING.
  *
- *  Dependencies: Xlib, XForms
+ * \author Alejandro Aguilar Sierra
+ * \author André Pönitz
  *
- *  Copyright: 1996, Alejandro Aguilar Sierra
- *
- *   You are free to use and modify this code under the terms of
- *   the GNU General Public Licence version 2 or later.
+ * Full author contact details are available in file CREDITS.
  */
 
 #ifndef MATH_CURSOR
 #define MATH_CURSOR
 
-#ifdef __GNUG__
-#pragma interface
-#endif
 
 #include "math_inset.h"
 #include "math_iterator.h"
-#include "LString.h"
+#include "support/std_string.h"
 
 class InsetFormulaBase;
 class BufferView;
-class MathPainterInfo;
+class PainterInfo;
 class MathUnknownInset;
-class Selection;
 
 /**
 
 [Have a look at math_inset.h first]
 
 The MathCursor is different from the kind of cursor used in the Outer
-World. It contains a stack of MathCursorPos, each of which is made
+World. It contains a stack of CursorPos, each of which is made
 up of a inset pointer, an index and a position offset, marking a path from
 this formula's MathHullInset to the current position.
 
@@ -47,6 +39,8 @@ class MathCursor {
 public:
        /// short of anything else reasonable
        typedef MathInset::size_type       size_type;
+       /// type for column numbers
+       typedef MathArray::difference_type difference_type;
        /// type for cursor positions within a cell
        typedef MathInset::pos_type        pos_type;
        /// type for cell indices
@@ -65,11 +59,13 @@ public:
        ///
        void insert(MathArray const &);
        ///
-       void paste(string const & data);
-       ///
-       void erase();
+       void insert2(string const &);
        ///
-       void backspace();
+       void paste(string const & data);
+       /// return false for empty math insets
+       bool erase();
+       /// return false for empty math insets
+       bool backspace();
        /// called for LFUN_HOME etc
        bool home(bool sel = false);
        /// called for LFUN_END etc
@@ -106,7 +102,7 @@ public:
        /// in pixels from left of screen
        int targetX() const;
        /// current inset
-       MathInset * par() const;
+       MathInset * inset() const;
        /// return the next enclosing grid inset and the cursor's index in it
        MathGridInset * enclosingGrid(idx_type & idx) const;
        /// go up to enclosing grid
@@ -115,6 +111,8 @@ public:
        void popToEnclosingHull();
        /// go up to the hull inset
        void popToHere(MathInset const * p);
+       /// adjust anchor position after deletions/insertions
+       void adjust(pos_type from, difference_type diff);
        ///
        InsetFormulaBase * formula() const;
        /// current offset in the current cell
@@ -125,7 +123,7 @@ public:
        size_type size() const;
        ///
        bool script(bool);
-       /// 
+       ///
        bool interpret(char);
        /// interpret name a name of a macro
        void macroModeClose();
@@ -149,8 +147,8 @@ public:
        void selCut();
        ///
        void selDel();
-       ///
-       void selPaste();
+       /// pastes n-th element of cut buffer
+       void selPaste(size_t n);
        ///
        void selHandle(bool);
        ///
@@ -160,7 +158,7 @@ public:
        /// clears or deletes selection depending on lyxrc setting
        void selClearOrDel();
        /// draws light-blue selection background
-       void drawSelection(MathPainterInfo & pi) const;
+       void drawSelection(PainterInfo & pi) const;
        ///
        void handleNest(MathAtom const & at);
        /// remove this as soon as LyXFunc::getStatus is "localized"
@@ -206,19 +204,19 @@ public:
        MathAtom & nextAtom();
 
        /// returns the selection
-       void getSelection(MathCursorPos &, MathCursorPos &) const;
+       void getSelection(CursorPos &, CursorPos &) const;
        /// returns the normalized anchor of the selection
-       MathCursorPos normalAnchor() const;
+       CursorPos normalAnchor() const;
 
        /// reference to the last item of the path, i.e. "The Cursor"
-       MathCursorPos & cursor();
+       CursorPos & cursor();
        /// reference to the last item of the path, i.e. "The Cursor"
-       MathCursorPos const & cursor() const;
+       CursorPos const & cursor() const;
        /// how deep are we nested?
        unsigned depth() const;
 
        /// local dispatcher
-       MathInset::result_type dispatch(FuncRequest const & cmd);
+       dispatch_result dispatch(FuncRequest const & cmd);
        /// describe the situation
        string info() const;
        /// dump selection information for debugging
@@ -227,6 +225,10 @@ public:
        void dump(char const * str) const;
        /// moves on
        void setSelection(MathIterator const & where, size_type n);
+       /// grab selection marked by anchor and current cursor
+       string grabSelection() const;
+       /// guess what
+       string grabAndEraseSelection();
        ///
        void insert(char c);
        ///
@@ -237,15 +239,12 @@ public:
        /// hack for reveal codes
        void markInsert();
        void markErase();
-       //void handleExtern(string const & arg);
-
-       ///
-       friend class Selection;
-
-
-private:
        /// injects content of a cell into parent
        void pullArg();
+       /// split font inset etc
+       void handleFont(string const & font);
+
+private:
        /// moves cursor index one cell to the left
        bool idxLeft();
        /// moves cursor index one cell to the right
@@ -265,17 +264,13 @@ private:
        /// are we in a nucleus of a script inset?
        bool inNucleus() const;
 
-       /// grab selection marked by anchor and current cursor 
-       string grabSelection() const;
        /// erase the selected part and re-sets the cursor
        void eraseSelection();
-       /// guess what
-       string grabAndEraseSelection();
 
        /// the name of the macro we are currently inputting
        string macroName() const;
        /// where in the curent cell does the macro name start?
-       MathInset::difference_type macroNamePos() const;
+       difference_type macroNamePos() const;
        /// can we enter the inset?
        bool openable(MathAtom const &, bool selection) const;
        /// write access to cursor cell position