#ifndef BUFFER_VIEW_H
#define BUFFER_VIEW_H
-#include "coordcache.h"
-#include "cursor.h"
-#include "metricsinfo.h"
-#include "UpdateFlags.h"
-#include "support/types.h"
+#include "update_flags.h"
-#include <boost/utility.hpp>
-#include <boost/signal.hpp>
+#include "support/strfwd.h"
+#include "support/types.h"
-#include <string>
+namespace lyx {
+namespace support { class FileName; }
-namespace lyx {
+namespace frontend { class Painter; }
+namespace frontend { class GuiBufferViewDelegate; }
class Buffer;
class Change;
+class CoordCache;
+class Cursor;
class DocIterator;
class FuncRequest;
class FuncStatus;
class Intl;
-class Language;
-class LCursor;
-class LyXText;
+class Inset;
+class Menu;
class ParIterator;
-class ViewMetricsInfo;
+class ParagraphMetrics;
+class Point;
+class Text;
+class TextMetrics;
+
+enum CursorStatus {
+ CUR_INSIDE,
+ CUR_ABOVE,
+ CUR_BELOW
+};
-/// Scrollbar Parameters
+/// Scrollbar Parameters.
struct ScrollbarParameters
{
- void reset(int h = 0, int p = 0, int l = 0)
- {
- height = h;
- position = p;
- lineScrollHeight = l;
- }
-
- /// The total document height in pixels
- int height;
- /// The current position in the document, in pixels
+ /// Minimum scrollbar position in pixels.
+ int min;
+ /// Maximum scrollbar position in pixels.
+ int max;
+ /// Current position in the document in pixels.
int position;
- /// the line-scroll amount, in pixels
- int lineScrollHeight;
+ /// Line-scroll amount in pixels.
+ int single_step;
+ /// Page-scroll amount in pixels.
+ int page_step;
};
+/// 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.
+ * It is the official interface between the LyX core and
+ * the frontend WorkArea.
*
- * Eventually we will allow several views onto a single
- * buffer, but not yet.
+ * \sa WorkArea
+ * \sa Buffer
+ * \sa CoordCache
*/
-class BufferView : boost::noncopyable {
+class BufferView {
public:
- BufferView();
-
+ ///
+ explicit BufferView(Buffer & buffer);
+ ///
~BufferView();
- /// set the buffer we are viewing
- void setBuffer(Buffer * b);
- /// return the buffer being viewed
- Buffer * buffer() const;
+ /// return the buffer being viewed.
+ Buffer & buffer();
+ Buffer const & buffer() const;
+
+ ///
+ void setFullScreen(bool full_screen) { full_screen_ = full_screen; }
+
+ /// right margin
+ int rightMargin() const;
- /// resize event has happened
- void resize();
+ /// left margin
+ int leftMargin() const;
- /// reload the contained buffer
- void reload();
- /// load a buffer into the view
- bool loadLyXFile(std::string const & name, bool tolastfiles = true);
+ /// \return true if the BufferView is at the top of the document.
+ bool isTopScreen() const;
- /** 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.
- * \return true if a full updateMetrics() is needed.
+ /// \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
*/
- bool update(Update::flags flags = Update::FitCursor | Update::Force);
+ void processUpdateFlags(Update::flags flags);
- /// 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();
- /// return the Scrollbar Parameters
+ /// 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
- void moveToPosition(int par_id, pos_type par_pos);
- /// return the current change at the cursor
+ /// \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;
- /// return the lyxtext we are using
- LyXText * getLyXText();
-
- /// return the lyxtext we are using
- LyXText const * getLyXText() const;
-
- /// move cursor to the named label
+ /// move cursor to the named label.
void gotoLabel(docstring const & label);
- /// set the cursor based on the given TeX source row
+ /// set the cursor based on the given TeX source row.
void setCursorFromRow(int row);
- /// 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
+ /// 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.
+ void scrollDown(int pixels);
+ /// scroll up document by the given number of pixels.
+ void scrollUp(int pixels);
+ /// scroll document by the given number of pixels.
+ void 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
+ /// 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
- void switchKeyMap();
-
- /// return true for events that will handle
+ /// 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
+ /// 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();
- ///
- void workAreaResize(int width, int height);
+ /// resize the BufferView.
+ /// \sa WorkArea
+ void resize(int width, int height);
- /// a function should be executed from the workarea
- bool workAreaDispatch(FuncRequest const & ev);
+ /// dispatch method helper for \c WorkArea
+ /// \sa WorkArea
+ void mouseEventDispatch(FuncRequest const & ev);
- /// access to anchor
+ /// access to anchor.
pit_type anchor_ref() const;
- /// access to full cursor
- LCursor & cursor();
- /// access to full cursor
- LCursor const & cursor() const;
- /// sets cursor and open all relevant collapsable insets.
+ ///
+ 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 &);
- /// 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(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();
+
///
- ViewMetricsInfo const & viewMetricsInfo();
+ TextMetrics const & textMetrics(Text const * t) const;
+ TextMetrics & textMetrics(Text const * t);
///
- void updateMetrics(bool singlepar = false);
+ ParagraphMetrics const & parMetrics(Text const *, pit_type) const;
///
- CoordCache & coordCache() {
- return coord_cache_;
- }
+ CoordCache & coordCache();
+ ///
+ CoordCache const & coordCache() const;
+
///
- CoordCache const & coordCache() const {
- return coord_cache_;
- }
- /// get this view's keyboard map handler
- Intl & getIntl() { return *intl_.get(); }
+ Point getPos(DocIterator const & dit, bool boundary) const;
+
+
///
- Intl const & getIntl() const { return *intl_.get(); }
+ void draw(frontend::Painter & pain);
+ /// get this view's keyboard map handler.
+ Intl & getIntl();
+ ///
+ Intl const & getIntl() const;
+
+ //
+ // Messages to the GUI
+ //
/// This signal is emitted when some message shows up.
- boost::signal<void(docstring)> message;
+ void message(docstring const & msg);
/// This signal is emitted when some dialog needs to be shown.
- boost::signal<void(std::string name)> showDialog;
+ void showDialog(std::string const & name);
/// 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;
+ /// 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.
- 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;
+ void updateDialog(std::string const & name, std::string const & data);
-private:
- ///
- bool multiParSel();
///
- int width_;
- ///
- int height_;
- ///
- ScrollbarParameters scrollbarParameters_;
+ void setGuiDelegate(frontend::GuiBufferViewDelegate *);
///
- ViewMetricsInfo metrics_info_;
- CoordCache coord_cache_;
+ 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);
///
- Buffer * buffer_;
+ 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;
- /// 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_;
+ int width_;
///
- bool multiparsel_cache_;
+ int height_;
///
- pit_type anchor_ref_;
+ bool full_screen_;
///
- int offset_ref_;
+ Buffer & buffer_;
- /// keyboard mapping object
- boost::scoped_ptr<Intl> const intl_;
+ 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; }
} // namespace lyx