X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2FBufferView.h;h=92e898735065ac2f8146fbb7b14fd8a3f43fac80;hb=28be7d552f62cc02fa86d7f79201d089bfb2d7b5;hp=2d40bc19666967470b739e358961983fe9bf4aa5;hpb=095cf2339405a9d8c1789168a545d7f75e2cac0e;p=lyx.git diff --git a/src/BufferView.h b/src/BufferView.h index 2d40bc1966..92e8987350 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. */ @@ -15,20 +15,13 @@ #ifndef BUFFER_VIEW_H #define BUFFER_VIEW_H -#include "CoordCache.h" -#include "Cursor.h" -#include "MetricsInfo.h" -#include "TextMetrics.h" +#include "DocumentClassPtr.h" +#include "TexRow.h" #include "update_flags.h" +#include "support/strfwd.h" #include "support/types.h" -#include - -#include -#include - - namespace lyx { namespace support { class FileName; } @@ -38,16 +31,25 @@ namespace frontend { class GuiBufferViewDelegate; } class Buffer; class Change; +class CoordCache; +class Cursor; +class CursorSlice; +class DispatchResult; class DocIterator; +class DocumentClass; class FuncRequest; class FuncStatus; class Intl; -class Cursor; -class Text; +class Inset; +class Length; +class PainterInfo; class ParIterator; class ParagraphMetrics; -class ViewMetricsInfo; - +class Point; +class TexRow; +class Text; +class TextMetrics; + enum CursorStatus { CUR_INSIDE, CUR_ABOVE, @@ -57,19 +59,19 @@ enum CursorStatus { /// Scrollbar Parameters. struct ScrollbarParameters { - void reset(int h = 0, int p = 0, int l = 0) - { - height = h; - position = p; - lineScrollHeight = l; - } - - /// Total document height in pixels. - int height; - /// Current position in the document in pixels. - int position; + // These parameters are normalized against the screen geometry and pixel + // coordinates. Position 0 corresponds to the top the the screen. + ScrollbarParameters() + : min(0), max(0), single_step(1), page_step(1) + {} + /// Minimum scrollbar position in pixels. + int min; + /// Maximum scrollbar position in pixels. + int max; /// Line-scroll amount in pixels. - int lineScrollHeight; + int single_step; + /// Page-scroll amount in pixels. + int page_step; }; /// Screen view of a Buffer. @@ -84,10 +86,10 @@ struct ScrollbarParameters * \sa Buffer * \sa CoordCache */ -class BufferView : boost::noncopyable { +class BufferView { public: /// - BufferView(Buffer & buffer); + explicit BufferView(Buffer & buffer); /// ~BufferView(); @@ -95,21 +97,62 @@ 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 the on-screen size of this length + /* + * This is a wrapper around Length::inPixels that uses the + * bufferview width as width and the EM value of the default + * document font. + */ + int inPixels(Length const & len) 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. * \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. + /// return true if one shall move the screen to fit the cursor. /// Only to be called with good y coordinates (after a bv::metrics) - bool fitCursor(); + bool needsFitCursor() const; + + // Returns the amount of horizontal scrolling applied to the + // top-level row where the cursor lies + int horizScrollOffset() const; + // Returns the amount of horizontal scrolling applied to the + // row of text starting at (pit, pos) + int horizScrollOffset(Text const * text, + pit_type pit, pos_type pos) const; + + // Returns true if the row of text starting at (pit, pos) was scrolled + // at the last draw event. + bool hadHorizScrollOffset(Text const * text, + pit_type pit, pos_type pos) const; + /// reset the scrollbar to reflect current view position. 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. + std::string contextMenu(int x, int y) const; /// Save the current position as bookmark. /// if idx == 0, save to temp_bookmark @@ -129,18 +172,38 @@ public: void gotoLabel(docstring const & label); /// set the cursor based on the given TeX source row. - void setCursorFromRow(int row); - - /// center the document view around the cursor. - void center(); + bool setCursorFromRow(int row); + /// set the cursor based on the given start and end TextEntries. + bool setCursorFromEntries(TexRow::TextEntry start, TexRow::TextEntry end); + + /// 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 + /// (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 + 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,14 +212,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 the Update::flags for further metrics update. - Update::flags dispatch(FuncRequest const & argument); + void dispatch(FuncRequest const & cmd, DispatchResult & dr); /// request an X11 selection. /// \return the selected string. @@ -170,8 +245,7 @@ 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; @@ -185,12 +259,14 @@ public: /// sets cursor. /// This will also open all relevant collapsable insets. void setCursor(DocIterator const &); + /// set the selection up to dit. + void setCursorSelectionTo(DocIterator const & dit); /// Check deleteEmptyParagraphMechanism and update metrics if needed. /// \retval true if an update was needed. 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 @@ -201,14 +277,11 @@ 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(); + /// selects the item at cursor if its paragraph is empty. + bool selectIfEmpty(DocIterator & cur); + /// update the internal \c ViewMetricsInfo. - /// \param singlepar indicates wether - void updateMetrics(bool singlepar = false); + void updateMetrics(); /// TextMetrics const & textMetrics(Text const * t) const; @@ -217,21 +290,27 @@ 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; + 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; /// 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 @@ -244,11 +323,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); @@ -256,75 +332,72 @@ public: /// void setGuiDelegate(frontend::GuiBufferViewDelegate *); + /// + 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); + /// 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: - // the position relative to (0, baseline) of outermost paragraph - Point coordOffset(DocIterator const & dit, bool boundary) const; + /// noncopyable + BufferView(BufferView const &); + void operator=(BufferView 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(); - /// - bool multiParSel(); - /// Search recursively for the the innermost inset that covers (x, y) position. + // Set the row on which the cursor lives. + void setCurrentRowSlice(CursorSlice const & rowSlice); + + // Check whether the row where the cursor lives needs to be scrolled. + // Update the drawing strategy if needed. + void checkCursorScrollOffset(PainterInfo & pi); + + /// 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. int x, //< x-coordinate on screen 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_; /// int height_; /// - ScrollbarParameters scrollbarParameters_; - - /// - ViewMetricsInfo metrics_info_; - /// - CoordCache coord_cache_; + bool full_screen_; /// 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 const intl_; - - /// last visited inset (kept to send setMouseHover(false) ) - Inset * last_inset_; - - /// A map from a Text to the associated text metrics - typedef std::map TextMetricsCache; - mutable TextMetricsCache text_metrics_; - - // Whom to notify. Not owned, so don't delete. - frontend::GuiBufferViewDelegate * gui_; + struct Private; + Private * const d; }; /// some space for drawing the 'nested' markers (in pixel) @@ -333,9 +406,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