X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2FBufferView.h;h=bceaf1f82fd92d4d6bdffc091c312130802d6bd6;hb=e28331ed63062dea10d0a21b9ec12034b4b17b9a;hp=5723cb72cd811925b704a2d8b75c755a5b02f1c7;hpb=d8ae51dbe178d6b10a56c747cfd399a4dbba8117;p=lyx.git

diff --git a/src/BufferView.h b/src/BufferView.h
index 5723cb72cd..bceaf1f82f 100644
--- a/src/BufferView.h
+++ b/src/BufferView.h
@@ -15,222 +15,291 @@
 #ifndef BUFFER_VIEW_H
 #define BUFFER_VIEW_H
 
-#include "frontends/LyXKeySym.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 DocIterator;
-class ErrorList;
 class FuncRequest;
 class FuncStatus;
-class Language;
+class Intl;
 class LCursor;
 class LyXText;
-class LyXView;
 class ParIterator;
+class ParagraphMetrics;
+class ViewMetricsInfo;
 
-namespace lyx {
-namespace frontend {
-class Painter;
-}
-}
-
-namespace Update {
-	enum flags {
-		FitCursor = 1,
-		Force = 2,
-		SinglePar = 4,
-		MultiParSel = 8
-	};
-
-inline flags operator|(flags const f, flags const g)
-{
-	return static_cast<flags>(int(f) | int(g));
-}
-
-inline flags operator&(flags const f, flags const g)
+/// Scrollbar Parameters.
+struct ScrollbarParameters
 {
-	return static_cast<flags>(int(f) & int(g));
-}
-
-} // namespace
-
+	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 w, int h);
+	BufferView();
 
 	~BufferView();
 
-	/// set the buffer we are viewing
+	/// 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
+	/// return the buffer being viewed.
 	Buffer * buffer() const;
 
-	/// return the painter object for drawing onto the view
-	lyx::frontend::Painter & painter() const;
-
-	/// return the owning main view
-	LyXView * owner() const;
-
-	/// resize event has happened
+	/// resize the BufferView.
 	void resize();
 
-	/// reload the contained buffer
-	void reload();
-	/// create a new buffer based on template
-	void 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);
-
-	/** perform pending painting updates. \c fitcursor means first
-	 *  to do a fitcursor, and to force an update if screen
-	 *  position changes. \c forceupdate means to force an update
-	 *  in any case.
+	/// load a buffer into the view.
+	bool loadLyXFile(support::FileName const & name, bool tolastfiles = true);
+
+	/// 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
 	 */
+	bool update(Update::flags flags = Update::FitCursor | Update::Force);
 
-	void update(Update::flags flags = Update::FitCursor | Update::Force);
-	/// move the screen to fit the cursor. Only to be called with
-	/// good y coordinates (after a bv::metrics)
+	/// 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
+	/// reset the scrollbar to reflect current view position.
 	void updateScrollbar();
-
-	/// FIXME
-	bool available() const;
-
-	/// 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);
-	/// save bookmarks to .lyx/session
-	void saveSavedPositions();
-
-	/// return the current change at the cursor
-	Change const getCurrentChange();
-
-	/// return the lyxtext we are using
+	/// 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
+	/// return the lyxtext we are using.
 	LyXText const * getLyXText() const;
 
-	/// simple replacing. Use the font of the first selected character
-	void replaceSelectionWithString(std::string const & str);
+	/// move cursor to the named label.
+	void gotoLabel(docstring const & label);
 
-	/// move cursor to the named label
-	void gotoLabel(std::string const & label);
-
-	/// 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
+	/// set the cursor based on the given TeX source row.
 	void setCursorFromRow(int row);
 
-	/// hide the cursor if it is visible
-	void hideCursor();
-
-	/// center the document view around the cursor
+	/// center the document view around the cursor.
 	void center();
-	/// scroll document by the given number of lines of default height
+	/// scroll document by the given number of lines of default height.
 	void scroll(int lines);
-	/// Scroll the view by a number of 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
+	/// return the pixel width of the document view.
 	int workWidth() const;
-	/// return the pixel height of the document view
+	/// return the pixel height of the document view.
 	int workHeight() const;
 
-	/// switch between primary and secondary keymaps for RTL entry
+	/// switch between primary and secondary keymaps for RTL entry.
 	void switchKeyMap();
 
-	/// 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);
-
-	/// return true for events that will handle
+	/// return true for events that will handle.
 	FuncStatus getStatus(FuncRequest const & cmd);
-	/// execute the given function
+	/// execute the given function.
 	bool dispatch(FuncRequest const & argument);
 
-	///
-	void selectionRequested();
-	///
-	void selectionLost();
-
-	///
-	void workAreaResize();
+	/// request an X11 selection.
+	/// \return the selected string.
+	docstring const requestSelection();
+	/// clear the X11 selection.
+	void clearSelection();
 
-        /// Receive a keypress
-        void workAreaKeyPress(LyXKeySymPtr key, key_modifier::state state);
+	/// resize method helper for \c WorkArea
+	/// \sa WorkArea
+	/// \sa resise
+	void workAreaResize(int width, int height);
 
-	/// a function should be executed from the workarea
+	/// dispatch method helper for \c WorkArea
+	/// \sa WorkArea
+	/// \retval true if a redraw is needed
 	bool workAreaDispatch(FuncRequest const & ev);
 
-	/// clear the X selection
-	void unsetXSel();
+	/// access to anchor.
+	pit_type anchor_ref() const;
 
-	/// access to offset
-	int offset_ref() const;
-	/// access to anchor
-	lyx::pit_type anchor_ref() const;
-
-	/// access to full cursor
+	/// access to full cursor.
 	LCursor & cursor();
-	/// access to full cursor
+	/// access to full cursor.
 	LCursor const & cursor() const;
-	///
-	LyXText * text() const;
-	/// sets cursor and open all relevant collapsable insets.
+	/// sets cursor.
+	/// This will also open all relevant collapsable insets.
 	void setCursor(DocIterator const &);
-	/// sets cursor; this is used when handling LFUN_MOUSE_PRESS.
-	void mouseSetCursor(LCursor & cur);
-
-	/* Sets the selection. When \c backwards == false, set anchor
+	/// 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.
 	 */
 	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);
+
 	///
-	bool const repaintAll() const;
+	TextMetrics const & textMetrics(LyXText const * t) const;
+	TextMetrics & textMetrics(LyXText const * t);
+	///
+	ParagraphMetrics const & parMetrics(LyXText const *, pit_type) const;
+
 	///
-	void const repaintAll(bool r) const;
+	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(); }
+
+	/// This signal is emitted when some message shows up.
+	boost::signal<void(docstring)> message;
+
+	/// This signal is emitted when some dialog needs to be shown.
+	boost::signal<void(std::string name)> showDialog;
+
+	/// This signal is emitted when some dialog needs to be shown with
+	/// some data.
+	boost::signal<void(std::string name,
+		std::string data)> showDialogWithData;
+
+	/// This signal is emitted when some inset dialogs needs to be shown.
+	boost::signal<void(std::string name, std::string data,
+		InsetBase * inset)> showInsetDialog;
+
+	/// This signal is emitted when some dialogs needs to be updated.
+	boost::signal<void(std::string name,
+		std::string data)> updateDialog;
+
+	/// This signal is emitted when the layout at the cursor is changed.
+	boost::signal<void(std::string layout)> layoutChanged;
 
 private:
 	///
-	class Pimpl;
+	bool multiParSel();
+	///
+	int width_;
+	///
+	int height_;
 	///
-	friend class BufferView::Pimpl;
+	ScrollbarParameters scrollbarParameters_;
+
+	///
+	ViewMetricsInfo metrics_info_;
+	///
+	CoordCache coord_cache_;
+	///
+	Buffer * buffer_;
+
+	/// 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_;
 	///
-	Pimpl * pimpl_;
+	bool multiparsel_cache_;
+	///
+	pit_type anchor_ref_;
+	///
+	int offset_ref_;
+
+	/// 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