* lfuns doxification for math macros

[lyx.git] / src / BufferView.h

diff --git a/src/BufferView.h b/src/BufferView.h
index df58d927e4d06c8d31355021cc527e8ce72dadc1..765267b421b0aaa68a9ea3b33ad8f8a926d85a15 100644 (file)
--- a/src/BufferView.h
+++ b/src/BufferView.h
@@ -15,18 +15,11 @@
 #ifndef BUFFER_VIEW_H
 #define BUFFER_VIEW_H
 
-#include "Dimension.h"
 #include "update_flags.h"
 
-#include "support/docstring.h"
+#include "support/strfwd.h"
 #include "support/types.h"
 
-#include <boost/noncopyable.hpp>
-
-#include <utility>
-#include <string>
-
-
 namespace lyx {
 
 namespace support { class FileName; }
@@ -43,11 +36,12 @@ class FuncRequest;
 class FuncStatus;
 class Intl;
 class Inset;
+class Menu;
 class ParIterator;
 class ParagraphMetrics;
+class Point;
 class Text;
 class TextMetrics;
-class ViewMetricsInfo;
 
 enum CursorStatus {
        CUR_INSIDE,
@@ -85,7 +79,7 @@ struct ScrollbarParameters
  * \sa Buffer
  * \sa CoordCache
  */
-class BufferView : boost::noncopyable {
+class BufferView {
 public:
        ///
        BufferView(Buffer & buffer);
@@ -111,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
@@ -132,8 +130,12 @@ public:
        /// set the cursor based on the given TeX source row.
        void setCursorFromRow(int row);
 
-       /// center the document view around the cursor.
-       void center();
+       /// Ensure the cursor is visible.
+       /// This method will automatically scroll and update the BufferView and updated 
+       /// if needed.
+       void showCursor();
+       /// LFUN_SCROLL Helper.
+       void lfunScroll(FuncRequest const & cmd);
        /// scroll down document by the given number of pixels.
        void scrollDown(int pixels);
        /// scroll up document by the given number of pixels.
@@ -150,14 +152,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.
@@ -201,14 +204,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;
@@ -244,11 +241,8 @@ public:
 
        /// This signal is emitted when some dialog needs to be shown with
        /// some data.
-       void showDialogWithData(std::string const & name, std::string const & data);
-
-       /// This signal is emitted when some inset dialogs needs to be shown.
-       void showInsetDialog(std::string const & name, std::string const & data,
-               Inset * inset);
+       void showDialog(std::string const & name, std::string const & data,
+               Inset * inset = 0);
 
        /// This signal is emitted when some dialogs needs to be updated.
        void updateDialog(std::string const & name, std::string const & data);
@@ -257,18 +251,22 @@ public:
        void setGuiDelegate(frontend::GuiBufferViewDelegate *);
 
        ///
-       docstring contentsOfPlaintextFile(std::string const & f, bool asParagraph);
+       docstring contentsOfPlaintextFile(support::FileName const & f);
        // Insert plain text file (if filename is empty, prompt for one)
-       void insertPlaintextFile(std::string const & fileName, bool asParagraph);
+       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();
-       ///
-       bool multiParSel();
 
        /// Search recursively for the the innermost inset that covers (x, y) position.
        /// \retval 0 if no inset is found.
@@ -276,7 +274,7 @@ 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_;
@@ -285,13 +283,8 @@ private:
        ///
        Buffer & buffer_;
 
-       ///
-       void menuInsertLyXFile(std::string const & filen);
-
-       void updateOffsetRef();
-
-       struct BufferViewPrivate;
-       BufferViewPrivate & d;
+       struct Private;
+       Private * const d;
 };
 
 /// some space for drawing the 'nested' markers (in pixel)