#ifndef BUFFER_VIEW_H
#define BUFFER_VIEW_H
+#include "metricsinfo.h"
+
+#include "frontends/LyXKeySym.h"
+
+#include "support/types.h"
+
#include <boost/utility.hpp>
+#include <boost/signal.hpp>
#include <string>
class Buffer;
class Change;
-class CursorSlice;
-class Encoding;
-class ErrorList;
+class DocIterator;
class FuncRequest;
-class InsetOld;
+class FuncStatus;
class Language;
class LCursor;
class LyXText;
-class LyXScreen;
class LyXView;
-class Painter;
-class TeXErrors;
-class UpdatableInset;
-
+class ParIterator;
+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
+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
* Create a view with the given owner main window,
* of the given dimensions.
*/
- BufferView(LyXView * owner, int x, int y, int w, int h);
+ BufferView(LyXView * owner);
~BufferView();
/// set the buffer we are viewing
- void buffer(Buffer * b);
+ void setBuffer(Buffer * b);
/// 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
- bool 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();
+ /// return the Scrollbar Parameters
+ ScrollbarParameters const & scrollbarParameters() const;
/// FIXME
bool available() const;
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
- LyXText * getLyXText() const;
-
- /// update paragraph dialogs
- void updateParagraphDialog();
+ LyXText * getLyXText();
- /// return the current encoding at the cursor
- Encoding const * getEncoding() const;
-
- /// return the parent language of the given inset
- Language const * getParentLanguage(InsetOld * inset) const;
-
- /// replace the currently selected word
- void replaceWord(std::string const & replacestring);
+ /// return the lyxtext we are using
+ LyXText const * getLyXText() const;
/// move cursor to the named label
void gotoLabel(std::string const & label);
- /// undo last action
- void undo();
- /// redo last action
- void redo();
-
- /// 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);
- /**
- * Insert an inset into the buffer.
- * Place it in a layout of lout,
- */
- bool insertInset(InsetOld * inset, std::string const & lout = std::string());
-
- /// Inserts a lyx file at cursor position. return false if it fails
- bool insertLyXFile(std::string const & file);
-
- /// FIXME
- bool fitLockedInsetCursor(int x, int y, int asc, int desc);
-
- /// 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);
+ 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();
- /// FIXME
- bool ChangeRefsIfUnique(std::string const & from, std::string const & to);
-
- /// 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);
-
- /// set target x position of cursor
- void x_target(int x);
- /// return target x position of cursor
- int x_target() const;
+
+ ///
+ void selectionRequested();
+ ///
+ void selectionLost();
+
+ ///
+ void workAreaResize(int width, int height);
+
+ /// a function should be executed from the workarea
+ 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 full cursor
- LCursor & fullCursor();
- /// access to full cursor
- void fullCursor(LCursor const &);
+ LCursor & cursor();
/// access to full cursor
- LCursor const & fullCursor() const;
- /// access to topmost cursor slice
- CursorSlice & cursor();
- /// access to topmost cursor slice
- CursorSlice const & cursor() const;
- /// access to selection anchor
- CursorSlice & anchor();
- /// access to selection anchor
- CursorSlice const & anchor() const;
- ///
- UpdatableInset * innerInset() const;
+ LCursor const & cursor() const;
///
LyXText * text() const;
- ///
- void resetAnchor();
+ /// 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
+ * cur + \c length.
+ */
+ void putSelectionAt(DocIterator const & cur,
+ int length, bool backwards);
+ ///
+ ViewMetricsInfo const & viewMetricsInfo();
+ ///
+ void updateMetrics(bool singlepar = false);
+
+ /// This signal is emitted when some message shows up.
+ boost::signal<void(std::string)> message;
private:
///
- struct Pimpl;
+ class Pimpl;
///
- friend struct BufferView::Pimpl;
+ friend class BufferView::Pimpl;
///
Pimpl * pimpl_;
-
- /**
- * The target x position of the cursor. This is used for when
- * we have text like :
- *
- * blah blah blah blah| blah blah blah
- * blah blah blah
- * blah blah blah blah blah blah
- *
- * When we move onto row 3, we would like to be vertically aligned
- * with where we were in row 1, despite the fact that row 2 is
- * shorter than x()
- */
- int x_target_;
-
};
#endif // BUFFERVIEW_H
projects / lyx.git / blobdiff