]> git.lyx.org Git - lyx.git/blobdiff - src/BufferView.h
minimal effort implementation of:
[lyx.git] / src / BufferView.h
index e9294d9423f7a3951e47e924fddaa66cd959e7a9..9989b826a1fbcd9cf390c9263bf172e612dacdb1 100644 (file)
 #ifndef BUFFER_VIEW_H
 #define BUFFER_VIEW_H
 
-#include "LString.h"
+#include "metricsinfo.h"
 
-#include "insets/inset.h"
+#include "frontends/LyXKeySym.h"
+
+#include "support/types.h"
 
 #include <boost/utility.hpp>
+#include <boost/signal.hpp>
+
+#include <string>
 
-class Change;
-class LyXView;
-class LyXText;
-class TeXErrors;
 class Buffer;
-class LyXScreen;
+class Change;
+class DocIterator;
+class FuncRequest;
+class FuncStatus;
 class Language;
-class Painter;
-class UpdatableInset;
-class WordLangTuple;
-class Encoding;
-class ErrorList;
+class LCursor;
+class LyXText;
+class LyXView;
+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
@@ -48,137 +90,77 @@ public:
         * 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(string const & fname, string const & tname,
-                    bool named = true);
        /// load a buffer into the view
-       bool loadLyXFile(string const & name, bool tolastfiles = true);
+       bool loadLyXFile(std::string const & name, bool tolastfiles = true);
 
-       /// fit the user cursor within the visible view
-       bool fitCursor();
-       /// perform pending painting updates
-       void update();
-       /** update for a particular inset. Gets a pointer and not a
-        *  reference because we really need the pointer information
-        *  to find it in the buffer.
+       /** 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.
         */
-       void updateInset(InsetOld const *);
+       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();
-       /// FIXME
-       void redoCurrentBuffer();
+       /// return the Scrollbar Parameters
+       ScrollbarParameters const & scrollbarParameters() const;
 
        /// FIXME
        bool available() const;
 
-       /// FIXME
-       void beforeChange(LyXText *);
-
        /// 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();
 
-       /**
-        * This holds the mapping between buffer paragraphs and screen rows.
-        * This should be private...but not yet. (Lgb)
-        */
-       LyXText * text;
        /// return the lyxtext we are using
-       LyXText * getLyXText() const;
-
-       /// Return the current inset we are "locked" in
-       UpdatableInset * theLockingInset() const;
-       /// lock the given inset FIXME: return value ?
-       bool lockInset(UpdatableInset * inset);
-       /// unlock the given inset
-       int unlockInset(UpdatableInset * inset);
-       /// unlock the currently locked inset
-       void insetUnlock();
-
-       /// 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;
-
-       /// Select the "current" word
-       void selectLastWord();
-       /// replace the currently selected word
-       void replaceWord(string const & replacestring);
-       /// Update after spellcheck finishes
-       void endOfSpellCheck();
-       /// return the next word
-       WordLangTuple const nextWord(float & value);
+       LyXText * getLyXText();
 
-       /// move cursor to the named label
-       void gotoLabel(string const & label);
+       /// return the lyxtext we are using
+       LyXText const * getLyXText() const;
 
-       /// undo last action
-       void undo();
-       /// redo last action
-       void redo();
+       /// move cursor to the named label
+       void gotoLabel(std::string const & label);
 
-       /// get the stored error list
-       ErrorList const & getErrorList() const;
-       /// show the error list to the user
-       void showErrorList(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, string const & lout = string());
-
-       /// Inserts a lyx file at cursor position. return false if it fails
-       bool insertLyXFile(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;
@@ -188,35 +170,62 @@ public:
        /// switch between primary and secondary keymaps for RTL entry
        void switchKeyMap();
 
-       /// FIXME
-       bool ChangeRefsIfUnique(string const & from, string const & to);
-
-       /// get the contents of the window system clipboard
-       string const getClipboard() const;
-       /// fill the window system clipboard
-       void stuffClipboard(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);
 
-private:
-       /// Set the current locking inset
-       void theLockingInset(UpdatableInset * inset);
-
-       /**
-        * Change all insets with the given code's contents to a new
-        * string. May only be used with InsetCommand-derived insets
-        * Returns true if a screen update is needed.
+       ///
+       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 & cursor();
+       /// access to full cursor
+       LCursor const & cursor() const;
+       ///
+       LyXText * text() const;
+       /// 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.
         */
-       bool ChangeInsets(InsetOld::Code code, string const & from,
-                         string const & to);
+       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;
 
-       struct Pimpl;
-       friend struct BufferView::Pimpl;
-
+private:
+       ///
+       class Pimpl;
+       ///
+       friend class BufferView::Pimpl;
+       ///
        Pimpl * pimpl_;
 };