#ifndef BUFFER_VIEW_H
#define BUFFER_VIEW_H
+#include "coordcache.h"
+#include "cursor.h"
+#include "metricsinfo.h"
+#include "TextMetrics.h"
+#include "UpdateFlags.h"
+
+#include "support/types.h"
+
+#include <boost/tuple/tuple.hpp>
#include <boost/utility.hpp>
+#include <boost/signal.hpp>
+#include <utility>
#include <string>
+
+namespace lyx {
+
+namespace support { class FileName; }
+
class Buffer;
class Change;
-class Encoding;
-class ErrorList;
+class DocIterator;
class FuncRequest;
-class InsetOld;
-class Language;
+class FuncStatus;
+class Intl;
class LCursor;
class LyXText;
-class LyXScreen;
-class LyXView;
-class Painter;
-class TeXErrors;
-class UpdatableInset;
-
+class ParIterator;
+class ParagraphMetrics;
+class ViewMetricsInfo;
+
+/// 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;
+ /// 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:
- /**
- * Create a view with the given owner main window,
- * of the given dimensions.
- */
- BufferView(LyXView * owner, int x, int y, int w, int h);
+ BufferView();
~BufferView();
- /// set the buffer we are viewing
- void buffer(Buffer * b);
- /// return the buffer being viewed
+ /// 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;
- /// return the painter object for drawing onto the view
- Painter & painter() const;
- /// return the screen object for handling re-drawing
- LyXScreen & screen() const;
- /// return the owning main view
- LyXView * owner() const;
-
- /// return the visible top y
- int top_y() const;
-
- /// set the visible top y
- void top_y(int);
-
- /// resize event has happened
+ /// resize the BufferView.
void resize();
- /// reload the contained buffer
- void reload();
- /// create a new buffer based on template
- bool newFile(std::string const & fname, std::string const & tname,
- bool named = true);
- /// 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);
- /// fit the user cursor within the visible view
- bool fitCursor();
- /// perform pending painting updates
- void update();
- /** update for a particular inset. Gets a pointer and not a
- * reference because we really need the pointer information
- * to find it in the buffer.
- *
- * Extracted from Matthias notes:
- *
- * If a inset wishes any redraw and/or update it just has to call
- * updateInset(this). It's is completly irrelevant, where the inset is.
- * UpdateInset will find it in any paragraph in any buffer.
- * Of course the insets in the current paragraph/buffer
- * are checked first, so no performance problem should occur.
+ /// 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 updateInset(InsetOld const *);
- /// reset the scrollbar to reflect current view position
- void updateScrollbar();
- /// FIXME
- void redoCurrentBuffer();
-
- /// FIXME
- bool available() const;
+ bool update(Update::flags flags = Update::FitCursor | Update::Force);
- /// Save the current position as bookmark i
- void savePosition(unsigned int i);
- /// Restore the position from bookmark i
- void restorePosition(unsigned int i);
- /// does the given bookmark have a saved position ?
- bool isSavedPosition(unsigned int i);
-
- /// return the current change at the cursor
- Change const getCurrentChange();
+ /// 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();
+ /// return the Scrollbar Parameters.
+ ScrollbarParameters const & scrollbarParameters() const;
+
+ /// Save the current position as bookmark.
+ /// if persistent=false, save to temp_bookmark
+ void saveBookmark(bool persistent);
+ /// 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<pit_type, int> 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.
+ LyXText * getLyXText();
+
+ /// return the lyxtext we are using.
+ LyXText const * getLyXText() 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);
- /**
- * This holds the mapping between buffer paragraphs and screen rows.
- * This should be private...but not yet. (Lgb)
- */
- LyXText * text;
- /// return the lyxtext we are using
- LyXText * getLyXText() const;
+ /// center the document view around the cursor.
+ void center();
+ /// scroll document by the given number of lines of default height.
+ void scroll(int lines);
+ /// Scroll the view by a number of pixels.
+ void scrollDocView(int pixels);
+ /// Set the cursor position based on the scrollbar one.
+ void setCursorFromScrollbar();
- /// update paragraph dialogs
- void updateParagraphDialog();
+ /// return the pixel width of the document view.
+ int workWidth() const;
+ /// return the pixel height of the document view.
+ int workHeight() const;
- /// return the current encoding at the cursor
- Encoding const * getEncoding() const;
+ /// switch between primary and secondary keymaps for RTL entry.
+ void switchKeyMap();
- /// return the parent language of the given inset
- Language const * getParentLanguage(InsetOld * inset) const;
+ /// return true for events that will handle.
+ FuncStatus getStatus(FuncRequest const & cmd);
+ /// execute the given function.
+ bool dispatch(FuncRequest const & argument);
- /// replace the currently selected word
- void replaceWord(std::string const & replacestring);
+ /// request an X11 selection.
+ /// \return the selected string.
+ docstring const requestSelection();
+ /// clear the X11 selection.
+ void clearSelection();
- /// move cursor to the named label
- void gotoLabel(std::string const & label);
+ /// resize method helper for \c WorkArea
+ /// \sa WorkArea
+ /// \sa resise
+ void workAreaResize(int width, int height);
- /// undo last action
- void undo();
- /// redo last action
- void redo();
+ /// dispatch method helper for \c WorkArea
+ /// \sa WorkArea
+ /// \retval true if a redraw is needed
+ bool workAreaDispatch(FuncRequest const & ev);
- /// get the stored error list
- ErrorList const & getErrorList() const;
- /// show the error list to the user
- void showErrorList(std::string const &) const;
- /// set the cursor based on the given TeX source row
- void setCursorFromRow(int row);
+ /// access to anchor.
+ pit_type anchor_ref() const;
- /**
- * Insert an inset into the buffer.
- * Place it in a layout of lout,
+ /// access to full cursor.
+ LCursor & cursor();
+ /// access to full cursor.
+ LCursor 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(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.
*/
- bool insertInset(InsetOld * inset, std::string const & lout = std::string());
+ 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;
- /// Inserts a lyx file at cursor position. return false if it fails
- bool insertLyXFile(std::string const & file);
+ ///
+ CoordCache & coordCache() {
+ return coord_cache_;
+ }
+ ///
+ CoordCache const & coordCache() const {
+ return coord_cache_;
+ }
+ /// get this view's keyboard map handler.
+ Intl & getIntl() { return *intl_.get(); }
+ ///
+ Intl const & getIntl() const { return *intl_.get(); }
- /// FIXME
- bool fitLockedInsetCursor(int x, int y, int asc, int desc);
+ /// This signal is emitted when some message shows up.
+ boost::signal<void(docstring)> message;
- /// hide the cursor if it is visible
- void hideCursor();
+ /// This signal is emitted when some dialog needs to be shown.
+ boost::signal<void(std::string name)> showDialog;
- /// center the document view around the cursor
- void center();
- /// scroll document by the given number of lines of default height
- void scroll(int lines);
- /// Scroll the view by a number of pixels
- void scrollDocView(int);
+ /// This signal is emitted when some dialog needs to be shown with
+ /// some data.
+ boost::signal<void(std::string name,
+ std::string data)> showDialogWithData;
- /// return the pixel width of the document view
- int workWidth() const;
- /// return the pixel height of the document view
- int workHeight() const;
+ /// This signal is emitted when some inset dialogs needs to be shown.
+ boost::signal<void(std::string name, std::string data,
+ InsetBase * inset)> showInsetDialog;
- /// switch between primary and secondary keymaps for RTL entry
- void switchKeyMap();
+ /// This signal is emitted when some dialogs needs to be updated.
+ boost::signal<void(std::string name,
+ std::string data)> updateDialog;
- /// FIXME
- bool ChangeRefsIfUnique(std::string const & from, std::string const & to);
+ /// This signal is emitted when the layout at the cursor is changed.
+ boost::signal<void(std::string layout)> layoutChanged;
- /// get the contents of the window system clipboard
- std::string const getClipboard() const;
- /// fill the window system clipboard
- void stuffClipboard(std::string const &) const;
- /// tell the window system we have a selection
- void haveSelection(bool sel);
+private:
+ ///
+ bool multiParSel();
+ ///
+ int width_;
+ ///
+ int height_;
+ ///
+ ScrollbarParameters scrollbarParameters_;
- /// execute the given function
- bool dispatch(FuncRequest const & argument);
-
- /// set target x position of cursor
- void BufferView::x_target(int x);
- /// return target x position of cursor
- int BufferView::x_target() const;
+ ///
+ ViewMetricsInfo metrics_info_;
+ ///
+ CoordCache coord_cache_;
+ ///
+ Buffer * buffer_;
- /// access to cursor
- LCursor & cursor();
- /// access to cursor
- LCursor const & cursor() 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_;
+ ///
+ LCursor cursor_;
///
- UpdatableInset * innerInset() const;
+ bool multiparsel_cache_;
+ ///
+ pit_type anchor_ref_;
+ ///
+ int offset_ref_;
-private:
- struct Pimpl;
- friend struct BufferView::Pimpl;
-
- Pimpl * pimpl_;
-
- /**
- * The target x position of the cursor. This is used for when
- * we have text like :
- *
- * blah blah blah blah| blah blah blah
- * blah blah blah
- * blah blah blah blah blah blah
- *
- * When we move onto row 3, we would like to be vertically aligned
- * with where we were in row 1, despite the fact that row 2 is
- * shorter than x()
- */
- int x_target_;
+ /// keyboard mapping object.
+ boost::scoped_ptr<Intl> 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<LyXText const *, TextMetrics> TextMetricsCache;
+ mutable TextMetricsCache text_metrics_;
};
+
+} // namespace lyx
+
#endif // BUFFERVIEW_H
projects / lyx.git / blobdiff