#ifndef BUFFER_VIEW_H
#define BUFFER_VIEW_H
+#include "coordcache.h"
+#include "cursor.h"
#include "metricsinfo.h"
-
-#include "frontends/LyXKeySym.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 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)
-{
- return static_cast<flags>(int(f) & int(g));
-}
-
-} // namespace
-
-/// Scrollbar Parameters
+/// Scrollbar Parameters.
struct ScrollbarParameters
{
void reset(int h = 0, int p = 0, int l = 0)
lineScrollHeight = l;
}
- /// The total document height in pixels
+ /// Total document height in pixels.
int height;
- /// The current position in the document, in pixels
+ /// Current position in the document in pixels.
int position;
- /// the line-scroll amount, in pixels
+ /// 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);
+ 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 first layout of the Buffer.
- std::string firstLayout();
- /// return the owning main view
- LyXView * owner() const;
-
- /// resize event has happened
+ /// resize the BufferView.
void resize();
- /// reload the contained buffer
- void reload();
- /// 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);
- /** 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.
+ /// 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);
- /// 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;
- /// 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
+ /// 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(std::string const & label);
+ /// move cursor to the named label.
+ void gotoLabel(docstring 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);
- /// 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();
- /// 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();
+ /// request an X11 selection.
+ /// \return the selected string.
+ docstring const requestSelection();
+ /// clear the X11 selection.
+ void clearSelection();
- ///
+ /// resize method helper for \c WorkArea
+ /// \sa WorkArea
+ /// \sa resise
void workAreaResize(int width, int height);
- /// Receive a keypress
- void workAreaKeyPress(LyXKeySymPtr key, key_modifier::state state);
-
- /// 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 offset
- int offset_ref() const;
- /// access to anchor
- lyx::pit_type anchor_ref() const;
+ /// access to anchor.
+ 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);
+ ///
+ TextMetrics const & textMetrics(LyXText const * t) const;
+ TextMetrics & textMetrics(LyXText const * t);
+ ///
+ ParagraphMetrics const & parMetrics(LyXText const *, pit_type) 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_;
///
- friend class BufferView::Pimpl;
+ int height_;
///
- Pimpl * 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_;
+ ///
+ 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
projects / lyx.git / blobdiff