X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2FBufferView.h;h=6cdc68534b3b3d2eed93d7547b1dd8ccf256a421;hb=5be391b274f2cbf4a1da03bc5ee2136cb6c4e660;hp=ad725f2121861a598cc5c724758c4bc214035302;hpb=b3b22b0c70717d0f44dcb91f559ddc0c3239d30c;p=lyx.git diff --git a/src/BufferView.h b/src/BufferView.h index ad725f2121..6cdc68534b 100644 --- a/src/BufferView.h +++ b/src/BufferView.h @@ -57,6 +57,16 @@ enum CursorStatus { CUR_BELOW }; +/// How to show cursor +enum ScrollType { + // Make sure row if visible (do nothing if it is visible already) + SCROLL_VISIBLE, + // Force cursor to be on top of screen + SCROLL_TOP, + // Force cursor to be at center of screen + SCROLL_CENTER +}; + /// Scrollbar Parameters. struct ScrollbarParameters { @@ -201,17 +211,17 @@ public: /// This method will automatically scroll and update the BufferView /// (metrics+drawing) if needed. void showCursor(); + /// Ensure the passed cursor \p dit is visible. /// This method will automatically scroll and update the BufferView /// (metrics+drawing) if needed. - /// \param recenter Whether the cursor should be centered on screen - /// \param force If true, disregard current position - void showCursor(DocIterator const & dit, bool recenter, bool force, - bool update); + /// \param how Use this scroll strategy + /// \param force If true, update screen after scrolling + void showCursor(DocIterator const & dit, ScrollType how, bool update); /// Scroll to the cursor. - /// \param recenter Whether the cursor should be centered on screen - /// \param force If true, disregard current position - bool scrollToCursor(DocIterator const & dit, bool recenter, bool force); + /// \param how Use this scroll strategy + /// \return true if screen was scrolled + bool scrollToCursor(DocIterator const & dit, ScrollType how); /// scroll down document by the given number of pixels. int scrollDown(int pixels); /// scroll up document by the given number of pixels.