* 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 "DocumentClassPtr.h"
+#include "TexRow.h"
#include "update_flags.h"
#include "support/strfwd.h"
class Change;
class CoordCache;
class Cursor;
+class CursorSlice;
+class DispatchResult;
class DocIterator;
+class DocumentClass;
class FuncRequest;
class FuncStatus;
class Intl;
class Inset;
-class Menu;
+class PainterInfo;
class ParIterator;
class ParagraphMetrics;
class Point;
+class TexRow;
class Text;
class TextMetrics;
/// 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.
class BufferView {
public:
///
- BufferView(Buffer & buffer);
+ explicit BufferView(Buffer & buffer);
///
~BufferView();
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.
*/
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.
/// \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
void gotoLabel(docstring const & label);
/// 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
- /// if needed.
+ 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();
- /// LFUN_SCROLL Helper.
- void lfunScroll(FuncRequest const & cmd);
+ /// 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();
/// 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.
/// 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);
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();
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 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:
/// 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();
- /// 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 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