]> git.lyx.org Git - lyx.git/blobdiff - src/BufferView.h
some refactoring
[lyx.git] / src / BufferView.h
index a27d010f78c2f8f5f536117cabed059a312589b0..192742b8c42ebfd7ae74301fe1a3d7cb37431d9f 100644 (file)
@@ -23,9 +23,7 @@
 
 #include "support/types.h"
 
-#include <boost/tuple/tuple.hpp>
-#include <boost/utility.hpp>
-#include <boost/signal.hpp>
+#include <boost/noncopyable.hpp>
 
 #include <utility>
 #include <string>
@@ -35,6 +33,9 @@ namespace lyx {
 
 namespace support { class FileName; }
 
+namespace frontend { class Painter; }
+namespace frontend { class GuiBufferViewDelegate; }
+
 class Buffer;
 class Change;
 class DocIterator;
@@ -46,6 +47,12 @@ class Text;
 class ParIterator;
 class ParagraphMetrics;
 class ViewMetricsInfo;
+enum CursorStatus {
+       CUR_INSIDE,
+       CUR_ABOVE,
+       CUR_BELOW
+};
 
 /// Scrollbar Parameters.
 struct ScrollbarParameters
@@ -79,19 +86,14 @@ struct ScrollbarParameters
  */
 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();
+       Buffer & buffer();
+       Buffer const & buffer() const;
 
        /// perform pending metrics updates.
        /** \c Update::FitCursor means first to do a FitCursor, and to
@@ -112,9 +114,9 @@ public:
        /// Save the current position as bookmark.
        /// 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 the bottom_pit and top_id of the new paragraph
-       boost::tuple<pit_type, pos_type, int> moveToPosition(
+       /// 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
@@ -131,8 +133,12 @@ public:
 
        /// center the document view around the cursor.
        void center();
-       /// scroll document by the given number of lines of default height.
-       void scroll(int lines);
+       /// scroll down document by the given number of pixels.
+       void scrollDown(int pixels);
+       /// scroll up document by the given number of pixels.
+       void scrollUp(int pixels);
+       /// scroll document by the given number of pixels.
+       void scroll(int pixels);
        /// Scroll the view by a number of pixels.
        void scrollDocView(int pixels);
        /// Set the cursor position based on the scrollbar one.
@@ -158,19 +164,19 @@ public:
        /// clear the X11 selection.
        void clearSelection();
 
-       /// resize method helper for \c WorkArea
+       /// resize the BufferView.
        /// \sa WorkArea
-       /// \sa resise
-       void workAreaResize(int width, int height);
+       void resize(int width, int height);
 
        /// dispatch method helper for \c WorkArea
        /// \sa WorkArea
-       /// \retval true if a redraw is needed
-       bool workAreaDispatch(FuncRequest const & ev);
+       void mouseEventDispatch(FuncRequest const & ev);
 
        /// access to anchor.
        pit_type anchor_ref() const;
 
+       ///
+       CursorStatus cursorStatus(DocIterator const & dit) const;
        /// access to full cursor.
        Cursor & cursor();
        /// access to full cursor.
@@ -210,41 +216,55 @@ public:
        ParagraphMetrics const & parMetrics(Text const *, pit_type) const;
 
        ///
-       CoordCache & coordCache() {
-               return coord_cache_;
-       }
+       CoordCache & coordCache() { return coord_cache_; }
        ///
-       CoordCache const & coordCache() const {
-               return coord_cache_;
-       }
+       CoordCache const & coordCache() const { return coord_cache_; }
+
+       ///
+       Point getPos(DocIterator const & dit, bool boundary) const;
+
+
+       ///
+       void draw(frontend::Painter & pain);
+
        /// get this view's keyboard map handler.
        Intl & getIntl() { return *intl_.get(); }
        ///
        Intl const & getIntl() const { return *intl_.get(); }
 
+       //
+       // Messages to the GUI
+       //
        /// This signal is emitted when some message shows up.
-       boost::signal<void(docstring)> message;
+       void message(docstring const & msg);
 
        /// This signal is emitted when some dialog needs to be shown.
-       boost::signal<void(std::string name)> showDialog;
+       void showDialog(std::string const & name);
 
        /// This signal is emitted when some dialog needs to be shown with
        /// some data.
-       boost::signal<void(std::string name,
-               std::string data)> showDialogWithData;
+       void showDialogWithData(std::string const & name, std::string const & data);
 
        /// This signal is emitted when some inset dialogs needs to be shown.
-       boost::signal<void(std::string name, std::string data,
-               Inset * inset)> showInsetDialog;
+       void showInsetDialog(std::string const & name, std::string const & data,
+               Inset * inset);
 
        /// This signal is emitted when some dialogs needs to be updated.
-       boost::signal<void(std::string name,
-               std::string data)> updateDialog;
+       void updateDialog(std::string const & name, std::string const & data);
 
-       /// This signal is emitted when the layout at the cursor is changed.
-       boost::signal<void(std::string layout)> layoutChanged;
+       ///
+       void setGuiDelegate(frontend::GuiBufferViewDelegate *);
 
+       ///
+       docstring contentsOfPlaintextFile(std::string const & f, bool asParagraph);
+       // Insert plain text file (if filename is empty, prompt for one)
+       void insertPlaintextFile(std::string const & fileName, bool asParagraph);
 private:
+       // the position relative to (0, baseline) of outermost paragraph
+       Point coordOffset(DocIterator const & dit, bool boundary) const;
+       /// Update current paragraph metrics.
+       /// \return true if no further update is needed.
+       bool singleParUpdate();
        ///
        bool multiParSel();
 
@@ -268,7 +288,7 @@ private:
        ///
        CoordCache coord_cache_;
        ///
-       Buffer * buffer_;
+       Buffer & buffer_;
 
        /// Estimated average par height for scrollbar.
        int wh_;
@@ -289,6 +309,10 @@ private:
        pit_type anchor_ref_;
        ///
        int offset_ref_;
+       ///
+       void updateOffsetRef();
+       ///
+       bool need_centering_;
 
        /// keyboard mapping object.
        boost::scoped_ptr<Intl> const intl_;
@@ -299,8 +323,19 @@ private:
        /// A map from a Text to the associated text metrics
        typedef std::map<Text const *, TextMetrics> TextMetricsCache;
        mutable TextMetricsCache text_metrics_;
+
+       // Whom to notify. Not owned, so don't delete.
+       frontend::GuiBufferViewDelegate * gui_;
 };
 
+/// some space for drawing the 'nested' markers (in pixel)
+inline int nestMargin() { return 15; }
+
+/// margin for changebar
+inline int changebarMargin() { return 12; }
+
+/// right margin
+inline int rightMargin() { return 10; }
 
 } // namespace lyx