// -*- C++ -*-
/**
* \file BufferView.h
- * Copyright 2002 the LyX Team
- * Read the file COPYING
+ * This file is part of LyX, the document processor.
+ * Licence details can be found in the file COPYING.
*
- * \author Lars Gullik Bjønnes
-*/
+ * \author Alfredo Braustein
+ * \author Lars Gullik Bjønnes
+ * \author John Levon
+ * \author Jürgen Vigna
+ *
+ * Full author contact details are available in file CREDITS.
+ */
#ifndef BUFFER_VIEW_H
#define BUFFER_VIEW_H
-#ifdef __GNUG__
-#pragma interface
-#endif
+#include "update_flags.h"
+
+#include "support/strfwd.h"
+#include "support/types.h"
-#include "LString.h"
-#include "undo.h"
+namespace lyx {
-#include "insets/inset.h"
+namespace support { class FileName; }
-#include <boost/utility.hpp>
+namespace frontend { class Painter; }
+namespace frontend { class GuiBufferViewDelegate; }
-class LyXView;
-class LyXText;
-class TeXErrors;
class Buffer;
-class LyXScreen;
-class Language;
-class Painter;
-class UpdatableInset;
-class WordLangTuple;
-class WorkArea;
-
-///
-class BufferView : boost::noncopyable {
-public:
- ///
- enum UpdateCodes {
- ///
- UPDATE = 0,
- ///
- SELECT = 1,
- ///
- FITCUR = 2,
- ///
- CHANGE = 4
- };
+class Change;
+class CoordCache;
+class Cursor;
+class DocIterator;
+class FuncRequest;
+class FuncStatus;
+class Intl;
+class Inset;
+class ParIterator;
+class ParagraphMetrics;
+class Point;
+class Text;
+class TextMetrics;
+enum CursorStatus {
+ CUR_INSIDE,
+ CUR_ABOVE,
+ CUR_BELOW
+};
+
+/// Scrollbar Parameters.
+struct ScrollbarParameters
+{
+ ScrollbarParameters()
+ : min(0), max(0), position(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.
+ int page_step;
+};
+
+/// Screen view of a Buffer.
+/**
+ * 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.
+ * It is the official interface between the LyX core and
+ * the frontend WorkArea.
+ *
+ * \sa WorkArea
+ * \sa Buffer
+ * \sa CoordCache
+ */
+class BufferView {
+public:
///
- BufferView(LyXView * owner, int , int , int, int);
+ explicit BufferView(Buffer & buffer);
///
~BufferView();
+
+ /// return the buffer being viewed.
+ Buffer & buffer();
+ Buffer const & buffer() const;
+
///
- Buffer * buffer() const;
- ///
- Painter & painter() const;
- ///
- LyXScreen & screen() const;
- /// return the work area for this bview
- WorkArea & workarea() const;
- ///
- void buffer(Buffer * b);
- ///
- void resize();
- /**
- * Repaint the pixmap. Used for when we don't want
- * to go through the full update() logic, just a simple
- * repaint of the whole screen.
+ 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.
+ * \c Update::Force means to force an update in any case.
+ * \retval true if a screen redraw is needed
*/
- void repaint();
- ///
+ void processUpdateFlags(Update::flags flags);
+
+ /// move the screen to fit the cursor.
+ /// Only to be called with good y coordinates (after a bv::metrics)
bool fitCursor();
- ///
- void update();
- //
- void update(LyXText *, UpdateCodes uc);
- ///
+ /// reset the scrollbar to reflect current view position.
void updateScrollbar();
- ///
- Inset * checkInsetHit(LyXText *, int & x, int & y);
- ///
- void redoCurrentBuffer();
- ///
- bool available() const;
- ///
- LyXView * owner() const;
- ///
- void beforeChange(LyXText *);
- ///
- void savePosition(unsigned int i);
- ///
- void restorePosition(unsigned int i);
- ///
- bool isSavedPosition(unsigned int i);
- /** This holds the mapping between buffer paragraphs and screen rows.
- This should be private...but not yet. (Lgb)
- */
- LyXText * text;
- ///
- LyXText * getLyXText() const;
- ///
- LyXText * getParentText(Inset * inset) const;
- ///
- Language const * getParentLanguage(Inset * inset) const;
- ///
- int workWidth() const;
- ///
- UpdatableInset * theLockingInset() const;
- ///
- void theLockingInset(UpdatableInset * inset);
- ///
- void updateInset(Inset * inset, bool mark_dirty);
- ///
- int slx;
- ///
- int sly;
- ///
- void insetUnlock();
- ///
- void replaceWord(string const & replacestring);
- ///
- void endOfSpellCheck();
- ///
- void selectLastWord();
- /// return the next word
- WordLangTuple const nextWord(float & value);
- ///
- bool gotoLabel(string const & label);
- ///
- void pasteEnvironment();
- ///
- void copyEnvironment();
- ///
- void menuUndo();
- ///
- void menuRedo();
- /// removes all autodeletable insets
- bool removeAutoInsets();
- ///
- void insertErrors(TeXErrors & terr);
- ///
+ /// 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;
+
+ /// Save the current position as bookmark.
+ /// if idx == 0, save to temp_bookmark
+ void saveBookmark(unsigned int idx);
+ /// 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;
+
+ /// move cursor to the named label.
+ void gotoLabel(docstring const & label);
+
+ /// set the cursor based on the given TeX source row.
void setCursorFromRow(int row);
- /** Insert an inset into the buffer.
- Place it in a layout of lout,
- if no_table make sure that it doesn't end up in a table.
- */
- bool insertInset(Inset * inset, string const & lout = string());
- /// Inserts a lyx file at cursor position. return #false# if it fails
- bool insertLyXFile(string const & file);
- ///
- bool lockInset(UpdatableInset * inset);
- ///
- void showLockedInsetCursor(int x, int y, int asc, int desc);
- ///
- void hideLockedInsetCursor();
- ///
- bool fitLockedInsetCursor(int x, int y, int asc, int desc);
- ///
- int unlockInset(UpdatableInset * inset);
+
+ /// set cursor to the given inset. Return true if found.
+ bool setCursorFromInset(Inset const *);
+
+ /// Ensure that the BufferView cursor is visible.
+ /// This method will automatically scroll and update the BufferView
+ /// 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);
+ /// 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);
+ /// Set the cursor position based on the scrollbar one.
+ void setCursorFromScrollbar();
+
+ /// return the pixel width of the document view.
+ int workWidth() const;
+ /// 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;
+ /// set the inline completion postfix and its position in the buffer.
+ /// Updates the updateFlags in \c cur.
+ void setInlineCompletion(Cursor & 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);
+ /// execute the given function.
+ /// \return true if the function has been processed.
+ bool dispatch(FuncRequest const & argument);
+
+ /// request an X11 selection.
+ /// \return the selected string.
+ docstring const requestSelection();
+ /// clear the X11 selection.
+ void clearSelection();
+
+ /// resize the BufferView.
+ /// \sa WorkArea
+ void resize(int width, int height);
+
+ /// dispatch method helper for \c WorkArea
+ /// \sa WorkArea
+ void mouseEventDispatch(FuncRequest const & ev);
+
+ /// access to anchor.
+ pit_type anchor_ref() const;
+
///
- void lockedInsetStoreUndo(Undo::undo_kind kind);
+ CursorStatus cursorStatus(DocIterator const & dit) const;
+ /// access to full cursor.
+ Cursor & cursor();
+ /// access to full cursor.
+ Cursor const & cursor() const;
+ /// sets cursor.
+ /// This will also open all relevant collapsable insets.
+ void setCursor(DocIterator const &);
+ /// 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 select = false);
+
+ /// 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);
+
+ /// update the internal \c ViewMetricsInfo.
+ void updateMetrics();
+
///
- void showCursor();
+ TextMetrics const & textMetrics(Text const * t) const;
+ TextMetrics & textMetrics(Text const * t);
///
- void hideCursor();
+ ParagraphMetrics const & parMetrics(Text const *, pit_type) const;
+
///
- void toggleSelection(bool = true);
+ CoordCache & coordCache();
///
- void toggleToggle();
+ CoordCache const & coordCache() const;
+
///
- void center();
+ Point getPos(DocIterator const & dit, bool boundary) const;
- /// Scroll the view by a number of pixels
- void scrollDocView(int);
///
- void switchKeyMap();
+ void draw(frontend::Painter & pain);
+ /// get this view's keyboard map handler.
+ Intl & getIntl();
///
- bool ChangeInsets(Inset::Code code, string const & from,
- string const & to);
- ///
- bool ChangeRefsIfUnique(string const & from, string const & to);
- ///
- bool ChangeCitationsIfUnique(string const & from, string const & to);
+ Intl const & getIntl() const;
+
+ //
+ // Messages to the GUI
+ //
+ /// This signal is emitted when some message shows up.
+ void message(docstring const & msg);
+
+ /// This signal is emitted when some dialog needs to be shown.
+ void showDialog(std::string const & name);
+
+ /// 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);
+
+ /// This signal is emitted when some dialogs needs to be updated.
+ void updateDialog(std::string const & name, std::string const & data);
+
///
- string const getClipboard() const;
+ void setGuiDelegate(frontend::GuiBufferViewDelegate *);
+
///
- void stuffClipboard(string const &) const;
+ 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);
///
- bool dispatch(FuncRequest const & argument);
+ void insertLyXFile(support::FileName const & f);
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;
+ /// 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.
+ /// \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;
+
///
- struct Pimpl;
+ int width_;
///
- friend struct BufferView::Pimpl;
+ int height_;
///
- Pimpl * pimpl_;
+ bool full_screen_;
+ ///
+ Buffer & buffer_;
+
+ 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; }
-///
-BufferView::UpdateCodes operator|(BufferView::UpdateCodes uc1,
- BufferView::UpdateCodes uc2);
+} // namespace lyx
-#endif
+#endif // BUFFERVIEW_H