src/BufferView_pimpl.h

   1 // -*- C++ -*-
   2 /**
   3  * \file BufferView_pimpl.h
   4  * This file is part of LyX, the document processor.
   5  * Licence details can be found in the file COPYING.
   6  *
   7  * \author Asger Alstrup
   8  * \author Alfredo Braustein
   9  * \author Lars Gullik Bjønnes
  10  * \author John Levon
  11  * \author André Pönitz
  12  * \author Dekel Tsur
  13  * \author Jürgen Vigna
  14  *
  15  * Full author contact details are available in file CREDITS.
  16  */
  17
  18 #ifndef BUFFERVIEW_PIMPL_H
  19 #define BUFFERVIEW_PIMPL_H
  20
  21 #include "BufferView.h"
  22 #include "cursor.h"
  23 #include "errorlist.h"
  24
  25 #include "insets/inset.h"
  26
  27 #include "frontends/key_state.h"
  28 #include "frontends/Timeout.h"
  29
  30 #include "support/types.h"
  31
  32 #include <boost/scoped_ptr.hpp>
  33 #include <boost/shared_ptr.hpp>
  34 #include <boost/signals/trackable.hpp>
  35
  36
  37 class Change;
  38 class LyXKeySym;
  39 class LyXView;
  40 class WorkArea;
  41 class LyXScreen;
  42 class FuncRequest;
  43
  44
  45 ///
  46 struct BufferView::Pimpl : public boost::signals::trackable {
  47         ///
  48         Pimpl(BufferView & bv, LyXView * owner,
  49               int xpos, int ypos, int width, int height);
  50         ///
  51         Painter & painter() const;
  52         /// return the screen for this bview
  53         LyXScreen & screen() const;
  54         ///
  55         void buffer(Buffer *);
  56         /// Return true if the cursor was fitted.
  57         bool fitCursor();
  58         ///
  59         void redoCurrentBuffer();
  60         ///
  61         void resizeCurrentBuffer();
  62         ///
  63         void update();
  64         /**
  65          * Repaint pixmap. Used for when we've made a visible
  66          * change but don't need the full update() logic
  67          */
  68         ///
  69         bool newFile(std::string const &, std::string const &, bool);
  70         ///
  71         bool loadLyXFile(std::string const &, bool);
  72         ///
  73         void workAreaResize();
  74         ///
  75         void updateScrollbar();
  76         ///
  77         void scrollDocView(int value);
  78         /// Wheel mouse scroll, move by multiples of text->defaultRowHeight().
  79         void scroll(int lines);
  80         ///
  81         typedef boost::shared_ptr<LyXKeySym> LyXKeySymPtr;
  82         ///
  83         void workAreaKeyPress(LyXKeySymPtr key, key_modifier::state state);
  84         ///
  85         void selectionRequested();
  86         ///
  87         void selectionLost();
  88         ///
  89         void cursorToggle();
  90         ///
  91         bool available() const;
  92         /// get the change at the cursor position
  93         Change const getCurrentChange();
  94         ///
  95         void savePosition(unsigned int i);
  96         ///
  97         void restorePosition(unsigned int i);
  98         ///
  99         bool isSavedPosition(unsigned int i);
 100         ///
 101         void switchKeyMap();
 102         ///
 103         void center();
 104         /// a function should be executed from the workarea
 105         bool workAreaDispatch(FuncRequest const & ev);
 106         /// a function should be executed
 107         bool dispatch(FuncRequest const & ev);
 108         ///
 109         int top_y() const;
 110         ///
 111         void top_y(int y);
 112 private:
 113         /// the y coordinate of the top of the screen
 114         int top_y_;
 115         /// An error list (replaces the error insets)
 116         ErrorList errorlist_;
 117         /// add an error to the list
 118         void addError(ErrorItem const &);
 119         /// buffer errors signal connection
 120         boost::signals::connection errorConnection_;
 121         /// buffer messages signal connection
 122         boost::signals::connection messageConnection_;
 123         /// buffer busy status signal connection
 124         boost::signals::connection busyConnection_;
 125         /// buffer title changed signal connection
 126         boost::signals::connection titleConnection_;
 127         /// buffer reset timers signal connection
 128         boost::signals::connection timerConnection_;
 129         /// buffer readonly status changed signal connection
 130         boost::signals::connection readonlyConnection_;
 131         /// buffer closing signal connection
 132         boost::signals::connection closingConnection_;
 133         /// connect to signals in the given buffer
 134         void connectBuffer(Buffer & buf);
 135         /// disconnect from signals in the given buffer
 136         void disconnectBuffer();
 137         /// track changes for the document
 138         void trackChanges();
 139         /// notify readonly status
 140         void showReadonly(bool);
 141
 142
 143         ///
 144         friend class BufferView;
 145
 146         ///
 147         BufferView * bv_;
 148         ///
 149         LyXView * owner_;
 150         ///
 151         Buffer * buffer_;
 152         ///
 153         boost::scoped_ptr<LyXScreen> screen_;
 154         ///
 155         boost::scoped_ptr<WorkArea> workarea_;
 156         ///
 157         Timeout cursor_timeout;
 158         ///
 159         void stuffClipboard(std::string const &) const;
 160         ///
 161         bool using_xterm_cursor;
 162         ///
 163         struct Position {
 164                 /// Filename
 165                 std::string filename;
 166                 /// Cursor paragraph Id
 167                 int par_id;
 168                 /// Cursor position
 169                 lyx::pos_type par_pos;
 170                 ///
 171                 Position() : par_id(0), par_pos(0) {}
 172                 ///
 173                 Position(std::string const & f, int id, lyx::pos_type pos)
 174                         : filename(f), par_id(id), par_pos(pos) {}
 175         };
 176         ///
 177         std::vector<Position> saved_positions;
 178         /// Get next inset of this class from current cursor position
 179         InsetBase * getInsetByCode(InsetBase::Code code);
 180         ///
 181         void MenuInsertLyXFile(std::string const & filen);
 182         /// our workarea
 183         WorkArea & workarea() const;
 184         /// this is used to handle XSelection events in the right manner
 185         struct {
 186                 CursorSlice cursor;
 187                 CursorSlice anchor;
 188                 bool set;
 189         } xsel_cache_;
 190         ///
 191         LCursor cursor_;
 192 };
 193 #endif // BUFFERVIEW_PIMPL_H