X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2FBufferView.h;h=f6d5b1894baeca201817065cc28514681e76b281;hb=55a3dd7b346d29a52ba305a4558e9e380ef50f47;hp=faac2f6c62b423cb1804709f71578266a8a5fea0;hpb=ae0667c112b1ca209821ae480eee439555eac994;p=lyx.git diff --git a/src/BufferView.h b/src/BufferView.h index faac2f6c62..f6d5b1894b 100644 --- a/src/BufferView.h +++ b/src/BufferView.h @@ -5,9 +5,9 @@ * Licence details can be found in the file COPYING. * * \author Alfredo Braustein - * \author Lars Gullik Bjønnes + * \author Lars Gullik Bjønnes * \author John Levon - * \author Jürgen Vigna + * \author Jürgen Vigna * * Full author contact details are available in file CREDITS. */ @@ -31,12 +31,13 @@ class Buffer; class Change; class CoordCache; class Cursor; +class DispatchResult; class DocIterator; +class DocumentClass; class FuncRequest; class FuncStatus; class Intl; class Inset; -class Menu; class ParIterator; class ParagraphMetrics; class Point; @@ -52,6 +53,9 @@ enum CursorStatus { /// Scrollbar Parameters. struct ScrollbarParameters { + ScrollbarParameters() + : min(0), max(0), position(0), single_step(1), page_step(1) + {} /// Minimum scrollbar position in pixels. int min; /// Maximum scrollbar position in pixels. @@ -79,7 +83,7 @@ struct ScrollbarParameters class BufferView { public: /// - BufferView(Buffer & buffer); + explicit BufferView(Buffer & buffer); /// ~BufferView(); @@ -87,6 +91,21 @@ public: Buffer & buffer(); Buffer const & buffer() const; + /// + void setFullScreen(bool full_screen) { full_screen_ = full_screen; } + + /// right margin + int rightMargin() const; + + /// left margin + int leftMargin() const; + + /// \return true if the BufferView is at the top of the document. + bool isTopScreen() const; + + /// \return true if the BufferView is at the bottom of the document. + bool isBottomScreen() const; + /// perform pending metrics updates. /** \c Update::FitCursor means first to do a FitCursor, and to * force an update if screen position changes. @@ -105,7 +124,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 @@ -127,20 +146,34 @@ public: /// set the cursor based on the given TeX source row. void setCursorFromRow(int row); - /// Ensure the cursor is visible. - /// This method will automatically scroll and update the BufferView and updated + /// set cursor to the given inset. Return true if found. + bool setCursorFromInset(Inset const *); + /// Recenters the BufferView such that the passed cursor + /// is in the center. + void recenter(); + /// Ensure that the BufferView cursor is visible. + /// This method will automatically scroll and update the BufferView + /// if needed. + void showCursor(); + /// Ensure the passed cursor \p dit is visible. + /// This method will automatically scroll and update the BufferView /// if needed. - void showCursor(); - /// LFUN_SCROLL Helper. - void lfunScroll(FuncRequest const & cmd); + /// \param recenter Whether the cursor should be centered on screen + 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. - void scrollDown(int pixels); + int scrollDown(int pixels); /// scroll up document by the given number of pixels. - void scrollUp(int pixels); + int scrollUp(int pixels); /// scroll document by the given number of pixels. - void scroll(int 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(); @@ -149,15 +182,26 @@ public: /// return the pixel height of the document view. int workHeight() const; + /// return the inline completion postfix. + docstring const & inlineCompletion() const; + /// return the number of unique characters in the inline completion. + 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 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. @@ -201,6 +245,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(); @@ -216,7 +263,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; /// @@ -253,18 +306,32 @@ public: void insertPlaintextFile(support::FileName const & f, bool asParagraph); /// 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; 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(); + /// 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 the innermost inset that covers (x, y) position. /// \retval 0 if no inset is found. Inset const * getCoveringInset( @@ -273,11 +340,19 @@ 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(DocumentClass const * const olddc); /// int width_; /// int height_; /// + bool full_screen_; + /// Buffer & buffer_; struct Private; @@ -290,9 +365,6 @@ inline int nestMargin() { return 15; } /// margin for changebar inline int changebarMargin() { return 12; } -/// right margin -inline int rightMargin() { return 10; } - } // namespace lyx #endif // BUFFERVIEW_H