]> git.lyx.org Git - lyx.git/blobdiff - src/BufferView.h
initial basic context menu support.
[lyx.git] / src / BufferView.h
index 3f68b00cfd6b8eaccc2babd4b6189b477f178bdd..f1897cb96449ddb3c9cdeaba07afe070a80b0c92 100644 (file)
 #ifndef BUFFER_VIEW_H
 #define BUFFER_VIEW_H
 
-#include "CoordCache.h"
-#include "Cursor.h"
-#include "MetricsInfo.h"
-#include "TextMetrics.h"
 #include "update_flags.h"
 
+#include "support/strfwd.h"
 #include "support/types.h"
 
-#include <boost/tuple/tuple.hpp>
-#include <boost/utility.hpp>
-#include <boost/signal.hpp>
-
-#include <utility>
-#include <string>
-
-
 namespace lyx {
 
 namespace support { class FileName; }
 
 namespace frontend { class Painter; }
+namespace frontend { class GuiBufferViewDelegate; }
 
 class Buffer;
 class Change;
+class CoordCache;
+class Cursor;
 class DocIterator;
 class FuncRequest;
 class FuncStatus;
 class Intl;
-class Cursor;
-class Text;
+class Inset;
+class Menu;
 class ParIterator;
 class ParagraphMetrics;
-class ViewMetricsInfo;
+class Point;
+class Text;
+class TextMetrics;
+
+enum CursorStatus {
+       CUR_INSIDE,
+       CUR_ABOVE,
+       CUR_BELOW
+};
 
 /// Scrollbar Parameters.
 struct ScrollbarParameters
@@ -79,11 +79,11 @@ struct ScrollbarParameters
  * \sa Buffer
  * \sa CoordCache
  */
-class BufferView : boost::noncopyable {
+class BufferView {
 public:
        ///
        BufferView(Buffer & buffer);
-
+       ///
        ~BufferView();
 
        /// return the buffer being viewed.
@@ -96,7 +96,7 @@ public:
         * \c Update::Force means to force an update in any case.
         * \retval true if a screen redraw is needed
         */
-       bool update(Update::flags flags = Update::FitCursor | Update::Force);
+       void processUpdateFlags(Update::flags flags);
 
        /// move the screen to fit the cursor.
        /// Only to be called with good y coordinates (after a bv::metrics)
@@ -105,6 +105,10 @@ public:
        void updateScrollbar();
        /// return the Scrollbar Parameters.
        ScrollbarParameters const & scrollbarParameters() const;
+       /// \return Tool tip for the given position.
+       docstring toolTip(int x, int y) const;
+       /// \return the context menu for the given position.
+       docstring contextMenu(int x, int y) const;
 
        /// Save the current position as bookmark.
        /// if idx == 0, save to temp_bookmark
@@ -126,10 +130,16 @@ public:
        /// set the cursor based on the given TeX source row.
        void setCursorFromRow(int row);
 
-       /// center the document view around the cursor.
-       void center();
-       /// scroll document by the given number of lines of default height.
-       void scroll(int lines);
+       /// Ensure the cursor is visible.
+       /// This method will automatically scroll and update the BufferView and updated 
+       /// if needed.
+       void showCursor();
+       /// 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.
@@ -140,14 +150,15 @@ public:
        /// return the pixel height of the document view.
        int workHeight() const;
 
+
        /// 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.
-       /// \return the Update::flags for further metrics update.
-       Update::flags dispatch(FuncRequest const & argument);
+       /// \return true if the function has been processed.
+       bool dispatch(FuncRequest const & argument);
 
        /// request an X11 selection.
        /// \return the selected string.
@@ -161,12 +172,13 @@ public:
 
        /// 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.
@@ -179,7 +191,7 @@ public:
        bool checkDepm(Cursor & cur, Cursor & old);
        /// sets cursor.
        /// This is used when handling LFUN_MOUSE_PRESS.
-       bool mouseSetCursor(Cursor & cur);
+       bool mouseSetCursor(Cursor & cur, bool select = false);
 
        /// sets the selection.
        /* When \c backwards == false, set anchor
@@ -190,14 +202,8 @@ public:
        void putSelectionAt(DocIterator const & cur,
                int length, bool backwards);
 
-       /// return the internal \c ViewMetricsInfo.
-       /// This is used specifically by the \c Workrea.
-       /// \sa WorkArea
-       /// \sa ViewMetricsInfo
-       ViewMetricsInfo const & viewMetricsInfo();
        /// update the internal \c ViewMetricsInfo.
-       /// \param singlepar indicates wether
-       void updateMetrics(bool singlepar = false);
+       void updateMetrics();
 
        ///
        TextMetrics const & textMetrics(Text const * t) const;
@@ -206,47 +212,59 @@ public:
        ParagraphMetrics const & parMetrics(Text const *, pit_type) const;
 
        ///
-       CoordCache & coordCache() {
-               return coord_cache_;
-       }
+       CoordCache & coordCache();
        ///
-       CoordCache const & coordCache() const {
-               return coord_cache_;
-       }
+       CoordCache const & coordCache() const;
+
+       ///
+       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 & getIntl();
        ///
-       Intl const & getIntl() const { return *intl_.get(); }
+       Intl const & getIntl() const;
 
+       //
+       // 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;
-
-       /// 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 showDialog(std::string const & name, std::string const & data,
+               Inset * inset = 0);
 
        /// 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(docstring layout)> layoutChanged;
+       ///
+       void setGuiDelegate(frontend::GuiBufferViewDelegate *);
 
-private:
        ///
-       bool multiParSel();
+       docstring contentsOfPlaintextFile(support::FileName const & f);
+       // Insert plain text file (if filename is empty, prompt for one)
+       void insertPlaintextFile(support::FileName const & f, bool asParagraph);
+       ///
+       void insertLyXFile(support::FileName const & f);
+
+private:
+       /// noncopyable
+       BufferView(BufferView const &);
+       void operator=(BufferView const &);
+
+       // 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();
 
        /// Search recursively for the the innermost inset that covers (x, y) position.
        /// \retval 0 if no inset is found.
@@ -254,57 +272,27 @@ private:
                Text const & text, //< The Text where we start searching.
                int x, //< x-coordinate on screen
                int y  //< y-coordinate on screen
-               );
+               ) const;
 
        ///
        int width_;
        ///
        int height_;
        ///
-       ScrollbarParameters scrollbarParameters_;
-
-       ///
-       ViewMetricsInfo metrics_info_;
-       ///
-       CoordCache coord_cache_;
-       ///
        Buffer & buffer_;
 
-       /// Estimated average par height for scrollbar.
-       int wh_;
-       ///
-       void menuInsertLyXFile(std::string const & filen);
-
-       /// this is used to handle XSelection events in the right manner.
-       struct {
-               CursorSlice cursor;
-               CursorSlice anchor;
-               bool set;
-       } xsel_cache_;
-       ///
-       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_;
+       struct Private;
+       Private * const d;
+};
 
-       /// last visited inset (kept to send setMouseHover(false) )
-       Inset * last_inset_;
+/// some space for drawing the 'nested' markers (in pixel)
+inline int nestMargin() { return 15; }
 
-       /// A map from a Text to the associated text metrics
-       typedef std::map<Text const *, TextMetrics> TextMetricsCache;
-       mutable TextMetricsCache text_metrics_;
-};
+/// margin for changebar
+inline int changebarMargin() { return 12; }
 
+/// right margin
+inline int rightMargin() { return 10; }
 
 } // namespace lyx