X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2FBufferView.h;h=92e898735065ac2f8146fbb7b14fd8a3f43fac80;hb=28be7d552f62cc02fa86d7f79201d089bfb2d7b5;hp=181b71c14c0d03782d43b5270fb64473a5d81527;hpb=6fc7d47a5f88276f0aff75e90cd5230613b872e9;p=lyx.git diff --git a/src/BufferView.h b/src/BufferView.h index 181b71c14c..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,54 +15,63 @@ #ifndef BUFFER_VIEW_H #define BUFFER_VIEW_H -#include "coordcache.h" -#include "cursor.h" -#include "metricsinfo.h" -#include "TextMetrics.h" -#include "UpdateFlags.h" +#include "DocumentClassPtr.h" +#include "TexRow.h" +#include "update_flags.h" +#include "support/strfwd.h" #include "support/types.h" -#include -#include -#include - -#include -#include - - namespace lyx { namespace support { class FileName; } +namespace frontend { class Painter; } +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 LCursor; -class LyXText; +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, + CUR_BELOW +}; /// 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. @@ -72,29 +81,44 @@ struct ScrollbarParameters * is a sliding window of the entire document rendering. * It is the official interface between the LyX core and * the frontend WorkArea. - * + * * \sa WorkArea * \sa Buffer * \sa CoordCache */ -class BufferView : boost::noncopyable { +class BufferView { public: - BufferView(); - + /// + explicit BufferView(Buffer & buffer); + /// ~BufferView(); - /// 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. - Buffer * buffer() const; + Buffer & buffer(); + Buffer const & buffer() const; - /// resize the BufferView. - void resize(); + /// + 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; - /// load a buffer into the view. - bool loadLyXFile(support::FileName const & name, bool tolastfiles = true); + /// \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 @@ -102,25 +126,44 @@ public: * \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 void saveBookmark(unsigned int idx); - /// 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 + /// goto a specified position, try top_id first, and then bottom_pit. + /// \return true if success + bool moveToPosition( + pit_type bottom_pit, ///< Paragraph pit, used when par_id is zero or invalid. + pos_type bottom_pos, ///< Paragraph pit, used when par_id is zero or invalid. + int top_id, ///< Paragraph ID, \sa Paragraph + pos_type top_pos ///< Position in the \c Paragraph ); /// return the current change at the cursor. Change const getCurrentChange() const; @@ -129,14 +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(); - /// scroll document by the given number of lines of default height. - void scroll(int lines); + 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. + int scrollDown(int pixels); + /// scroll up document by the given number of pixels. + int scrollUp(int pixels); + /// 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(); @@ -145,14 +212,26 @@ public: /// return the pixel height of the document view. int workHeight() const; - /// switch between primary and secondary keymaps for RTL entry. - void switchKeyMap(); - - /// return true for events that will handle. - FuncStatus getStatus(FuncRequest const & cmd); + /// 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 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. @@ -160,32 +239,34 @@ public: /// clear the X11 selection. void clearSelection(); - /// resize method helper for \c WorkArea + /// resize the BufferView. /// \sa WorkArea - /// \sa resise - void workAreaResize(int width, int height); + void resize(int width, int height); /// 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; + /// + CursorStatus cursorStatus(DocIterator const & dit) const; /// access to full cursor. - LCursor & cursor(); + Cursor & cursor(); /// access to full cursor. - LCursor const & cursor() const; + Cursor const & cursor() const; /// 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(LCursor & cur, LCursor & old); + bool checkDepm(Cursor & cur, Cursor & old); /// sets cursor. /// This is used when handling LFUN_MOUSE_PRESS. - bool mouseSetCursor(LCursor & cur); + bool mouseSetCursor(Cursor & cur, bool select = false); /// sets the selection. /* When \c backwards == false, set anchor @@ -196,113 +277,134 @@ 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(LyXText const * t) const; - TextMetrics & textMetrics(LyXText const * t); + TextMetrics const & textMetrics(Text const * t) const; + TextMetrics & textMetrics(Text const * t); /// - ParagraphMetrics const & parMetrics(LyXText const *, pit_type) const; + ParagraphMetrics const & parMetrics(Text const *, pit_type) const; /// - CoordCache & coordCache() { - return coord_cache_; - } + CoordCache & coordCache(); + /// + CoordCache const & coordCache() 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; + + /// - CoordCache const & coordCache() const { - return coord_cache_; - } + 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 + // /// This signal is emitted when some message shows up. - boost::signal message; + void message(docstring const & msg); /// This signal is emitted when some dialog needs to be shown. - boost::signal showDialog; + void showDialog(std::string const & name); /// This signal is emitted when some dialog needs to be shown with /// some data. - boost::signal showDialogWithData; - - /// This signal is emitted when some inset dialogs needs to be shown. - boost::signal showInsetDialog; + void showDialog(std::string const & name, std::string const & data, + Inset * inset = 0); /// This signal is emitted when some dialogs needs to be updated. - boost::signal updateDialog; + void updateDialog(std::string const & name, std::string const & data); - /// This signal is emitted when the layout at the cursor is changed. - boost::signal layoutChanged; + /// + void setGuiDelegate(frontend::GuiBufferViewDelegate *); -private: /// - bool multiParSel(); + docstring contentsOfPlaintextFile(support::FileName const & f); + // Insert plain text file (if filename is empty, prompt for one) + 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(); - /// Search recursively for the the innermost inset that covers (x, y) position. +private: + /// 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(); + + // 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. - InsetBase const * getCoveringInset( - LyXText const & text, //< The LyXText where we start searching. + 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; - /// - int width_; - /// - int height_; - /// - ScrollbarParameters scrollbarParameters_; - - /// - ViewMetricsInfo metrics_info_; - /// - CoordCache coord_cache_; - /// - Buffer * buffer_; + /// 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; - /// 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_; + void updateDocumentClass(DocumentClassConstPtr olddc); /// - LCursor cursor_; + int width_; /// - bool multiparsel_cache_; + int height_; /// - pit_type anchor_ref_; + bool full_screen_; /// - int offset_ref_; + Buffer & buffer_; - /// 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_; + struct Private; + Private * const d; }; +/// some space for drawing the 'nested' markers (in pixel) +inline int nestMargin() { return 15; } + +/// margin for changebar +inline int changebarMargin() { return 12; } } // namespace lyx