]> git.lyx.org Git - lyx.git/blobdiff - src/BufferView_pimpl.h
revert recent change to development/FORMAT (don't change history)
[lyx.git] / src / BufferView_pimpl.h
index 313e6c459b5d18622f2460c1cbea79f80c3cb138..14c4d52ba5740b6f6ccddcfd99264f071f1b951b 100644 (file)
 // -*- C++ -*-
+/**
+ * \file BufferView_pimpl.h
+ * This file is part of LyX, the document processor.
+ * Licence details can be found in the file COPYING.
+ *
+ * \author Asger Alstrup
+ * \author Alfredo Braustein
+ * \author Lars Gullik Bjønnes
+ * \author John Levon
+ * \author André Pönitz
+ * \author Dekel Tsur
+ * \author Jürgen Vigna
+ *
+ * Full author contact details are available in file CREDITS.
+ */
 
 #ifndef BUFFERVIEW_PIMPL_H
 #define BUFFERVIEW_PIMPL_H
 
 #include "BufferView.h"
-#include "commandtags.h"
-#include "frontends/mouse_state.h"
-#include "frontends/Timeout.h"
-// FIXME remove me 
-#include "frontends/WorkArea.h"
-#include "box.h"
-#include "insets/insetspecialchar.h"
-#include "support/types.h"
+#include "cursor.h"
+#include "metricsinfo.h"
 
-#include <boost/scoped_ptr.hpp>
+#include "frontends/LyXKeySym.h"
 
-#ifdef __GNUG__
-#pragma interface
-#endif
+#include "support/types.h"
 
+class Change;
 class LyXView;
-class WorkArea;
-class LyXScreen;
+
+class FuncRequest;
+class FuncStatus;
+
+namespace lyx {
+namespace frontend {
+class Gui;
+}
+}
+
 
 ///
-struct BufferView::Pimpl : public SigC::Object {
-       ///
-       Pimpl(BufferView * i, LyXView * o,
-             int xpos, int ypos, int width, int height);
-       ///
-       Painter & painter();
-       ///
-       void buffer(Buffer *);
+class BufferView::Pimpl {
+public:
        ///
-       void resize(int xpos, int ypos, int width, int height);
+       Pimpl(BufferView & bv, LyXView * owner);
        ///
-       void resize();
+       void setBuffer(Buffer * buf);
+       /// return the first layout of the Buffer.
+       std::string firstLayout();
        ///
-       void redraw();
-       /// Return true if the cursor was fitted.
+       void resizeCurrentBuffer();
+       //
        bool fitCursor();
-       ///
-       void redoCurrentBuffer();
-       ///
-       int resizeCurrentBuffer();
-       ///
-       void update();
        //
-       void update(LyXText *, BufferView::UpdateCodes);
-       /// Update pixmap of screen
-       void updateScreen();
-       ///
-       void workAreaExpose();
-       ///
-       void updateScrollbar();
-       ///
-       void scrollCB(double value);
-       /**
-        * Returns an inset if inset was hit, or 0 if not.
-        *
-        * If hit, the coordinates are changed relative to the inset.
-        */
-       Inset * checkInsetHit(LyXText *, int & x, int & y);
-       ///
-       int scrollUp(long time);
+       bool multiParSel();
        ///
-       int scrollDown(long time);
+       bool update(Update::flags flags = Update::Force);
+       /// load a buffer into the view
+       bool loadLyXFile(std::string const &, bool);
        ///
-       void workAreaKeyPress(KeySym, key_modifier::state state);
+       void workAreaResize(int width, int height);
        ///
-       void workAreaMotionNotify(int x, int y, mouse_button::state state);
-       ///
-       void workAreaButtonPress(int x, int y, mouse_button::state button);
+       void updateScrollbar();
        ///
-       void workAreaButtonRelease(int x, int y, mouse_button::state button);
+       ScrollbarParameters const & scrollbarParameters() const;
        ///
-       void doubleClick(int x, int y, mouse_button::state button);
+       void scrollDocView(int value);
        ///
-       void tripleClick(int x, int y, mouse_button::state button);
+       void setCursorFromScrollbar();
+       /// Wheel mouse scroll, move by multiples of text->defaultRowHeight().
+       void scroll(int lines);
        ///
        void selectionRequested();
        ///
        void selectionLost();
        ///
-       void enterView();
-       ///
-       void leaveView();
-       ///
-       void cursorToggle();
-       ///
-       void cursorPrevious(LyXText *);
-       ///
-       void cursorNext(LyXText *);
-       ///
        bool available() const;
-       ///
-       void beforeChange(LyXText *);
+       /// get the change at the cursor position
+       Change const getCurrentChange();
        ///
        void savePosition(unsigned int i);
        ///
        void restorePosition(unsigned int i);
        ///
        bool isSavedPosition(unsigned int i);
+       /// save bookmarks to .lyx/session
+       void saveSavedPositions();
        ///
-       void setState();
-#if 0
-       ///
-       void insetSleep();
-       ///
-       void insetWakeup();
-#endif
-       ///
-       void insetUnlock();
-       ///
-       bool focus() const;
-       ///
-       void focus(bool);
-       ///
-       bool active() const;
-       ///
-       bool belowMouse() const;
-       ///
-       void showCursor();
-       ///
-       void hideCursor();
-       ///
-       void toggleSelection(bool = true);
-       ///
-       void toggleToggle();
+       void switchKeyMap();
        ///
        void center();
-       ///
-       bool insertInset(Inset * inset, string const & lout = string());
-       ///
-       void updateInset(Inset * inset, bool mark_dirty);
-       ///
-       bool Dispatch(kb_action action, string const & argument);
-private:
+       /// a function should be executed from the workarea
+       bool workAreaDispatch(FuncRequest const & ev);
+       /// return true for events that will handle
+       FuncStatus getStatus(FuncRequest const & cmd);
+       /// a function should be executed
+       bool dispatch(FuncRequest const & ev);
+
+       /// Width and height of the BufferView in Pixels
        /**
-        * Return the on-screen dimensions of the inset at the cursor.
-        * Pre-condition: the cursor must be at an inset.
-        */
-       Box insetDimensions(LyXText const & text, LyXCursor const & cursor) const;
+       This is set externally by the workAreaResize method.
+       */
+       int width() const;
+       /// Height of the BufferView in Pixels
        /**
-        * check if the given co-ordinates are inside an inset at the given cursor,
-        * if one exists. If so, the inset is returned, and the co-ordinates are
-        * made relative. Otherwise, 0 is returned.
-        */
-       Inset * checkInset(LyXText const & text, LyXCursor const & cursor, int & x, int & y) const;
-       ///
-       friend class BufferView;
-       /// open and lock an updatable inset
-       bool open_new_inset(UpdatableInset * new_inset, bool behind = false);
+       This is set externally by the workAreaResize method.
+       */
+       int height() const;
+
        ///
-       void specialChar(InsetSpecialChar::Kind);
+       ViewMetricsInfo const & viewMetricsInfo();
        ///
-       void newline();
+       void updateMetrics(bool singlepar = false);
+
+private:
        ///
-       void hfill();
+       int width_;
        ///
-       void smartQuote();
+       int height_;
        ///
-       void insertAndEditInset(Inset *);
+       ScrollbarParameters scrollbarParameters_;
+
+       /// track changes for the document
+       void trackChanges();
+
        ///
-       void gotoInset(std::vector<Inset::Code> const & codes,
-                      bool same_content);
+       ViewMetricsInfo metrics_info_;
+
        ///
-       void gotoInset(Inset::Code codes, bool same_content);
+       friend class BufferView;
+
        ///
        BufferView * bv_;
        ///
        LyXView * owner_;
        ///
        Buffer * buffer_;
+
+       /// Estimated average par height for scrollbar
+       int wh_;
        ///
-       boost::scoped_ptr<LyXScreen> screen_;
-       ///
-       long current_scrollbar_value;
-       ///
-       Timeout cursor_timeout;
-       ///
-       WorkArea workarea_;
-       ///
-       void pasteClipboard(bool asPara);
-       ///
-       void stuffClipboard(string const &) const;
-       ///
-       bool using_xterm_cursor;
-       ///
-       struct Position {
+       class Position {
+       public:
                /// Filename
-               string filename;
+               std::string filename;
                /// Cursor paragraph Id
                int par_id;
                /// Cursor position
@@ -198,18 +151,28 @@ private:
                ///
                Position() : par_id(0), par_pos(0) {}
                ///
-               Position(string const & f, int id, lyx::pos_type pos)
+               Position(std::string const & f, int id, lyx::pos_type pos)
                        : filename(f), par_id(id), par_pos(pos) {}
        };
        ///
        std::vector<Position> saved_positions;
        ///
-       void moveCursorUpdate(bool selecting, bool fitcur = true);
-       /// Get next inset of this class from current cursor position
-       Inset * getInsetByCode(Inset::Code code);
+       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_;
        ///
-       void MenuInsertLyXFile(string const & filen);
+       bool multiparsel_cache_;
        ///
-       bool inset_slept;
+       lyx::pit_type anchor_ref_;
+       ///
+       int offset_ref_;
+
 };
-#endif
+#endif // BUFFERVIEW_PIMPL_H