// -*- C++ -*-
-/* This file is part of
- * ======================================================
- *
- * LyX, The Document Processor
- *
- * Copyright 1995 Matthias Ettrich
- * Copyright 1995-2000 The LyX Team.
+/**
+ * \file BufferView.h
+ * This file is part of LyX, the document processor.
+ * Licence details can be found in the file COPYING.
+ *
+ * \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 "coordcache.h"
+#include "cursor.h"
+#include "metricsinfo.h"
+#include "TextMetrics.h"
+#include "UpdateFlags.h"
+
+#include "support/types.h"
-#include FORMS_H_LOCATION
-#include "undo.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 LyXView;
-class LyXText;
-class TeXErrors;
class Buffer;
-class LyXScreen;
-class WorkArea;
-class Language;
+class Change;
+class DocIterator;
+class FuncRequest;
+class FuncStatus;
+class Intl;
+class LCursor;
+class LyXText;
+class ParIterator;
+class ParagraphMetrics;
+class ViewMetricsInfo;
-///
-class BufferView : public noncopyable {
+/// 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 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 : boost::noncopyable {
public:
- ///
- enum UpdateCodes {
- ///
- UPDATE = 0,
- ///
- SELECT = 1,
- ///
- FITCUR = 2,
- ///
- CHANGE = 4
- };
-
- ///
- BufferView(LyXView * owner, int , int , int, int);
- ///
+ BufferView();
+
~BufferView();
- ///
+
+ /// 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;
- ///
- Painter & painter();
- ///
- LyXScreen * screen() const;
- ///
- WorkArea * workarea() const;
- ///
- void buffer(Buffer * b);
- ///
- void resize(int, int, int, int);
- ///
+
+ /// resize the BufferView.
void resize();
- ///
- void redraw();
- ///
- void fitCursor(LyXText *);
- ///
- void update();
- //
- void update(UpdateCodes uc);
- ///
+
+ /// 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);
+
+ /// 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();
- ///
- Inset * checkInsetHit(LyXText *, int & x, int & y,
- unsigned int button);
- ///
- void redoCurrentBuffer();
- ///
- int resizeCurrentBuffer();
- ///
- void gotoError();
- ///
- void cursorPrevious(LyXText *);
- ///
- void cursorNext(LyXText *);
- ///
- bool available() const;
- ///
- LyXView * owner() const;
- ///
- void beforeChange();
- ///
- void savePosition();
- ///
- void restorePosition();
- ///
- bool NoSavedPositions();
- /** 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);
- ///
- bool inset_slept;
- ///
- int slx;
- ///
- int sly;
- ///
- void insetUnlock();
- ///
- void insetSleep();
- ///
- void insetWakeup();
- ///
- void replaceWord(string const & replacestring);
- ///
- void endOfSpellCheck();
- ///
- void selectLastWord();
- ///
- string const nextWord(float & value);
- ///
- void insertCorrectQuote();
- ///
- void gotoNote();
- ///
- bool gotoLabel(string const & label);
- ///
- void paste();
- ///
- void cut();
- ///
- void copy();
- ///
- void pasteEnvironment();
- ///
- void copyEnvironment();
- ///
- void hfill();
- ///
- void protectedBlank();
- ///
- void newline();
- ///
- void menuSeparator();
- ///
- void endOfSentenceDot();
- ///
- void ldots();
- ///
- void hyphenationPoint();
- ///
- void menuUndo();
- ///
- void menuRedo();
-#ifndef NEW_INSETS
- ///
- void toggleFloat();
- ///
- void openStuff();
-#endif
- ///
- void insertNote();
-#ifndef NEW_INSETS
- ///
- void allFloats(char flag, char figmar);
-#endif
- /// removes all autodeletable insets
- bool removeAutoInsets();
- ///
- void insertErrors(TeXErrors & terr);
- ///
+ /// 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);
- /** Insert an inset into the buffer.
- Placie 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(),
- bool no_table = false);
- /// open and lock an updatable inset
- bool open_new_inset(UpdatableInset * new_inset, bool behind = false);
- /** 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();
- ///
- void fitLockedInsetCursor(int x, int y, int asc, int desc);
- ///
- int unlockInset(UpdatableInset * inset);
- ///
- void lockedInsetStoreUndo(Undo::undo_kind kind);
- ///
- void showCursor();
- ///
- void hideCursor();
- ///
- void toggleSelection(bool = true);
- ///
- void toggleToggle();
- ///
+
+ /// center the document view around the cursor.
void center();
-
- ///
- bool focus() const;
- ///
- void focus(bool);
- ///
- bool active() const;
- ///
- bool belowMouse() const;
- /// A callback for the slider in the scrollbar.
- void scrollCB(double);
+ /// 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();
+
+ /// return the pixel width of the document view.
+ int workWidth() const;
+ /// 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.
+ FuncStatus getStatus(FuncRequest const & cmd);
+ /// execute the given function.
+ bool dispatch(FuncRequest const & argument);
+
+ /// 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);
+
+ /// dispatch method helper for \c WorkArea
+ /// \sa WorkArea
+ /// \retval true if a redraw is needed
+ bool workAreaDispatch(FuncRequest const & ev);
+
+ /// access to anchor.
+ pit_type anchor_ref() const;
+
+ /// 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.
+ */
+ 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);
///
- void setState();
+ TextMetrics const & textMetrics(LyXText const * t) const;
+ TextMetrics & textMetrics(LyXText const * t);
+ ///
+ ParagraphMetrics const & parMetrics(LyXText const *, pit_type) const;
///
- void pushIntoUpdateList(Inset * i);
-#if 0
+ CoordCache & coordCache() {
+ return coord_cache_;
+ }
///
- void workAreaExpose();
+ CoordCache const & coordCache() const {
+ return coord_cache_;
+ }
+ /// get this view's keyboard map handler.
+ Intl & getIntl() { return *intl_.get(); }
///
- void workAreaButtonPress(int x, int y, unsigned int button);
+ 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:
///
- void workAreaButtonRelease(int x, int y, unsigned int button);
+ bool multiParSel();
///
- void workAreaMotionNotify(int x, int y, unsigned int state);
+ int width_;
///
- void doubleClick(int x, int y, unsigned int button);
+ int height_;
///
- void tripleClick(int x, int y, unsigned int button);
+ ScrollbarParameters scrollbarParameters_;
+
///
- void enterView();
+ ViewMetricsInfo metrics_info_;
///
- void leaveView();
-#endif
+ CoordCache coord_cache_;
///
- bool ChangeRefs(string const & from, string const & to);
+ Buffer * buffer_;
+
+ /// Estimated average par height for scrollbar.
+ int wh_;
///
- bool ChangeRefsIfUnique(string const & from, string const & to);
+ 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_;
///
- void pasteClipboard(bool asPara);
+ LCursor cursor_;
///
- void stuffClipboard(string const &) const;
-private:
- struct Pimpl;
+ bool multiparsel_cache_;
///
- friend struct BufferView::Pimpl;
+ pit_type anchor_ref_;
///
- Pimpl * pimpl_;
+ 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_;
};
-///
-BufferView::UpdateCodes operator|(BufferView::UpdateCodes uc1,
- BufferView::UpdateCodes uc2);
+} // namespace lyx
-#endif
+#endif // BUFFERVIEW_H
projects / lyx.git / blobdiff