]> git.lyx.org Git - lyx.git/blobdiff - src/BufferView.h
Improve and unify error messages
[lyx.git] / src / BufferView.h
index 9335a85ab4b22b452847364304d002f62ebd3608..a144aee136971a57368ce78feeeb6ff3998def24 100644 (file)
@@ -15,6 +15,7 @@
 #ifndef BUFFER_VIEW_H
 #define BUFFER_VIEW_H
 
+#include "DocumentClassPtr.h"
 #include "update_flags.h"
 
 #include "support/strfwd.h"
@@ -31,7 +32,9 @@ class Buffer;
 class Change;
 class CoordCache;
 class Cursor;
+class DispatchResult;
 class DocIterator;
+class DocumentClass;
 class FuncRequest;
 class FuncStatus;
 class Intl;
@@ -122,7 +125,7 @@ public:
        /// \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;
+       std::string contextMenu(int x, int y) const;
 
        /// Save the current position as bookmark.
        /// if idx == 0, save to temp_bookmark
@@ -152,14 +155,18 @@ public:
        /// Ensure that the BufferView cursor is visible.
        /// This method will automatically scroll and update the BufferView
        /// if needed.
-       void showCursor(); 
+       void showCursor();
        /// Ensure the passed cursor \p dit is visible.
        /// This method will automatically scroll and update the BufferView
        /// if needed.
        /// \param recenter Whether the cursor should be centered on screen
-       void showCursor(DocIterator const & dit, bool recenter = false);
-       /// LFUN_SCROLL Helper.
-       void lfunScroll(FuncRequest const & cmd);
+       void showCursor(DocIterator const & dit, bool recenter,
+               bool update);
+       /// Scroll to the cursor.
+       void scrollToCursor();
+       /// Scroll to the cursor.
+       /// \param recenter Whether the cursor should be centered on screen
+       bool scrollToCursor(DocIterator const & dit, bool recenter);
        /// scroll down document by the given number of pixels.
        int scrollDown(int pixels);
        /// scroll up document by the given number of pixels.
@@ -167,7 +174,7 @@ public:
        /// scroll document by the given number of pixels.
        int scroll(int pixels);
        /// Scroll the view by a number of pixels.
-       void scrollDocView(int pixels);
+       void scrollDocView(int pixels, bool update);
        /// Set the cursor position based on the scrollbar one.
        void setCursorFromScrollbar();
 
@@ -182,19 +189,20 @@ public:
        size_t const & inlineCompletionUniqueChars() const;
        /// return the position in the buffer of the inline completion postfix.
        DocIterator const & inlineCompletionPos() const;
+       /// make sure inline completion position is OK
+       void resetInlineCompletionPos();
        /// set the inline completion postfix and its position in the buffer.
        /// Updates the updateFlags in \c cur.
-       void setInlineCompletion(Cursor & cur, DocIterator const & pos,
+       void setInlineCompletion(Cursor const & cur, DocIterator const & pos,
                docstring const & completion, size_t uniqueChars = 0);
 
        /// 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);
+       /// \return true if we've made a decision
+       bool getStatus(FuncRequest const & cmd, FuncStatus & flag);
        /// execute the given function.
-       /// \return true if the function has been processed.
-       bool dispatch(FuncRequest const & argument);
+       void dispatch(FuncRequest const & cmd, DispatchResult & dr);
 
        /// request an X11 selection.
        /// \return the selected string.
@@ -238,6 +246,9 @@ public:
        void putSelectionAt(DocIterator const & cur,
                int length, bool backwards);
 
+       /// selects the item at cursor if its paragraph is empty.
+       bool selectIfEmpty(DocIterator & cur);
+
        /// update the internal \c ViewMetricsInfo.
        void updateMetrics();
 
@@ -253,9 +264,13 @@ public:
        CoordCache const & coordCache() const;
 
        ///
-       Point getPos(DocIterator const & dit, bool boundary) const;
+       Point getPos(DocIterator const & dit) const;
        /// is the paragraph of the cursor visible ?
        bool paragraphVisible(DocIterator const & dit) const;
+       /// is the cursor currently visible in the view
+       bool cursorInView(Point const & p, int h) const;
+       /// get the position and height of the cursor
+       void cursorPosAndHeight(Point & p, int & h) const;
 
 
        ///
@@ -294,19 +309,33 @@ public:
        void insertLyXFile(support::FileName const & f);
        /// save temporary bookmark for jump back navigation
        void bookmarkEditPosition();
+       /// Find and return the inset associated with given dialog name.
+       Inset * editedInset(std::string const & name) const;
+       /// Associate an inset associated with given dialog name.
+       void editInset(std::string const & name, Inset * inset);
+       ///
+       void clearLastInset(Inset * inset) const;
+       /// Is the mouse hovering a clickable inset or element?
+       bool clickableInset() const;
+       ///
+       void makeDocumentClass();
 
 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;
+       /// the position relative to (0, baseline) of outermost paragraph
+       Point coordOffset(DocIterator const & dit) 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.
+       /// The minimal size of the document that is visible. Used
+       /// when it is allowed to scroll below the document.
+       int minVisiblePart();
+
+       /// Search recursively for 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.
@@ -314,6 +343,12 @@ private:
                int y  //< y-coordinate on screen
                ) const;
 
+       /// Update the hovering status of the insets. This is called when
+       /// either the screen is updated or when the buffer has scolled.
+       void updateHoveredInset() const;
+
+       ///
+       void updateDocumentClass(DocumentClassConstPtr olddc);
        ///
        int width_;
        ///