]> git.lyx.org Git - lyx.git/blobdiff - src/BufferView.h
simplify BufferView::moveToPosition() use for the external use (in LyXView and LyXFunc).
[lyx.git] / src / BufferView.h
index b57d348048c2b33b87837a671d95369507584c14..a063e62c0133799790e31ed782f4a85d5ab34a18 100644 (file)
 #ifndef BUFFER_VIEW_H
 #define BUFFER_VIEW_H
 
-#include "coordcache.h"
-#include "cursor.h"
-#include "metricsinfo.h"
+#include "CoordCache.h"
+#include "Cursor.h"
+#include "MetricsInfo.h"
 #include "TextMetrics.h"
-#include "UpdateFlags.h"
+#include "update_flags.h"
 
 #include "support/types.h"
 
+#include <boost/tuple/tuple.hpp>
 #include <boost/utility.hpp>
 #include <boost/signal.hpp>
 
@@ -40,8 +41,8 @@ class DocIterator;
 class FuncRequest;
 class FuncStatus;
 class Intl;
-class LCursor;
-class LyXText;
+class Cursor;
+class Text;
 class ParIterator;
 class ParagraphMetrics;
 class ViewMetricsInfo;
@@ -71,31 +72,21 @@ struct ScrollbarParameters
  * is a sliding window of the entire document rendering.
  * It is the official interface between the LyX core and
  * the frontend WorkArea.
- * 
+ *
  * \sa WorkArea
  * \sa Buffer
  * \sa CoordCache
  */
 class BufferView : boost::noncopyable {
 public:
-       BufferView();
+       ///
+       BufferView(Buffer & buffer);
 
        ~BufferView();
 
-       /// set the buffer we are viewing.
-       /// \todo FIXME: eventually, we will create a new BufferView
-       /// when switching Buffers, so this method should go.
-       void setBuffer(Buffer * b);
        /// return the buffer being viewed.
-       Buffer * buffer() const;
-
-       /// resize the BufferView.
-       void resize();
-
-       /// redisplay the referenced buffer.
-       void reload();
-       /// load a buffer into the view.
-       bool loadLyXFile(support::FileName const & name, bool tolastfiles = true);
+       Buffer & buffer();
+       Buffer const & buffer() const;
 
        /// perform pending metrics updates.
        /** \c Update::FitCursor means first to do a FitCursor, and to
@@ -114,22 +105,19 @@ public:
        ScrollbarParameters const & scrollbarParameters() const;
 
        /// Save the current position as bookmark.
-       /// if persistent=false, save to temp_bookmark
-       void saveBookmark(bool persistent);
-       /// goto a specified position.
-       void moveToPosition(
-               int par_id, ///< Paragraph ID, \sa Paragraph
-               pos_type par_pos ///< Position in the \c Paragraph
+       /// if idx == 0, save to temp_bookmark
+       void saveBookmark(unsigned int idx);
+       /// goto a specified position, try top_id first, and then bottom_pit.
+       /// \return true if success
+       bool moveToPosition(
+               pit_type bottom_pit, ///< Paragraph pit, used when par_id is zero or invalid.
+               pos_type bottom_pos, ///< Paragraph pit, used when par_id is zero or invalid.
+               int top_id, ///< Paragraph ID, \sa Paragraph
+               pos_type top_pos ///< Position in the \c Paragraph
                );
        /// return the current change at the cursor.
        Change const getCurrentChange() const;
 
-       /// return the lyxtext we are using.
-       LyXText * getLyXText();
-
-       /// return the lyxtext we are using.
-       LyXText const * getLyXText() const;
-
        /// move cursor to the named label.
        void gotoLabel(docstring const & label);
 
@@ -150,13 +138,14 @@ public:
        /// return the pixel height of the document view.
        int workHeight() const;
 
-       /// switch between primary and secondary keymaps for RTL entry.
-       void switchKeyMap();
+       /// translate and insert a character, using the correct keymap.
+       void translateAndInsert(char_type c, Text * t, Cursor & cur);
 
        /// return true for events that will handle.
        FuncStatus getStatus(FuncRequest const & cmd);
        /// execute the given function.
-       bool dispatch(FuncRequest const & argument);
+       /// \return the Update::flags for further metrics update.
+       Update::flags dispatch(FuncRequest const & argument);
 
        /// request an X11 selection.
        /// \return the selected string.
@@ -178,18 +167,18 @@ public:
        pit_type anchor_ref() const;
 
        /// access to full cursor.
-       LCursor & cursor();
+       Cursor & cursor();
        /// access to full cursor.
-       LCursor const & cursor() const;
+       Cursor const & cursor() const;
        /// sets cursor.
        /// This will also open all relevant collapsable insets.
        void setCursor(DocIterator const &);
        /// Check deleteEmptyParagraphMechanism and update metrics if needed.
        /// \retval true if an update was needed.
-       bool checkDepm(LCursor & cur, LCursor & old);
+       bool checkDepm(Cursor & cur, Cursor & old);
        /// sets cursor.
        /// This is used when handling LFUN_MOUSE_PRESS.
-       bool mouseSetCursor(LCursor & cur);
+       bool mouseSetCursor(Cursor & cur);
 
        /// sets the selection.
        /* When \c backwards == false, set anchor
@@ -210,10 +199,10 @@ public:
        void updateMetrics(bool singlepar = false);
 
        ///
-       TextMetrics const & textMetrics(LyXText const * t) const;
-       TextMetrics & textMetrics(LyXText const * t);
+       TextMetrics const & textMetrics(Text const * t) const;
+       TextMetrics & textMetrics(Text const * t);
        ///
-       ParagraphMetrics const & parMetrics(LyXText const *, pit_type) const;
+       ParagraphMetrics const & parMetrics(Text const *, pit_type) const;
 
        ///
        CoordCache & coordCache() {
@@ -241,18 +230,27 @@ public:
 
        /// This signal is emitted when some inset dialogs needs to be shown.
        boost::signal<void(std::string name, std::string data,
-               InsetBase * inset)> showInsetDialog;
+               Inset * inset)> showInsetDialog;
 
        /// This signal is emitted when some dialogs needs to be updated.
        boost::signal<void(std::string name,
                std::string data)> updateDialog;
 
        /// This signal is emitted when the layout at the cursor is changed.
-       boost::signal<void(std::string layout)> layoutChanged;
+       boost::signal<void(docstring layout)> layoutChanged;
 
 private:
        ///
        bool multiParSel();
+
+       /// Search recursively for the the innermost inset that covers (x, y) position.
+       /// \retval 0 if no inset is found.
+       Inset const * getCoveringInset(
+               Text const & text, //< The Text where we start searching.
+               int x, //< x-coordinate on screen
+               int y  //< y-coordinate on screen
+               );
+
        ///
        int width_;
        ///
@@ -265,7 +263,7 @@ private:
        ///
        CoordCache coord_cache_;
        ///
-       Buffer * buffer_;
+       Buffer & buffer_;
 
        /// Estimated average par height for scrollbar.
        int wh_;
@@ -279,22 +277,26 @@ private:
                bool set;
        } xsel_cache_;
        ///
-       LCursor cursor_;
+       Cursor cursor_;
        ///
        bool multiparsel_cache_;
        ///
        pit_type anchor_ref_;
        ///
        int offset_ref_;
+       ///
+       void updateOffsetRef();
+       ///
+       bool need_centering_;
 
        /// keyboard mapping object.
        boost::scoped_ptr<Intl> const intl_;
 
        /// last visited inset (kept to send setMouseHover(false) )
-       InsetBase * last_inset_;
+       Inset * last_inset_;
 
-       /// A map from a LyXText to the associated text metrics
-       typedef std::map<LyXText const *, TextMetrics> TextMetricsCache;
+       /// A map from a Text to the associated text metrics
+       typedef std::map<Text const *, TextMetrics> TextMetricsCache;
        mutable TextMetricsCache text_metrics_;
 };