#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 <boost/utility.hpp>
+#include <boost/signal.hpp>
#include <string>
+
+namespace lyx {
+
class Buffer;
class Change;
class DocIterator;
-class ErrorList;
class FuncRequest;
class FuncStatus;
-class InsetOld;
+class Intl;
class Language;
class LCursor;
class LyXText;
-class LyXScreen;
-class LyXView;
-class Painter;
class ParIterator;
+class ViewMetricsInfo;
+
+/// 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
+ int position;
+ /// the line-scroll amount, in pixels
+ int lineScrollHeight;
+};
/**
* A buffer view encapsulates a view onto a particular
*/
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();
/// 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
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);
- /// fit the user cursor within the visible view
+ /** 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.
+ */
+ 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();
- /// perform pending painting updates
- void update();
/// reset the scrollbar to reflect current view position
void updateScrollbar();
- /// FIXME
- void redoCurrentBuffer();
-
- /// FIXME
- bool available() const;
+ /// return the Scrollbar Parameters
+ ScrollbarParameters const & scrollbarParameters() const;
/// Save the current position as bookmark i
void savePosition(unsigned int 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();
+ Change const getCurrentChange() const;
/// return the lyxtext we are using
- LyXText * getLyXText() const;
+ LyXText * getLyXText();
- /// simple replacing. Use the font of the first selected character
- void replaceSelectionWithString(std::string const & str);
+ /// return the lyxtext we are using
+ LyXText const * getLyXText() const;
/// move cursor to the named label
- void gotoLabel(std::string const & 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
void setCursorFromRow(int row);
- /// hide the cursor if it is visible
- void hideCursor();
-
/// 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();
/// return the pixel width of the document view
int workWidth() const;
/// 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
FuncStatus getStatus(FuncRequest const & cmd);
/// execute the given function
bool dispatch(FuncRequest const & argument);
- /// clear the X selection
- void unsetXSel();
+ ///
+ docstring const requestSelection();
+ ///
+ void clearSelection();
+
+ ///
+ void workAreaResize(int width, int height);
+
+ /// a function should be executed from the workarea
+ 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;
- ///
- LyXText * text() const;
- ///
- void setCursor(ParIterator const & par, lyx::pos_type pos);
+ /// sets cursor and 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
* to \c cur and cursor to \c cur + \c length. When \c
* backwards == true, set anchor to \c cur and cursor to \c
*/
void putSelectionAt(DocIterator const & cur,
int length, bool backwards);
+ ///
+ ViewMetricsInfo const & viewMetricsInfo();
+ ///
+ void updateMetrics(bool singlepar = false);
+
+ ///
+ 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:
///
- struct Pimpl;
+ bool multiParSel();
+ ///
+ int width_;
+ ///
+ int height_;
+ ///
+ ScrollbarParameters scrollbarParameters_;
+
+ ///
+ ViewMetricsInfo metrics_info_;
+ CoordCache coord_cache_;
+ ///
+ Buffer * buffer_;
+
+ /// Estimated average par height for scrollbar
+ int wh_;
///
- friend struct BufferView::Pimpl;
+ class Position {
+ public:
+ /// Filename
+ std::string filename;
+ /// Cursor paragraph Id
+ int par_id;
+ /// Cursor position
+ pos_type par_pos;
+ ///
+ Position() : par_id(0), par_pos(0) {}
+ ///
+ Position(std::string const & f, int id, pos_type pos)
+ : filename(f), par_id(id), par_pos(pos) {}
+ };
+ ///
+ std::vector<Position> saved_positions;
+ ///
+ 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_;
///
- Pimpl * pimpl_;
+ LCursor cursor_;
+ ///
+ bool multiparsel_cache_;
+ ///
+ pit_type anchor_ref_;
+ ///
+ int offset_ref_;
+
+ /// keyboard mapping object
+ boost::scoped_ptr<Intl> const intl_;
};
+
+} // namespace lyx
+
#endif // BUFFERVIEW_H