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         ///
 105         bool insertInset(InsetBase * inset, std::string const & lout = std::string());
 106         /// a function should be executed from the workarea
 107         bool workAreaDispatch(FuncRequest const & ev);
 108         /// a function should be executed
 109         bool dispatch(FuncRequest const & ev);
 110         ///
 111         int top_y() const;
 112         ///
 113         void top_y(int y);
 114         /// update paragraph dialogs
 115         void updateParagraphDialog();
 116 private:
 117         /// the y coordinate of the top of the screen
 118         int top_y_;
 119         /// An error list (replaces the error insets)
 120         ErrorList errorlist_;
 121         /// add an error to the list
 122         void addError(ErrorItem const &);
 123         /// buffer errors signal connection
 124         boost::signals::connection errorConnection_;
 125         /// buffer messages signal connection
 126         boost::signals::connection messageConnection_;
 127         /// buffer busy status signal connection
 128         boost::signals::connection busyConnection_;
 129         /// buffer title changed signal connection
 130         boost::signals::connection titleConnection_;
 131         /// buffer reset timers signal connection
 132         boost::signals::connection timerConnection_;
 133         /// buffer readonly status changed signal connection
 134         boost::signals::connection readonlyConnection_;
 135         /// buffer closing signal connection
 136         boost::signals::connection closingConnection_;
 137         /// connect to signals in the given buffer
 138         void connectBuffer(Buffer & buf);
 139         /// disconnect from signals in the given buffer
 140         void disconnectBuffer();
 141         /// track changes for the document
 142         void trackChanges();
 143         /// notify readonly status
 144         void showReadonly(bool);
 145
 146         /**
 147          * Change all insets with the given code's contents to a new
 148          * string. May only be used with InsetCommand-derived insets
 149          * Returns true if a screen update is needed.
 150          */
 151         bool ChangeInsets(InsetBase::Code code, std::string const & from,
 152                           std::string const & to);
 153
 154         ///
 155         friend class BufferView;
 156
 157         ///
 158         BufferView * bv_;
 159         ///
 160         LyXView * owner_;
 161         ///
 162         Buffer * buffer_;
 163         ///
 164         boost::scoped_ptr<LyXScreen> screen_;
 165         ///
 166         boost::scoped_ptr<WorkArea> workarea_;
 167         ///
 168         Timeout cursor_timeout;
 169         ///
 170         void stuffClipboard(std::string const &) const;
 171         ///
 172         bool using_xterm_cursor;
 173         ///
 174         struct Position {
 175                 /// Filename
 176                 std::string filename;
 177                 /// Cursor paragraph Id
 178                 int par_id;
 179                 /// Cursor position
 180                 lyx::pos_type par_pos;
 181                 ///
 182                 Position() : par_id(0), par_pos(0) {}
 183                 ///
 184                 Position(std::string const & f, int id, lyx::pos_type pos)
 185                         : filename(f), par_id(id), par_pos(pos) {}
 186         };
 187         ///
 188         std::vector<Position> saved_positions;
 189         /// Get next inset of this class from current cursor position
 190         InsetBase * getInsetByCode(InsetBase::Code code);
 191         ///
 192         void MenuInsertLyXFile(std::string const & filen);
 193         /// our workarea
 194         WorkArea & workarea() const;
 195         /// this is used to handle XSelection events in the right manner
 196         struct {
 197                 CursorSlice cursor;
 198                 CursorSlice anchor;
 199                 bool set;
 200         } xsel_cache_;
 201         ///
 202         LCursor cursor_;
 203 };
 204 #endif // BUFFERVIEW_PIMPL_H