X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2FBufferView.h;h=bceaf1f82fd92d4d6bdffc091c312130802d6bd6;hb=e28331ed63062dea10d0a21b9ec12034b4b17b9a;hp=74483502ebf1e044cf9c29bdc65201187312db48;hpb=f49f2f6e22a087a05904fe73b989daf26cc5e41e;p=lyx.git diff --git a/src/BufferView.h b/src/BufferView.h index 74483502eb..bceaf1f82f 100644 --- a/src/BufferView.h +++ b/src/BufferView.h @@ -18,30 +18,36 @@ #include "coordcache.h" #include "cursor.h" #include "metricsinfo.h" +#include "TextMetrics.h" #include "UpdateFlags.h" + #include "support/types.h" +#include #include #include +#include #include namespace lyx { +namespace support { class FileName; } + class Buffer; class Change; class DocIterator; class FuncRequest; class FuncStatus; class Intl; -class Language; class LCursor; class LyXText; class ParIterator; +class ParagraphMetrics; class ViewMetricsInfo; -/// Scrollbar Parameters +/// Scrollbar Parameters. struct ScrollbarParameters { void reset(int h = 0, int p = 0, int l = 0) @@ -51,21 +57,25 @@ struct ScrollbarParameters lineScrollHeight = l; } - /// The total document height in pixels + /// Total document height in pixels. int height; - /// The current position in the document, in pixels + /// Current position in the document in pixels. int position; - /// the line-scroll amount, in pixels + /// Line-scroll amount in pixels. int lineScrollHeight; }; +/// Screen view of a Buffer. /** - * A buffer view encapsulates a view onto a particular + * A BufferView encapsulates a view onto a particular * buffer, and allows access to operate upon it. A view * is a sliding window of the entire document rendering. - * - * Eventually we will allow several views onto a single - * buffer, but not yet. + * It is the official interface between the LyX core and + * the frontend WorkArea. + * + * \sa WorkArea + * \sa Buffer + * \sa CoordCache */ class BufferView : boost::noncopyable { public: @@ -73,111 +83,139 @@ public: ~BufferView(); - /// set the buffer we are viewing + /// set the buffer we are viewing. + /// \todo FIXME: eventually, we will create a new BufferView + /// when switching Buffers, so this method should go. void setBuffer(Buffer * b); - /// return the buffer being viewed + /// return the buffer being viewed. Buffer * buffer() const; - /// resize event has happened + /// resize the BufferView. void resize(); - /// reload the contained buffer - void reload(); - /// load a buffer into the view - bool loadLyXFile(std::string const & name, bool tolastfiles = true); + /// load a buffer into the view. + bool loadLyXFile(support::FileName const & name, bool tolastfiles = true); - /** perform pending painting updates. \c fitcursor means first - * to do a fitcursor, and to force an update if screen - * position changes. \c forceupdate means to force an update - * in any case. - * \return true if a full updateMetrics() is needed. + /// 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); - /// move the screen to fit the cursor. Only to be called with - /// good y coordinates (after a bv::metrics) + /// move the screen to fit the cursor. + /// Only to be called with good y coordinates (after a bv::metrics) bool fitCursor(); - /// reset the scrollbar to reflect current view position + /// reset the scrollbar to reflect current view position. void updateScrollbar(); - /// return the Scrollbar Parameters + /// return the Scrollbar Parameters. ScrollbarParameters const & scrollbarParameters() const; - /// Save the current position as bookmark, if persistent=false, save to temp_bookmark + /// Save the current position as bookmark. + /// if persistent=false, save to temp_bookmark void saveBookmark(bool persistent); - /// goto a specified position - void moveToPosition(int par_id, pos_type par_pos); - /// return the current change at the cursor + /// goto a specified position, try par_id first, and then par_pit + /// return the par_pit and par_id of the new paragraph + boost::tuple moveToPosition( + pit_type par_pit, ///< Paragraph pit, used when par_id is zero or invalid. + int par_id, ///< Paragraph ID, \sa Paragraph + pos_type par_pos ///< Position in the \c Paragraph + ); + /// return the current change at the cursor. Change const getCurrentChange() const; - /// return the lyxtext we are using + /// return the lyxtext we are using. LyXText * getLyXText(); - /// return the lyxtext we are using + /// return the lyxtext we are using. LyXText const * getLyXText() const; - /// move cursor to the named label + /// move cursor to the named label. void gotoLabel(docstring const & label); - /// set the cursor based on the given TeX source row + /// set the cursor based on the given TeX source row. void setCursorFromRow(int row); - /// center the document view around the cursor + /// center the document view around the cursor. void center(); - /// scroll document by the given number of lines of default height + /// scroll document by the given number of lines of default height. void scroll(int lines); - /// Scroll the view by a number of pixels + /// Scroll the view by a number of pixels. void scrollDocView(int pixels); /// Set the cursor position based on the scrollbar one. void setCursorFromScrollbar(); - /// return the pixel width of the document view + /// return the pixel width of the document view. int workWidth() const; - /// return the pixel height of the document view + /// return the pixel height of the document view. int workHeight() const; - /// switch between primary and secondary keymaps for RTL entry + /// switch between primary and secondary keymaps for RTL entry. void switchKeyMap(); - /// return true for events that will handle + /// return true for events that will handle. FuncStatus getStatus(FuncRequest const & cmd); - /// execute the given function + /// execute the given function. bool dispatch(FuncRequest const & argument); - /// + /// request an X11 selection. + /// \return the selected string. docstring const requestSelection(); - /// + /// clear the X11 selection. void clearSelection(); - /// + /// resize method helper for \c WorkArea + /// \sa WorkArea + /// \sa resise void workAreaResize(int width, int height); - /// a function should be executed from the workarea + /// dispatch method helper for \c WorkArea + /// \sa WorkArea + /// \retval true if a redraw is needed bool workAreaDispatch(FuncRequest const & ev); - /// access to anchor + /// access to anchor. pit_type anchor_ref() const; - /// access to full cursor + /// access to full cursor. LCursor & cursor(); - /// access to full cursor + /// access to full cursor. LCursor const & cursor() const; - /// sets cursor and open all relevant collapsable insets. + /// sets cursor. + /// This will also open all relevant collapsable insets. void setCursor(DocIterator const &); - /// sets cursor; this is used when handling LFUN_MOUSE_PRESS. - void mouseSetCursor(LCursor & cur); - - /* Sets the selection. When \c backwards == false, set anchor + /// Check deleteEmptyParagraphMechanism and update metrics if needed. + /// \retval true if an update was needed. + bool checkDepm(LCursor & cur, LCursor & old); + /// sets cursor. + /// This is used when handling LFUN_MOUSE_PRESS. + bool mouseSetCursor(LCursor & cur); + + /// sets the selection. + /* When \c backwards == false, set anchor * to \c cur and cursor to \c cur + \c length. When \c * backwards == true, set anchor to \c cur and cursor to \c * cur + \c length. */ 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); + /// + TextMetrics const & textMetrics(LyXText const * t) const; + TextMetrics & textMetrics(LyXText const * t); + /// + ParagraphMetrics const & parMetrics(LyXText const *, pit_type) const; + /// CoordCache & coordCache() { return coord_cache_; @@ -186,7 +224,7 @@ public: CoordCache const & coordCache() const { return coord_cache_; } - /// get this view's keyboard map handler + /// get this view's keyboard map handler. Intl & getIntl() { return *intl_.get(); } /// Intl const & getIntl() const { return *intl_.get(); } @@ -198,7 +236,7 @@ public: boost::signal showDialog; /// This signal is emitted when some dialog needs to be shown with - /// some data + /// some data. boost::signal showDialogWithData; @@ -225,17 +263,17 @@ private: /// ViewMetricsInfo metrics_info_; + /// CoordCache coord_cache_; /// Buffer * buffer_; - /// Estimated average par height for scrollbar + /// 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 + /// this is used to handle XSelection events in the right manner. struct { CursorSlice cursor; CursorSlice anchor; @@ -250,8 +288,15 @@ private: /// int offset_ref_; - /// keyboard mapping object + /// keyboard mapping object. boost::scoped_ptr const intl_; + + /// last visited inset (kept to send setMouseHover(false) ) + InsetBase * last_inset_; + + /// A map from a LyXText to the associated text metrics + typedef std::map TextMetricsCache; + mutable TextMetricsCache text_metrics_; };