* 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.
*/
#ifndef BUFFER_VIEW_H
#define BUFFER_VIEW_H
+#include "CoordCache.h"
+#include "DocumentClassPtr.h"
+#include "TexRow.h"
#include "update_flags.h"
#include "support/strfwd.h"
namespace support { class FileName; }
+namespace frontend { struct CaretGeometry; }
namespace frontend { class Painter; }
namespace frontend { class GuiBufferViewDelegate; }
class Buffer;
class Change;
-class CoordCache;
class Cursor;
+class CursorSlice;
+class Dimension;
+class DispatchResult;
class DocIterator;
class FuncRequest;
class FuncStatus;
class Intl;
class Inset;
-class Menu;
-class ParIterator;
+class InsetMathNest;
+class Length;
+class MathData;
+class MathRow;
class ParagraphMetrics;
class Point;
class Text;
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
{
+ // 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;
- /// Current position in the document in pixels.
- int position;
/// Line-scroll amount in pixels.
int single_step;
/// Page-scroll amount in pixels.
class BufferView {
public:
///
- BufferView(Buffer & buffer);
+ explicit BufferView(Buffer & buffer);
///
~BufferView();
Buffer & buffer();
Buffer const & buffer() const;
- /// perform pending metrics updates.
- /** \c Update::FitCursor means first to do a FitCursor, and to
+ ///
+ void setFullScreen(bool full_screen) { full_screen_ = full_screen; }
+
+ /// default value for the margins
+ int defaultMargin() const;
+ /// right margin
+ int rightMargin() const;
+ /// left margin
+ int leftMargin() const;
+ /// top margin
+ int topMargin() const;
+ /// bottom margin
+ int bottomMargin() const;
+
+ docstring const & searchRequestCache() const;
+ void setSearchRequestCache(docstring const & text);
+
+ /// 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 the number of pixels equivalent to \c pix pixels at
+ * 100dpi and 100% zoom.
+ */
+ int zoomedPixels(int pix) 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;
+
+ /// Add \p flags to current update flags and trigger an update.
+ /* If this method is invoked several times before the update
+ * actually takes place, the effect is cumulative.
+ * \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
*/
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();
- /// reset the scrollbar to reflect current view position.
- void updateScrollbar();
+ 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;
+
+ /// reset the scrollbar parameters to reflect current view position.
+ void updateScrollbarParameters();
/// 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.
- docstring contextMenu(int x, int y) const;
+ std::string contextMenu(int x, int y) const;
+ /// \return the math inset with a context menu for the given position
+ Inset const * mathContextMenu(InsetMathNest const * inset,
+ CoordCache::Insets const & inset_cache, int x, int y) const;
+ /// \return the clickable math inset for the given position
+ Inset const * clickableMathInset(InsetMathNest const * inset,
+ CoordCache::Insets const & inset_cache, int x, int y) const;
/// Save the current position as bookmark.
/// if idx == 0, save to temp_bookmark
void gotoLabel(docstring const & label);
/// set the cursor based on the given TeX source row.
- void setCursorFromRow(int row);
-
+ 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
- /// if needed.
+ /// (metrics+drawing) 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(DocIterator const & dit);
- /// LFUN_SCROLL Helper.
- void lfunScroll(FuncRequest const & cmd);
+ /// (metrics+drawing) if needed.
+ /// \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 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.
- 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();
/// 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 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.
- docstring const requestSelection();
+ docstring requestSelection();
/// clear the X11 selection.
void clearSelection();
/// \sa WorkArea
void mouseEventDispatch(FuncRequest const & ev);
- /// access to anchor.
- pit_type anchor_ref() const;
-
///
CursorStatus cursorStatus(DocIterator const & dit) const;
/// access to full cursor.
/// access to full cursor.
Cursor const & cursor() const;
/// sets cursor.
- /// This will also open all relevant collapsable insets.
+ /// This will also open all relevant collapsible 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);
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();
+ // this is the "nodraw" drawing stage: only set the positions of the
+ // insets in metrics cache.
+ void updatePosCache();
+
///
TextMetrics const & textMetrics(Text const * t) const;
TextMetrics & textMetrics(Text const * t);
CoordCache const & coordCache() const;
///
- Point getPos(DocIterator const & dit, bool boundary) const;
+ MathRow const & mathRow(MathData const * cell) const;
+ ///
+ void setMathRow(MathData const * cell, MathRow const & mrow);
+ ///
+ Point getPos(DocIterator const & dit) const;
+ /// is the paragraph of the cursor visible ?
+ bool paragraphVisible(DocIterator const & dit) const;
+ /// is the caret currently visible in the view
+ bool caretInView() const;
+ /// get the position and height of the caret
+ void caretPosAndDim(Point & p, Dimension & dim) const;
+ /// compute the shape of the caret
+ void buildCaretGeometry(bool complet);
+ /// the shape of the caret
+ frontend::CaretGeometry const & caretGeometry() const;
///
- void draw(frontend::Painter & pain);
+ void draw(frontend::Painter & pain, bool paint_caret);
/// get this view's keyboard map handler.
Intl & getIntl();
/// This signal is emitted when some dialog needs to be shown with
/// some data.
void showDialog(std::string const & name, std::string const & data,
- Inset * inset = 0);
+ Inset * inset = nullptr);
/// This signal is emitted when some dialogs needs to be updated.
void updateDialog(std::string const & name, std::string const & data);
// 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);
+ void insertLyXFile(support::FileName const & f, bool const ignorelang = false);
+ /// 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();
+ /// Are we currently performing a selection with the mouse?
+ bool mouseSelecting() 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();
+ /// do the work for the public updateMetrics()
+ void updateMetrics(Update::flags & update_flags);
+
+ // Set the row on which the cursor lives.
+ void setCurrentRowSlice(CursorSlice const & rowSlice);
- /// Search recursively for the the innermost inset that covers (x, y) position.
+ // Check whether the row where the cursor lives needs to be scrolled.
+ // Update the drawing strategy if needed.
+ void checkCursorScrollOffset();
+
+ /// 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 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_;
///
+ bool full_screen_;
+ ///
Buffer & buffer_;
struct Private;
/// margin for changebar
inline int changebarMargin() { return 12; }
-/// right margin
-inline int rightMargin() { return 10; }
-
} // namespace lyx
#endif // BUFFERVIEW_H
projects / lyx.git / blobdiff